The PDF output of the documentation for an XML Schema can be customized but you need to run two transformations and to customize the intermediate file (the output of the first transformation) instead of just running the action XML Schema Documentation
from menu Tools -> Generate Documentation
. You can follow this procedure which has two parts for the two transformations and for inserting the custom text in the documentation (updated from
, general description
1. Customize the XSLT stylesheet [Oxygen-install-dir]/frameworks/schema_documentation/xsl/xsdDocDocbook.xsl
for including the text that you want in the content of the schema documentation.
In the XSLT template with the attibute match="schemaDoc"
you should add your content between the following two elements:
Code: Select all
<pubdate><xsl:value-of select="format-date(current-date(),'[Mn] [D], [Y]', 'en', (), ())"/></pubdate>
Code: Select all
Please note that you should insert here DocBook XML elements like <para>
, etc. If you are not familiar with DocBook XML documents please look at this video demo
on the page with all the Oxygen video demos
2. Create an intermediary file with the content of the documentation for your XML Schema.
2.1 Go to menu Tools -> Generate Documentation -> XML Schema Documentation
2.2 Select the Custom
radio button in the dialog box XML Schema Documentation
2.3 Press the Options
button which opens a new dialog box called Custom format options
and in this dialog select the following:
- Custom XSL: [Oxygen-install-dir]/frameworks/schema_documentation/xsl/xsdDocDocbook.xsl
- select the checkbox Copy additional resources to the output folder
- press the OK
2.4 When you return to the Custom format options
dialog box just press the Generate
button which will generate a DocBook XML file with an intermediary form of the schema documentation.
3. Create the final PDF document.
3.1 Create a new transformation scenario
associated with the intermediary XML file that you edited at step 2 by going to menu Document -> Transformation -> Configure Transformation Scenario
(or by pressing the toolbar button with the same tooltip text, that is Configure Transformation Scenario
3.2 In the dialog box for editing the new transformation, on the XSLT tab you should enter the following file in the XSL URL combo box by using the small yellow folder icon (which opens a file system navigator dialog box):
3.3 On the FO Processor tab of the same dialog box select the radio buttons Perform FO Processing
and XSLT result as input
3.4 On the Output
tab you should set an output file path where you want to create the final PDF document.
3.5 Press the OK
button in the dialog box for editing the transformation.
3.6 Press the Apply Associated
button in the dialog box called Configure Transformation Scenario
At the end of this procedure you should get the customized PDF output for the documentation of your XML Schema.