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

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

• To: AndrewWatt2000@a...
• Subject: Re: Documenting XSLT (Was: Note from the Troll)
• From: Adam Turoff <ziggy@p...>
• Date: Mon, 28 Oct 2002 15:53:12 -0500
• Cc: xml-dev@l...
• In-reply-to: <6f.3008d197.2aeef90a@a...>
• References: <6f.3008d197.2aeef90a@a...>
• User-agent: Mutt/1.4i

On Mon, Oct 28, 2002 at 03:33:14PM -0500, AndrewWatt2000@a... wrote:
> In a message dated 28/10/2002 20:22:23 GMT Standard Time, dareo@m... 
> 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..." -->
 ...
</xsl:template>

> 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;')"/>
 </xsl:for-each>
</xsl:template>

> 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.

Z.

• References:
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: AndrewWatt2000@a...

• Prev by Date: Re: Documenting XSLT (Was: Note from the Troll)
• Next by Date: Re: Documenting XSLT (Was: Note from the Troll)
• Previous by thread: Re: Documenting XSLT (Was: Note from the Troll)
• Next by thread: Re: Documenting XSLT (Was: Note from the Troll)
• Index(es):
  • Date
  • Thread