Q: Updated History Table

2020-05-19T14:41:23Z

Updated History Table

← Older revision		Revision as of 14:41, 19 May 2020
Line 45:		Line 45:

	== History ==		== History ==
	~~{{ambox\|text=History information is needed. What changes have occurred over previous versions?}}~~
	{\| class="wikitable"		{\| class="wikitable"
	! Version		! Version
	! Change(s)		! Change(s)
	\|-		\|-
	\|[[File:~~LV2018~~.png\|frameless\|border\|64x64px\|LabVIEW ~~2018~~\|link=LabVIEW ~~2018~~]]		\|[[File:LV8-2013.png\|frameless\|border\|64x64px\|LabVIEW 2009\|link=LabVIEW 2009]]
	\|~~More info to come~~.		\| This method was added in [[LabVIEW 2009]].
	\|}		\|}
	== See Also ==		== See Also ==

Q: Category reorg

2020-05-07T14:16:36Z

Category reorg

← Older revision		Revision as of 14:16, 7 May 2020
Line 59:		Line 59:
	{{ambox\|text=Add links to external resources that would also help.}}		{{ambox\|text=Add links to external resources that would also help.}}

	~~[[Category:Method]]~~ [[Category:VI Server Method]]		[[Category:VI Server Method]]

Q: Added new method page.

2020-04-24T12:50:48Z

Added new method page.

New page

{{VIServerMethod
| classid = 126
| methodid = 18A16403
| scope=basic
| dataname = Generate Documentation
| shortname = Generate Documentation
| longname = Generate Documentation
| datatypeimage = none
| datatype = No return value
| invokenodeimage = StatechartLibrary-Generate Documentation.png
| availableinrealtime = No
| availableinruntime = No
| loadsbd = No
| loadsfp = No
| needsauthentication = No
| remoteallowed = Yes
| settablewhenrunning = No
|}}
{{TOCright}}
Generates an [[XML file]] that contains information about all components, including [[states]], [[pseudostates]], [[connectors]], [[regions]], and [[transitions]], of a statechart. You can view the XML file in a Web browser.

This method also generates a folder of support files in the same location as the XML file you generate. This support folder contains files that the XML file references, including images of the statechart components, an [[EXtensible Stylesheet Language Transformations (XSLT)]] file, and an [[XML Schema Definition (XSD)]] file.

{| class="wikitable"
|-
| '''Note''' You may freely distribute your generated XML file and support folder containing the XSLT and XSD files. However, National Instruments claims all copyrights on <code>NI_Statechart_Documentation_Tool.xslt</code> and <code>NI_Statechart_Documentation_Tool.xsd</code>. Do not use or distribute these files except with the associated XML file and support folder generated by the LabVIEW Statechart Module Generate Documentation feature. You may modify <code>NI_Statechart_Documentation_Tool.xslt</code>, but the file must retain the National Instruments copyright notice contained therein, which may not be modified or obscured. You also must add a prominent notice at the top of the file that states that you have modified the file. You may not modify <code>NI_Statechart_Documentation_Tool.xsd</code>.
|}
This method is similar to the '''Generate Documentation''' item on the shortcut menu of an <code>.lvsc</code> item, or statechart library, in a statechart project. This method also is similar to the '''File»Generate Documentation''' menu item in the [[Statechart Editor]] window.
==Parameters==
{| class="wikitable"
|-
! scope="column" style="text-align:Center;" | Data type
! scope="column" style="text-align:Left;" | Name
! scope="column" style="text-align:Left;" | Required
! scope="column" style="text-align:Left;" | Description
|-
! scope="row" style="text-align:Center;" | [[File:Path.png|frameless|border|Path|link=Path data type]]
| '''Path'''
| Yes
| Specifies the location to which LabVIEW saves the XML file and the folder of support files. The path you specify must end in the <code>.xml</code> file extension. The default value is the same location as the statechart you document.
|}

== Uses ==
{{ambox|text=Specific use cases for this method.}}

== History ==
{{ambox|text=History information is needed. What changes have occurred over previous versions?}}
{| class="wikitable"
! Version
! Change(s)
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|More info to come.
|}
== See Also ==
{{ambox|text=Add links to internal wiki pages that would also help.}}

== External Links ==
{{ambox|text=Add links to external resources that would also help.}}

[[Category:Method]] [[Category:VI Server Method]]

StatechartLibrary class/Generate Documentation method - Revision history

Q: Updated History Table

Q: Category reorg

Q: Added new method page.