search

NREL / SolTrace

SolTrace
https://www.nrel.gov/csp/soltrace.html
Other
42 stars 30 forks source link

Updates to interface documentation #12

Open mjwagner2 opened 6 years ago

mjwagner2 commented 6 years ago

The current help functionality in SolTrace consists of LK a function reference listing and a link to the PDF of the Wendelin et al. NREL report on SolTrace. In the older version of SolTrace (pre-wxWidgets...), an interactive help structure existed that provided reference and guidance for each input page.

Moving forward, SolTrace should be updated to restore interactive help menu functionality. Files associated with the old help menu are attached.

old-soltrace-help.zip

The documentation needs to be updated to be accurate for the current model, and it requires expansion to cover new features as needed.

gtompkins40 commented 6 years ago

I am currently trying to build a portfolio of documentation for my resume and would like to help with any documentation needs. You can email me any details if you would like my help. If not feel free to ignore. Thank you for your time.

mjwagner2 commented 6 years ago

@gtompkins40 Hi Garrett, that would be great. Any help you can provide would be welcome, even if it is just taking things a step further. I'll follow up by email shortly.

mjwagner2 commented 6 years ago

I'm attaching the following:

The help system was created using HelpNDoc, which is free for personal use. NREL holds a professional license, so we can compile and distribute the final version. The HelpNDoc file has been added to a new branch for documentation updates here.

gtompkins40 commented 6 years ago

I've read through the PDF and I will start to make edits as best I can over the next few days. Thanks again for this opportunity and I apologize for the slow going.

-Garrett Tompkins

On Wed, Jul 25, 2018 at 11:34 AM, Mike Wagner notifications@github.com wrote:

I'm attaching the following:

The help system was created using HelpNDoc https://www.helpndoc.com/download, which is free for personal use. NREL holds a professional license, so we can compile and distribute the final version. The HelpNDoc file has been added to a new branch for documentation updates here https://github.com/NREL/SolTrace/blob/documentation-update/projectdoc/help-menu/soltrace_doc.hnd .

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/NREL/SolTrace/issues/12#issuecomment-407797260, or mute the thread https://github.com/notifications/unsubscribe-auth/AQ0-jpBC9A58kMYaBukD-ZpTnvcvGhiLks5uKI_sgaJpZM4VNYsJ .