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 ]

On Mon, Oct 28, 2002 at 03:33:14PM -0500, AndrewWatt2000@aol.com wrote:
> In a message dated 28/10/2002 20:22:23 GMT Standard Time, dareo@microsoft.com 
> writes:
> > What does a documentation element add to XSLT that XML comments cannot 
> > provide? 
> A documentation element, if properly used, would assist automatically 
> generating documentation using XSLT as can now be done for large SVG or XSD 
> Schema files.

<xsl:template match="xsl:template/comment()">
 <!-- Here's a template to "automatically generate documentation..." -->

> Additionally, having a documentation element would assist debugging of XSLT 
> stylesheets. 

<!-- Don't emit any text by default -->
<xsl:template match="text()"/>

<!-- We're screen scraping HTML looking for the navigation table -->
<xsl:template match="body/table/tr/td[1]/table">
 <!-- Selects: navigation table  -->
 <!-- Purpose: glean out the nav links for this page -->
 <!-- Output:  a textual list of links -->
 <xsl:for-each select=".//a[@href]">
  <xsl:value-of select="concat(@href, '&#xa;')"/>

> If you use comments heavily for documentation it is more awkward 
> to comment out sections of code since comments don't nest. 

Comments don't nest.  So don't nest them.  Problem solved.  :-)

> If a documentation 
> element existed I would expect that the debugging process would be easier.

If 1,000 people used the language features as they were designed instead
of demanding 1,000 "must have" features, I would expect that the
development process would be easier.



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

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