This PR adds 'Help' buttons that link to the documentation and other 'help'-related functionalities.
'Help' button
A 'Help' radio button was added to the ModuleSelectorDialog class, and individual dialog classes of Sign-level, Sign type and X-slot specifications. Consequently, all dialogs that inherit ModuleSelectorDialog and the three major specification dialogs will now include an additional 'Help' button at the bottom of the window. The button will appear on the left-most side if on Mac and right-most on Windows, aligning with the customary layout for each OS.
MacOS
Windows
Each 'Help' button opens a URL. The destination is specified in the dictionary help_map in link_help.py. It specifies the mapping between functionalities (e.g., movement, non-manual, orientation, preferences, etc.) and the help page. For instance, the key-value pair of 'movement': 'movement_module' indicates that the help button in the movement specification dialog should link to... slp-aa.readthedocs.io/en/latest/movement_module.html.
'Help' menu
The 'Help' menu was added to the menu bar, with three sub-menus: 'Help,' 'About' and 'Show version number.' On Mac, the 'About' menu will be under the program name menu next to .
Help > Show version number: prompts a message box that shows a version number. The specific message differs by the user's environment: "You are running SLPAA version x.y.z" or "You are running SLPAA from the source code." The latter can be followed by a git hash if available.
Running as executable
Running from the source (if no git info available)
This PR adds 'Help' buttons that link to the documentation and other 'help'-related functionalities.
'Help' button
A 'Help' radio button was added to the
ModuleSelectorDialogclass, and individual dialog classes of Sign-level, Sign type and X-slot specifications. Consequently, all dialogs that inheritModuleSelectorDialogand the three major specification dialogs will now include an additional 'Help' button at the bottom of the window. The button will appear on the left-most side if on Mac and right-most on Windows, aligning with the customary layout for each OS.Each 'Help' button opens a URL. The destination is specified in the dictionary
help_mapinlink_help.py. It specifies the mapping between functionalities (e.g., movement, non-manual, orientation, preferences, etc.) and the help page. For instance, the key-value pair of'movement': 'movement_module'indicates that the help button in the movement specification dialog should link to... slp-aa.readthedocs.io/en/latest/movement_module.html.'Help' menu
The 'Help' menu was added to the menu bar, with three sub-menus: 'Help,' 'About' and 'Show version number.' On Mac, the 'About' menu will be under the program name menu next to .
(if no git info available)
(if git info available)