Specification

From EXPath

Revision as of 16:32, 7 February 2010 by FGeorges (Talk | contribs)
Jump to: navigation, search

Informations about specifications, especially specification authoring.

The schema

The schema used for specifications is W3C's XMLSpec, used for W3C's specifications, drafts and notes. This doctype was written initially for the XML spec itself (hence its name) and has been customized by several working groups over the years, for their own needs, so there are a few different versions available over there. You can read the user guide and the resources listing of the official version for more informations.

For EXPath we use the latest version of this doctype, pre-installed in oXygen for instance. There are a few new elements for the special needs of EXPath (e.g. function signatures). Those changed still have to be described here.

Setup

TODO: Describe how to transform a spec written using XMLSpec to XHTML with EXPath specifics (layout, logo, etc.)

Example

While waiting for more rigorous documentation, here are everything you should need to create a spec for EXPath and transform it to its final XHTML format. The first file is a source example. It contains a few content, but shows the complete overall structure of a specification. You will need to transform it with the EXPath's stylesheet, which imports the W3C's stylesheet. To transform it, use your preferred XSLT processor. For instance using Saxon 9+:

java -cp saxon9.jar net.sf.saxon.Transform -xsl:xmlspec-fg.xsl -s:zip.xml -o:zip.html
Personal tools