search

AAVSO / VStar

VStar is a visualisation and analysis tool for variable star data brought to you by AAVSO
https://www.aavso.org/vstar
GNU Affero General Public License v3.0
9 stars 3 forks source link

Plugin manager help functionality #380

Closed mpyat2 closed 8 months ago

mpyat2 commented 8 months ago

Hi @dbenn ,

Please take a look at this if you have time. In addition to the 'Help' functionality implemented in the plug-in manager dialog, I've added 'Help' button to some plug-in dialogs (New star from AAVSOnet/APASS, Create B-B series, Gaia, ZTF, New star from VeLa, Fourier Model (Period count/ periods dialogs), Heliocentric JD converter.

Ironically, with this approach, the plug-ins have better help support than the main program. Probably we could think about a better help subsystem (in the future).

Cheers, Max

dbenn commented 8 months ago

I agree that the plugin context-sensitive help is great and would be good to do for the tool itself. The 130+ page user manual was a big undertaking at the time, especially in my spare time, and at least the hard part is done (the content). If I was doing it again I'd put the manual on a wiki, which would make pointing to sub-sections easier; but this was pre-GitHub times.

mpyat2 commented 8 months ago

Hi @dbenn , yes, if the manual is converted to separate pages, they could be used as help topics. Meanwhile, I've added a button to the chooser (file open dialog). I've also created a stub for the "AAVSO download and simple formats" source Wiki page (the internal plug-in). Slightly lately, I will push the changes. image

mpyat2 commented 8 months ago

OK, I pushed the changes. Now, file chooser contains a help [?] button that invokes the plugin's help. 'Help' button title was localized, the comment to getDocName() was extended.

dbenn commented 8 months ago

Thanks @mpyat2. Anything else to be done or happy for me to merge?

mpyat2 commented 8 months ago

Hi @dbenn , please merge it!