Generating XSLT documentation from command line

[nickle]

I would like to generate the xslt documentation for a group of xslt files.

1. There are multiple root files, which include other files. It looks like from the samples the documentation copes with this.

Can I specify a directory and ask for all files in that directory to be documented?

2. I can't see or find any help on the command line for building the documentation. I want to run this as part of a continuous build process from Ant. Is there some documentation on the command line choices?

Nick

[adrian]

Hello,

1. The tool is file based, so you cannot use it for an entire directory.

But assuming you don't actually have hundreds of stylesheets you can invoke the script in turn for each stylesheet.
e.g. generateDoc.bat

Code: Select all

call stylesheetDocumentation.bat myXSL1.xsl

call stylesheetDocumentation.bat myXSL2.xsl

Or you could use the capabilities of the batch(for Windows) or bash(for Linux/Mac) to list all the stylesheets and invoke the script for each.

If you want to have a specific set of settings for the documentation generation then you can first use the tool from the GUI: Tools -> Generate Documentation -> XSLT Stylesheet Documentation, establish the wanted configuration in the Settings tab and use the 'Export settings' to save the custom settings to a file.
Afterwards that settings file can be used with the command line tool by specifying the argument: -cfg:settingsFile

2. The documentation on the command line scripts is rather sparse:
http://www.oxygenxml.com/doc/ug-oxygen/ ... -line.html
I believe the usage help obtained when running the command line script without any arguments would be more helpful.
For Linux/Mac the script is: stylesheetDocumentation.sh
For Windows: stylesheetDocumentation.bat

Code: Select all

stylesheetDocumentation xslFile [ [-cfg:configFile] | [[-out:outputFile] [-format:<value>] [-xsl:customFormatXslFile] [-split:<value>] [-openInBrowser:<value>]]



Where:

   stylesheetFile = the XSL file

   -cfg:configfile = the configuration file.      It contains the output file, split method, output format options

     and some advanced options regarding the included components and components details.

     If an external configuration file is specified all other supplied arguments except the XSL file will be ignored.

     You can create such a file in the Oxygen "XSL Stylesheet Documentation" dialog. See the Oxygen user manual for additional information on how to create one.



   -out:outputFile = the file where the generated documentation will be saved.

     By default it is the name of the stylesheet file with 'html' extension.

   -format:<value> = the output format type used when generating the documentation.

     value = [html | custom]

             html    = generate documentation in HTML format.

             custom  = generate documentation in a custom format.



   -xsl:<customFormatXslFile> = the XSL file to be applied on the intermediate xml format.

     If there is no xsl file provided then the result will be in the HTML format.

   -split:<value>  = the split method used when generating the documentation. Splitting is recommended for large stylesheets

     value = [none | component | location].

             none      = generate one single output file.

             component = generate an output file for every component in the stylesheet.

             location  = generate an output file for every stylesheet location.

     By default the used method is 'none'

   -openInBrowser:<value> = open the result of the transformation in browser.

     value = [true | false].

             true = open the resulted file in browser.

             false = do not open the resulted file in browser.

     By default the value is false.



Example: stylesheetDocumentation example.xsl -out:stylesheetDocumentation.html -format:custom -xsl:customFormat.xsl -split:location

Regards,
Adrian