Re: standard method of documenting XSLT code?

Play the video

Subject: Re: standard method of documenting XSLT code?
From: "G. Ken Holman" <gkholman@xxxxxxxxxxxxxxxxxxxx>
Date: Wed, 24 Apr 2002 12:22:05 -0400

At 2002-04-24 10:54 -0500, Don Smith wrote:

Anyone done anything with documenting XSLT code, perhaps like the
<documentation> element in W3C Schemas?

Since an XSLT document is an XML document, you can add any kind of documentation constructs you want in XML.

Here is an excerpt from page 139 of our book "Practical Transformation Using XSLT and XPath" (ISBN 1-894049-08-X), also found on page 145 of "Definitive XSLT and XPath" (ISBN 0-13-065196-6) that happens to be in the sample chapter 5 that is made available in total for evaluation:


===8<---
<?xml version="1.0"?><!--hellodoc.xsl-->
<!--XSLT 1.0 - http://www.CraneSoftwrights.com/training -->

<xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
               version="1.0" exclude-result-prefixes="mydoc"
               xmlns:mydoc="http://www.mycompany.com/mydoc">

<xsl:output method="html"/>

<mydoc:para>
The following construct is the root template.
</mydoc:para>

<xsl:template match="/">                         <!--root rule-->
...
===8<---

Using this convention you can have as rich or as simple documentation constructs as you wish. There are no standardized constructs.

More information on the books is available from the top link of our home page.

I hope this helps.

................... Ken


--
Upcoming: 3-days XSLT/XPath and/or 2-days XSLFO: June 17-21, 2002
-       : 3-days XML Information Modeling: July 31-August 2, 2002

G. Ken Holman                mailto:gkholman@xxxxxxxxxxxxxxxxxxxx
Crane Softwrights Ltd.         http://www.CraneSoftwrights.com/s/
Box 266, Kars, Ontario CANADA K0A-2E0 +1(613)489-0999 (Fax:-0995)
ISBN 0-13-065196-6                      Definitive XSLT and XPath
ISBN 1-894049-08-X  Practical Transformation Using XSLT and XPath
ISBN 1-894049-07-1               Practical Formatting Using XSLFO
XSL/XML/DSSSL/SGML/OmniMark services, books(electronic, printed),
articles, training(instructor-live,Internet-live,web/CD,licensed)
Next public training:                  2002-05-06,07,09,10,13,20,
-                          06-04,07,10,11,13,14,17,20,07-31,08-05

XSL-List info and archive: http://www.mulberrytech.com/xsl/xsl-list

Current Thread
RE: standard method of documenting XSLT code?, (continued) Chris Bayes - Thu, 25 Apr 2002 22:14:25 -0400 (EDT) Chris Bayes - Thu, 25 Apr 2002 22:24:32 -0400 (EDT) Carsten Klein - Fri, 26 Apr 2002 09:25:34 -0400 (EDT) Don Smith - Wed, 24 Apr 2002 11:55:13 -0400 (EDT) G. Ken Holman - Wed, 24 Apr 2002 12:17:23 -0400 (EDT) <= DPawson - Thu, 25 Apr 2002 07:54:14 -0400 (EDT)

<- Previous	Index	Next ->
standard method of documentin, Don Smith	Thread	RE: standard method of docume, DPawson
Re: standard method of docume, Daniel Veillard	Date	Re: Another XSL question, Jeff Kenton
	Month

PURCHASE STYLUS STUDIO ONLINE TODAY!

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

Download The World's Best XML IDE!

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

Subscribe in XML format

RSS 2.0
Atom 0.3

XML Editor - Download a 15 Day Free Trial Now >

See What's New in Stylus Studio >

Buy Stylus Studio - XML Editor - Now >