[oXygen-user] XML Schema documentation

Florent Georges lists at fgeorges.org
Tue Mar 19 09:38:47 CDT 2013

  Thank you.  I missed the option, and as far as I am able to use HTML p elements I am happy for now.

  By the way, if I use a prefix for the HTML namespace, the elements are still escaped in the "Diagram" section of the generated HTML documentation (the small "tooltip box" below the diagram of the documented type), and the spaces required by indenting the annotation are preserved.  If I make the HTML namespace the default namespace, then the tooltip box is fine.


Florent Georges

----- Mail original -----
> De : Oxygen XML Editor Support <support at oxygenxml.com>
> À : Florent Georges <lists at fgeorges.org>
> Cc : oXygen User ML <oxygen-user at oxygenxml.com>
> Envoyé le : Mardi 19 mars 2013 13h52
> Objet : Re: [oXygen-user] XML Schema documentation
> Hi,
> Note that in the Settings from the "XML Schema Documentation" dialog 
> there is an option "Escape XML content" nested under the 
> "Annotations" option. When enabled (it is by default) this option 
> causes the tags themselves from the annotation to show up in the output. So, 
> disable it.
> Having said that, for XML Schema there is currently no common styling format 
> supported for both HTML and PDF output.
> If you use HTML tags, they work correctly in the HTML output, but not in the PDF 
> output.
> If you use DocBook 5 tags (namespace is required), they are correctly 
> interpreted in the PDF output, but not in the HTML output.
> I've submitted a feature request to investigate the support for a common tag 
> format for all output formats in a future version of Oxygen (probably for 
> DocBook 5 tags).
> Alternative solutions:
> - use DocBook tags in annotations. However, for HTML, instead of using directly 
> the HTML output format, you can use the DocBook output and then manually 
> transform the DocBook result into HTML. This loses the option of splitting the 
> output into multiple HTML files (by namespace/location/component) and may also 
> require some additional tweaking.
> - use DocBook tags in annotations and for HTML use the Custom output format. 
> This requires some additional customization of the HTML stylesheets from: 
> Oxygen/frameworks/schema_documentation/xsl/xsdDocHtml.xsl to transform the 
> DocBook tags to their HTML counterparts. Then in the Options of the Custom 
> output you can specify the customized stylesheet.
> Regards,
> Adrian
> Adrian Buza
> oXygen XML Editor and Author Support
> Tel: +1-650-352-1250 ext.202
> Fax: +40-251-461482
> support at oxygenxml.com
> http://www.oxygenxml.com
> Florent Georges wrote:
>>    Hi,
>>    When using the action "Tools > Generate Documentation > XML 
> Schema
>>  Documentation", what is supposed to be in xs:documentation?  If I put
>>  any element in there (e.g. in HTML or DocBook namespace), they are
>>  included verbatim within the PDF output (I mean, the tags themselves
>>  show up in the PDF).
>>    Does it support only text?  Is there any equivalent to the namespace
>>  http://www.oxygenxml.com/ns/doc/xsl available for XSLT?
>>    Regards,

More information about the oXygen-user mailing list