[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: Jeni Tennison <jeni@j...>
• Subject: Re: Documenting XSLT (Was: Note from the Troll)
• From: "m batsis" <mbatsis@n...>
• Date: Tue, 29 Oct 2002 15:28:07 +0200
• Cc: David Carlisle <davidc@n...>, AndrewWatt2000@a..., xml-dev@l...
• In-reply-to: <1ad.b129a52.2aeef6e2@a...>
• Organization: Netsmart S.A., Greece
• References: <1ad.b129a52.2aeef6e2@a...> <200210291010.KAA29212@p...> <172241925760.20021029125505@j...>
• Reply-to: mbatsis@n...
• User-agent: Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.2b) Gecko/20021016

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>
</htm:div>

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,

Manos

• Follow-Ups:
  • Re: Documenting XSLT (Was: Note from the Troll)
    • From: Jeni Tennison <jeni@j...>

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

• Prev by Date: RE: ANN: xpath1() scheme for XPointer
• 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