[oXygen-user] Oxygen 11 Beta/XSLT doc feature/documentation or examples

[Alex]

Hello,

We are in the process of updating the help pages and the XSLT 
documentation support is not yet present.

The xsl:stylesheet element may contain any element not from the XSLT 
namespace, provided that the expanded QName of the element has a 
non-null namespace URI, elements referred to as user-defined data 
elements. oXygen uses such elements to document the stylesheet and the 
top-level elements they precede.

oXygen offers its own schema for XSLT documentation (which can be found 
at 
{INSTALATION_DIRECTORY}/frameworks/stylesheet_documentation/stylesheet_documentation.xsd) 
or you can specify your own schema in Preferences page Editor / Content 
Completion / XSL. Using the documentation schema, content completion 
will be offered inside the xsl:stylesheet element. A contextual action 
for adding documentation blocks is also available: Contextual 
Menu/Refactoring/Add component documentation. If you are with the caret 
inside the xsl:stylesheet element context, documentation blocks will be 
generated for all XSLT elements. If you are with the caret inside a 
specific XSLT element (like a template or a function) a documentation 
block will be generated for that element only.

The tool for XSLT documentation, which can be started from menu Tools -> 
Generate Documentation -> XSLT Stylesheet Documentation, will recognize 
the documentation language and will include the documentation in the 
generated HTML files. The documentation languages that are handled by 
default include oXygen XSLT documentation language, Docbook, DITA, XHTML 
1.0, XSLStyle XSLT documentation framework, Doxsl XSLT Documentation 
framework. For an unknown documentation language, by default, the 
elements will be just be copied in the output. You can change this 
behavior by using a "Custom" format inside the "Output" panel of the 
XSLT Stylesheet Documentation dialog and specifying your own XSLT 
stylesheet to used. But if you need more info about  a custom XSLT 
documentation language and how to control the way it is transform in the 
HTML documentation please let me know and I will provide more information.

Best regards,
Alex

Stefan Krause wrote:
> Hello,
>
> I'm very glad that Oxygen now provides a feature for stylesheet
> documentation. Many thanks.
>
> I started to test this features, but I didn't found in the help pages
> and the forum any hint how to use this feature.
>
> Could you please point me to a help page ore to some examples?
>
> Thanks,
>
> Stefan Krause
>
> _______________________________________________
> oXygen-user mailing list
> 
> http://www.oxygenxml.com/mailman/listinfo/oxygen-user
>