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

• Creation of Qt help files for Maxima (qch and qhc)
  • Status: Done
• Dedicated Documentation panel
  • Status: Done
• Context sensitive help support
  • Status: Done
• Topic based searching
  • Status: Pending
• Availability of qch files over KDE store
  • Status: Pending

Month 1 (June 1 - July 3)

During the first half of the period, I have created Qt help files namely qch and qhc from the Maxima's source code for it's documentation. I have added some custom styling to it as well. In the second half of the coding period, I was busy writing code to implement a dedicated documentation panel which would display the relevant help to the user. I have also successfully implemented context sensitive search capabilities inside the worksheet for Maxima backend. This page lists all the commits made so far. To get more detailed information, consider going through the blog post listed below.

Link to my blog

https://coderunner20.blogspot.com/

My Branch

https://invent.kde.org/education/cantor/-/tree/gsoc20_documentation

Contact Me

Email: [email protected]

IRC: shubham1000

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

Gitlab Profile: https://invent.kde.org/shubham