Updates to interface documentation

[mjwagner2]

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]

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]

@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]

I'm attaching the following:

• An annotated PDF of the prior help documentation with specific guidance on what requires updates.
• Documentation for the point-focus option on the trace page. The LaTeX source for the PDF is here, and figures are here.

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]

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 ***@***.***> wrote: I'm attaching the following: - An annotated PDF <https://github.com/NREL/SolTrace/files/2228486/SolTrace_notes.pdf> of the prior help documentation with specific guidance on what requires updates. - Documentation <https://github.com/NREL/SolTrace/files/2228489/soltrace-point-focus.pdf> for the point-focus option on the trace page. The LaTeX source for the PDF is here <https://github.com/NREL/SolTrace/blob/documentation-update/projectdoc/soltrace.tex>, and figures are here <https://github.com/NREL/SolTrace/tree/documentation-update/projectdoc/figures> . 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 <#12 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AQ0-jpBC9A58kMYaBukD-ZpTnvcvGhiLks5uKI_sgaJpZM4VNYsJ> .