Customizing the PDF Output of Generated XML Schema Documentation
To customize the PDF output of the generated XML Schema documentation, use the following procedure:
- Customize the
[OXYGEN_INSTALL_DIR]/frameworks/schema_documentation/xsl/xsdDocDocbook.xsl
stylesheet to include the content that you want to add in the PDF output. Add the content in the XSLT template with thematch="schemaDoc"
attribute between theinfo
andxsl:apply-templates
elements, as commented in the following example:<info> <pubdate><xsl:value-of select="format-date(current-date(), '[Mn] [D], [Y]', 'en', (), ())"/></pubdate> </info> <!-- Add the XSLT template content with match="schemaDoc" attribute here --> <xsl:apply-templates select="schemaHierarchy"/>
Note
The content that you insert here has to be wrapped in DocBook markup. For details about working with DocBook see the following video demonstration: https://www.oxygenxml.com/demo/DocBook_Editing_in_Author.html. - Create an intermediary file that holds the content of your XML Schema documentation.
- Go to .
- Select Custom for the output format and click the Options button.
- In the Custom format options dialog box, do the following:
- Enter the customized stylesheet in the Custom XSL field
(
[OXYGEN_INSTALL_DIR]/frameworks/schema_documentation/xsl/xsdDocDocbook.xsl
). - Enable the Copy additional resources to the output folder option, and leave the default selection in the Resources field.
- Click OK.
- Enter the customized stylesheet in the Custom XSL field
(
- When you return to the XML Schema Documentation dialog box, just press the Generate button to generate a DocBook XML file with an intermediary form of the Schema documentation.
- Create the final PDF document.
- Use the Configure Transformation Scenario(s) action from the toolbar or the menu, click New, and select XML transformation with XSLT.
- In the New Scenario dialog box, go to the XSL
URL field and choose the
[OXYGEN_INSTALL_DIR]/frameworks/docbook/oxygen/xsdDocDocbookCustomizationFO.xsl
file. - Go to the FO Processor tab and enable the Perform FO Processing and XSLT result as input options.
- Go to the Output tab and select the directory where you want to store the XML Schema documentation output and click OK.
- Click Apply Associated.
Tip
If you want your modifications to be permanent so
that you can simply select the PDF output format in the XML Schema
Documentation dialog box, rather than configuring a custom format each time you
generate this documentation, follow this procedure:
- Create a JAR or ZIP file that includes the modified stylesheet (customized in step
1
above), placed in the following directory structure:
builtin/documentation/schema_documentation/xsdDocDocbook.xsl
. - Create a new directory named endorsed inside the
[OXYGEN_INSTALL_DIR]/lib
directory and place the created JAR or ZIP file inside it. - Restart Oxygen XML Editor and the PDF output format will now use your customized stylesheet.