GSoC/2020/StatusReports/Shubham

Integrated Documentation

At the moment the external documentation like for example for Maxima http://maxima.sourceforge.net/docs/manual/en/maxima.html, and similar for Octave, python, etc., is opened in the external browser window. Ideally, it should be shown inside of the application in the help/documentation panel and enable a quick access to the documentation together with some more advanced search capabilities. Integrated search and also the context sensitive help (user marks a keyword in the worksheet, hits e.g. the F1 button and the documentation for the selected keyword is shown) should be possible. Qt Help Framework (http://doc.qt.io/qt-5/qthelp-framework.html) should be utilized for this. For indexing and searching in a unified manner the documentation together with the search index should be available locally. Qt help's qch file should be available for download on store.kde.org. Users of different systems (Maxima, Octave, R, etc.) would download the documentation they need. Ideally, there should be similar appearance of documentations by css-styling the html files for different systems prior to creating those qch files.

Project Goals

• Implementation in C++ (documentation panel, searching, short cuts for faster navigation, etc.)
• Creation of Qt help files for major computer algebra systems and programming languages supported by Cantor
• Availability of qch files over KDE store

Link to my blog

https://coderunner99.blogspot.com/

Contact Me

Email: [email protected]

IRC: shubham1000

Github Profile: https://github.com/Shubham-100