LabVIEW Add-on Dev Center » Product Documentation » VI to XML Documentation Tool
Requirements
Installation
To install the VI Properties Editor package, you will first need to install VI Package Manager (VIPM) from JKI. Once VIPM has been installed, simply download the attached .vip file below, double-click, and follow on-screen instructions to complete the install.
Once the install through VI Package Manager is complete, restart LabVIEW to refresh the menu options.
How-To
When finished tagging, click 'Finish' and you will return to the Generate Files window
Add the 'topLevel=True' tag to the XML file created for the top-level palette file using Notepad++
Limitations & Known Issues
Support
Please post a comment below to report an issue.
Check out the following third-party tools for creating documentation for LabVIEW APIs and applications:
There are some documentation tools built into the LabVIEW IDE (File > Print) but they do not output the same format as one would see in existing CHM documents -- I also recommend checking out these tools on the LabVIEW Tools Network as they do not have a dependency on FAR or ActivePerl like the tools above:
If you go to the LabVIEW Tools Network and search for 'help document' both of these come up.
-RDR
I would argue that HELPer (http://vigods.com/toolkits/HELPer/helper.html) is a much more easy and powerful tool to use. Try it out too.
Tried this in LabVIEW 2017, but the tagging part didn't seem to work (i.e. the tags didn't register if one re-scanned the directory).
Hello RDR, this post looks interesting of all help documentation tools. Thanks for the post!
I tried this today but I'm unable to tag VIs. I selected VIs to document in tagger window and clicked create report. I got File not found error (C:\Program Files (x86)\National Instruments\LabVIEW 2017\project\VI Documentation\_VI2XMLTool\tag_vis_to_document\VIXML Tagging Tools UI.llb\Generate Report.vi)
As creating report is marked optional, I ignored it and proceed to generate XML files but I got this error "You have not tagged VIs to take screenshots" & "You have not tagged VIs to Document". I also didn't find XML file to edit and make top level = True.
Can you please help me out with this?
Thanks,
Avinash.
Hello @rdr,
I also encountered some issues on LabVIEW 2017 SP1. When I tagged the files and then want to create XMLs I receive two error Messages:
Nevertheless there are some files created. When I now try to start the second step to transform XMLs to HTML I receive a fatal error:What might be the problem? Is the tool still working?
I also tried HELPer, but that tool seems to crash on my system and some documentation links are broken.
Thanks,
Mario