[XML-DEV Mailing List Archive Home] [By Thread] [By Date] [Recent Entries] [Reply To This Message]

Re: Documenting XSLT (Was: Note from the Troll)

documenting xslt templates
In a message dated 28/10/2002 20:51:26 GMT Standard Time, gkholman@C... writes:

>The problem might, at least partly, be attributed to the absence of a
>documentation element in XSLT 1.0.

On the contrary, I use top-level elements from non-XSLT namespaces for
documentation of top-level XSLT constructs.  I mention this on page 139 of
the 10th edition of our electronic book, and it happens to be quoted in the
Amazon excerpt (sample page 18 of 44) of the paper rendition of the 9th
edition of our book.

I concede there are no documentation constructs to use *inside* a template,
but already being able to add structured comments for templates is useful.


Don't you find it an odd solution for XSLT 1.0 - that you have to use a non-XSLT element to document it? Or are you so used to that being the only / best option for XSLT 1.0 that you just accept it?

If you were designing XSLT 1.0 from scratch wouldn't you add a documentation element which can be used widely throughout the document (or modules) in the way the the SVG 1.0 <desc> and the XSD Schema <documentation> element can be used? And, specifically, wouldn't you design that XSLT documentation element so it can be nested inside templates?

Andrew Watt


Purchasing Stylus Studio from our online shop is Easy, Secure and Value Priced!

Buy Stylus Studio Now

Download The World's Best XML IDE!

Accelerate XML development with our award-winning XML IDE - Download a free trial today!

Don't miss another message! Subscribe to this list today.
First Name
Last Name
Subscribe in XML format
RSS 2.0
Atom 0.3

Stylus Studio has published XML-DEV in RSS and ATOM formats, enabling users to easily subcribe to the list from their preferred news reader application.

Stylus Studio Sponsored Links are added links designed to provide related and additional information to the visitors of this website. they were not included by the author in the initial post. To view the content without the Sponsor Links please click here.

Site Map | Privacy Policy | Terms of Use | Trademarks
Free Stylus Studio XML Training:
W3C Member
Stylus Studio® and DataDirect XQuery ™are products from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2013 All Rights Reserved.