Skip to content

#242 Added new configuration value and generation summary dialog

John Medlandrequested to merge
j-medland/labview-doc-generator:feature/pre-generation-summary into develop

Ahoy!

This MR is based on the discussion from the Wovalab Zulip topic #Antidoc > Allow Relative Paths in Custom Output Directory

To summarise: I wanted to be able to use relative paths to specify the output destination directory but there is no easy way to verify the path easily until the actual generation step of the tool's usage. I proposed a "Generation Summary Dialog" which would allow for users to quickly check all the settings looked good without having to just run the document generation and check the result.

This MR includes a couple of main changes - firstly this dialog will be shown when the user clicks "Generate" on the Antidoc Tool window.

image

This provides the ability to review the settings and either continue, cancel or cancel and jump straight to the General Settings. I had thought about making it so the user could go back and forth between the Summary Dialog and the General Settings Dialog but this flow can be confusing depending on what settings get changed.

As discussed, the option to hide this Generation Summary Dialog in the future is provided and this can also be changed via the General Settings.

And now finally - I can specify a relative path and see the resolved path before any time-consuming generation takes place

image

Please note - to support the fact that the relative path might require multi-level folder structures to be created, the "New Folder.vi" nodes have been swapped for the "Create Directory Recursive".

Two items had missed being marked to "Exclude compiled code" which I have now set and I have added code to hide the Antidoc Tool window when a File Dialog is opened when loading a configuration file (else it can and block the file dialog).

I haven't updated the VIPM package build spec as I assume that gets updated as part of the release process but I have been able to build and install the package on my PC (Windows, LV2020).

If you would like me to make any changes then let me know or you are welcome to make changes as you see fit.

Cheers

John

Edited by John Medland

Merge request reports