OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help



   Re: [xml-dev] Documenting XSLT (Was: Note from the Troll)

[ Lists Home | Date Index | Thread Index ]

In a message dated 28/10/2002 20:51:26 GMT Standard Time, gkholman@CraneSoftwrights.com 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


News | XML in Industry | Calendar | XML Registry
Marketplace | Resources | MyXML.org | Sponsors | Privacy Statement

Copyright 2001 XML.org. This site is hosted by OASIS