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 ]

Hi Jeni,

Jeni Tennison wrote:

> David,
> >If you want to stick some xhtml before each template saying what it
> >does, just do so. What would a specific documentation element give
> >you?
> A documentation element (or a documentation namespace, which I'd
> prefer) would enable me to stick *structured* documentation *within* a
> template to explain a particular chunk of code.

That would only get us to template level documentation, meaning 
associating something like xsl:documentation with a template. Some have 
been doing this by adding a name attribute to each template and then 
make documentation with global html elements like:

<htm:div id="someTemplateName">
    <htm:p>text describing the template</htm:p>

to document

<xsl:template name="someTemplateName">

However, a documentation element would probably have the ability to be 
more specific (meaning the target of the documentation). I would also 
agree on a namespace for documentation constructs, including attributes 
(much easier to tell what they document: the element on which they are 
attached and it's child nodes).

Kindest regards,



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

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