Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feat] Create a "Notes" panel for GRASS GIS Mapset with Markdown Support #4237

Open
lindakarlovska opened this issue Aug 27, 2024 · 3 comments
Labels
enhancement New feature or request GUI wxGUI related

Comments

@lindakarlovska
Copy link
Contributor

Overview:
It would be nice to improve the project management and reproducibility by documenting details about the content of the current mapset directly in the GUI. I can imagine the new panel, let's say the "Notes" panel or "Metadata" panel implemented as a Markdown editor and viewer where users can write notes on stored maps, the analyses performed, and other relevant metadata. The notes will be saved as a Markdown file within the mapset directory and continuously updated to reflect any changes. This could make it easier for users to keep track of important information related to their work.

Key features:

  • A panel in the GRASS GIS GUI that includes a text editor for writing in Markdown format.
  • A live preview window displaying the rendered Markdown as HTML.
  • Existing notes should be loaded when opening a mapset.
  • It should allow users to save the Markdown file manually.
  • The file should be automatically updated when users modify the content in the Notes Panel.

Implementation
The suggestion is to use the markdown2 library for converting Markdown to HTML and wx.html2 for displaying Markdown content in the panel. I have created locally a small simple example of such a panel, it could look e.g. something like:
Screenshot from 2024-08-27 10-01-15

Any comments and suggestions are welcome!

@lindakarlovska lindakarlovska added enhancement New feature or request GUI wxGUI related labels Aug 27, 2024
@petrasovaa
Copy link
Contributor

Similarly, there are requests for having a jupyter notebook integrated in the GUI. I am not sure how feasible that is.

@wenzeslaus
Copy link
Member

Markdown notes are more feasible then whole notebook system.

@wenzeslaus
Copy link
Member

Right now, each project can have a title, but that's rarely visible anywhere. Maps can have titles too, but that's also somewhat underused.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request GUI wxGUI related
Projects
None yet
Development

No branches or pull requests

3 participants