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

Re: XSL - Documentation

Subject: Re: XSL - Documentation
From: David Carlisle <davidc@xxxxxxxxx>
Date: Thu, 14 May 2009 09:13:28 +0100
Re:  XSL - Documentation
> Which is quiet a restriction David
> 
> A single pass to strip documentation isn't exactly hard work.
but inconvenient sometines especially for stylesheets like pmathml.sty
that are distributed for _others_ to run client side, as either you need
to distribute both forms, or tell others how to strip.

The restriction is only a restriction on the authoring of the
documentation, not where it appears. With the method I suggested if you
put a (namespaced) id attribute on any element internal to the template
then you can sticka <xhtml:span (or div or p or anything elese)  with a
namedspaced ref attribute and that documentation will be taken as
documenting the xslt instruction with the id, and shown just before that
instruction.

So the only thing you can't directly document using this method is a
literal result element, but that isn't so much of a restriction as you
can always use an emty xsl:text to carry the documenttation.

<xhtml:p>This template matches foo and makes a table</xhtml:p>
<xhtml:span doc:ref="aaa">
this is a literal result element to make a table
</xhtml:span>
<xsl:template match="foo">
...
<xsl:text doc:id="aaa"/>
<table>
<thead>...


</xsl:template>


> , go take a look at some of
> the templates you've written! They need internal documentation :-)

Given my typing, you'll probably find my code is a lot easier to read
than my english:-)

David

________________________________________________________________________
The Numerical Algorithms Group Ltd is a company registered in England
and Wales with company number 1249803. The registered office is:
Wilkinson House, Jordan Hill Road, Oxford OX2 8DR, United Kingdom.

This e-mail has been scanned for all viruses by Star. The service is
powered by MessageLabs. 
________________________________________________________________________

Current Thread

PURCHASE STYLUS STUDIO ONLINE TODAY!

Purchasing Stylus Studio from our online shop is Easy, Secure and Value Priced!

Buy Stylus Studio Now

Download The World's Best XML IDE!

Accelerate XML development with our award-winning XML IDE - Download a free trial today!

Don't miss another message! Subscribe to this list today.
Email
First Name
Last Name
Company
Subscribe in XML format
RSS 2.0
Atom 0.3
Site Map | Privacy Policy | Terms of Use | Trademarks
Free Stylus Studio XML Training:
W3C Member
Stylus Studio® and DataDirect XQuery ™are products from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2013 All Rights Reserved.