Skip to content

Proposal to integrate KTextEditor into Cantor

Project abstract

Cantor is a KDE user application that provides a graphical front-end to various computer algebra systems and programming languages.

I propose to integrate the KTextEditor component into Cantor to replace the current WorksheetEntry implementation.

Proposal

The project aims to leverage the features of KTextEditor in Cantor by replacing the existing cell management logic. This integration will simplify the codebase and add various new features to Cantor, such as:

  • Vi Mode
  • Improved syntax highlighting
  • Auto-Indent
  • Code completion
  • Spell Check

Since the KTextEditor is already being used in applications like KDevelop, the integration will help create a consistent user experience across the KDE software ecosystem.

The proposal also seeks to address the following bugs relevant to the text editor component:

Implementation Plan

  1. Research and Design: Gaining a deeper understanding of Cantor's source code and studying KTextEditor's feature sets. Understand integration of KTextEditor in other KDE applications.
  2. Code Implementation: Replace the current text editor component in Cantor with KTextEditor, ensuring no regressions to existing functionality.
  3. User Interface Integration: Adding configuration option in user settings. Provide options within Cantor's settings to configure newly implemented features.
  4. Documentation: The necessary implementation details will be documented for other contributors to achieve a maintainable design. Once all the changes have been finalized and merged, the Cantor handbook will be updated with relevant user documentation.
  5. Testing: Write tests to ensure the correctness of the implementation and integrate them into the CI systems used by the project.

Timeline

  • Week 1: Research and Design
  • Week 2-6: Code Implementation
  • Week 7-8: User Interface Integration
  • Week 9: Documentation and Testing
  • Week 10: Bug Fixes and QA

Note: The above timeline is a preliminary estimate and adjustments may be required based on community feedback and final design.

About Me

I am Anshul Dalal, a systems programmer looking to expand my knowledge of desktop application development with Qt. Currently pursuing my Bachelor's in Computer Science, I am excited about the opportunity to work on this proposal. It not only serves as a great learning exercise but also provides value to Cantor users.

My background includes experience in developing drivers in C and the Rust programming language. I have contributed several patches to the Linux kernel, including the development of four device drivers. I am eager to become an active member of the KDE community and successfully deliver on the proposal during the program!

My notable open source contributions to the Linux kernel:

I have linked my Resume below, thanks for your time,

Anshul

References

  1. Cantor: https://apps.kde.org/cantor/
  2. Mailing List: kde-edu@kde.org
  3. KTextEditor: https://api.kde.org/frameworks/ktexteditor/html/
  4. My Resume: https://archusr64.github.io/resume/Resume.pdf

Contact

Email: anshulusr@gmail.com

Element: @archusr:matrix.org

IRC Nickname: archusr

/cc @teams/season-of-kde

Edited by Anshul Dalal