Index of /2007/xml/sml

[ICO]NameLast modifiedSizeDescription
[PARENTDIR]Parent Directory  -  
[TXT]xlink-note.html2009-10-13 18:03 22K 
[DIR]tests/2009-10-13 18:03 -  
[TXT]README.html2009-09-10 20:07 4.6K 
[TXT]epr-note.html2009-06-26 17:05 52K 
[DIR]extra/2009-04-22 16:18 -  
[DIR]build/2009-04-22 16:18 -  
[ ]common.dtd2009-04-22 16:15 1.0K 
[ ]sml-source.xml2009-04-22 11:19 153K 
[ ]sml-if-source.xml2009-04-22 11:19 89K 
[ ]previous-participants.rdf2009-04-22 11:19 2.0K 
[ ]participants.rdf2009-04-22 11:19 1.3K 
[DIR]xsl/2009-04-22 11:17 -  
[ ]sml-source.xsd2009-04-17 22:42 6.0K 
[ ]sml-if-source.xsd2009-01-28 19:24 8.8K 
[ ]build.xml2009-01-25 04:52 10K 
[ ]sample-model-source.xsd2008-04-16 07:16 6.5K 
[ ]namespace-source.xhtml2008-01-17 21:21 2.3K 
[DIR]tools/2007-07-10 15:56 -  
[ ]xmlspec.dtd2007-06-05 18:10 80K 
[ ]namespace-if-source.xhtml2007-06-05 18:10 2.3K 
[ ]diffmk.xml2007-06-05 18:10 4.9K 
SML Editors README

SML README

Look at the Eclipse documentation to configure your editing tool. SML uses the public CVS Repository (dev.w3.org). You want to check out 2007/xml/sml.

Files

sml-source.xml: contains the main source for SML 1.1.

sml-if-source.xml: contains the main source for SML IF 1.1.

*.xsd: contains the XML Schema documents associated with SML and SMLF IF

common.dtd: contains values used by the files above. Modified this file if you're going to publish a public version of the document on /TR.

namespace*.xhtml: contains the namespace documents associated with SML and SML IF.

*.rdf: contains the list of current and previous participants in the group.

xmlspec.dtd: the DTD for xmlspec documents, avoid touching it.

extra/ : This directory is used during the building of the specification, you can safely ignore it.

xsl/ : This directory contains various XSL files used during the transformation

build/: This directory is where the final documents are.

build/ns: This directory is where the final namespace and schema documents are.

tools/: This directory contains various jar files used by ant. Don't touch.

build.xml: the ant file. Works well with ant 1.7 at least.

Ant tasks

Most of the time, you will use the task "html". It takes the sources and produces the final documents (build/sml.html and build/sml-if.html). The "main" task does the same except that it updates the acknowledgments in the process. The "clean" task will remove all generated contents.

Note: you might see some warnings, generated by saxon, indicating you're applying XSLT 1.0 style sheets with an XSLT 2 engine. You can safely ignore those here.

The transformation goes through several stages:

  1. validate sml-source.xml and sml-if-source.xml
  2. transform *.xsd into their final form in build/ns/*.xsd (add copyright information, remove the use of common.dtd, ...)
  3. transform sml-source.xml and sml-if-source.xml into XML files. It applies xinclude and a few heuristic to determine some of the URIs.
  4. transform the result of the previous action into the final HTML documents: build/sml.html and build/sml-if.html).

Check in

For an editors' copy: you want to check in sml-source.xml, sml-if-source.xml, *.xsd, build/sml.html, and build/sml-if.html.

For a publication: you want to check in sml-source.xml, sml-if-source.xml, *.xsd, and *.rdf.

Publication

First, update common.dtd. The following section should be updated and UNcommented:

<!--

<!ENTITY draft.year "2007">
<!ENTITY draft.month "July">
<!ENTITY draft.mm "07">
<!ENTITY draft.day "4">
<!ENTITY draft.dd "04">

<!ENTITY status "wd">
-->

Then, use the task "publication". This will create build/sml-specification.zip and build/sml-if-specification.zip. Check the trace of the ant process closely since the task applies several tests and may tell you if something could need your attention. The zip files contains the HTML documents, their XML versions, the namespace documents and the schema documents. Note that a lot of tests are done on the documents, in particular the pubrules checker. I should take unzip in a temporary web location and have the pubrules checker check that online document. The webmaster will run the pubrules checker in any case and will refuse to publish until the problems have been fixed.