Cantor Integrated Documentation : Week 3 and 4 Progress

Hello KDE people. First phase evaluations is due from today onward until 3rd of July. It has been coupe of weeks since I had posted about my project. I was quite busy writing code implementing the documentation panel for the various backends supported by Cantor. In the last post I have explained about how I generated the help files namely qhc (Qt Help Collection) and qch (Qt Compressed Help) from the documentation's source file. In today's post I will explain how I utilized Maxima's help files to actually display help inside the Cantor application itself. So here are the things done:-

Things Done

1. Implementation of Documentation Panel
Cantor has dedicated panels for Variable manager and some general Help. So I have created a new panel dedicated to display the documentation of the backend which is currently active. To implement it, I have borrowed some basic code from the cantor/src/panelplugins and added widgets similar to any documentation help. I have added tabs for displaying Contents, Index and Search for the documentation. These widgets are populated by loading the help files using a QHelpEngine instance. Currently, Search functionality is yet to be implemented.

2. Display of documentation inside the Documentation Panel
I have kept the design as simple as possible. I have divided the display area into 2 halves, one half is the QTabWidget which displays the above listed widgets and the other half is the QWebEngineView, which I am using as a display area for the contents of the documentation. To make the display responsive to the events on the QTabWidget, I have connected the signals of the index and content widget to a slot which displays the contents in the View.

3. Context Sensitive Search Capabilities

I have successfully implemented the Context Sensitive Search capability. The user can now while in the worksheet, can select any keyword and then press F2 to show the relevant documentation about that topic. The QWebEngineView updates in real time.

User selected 'sin' and then pressed F2 to forward to the related documentation
On pressing F2 key while 'sin' keyword was selected, the index was filtered and the corresponding topic documentation was shown in the view area. 

For those interested in trying it out themselves and/or playing with the code, can clone my repository and build it from source. Here is the link to my repository on which I am working.

That's all folks for this time, until then, Good bye!!

Comments

Post a Comment

Popular posts from this blog

Cantor Integrated Documentation : Week 1 and 2 Progress

Image
Hello KDE people!! It's been almost couple of weeks of the coding period already, and it has been hectic already. I was mostly able to stick to the timeline I had proposed, just loosing couple of days here and there. None the less, I am here presenting my progress on the project. Things Done 1. Creation of QHP file It stands for Qt Help Project. This is similar to xml’s file format. It contains the table of contents, indices, and references to the actual documentation files (*.html). This file is later passed to qhcp (Qt Help Collection File). It contains various tags like table of contents, section tag for defining the actual documentation, keywords tag for defining the indices for the documentation, files tag for listing all the files required. Click here for more details on qhp For adding the keywords that will serve as the index for the documentation, I made use of the index.hhk file that is shipped with the official installation of Maxima. But, copying and
Read more

Cantor Integrated Documentation : Month 3 Progress

Image
Hello KDE people. Phase 3 evaluation is on. In this blog  post, I will update you on the progress made during the final month of the coding period. So here are the things done:- Things Done 1. Added  NumPy's and Julia's doumentation I have generated NumPy's and Julia's Qt Help files from their official documentation and then added it to the documentation panel. Here is how NumPy's documentation looks like. 2. Added Widget inside backend's Settings page  to add/remove local/remote Qt Help files I have added a widget inside backend's settings dialog page which will allow the users to add/remove local Qt documentation help files or install newer ones from the Cantor's section on the KDE store. Currently I have just added the widget, I plan to complete this feature in the next few days. This is how the widget  looks like. "Add" button opens up a dialog to add a new locally present Qt Help file, while "Get New Documentation"
Read more

Cantor Integrated Documentation : Month 2 Progress

Image
Hello KDE people. Phase 2 evaluation is due from today onward until the 31st of July. In this blog  post, I will update you on the progress made during the second month of the coding period. So here are the things done:- Things Done 1. Changed the layout  of the documentation panel First of all, I have changed the basic layout of the panel altogether. Now it is much more attractive UI wise, more usable UX wise, and overall a good package with looks and features.  Here is how it looks like. Documentation Panel 2. Add several minor widgets to improve the usability " Search through keywords "  widget: This widget will be used by the user to search for help for particular keywords. This widget has a completer that displays the suggestions in real-time so that the user can reach the documentation for the intended keyword. " Find in Page text "  widget: This widget will be used for string matching. It contains an input box where users can type in the
Read more