Create a "Help" menu item

[petertzy]

Create a "Help" menu item; clicking it will open a dialog box. Advanced options could include a user manual providing detailed instructions on how to use the software. For now, create a simple dialog box displaying necessary usage steps.

[PMaruthiPrasad]

Hi @petertzy ,
I am planning to make Help menu as shown below.

This menu item will have a dialog box, which display brief description of each menu option as shown below.

File Menu

New
Creates a new blank Markdown (.md) document for editing.

Open File
Opens an existing Markdown (.md) file from your system for viewing or editing.

Save File
Saves the current Markdown document to the selected file location.

Export to HTML
Converts the current Markdown document into an HTML file for web viewing.

Export to Word
Exports the current Markdown document as a Microsoft Word (.docx) file.

Export to PDF
Generates a PDF version of the current Markdown document.

Close
Closes the currently open Markdown document without exiting the application.

Close All
Closes all open Markdown documents in the editor.

Exit
Closes the application completely.

can you assign this task to me?

[petertzy]

Hi @PMaruthiPrasad,
thanks for your proposal and for the detailed description. The approach looks good.
I’ve assigned this issue to you. Feel free to proceed, and let me know if you have any questions.

[IlyasFardaouix]

I think the issue here is that the dialog box functionality is currently implemented in file_handler.py, but it's being used as a utility function in various places. To create a "Help" menu item, we'll need to integrate this functionality into the main app logic. I'd suggest taking a look at app.py and __init__.py to see how we can create a new menu item that opens a dialog box displaying the necessary usage steps. One thing to check is how MarkdownReader is initialized and if we can inject the dialog box functionality into it.

[PMaruthiPrasad]

Hi @IlyasFardaouix ,
I couldn't get your thought process completely.
However I started implementing it and now I am working on text alignment.
The latest code is here (https://github.com/PMaruthiPrasad/markdown-reader, branch: help_menu), please have a look.
let me know if any changes required in my approach.

[IlyasFardaouix]

Hi @PMaruthiPrasad, thanks for sharing your latest code. I took a look and I think you're on the right track. One thing I'd like to clarify is how you're planning to integrate the MarkdownReader initialization with the new "Help" menu item. Are you thinking of creating a new instance of MarkdownReader specifically for the dialog box, or reusing the existing instance? This will help me better understand your design and provide more targeted feedback.

[PMaruthiPrasad]

Hi @IlyasFardaouix , I am reusing the existing instance.