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

Hi Manos,

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

Sorry, by "within a template" I meant "anywhere, not just at the
top-level". I didn't mean to imply directly inside xsl:template.

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

Very good point about attributes. I guess that the advantage of an
xsl:documentation element (over a documentation namespace) would be
that you could say that each XSLT element contains an optional
xsl:documentation element as its first child, with the semantic that a
xsl:documentation element provides documentation for the element in
which it's nested.

Cheers,

Jeni

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

• 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...>
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: Jeni Tennison <jeni@j...>
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: "m batsis" <mbatsis@n...>

• Prev by Date: XML Object Serialization
• 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