[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: David Carlisle <davidc@n...>
• Subject: Re: Documenting XSLT (Was: Note from the Troll)
• From: Jeni Tennison <jeni@j...>
• Date: Tue, 29 Oct 2002 12:55:05 +0000
• Cc: AndrewWatt2000@a..., xml-dev@l...
• In-reply-to: <200210291010.KAA29212@p...>
• Organization: Jeni Tennison Consulting Ltd
• References: <1ad.b129a52.2aeef6e2@a...><200210291010.KAA29212@p...>
• Reply-to: Jeni Tennison <jeni@j...>

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.

We've discussed documentation work-arounds in XSLT 1.0 on and off for
years -- make the documentation elements extension elements and
include an empty xsl:fallback; run the stylesheet through a
de-documentation-izer before using it; use XML comments with XML
inside that you get out via disable-output-escaping.

None of these is exactly ideal.
  
Cheers,

Jeni

---
Jeni Tennison
http://www.jenitennison.com/

• Follow-Ups:
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: Steve Ball <Steve.Ball@z...>
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: "m batsis" <mbatsis@n...>
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: David Carlisle <davidc@n...>

• References:
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: AndrewWatt2000@a...
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: David Carlisle <davidc@n...>

• Prev by Date: Fwd: RE: What is XML For?
• Next by Date: RE: Re: What is XML For?
• 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