documentation.html

<?xml version="1.0"?>
<html xmlns:xi="http://www.w3.org/2001/XInclude">
<head>
<style type="text/css">
						.text {color: teal}
						.tag {color: maroon}
						.navig {color: olive}
 				</style>
<title>14. Documenting Schemas (samples)</title>
</head>
<body>
<h2>14. Documenting Schemas (samples)</h2>
<div>
<h3>Sample 1</h3>
<pre>
<p>[<a href="examples/documentation/text.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag">
      &lt;xs:documentation xml:lang=&quot;en&quot;&gt;<span class="text">
        The author of a book.</span>
      &lt;/xs:documentation&gt;</span><span class="tag">
      &lt;xs:documentation xml:lang=&quot;fr&quot;&gt;<span class="text">
        Designe l'auteur d'un livre.</span>
      &lt;/xs:documentation&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 2</h3>
<pre>
<p>[<a href="examples/documentation/xhtml.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag">
      &lt;xs:documentation xml:lang=&quot;en&quot;&gt;<span class="tag">
        &lt;p id=&quot;author&quot; xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;<span class="text">
          This element describes the</span><span class="tag">
          &lt;em&gt;<span class="text">
            author</span>
          &lt;/em&gt;</span><span class="text">
          of a</span><span class="tag">
          &lt;a href=&quot;#book&quot;&gt;<span class="text">
            book</span>
          &lt;/a&gt;</span>
        &lt;/p&gt;</span><span class="text">
        .</span>
      &lt;/xs:documentation&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 3</h3>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="text">
</span>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot;&gt;<span class="tag">
    &lt;title&gt;<span class="text">
      An author</span>
    &lt;/title&gt;</span><span class="tag"> 
    &lt;ellipse style=&quot;stroke:#000000; fill:#e3e000;    
      stroke-width:2pt;&quot;id=&quot;head&quot; cx=&quot;280&quot; cy=&quot;250&quot; rx=&quot;110&quot; ry=&quot;130&quot;/&gt;</span><span class="tag"> 
    &lt;ellipse style=&quot;stroke:none; fill:#7f7f7f;  &quot; id=&quot;leftEye&quot;
      cx=&quot;240&quot;cy=&quot;225&quot; rx=&quot;18&quot; ry=&quot;18&quot;/&gt;</span><span class="tag"> 
    &lt;ellipse style=&quot;stroke:none; fill:#7f7f7f;  &quot; id=&quot;rightEye&quot;
      cx=&quot;320&quot;cy=&quot;225&quot; rx=&quot;18&quot; ry=&quot;18&quot;/&gt;</span><span class="tag"> 
    &lt;path style=&quot;fill:none;stroke:#7F7F7F; stroke-width:5pt;&quot;
      id=&quot;mouth&quot;d=&quot;M 222 280 A 58 48 0 0 0 338 280&quot;/&gt;</span>
  &lt;/svg&gt;</span>
<span xmlns:exsl="http://exslt.org/common" class="text">
</span>
</pre>
<hr/>
</div>
<div>
<h3>Sample 4</h3>
<pre>
<p>[<a href="examples/documentation/svg.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag">
      &lt;xs:documentation&gt;<span class="tag">
        &lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot;&gt;<span class="tag">
          &lt;title&gt;<span class="text">
            An author</span>
          &lt;/title&gt;</span><span class="tag"> 
          &lt;ellipse style=&quot;stroke:#000000; fill:#e3e000;
            stroke-width:2pt;&quot; id=&quot;head&quot; cx=&quot;280&quot; cy=&quot;250&quot; rx=&quot;110&quot;
            ry=&quot;130&quot;/&gt;</span><span class="tag"> 
          &lt;ellipse style=&quot;stroke:none; fill:#7f7f7f; &quot; id=&quot;leftEye&quot;
            cx=&quot;240&quot;cy=&quot;225&quot; rx=&quot;18&quot; ry=&quot;18&quot;/&gt;</span><span class="tag"> 
          &lt;ellipse style=&quot;stroke:none; fill:#7f7f7f; &quot; id=&quot;rightEye&quot;
            cx=&quot;320&quot;cy=&quot;225&quot; rx=&quot;18&quot; ry=&quot;18&quot;/&gt;</span><span class="tag"> 
          &lt;path style=&quot;fill:none;stroke:#7F7F7F; stroke-width:5pt;&quot;
            id=&quot;mouth&quot;d=&quot;M 222 280 A 58 48 0 0 0 338 280&quot;/&gt;</span>
        &lt;/svg&gt;</span>
      &lt;/xs:documentation&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 5</h3>
<pre>
<p>[<a href="examples/documentation/dc.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag">
      &lt;xs:appinfo xmlns:dc=&quot;http://purl.org/dc/elements/1.1/&quot;&gt;<span class="tag">
        &lt;dc:creator&gt;<span class="text">
          Eric van der Vlist (mailto:vdv@dyomedea.com)</span>
        &lt;/dc:creator&gt;</span><span class="tag">
        &lt;dc:date&gt;<span class="text">
          2002-02-01</span>
        &lt;/dc:date&gt;</span><span class="tag">
        &lt;dc:subject&gt;<span class="text">
          author,person,book</span>
        &lt;/dc:subject&gt;</span><span class="tag">
        &lt;dc:description&gt;<span class="text">
          This element describes the author of a book.</span>
        &lt;/dc:description&gt;</span>
      &lt;/xs:appinfo&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 6</h3>
<pre>
<p>[<a href="examples/XMLSchema.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:simpleType name=&quot;string&quot; id=&quot;string&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag">
      &lt;xs:appinfo&gt;<span class="tag">
        &lt;hfp:hasFacet name=&quot;length&quot;/&gt;</span><span class="tag">
        &lt;hfp:hasFacet name=&quot;minLength&quot;/&gt;</span><span class="tag">
        &lt;hfp:hasFacet name=&quot;maxLength&quot;/&gt;</span><span class="tag">
        &lt;hfp:hasFacet name=&quot;pattern&quot;/&gt;</span><span class="tag">
        &lt;hfp:hasFacet name=&quot;enumeration&quot;/&gt;</span><span class="tag">
        &lt;hfp:hasFacet name=&quot;whiteSpace&quot;/&gt;</span><span class="tag">
        &lt;hfp:hasProperty name=&quot;ordered&quot; value=&quot;false&quot;/&gt;</span><span class="tag">
        &lt;hfp:hasProperty name=&quot;bounded&quot; value=&quot;false&quot;/&gt;</span><span class="tag"> 
        &lt;hfp:hasProperty name=&quot;cardinality&quot; value=&quot;countably
          infinite&quot;/&gt;</span><span class="tag">
        &lt;hfp:hasProperty name=&quot;numeric&quot; value=&quot;false&quot;/&gt;</span>
      &lt;/xs:appinfo&gt;</span><span class="tag"> 
      &lt;xs:documentation
        source=&quot;http://www.w3.org/TR/xmlschema-2/#string&quot;/&gt;</span>
    &lt;/xs:annotation&gt;</span><span class="tag">
    &lt;xs:restriction base=&quot;xs:anySimpleType&quot;&gt;<span class="tag">
      &lt;xs:whiteSpace value=&quot;preserve&quot; id=&quot;string.preserve&quot;/&gt;</span>
    &lt;/xs:restriction&gt;</span>
  &lt;/xs:simpleType&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 7</h3>
<pre>
<p>[<a href="examples/documentation/saf.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag"> 
      &lt;xs:appinfo source=&quot;saf:meta-data-item&quot;
        xmlns:sql=&quot;http://www.extensibility.com/saf/spec/safsample/sql-map.saf&quot;
        &gt;<span class="tag">
        &lt;sql:select&gt;<span class="text">
          select</span><span class="tag">
          &lt;sql:elem&gt;<span class="text">
            name</span>
          &lt;/sql:elem&gt;</span><span class="text">
          ,</span><span class="tag">
          &lt;sql:elem&gt;<span class="text">
            birthdate</span>
          &lt;/sql:elem&gt;</span><span class="text">
          ,</span><span class="tag">
          &lt;sql:attr&gt;<span class="text">
            deathdate</span>
          &lt;/sql:attr&gt;</span><span class="text">
          from tbl_author</span>
        &lt;/sql:select&gt;</span>
      &lt;/xs:appinfo&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 8</h3>
<pre>
<p>[<a href="examples/documentation/schematron.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag">
      &lt;xs:appinfo xmlns:sch=&quot;http://www.ascc.net/xml/schematron&quot;&gt;<span class="tag">
        &lt;sch:pattern name=&quot;Born before dead&quot;&gt;<span class="tag">
          &lt;sch:rule context=&quot;author&quot;&gt;<span class="tag"> 
            &lt;sch:assert test=&quot;not(dead) or (dead &gt; born)&quot;
              diagnostics=&quot;bornAfterDead&quot;&gt;<span class="text">
              An author should die after her or his death.</span>
            &lt;/sch:assert&gt;</span><span class="tag">
            &lt;sch:diagnostics&gt;<span class="tag">
              &lt;sch:diagnostic id=&quot;bornAfterDead&quot;&gt;<span class="text"> 
                Error, this author is born after her or his birth!
                Author=</span><span class="tag">
                &lt;sch:value-of select=&quot;name&quot;/&gt;</span><span class="text">
                Birth =</span><span class="tag">
                &lt;sch:value-of select=&quot;born&quot;/&gt;</span><span class="text">
                Death =</span><span class="tag">
                &lt;sch:value-of select=&quot;dead&quot;/&gt;</span>
              &lt;/sch:diagnostic&gt;</span>
            &lt;/sch:diagnostics&gt;</span>
          &lt;/sch:rule&gt;</span>
        &lt;/sch:pattern&gt;</span>
      &lt;/xs:appinfo&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 9</h3>
<pre>
<p>[<a href="examples/documentation/xslt.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;book&quot; type=&quot;book&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag">
      &lt;xs:appinfo xmlns:xsl=&quot;http://www.w3.org/1999/XSL/Transform&quot;&gt;<span class="tag">
        &lt;xsl:template match=&quot;book&quot;&gt;<span class="tag">
          &lt;xsl:apply-templates select=&quot;title&quot;/&gt;</span><span class="tag">
          &lt;xsl:apply-templates select=&quot;isbn&quot;/&gt;</span><span class="tag">
          &lt;p&gt;<span class="text">
            Authors:</span>
          &lt;/p&gt;</span><span class="tag">
          &lt;ul&gt;<span class="tag">
            &lt;xsl:apply-templates select=&quot;author&quot;/&gt;</span>
          &lt;/ul&gt;</span><span class="tag">
          &lt;p&gt;<span class="text">
            Characters:</span>
          &lt;/p&gt;</span><span class="tag">
          &lt;ul&gt;<span class="tag">
            &lt;xsl:apply-templates select=&quot;character&quot;/&gt;</span>
          &lt;/ul&gt;</span>
        &lt;/xsl:template&gt;</span>
      &lt;/xs:appinfo&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 10</h3>
<pre>
<p>[<a href="examples/documentation/rddl.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag"> 
      &lt;xs:appinfo xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot;
        xmlns:rddl=&quot;http://www.rddl.org/&quot;&gt;<span class="tag"> 
        &lt;rddl:resource id=&quot;author-transform&quot;
          xlink:arcrole=&quot;http://www.w3.org/1999/xhtml&quot;
          xlink:role=&quot;http://www.w3.org/1999/XSL/Transform&quot;
          xlink:title=&quot;Author template&quot;
          xlink:href=&quot;library.xslt#author&quot;&gt;<span class="tag">
          &lt;div class=&quot;resource&quot;&gt;<span class="tag">
            &lt;h4&gt;<span class="text">
              XSLT Transformation</span>
            &lt;/h4&gt;</span><span class="tag">
            &lt;p&gt;<span class="text">
              This</span><span class="tag">
              &lt;a href=&quot;library.xslt#author&quot;&gt;<span class="text">
                template</span>
              &lt;/a&gt;</span><span class="text">
              displays the description of an author.</span>
            &lt;/p&gt;</span>
          &lt;/div&gt;</span>
        &lt;/rddl:resource&gt;</span><span class="tag"> 
        &lt;rddl:resource id=&quot;CSS&quot; xlink:title=&quot;CSS Stylesheet&quot;
          xlink:role=&quot;http://www.isi.edu/in-notes/iana/assignments/media-types/text/css&quot;
          xlink:href=&quot;author.css&quot;&gt;<span class="tag">
          &lt;div class=&quot;resource&quot;&gt;<span class="tag">
            &lt;h4&gt;<span class="text">
              CSS Stylesheet</span>
            &lt;/h4&gt;</span><span class="tag">
            &lt;p&gt;<span class="text">
              A</span><span class="tag">
              &lt;a href=&quot;author.css&quot;&gt;<span class="text">
                CSS stylesheet</span>
              &lt;/a&gt;</span><span class="text"> 
              defining the styles which may be used to display an
              author.</span>
            &lt;/p&gt;</span>
          &lt;/div&gt;</span>
        &lt;/rddl:resource&gt;</span>
      &lt;/xs:appinfo&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 11</h3>
<pre>
<p>[<a href="examples/documentation/att.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag"> 
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot; doc:doc=&quot;This element
    describes the author of a book.&quot;
    xmlns:doc=&quot;http://dyomedea.com/ns/doc&quot;/&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 12</h3>
<pre>
<p>[<a href="examples/documentation/saf-att.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag"> 
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot; sql:table=&quot;TBL_AUTHOR&quot;
    xmlns:sql=&quot;http://www.extensibility.com/saf/spec/safsample/sql-map.saf&quot;
    /&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 13</h3>
<pre>
<p>[<a href="examples/documentation/xlink.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag"> 
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;
    xlink:arcrole=&quot;http://www.w3.org/1999/xhtml&quot;
    xlink:role=&quot;http://www.w3.org/1999/XSL/Transform&quot;
    xlink:title=&quot;Author template&quot; xlink:href=&quot;library.xslt#author&quot;
    xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot;/&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 14</h3>
<pre>
<p>[<a href="examples/documentation/rddl-concise.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag"> 
      &lt;xs:appinfo
        xlink:arcrole=&quot;http://www.w3.org/1999/XSL/Transform&quot;
        xlink:role=&quot;http://www.w3.org/1999/XSL/Transform&quot;
        xlink:title=&quot;Author template&quot; xlink:href=&quot;library.xslt#author&quot;
        xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot;&gt;<span class="tag">
        &lt;div class=&quot;resource&quot;&gt;<span class="tag">
          &lt;h4&gt;<span class="text">
            XSLT Transformation</span>
          &lt;/h4&gt;</span><span class="tag">
          &lt;p&gt;<span class="text">
            This</span><span class="tag">
            &lt;a href=&quot;library.xslt#author&quot;&gt;<span class="text">
              template</span>
            &lt;/a&gt;</span><span class="text">
            displays the description of an author.</span>
          &lt;/p&gt;</span>
        &lt;/div&gt;</span>
      &lt;/xs:appinfo&gt;</span><span class="tag"> 
      &lt;xs:appinfo title=&quot;CSS Stylesheet&quot;
        role=&quot;http://www.isi.edu/in-notes/iana/assignments/media-types/text/css&quot;
        href=&quot;author.css&quot;&gt;<span class="tag">
        &lt;div class=&quot;resource&quot;&gt;<span class="tag">
          &lt;h4&gt;<span class="text">
            CSS Stylesheet</span>
          &lt;/h4&gt;</span><span class="tag">
          &lt;p&gt;<span class="text">
            A</span><span class="tag">
            &lt;a href=&quot;author.css&quot;&gt;<span class="text">
              CSS stylesheet</span>
            &lt;/a&gt;</span><span class="text"> 
            defining the styles which may be used to display an
            author.</span>
          &lt;/p&gt;</span>
        &lt;/div&gt;</span>
      &lt;/xs:appinfo&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 15</h3>
<pre>
<p>[<a href="examples/documentation/comment.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;
    &lt;!-- This element describes the author of a book. --&gt;
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 16</h3>
<pre>
<p>[<a href="examples/documentation/text.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;<span class="tag">
    &lt;xs:annotation&gt;<span class="tag">
      &lt;xs:documentation xml:lang=&quot;en&quot;&gt;<span class="text">
        The author of a book.</span>
      &lt;/xs:documentation&gt;</span><span class="tag">
      &lt;xs:documentation xml:lang=&quot;fr&quot;&gt;<span class="text">
        Designe l'auteur d'un livre.</span>
      &lt;/xs:documentation&gt;</span>
    &lt;/xs:annotation&gt;</span>
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 17</h3>
<pre>
<p>[<a href="examples/documentation/att.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag"> 
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot; doc:doc=&quot;This element
    describes the author of a book.&quot;
    xmlns:doc=&quot;http://dyomedea.com/ns/doc&quot;/&gt;</span>
</pre>
</pre>
<hr/>
</div>
<div>
<h3>Sample 18</h3>
<pre>
<p>[<a href="examples/documentation/comment.xsd" title="download" target="download">download</a>]</p>
<pre>
<span xmlns:exsl="http://exslt.org/common" class="tag">
  &lt;xs:element name=&quot;author&quot; type=&quot;author&quot;&gt;
    &lt;!-- This element describes the author of a book. --&gt;
  &lt;/xs:element&gt;</span>
</pre>
</pre>
<hr/>
</div>
</body>
</html>