devhelp2.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3 get http://xml.fiforms.org/xs3p/ and generate docs
   4 xsltproc -o devhelp2.xsd.html $HOME/download/xs3p-1.1.3/xs3p.xsl devhelp2.xsd
   5 -->
   6 <xsd:schema
   7   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
   8   targetNamespace="http://www.devhelp.net/book"
   9   xmlns="http://www.devhelp.net/book"
  10   elementFormDefault="qualified">
  11
  12   <xsd:annotation>
  13     <xsd:documentation>
  14       Devhelp2 files are use in the 'devhelp' documentation browser.
  15     </xsd:documentation>
  16   </xsd:annotation>
  17
  18   <xsd:simpleType name="keyword-type">
  19     <xsd:annotation>
  20       <xsd:documentation>
  21         Known keyword types.
  22       </xsd:documentation>
  23     </xsd:annotation>
  24     <xsd:restriction base="xsd:string">
  25       <xsd:enumeration value="constant"/>
  26       <xsd:enumeration value="enum"/>
  27       <xsd:enumeration value="function"/>
  28       <xsd:enumeration value="macro"/>
  29       <xsd:enumeration value="property"/>
  30       <xsd:enumeration value="signal"/>
  31       <xsd:enumeration value="struct"/>
  32       <xsd:enumeration value="typedef"/>
  33       <xsd:enumeration value="union"/>
  34       <xsd:enumeration value="variable"/>
  35     </xsd:restriction>
  36   </xsd:simpleType>
  37
  38   <xsd:simpleType name="language-type">
  39     <xsd:annotation>
  40       <xsd:documentation>
  41         Known programing languages.
  42       </xsd:documentation>
  43     </xsd:annotation>
  44     <xsd:restriction base="xsd:string">
  45       <xsd:enumeration value="c"/>
  46       <xsd:enumeration value="c++"/>
  47       <xsd:enumeration value="c#"/>
  48       <xsd:enumeration value="java"/>
  49       <xsd:enumeration value="javascript"/>
  50       <xsd:enumeration value="perl"/>
  51       <xsd:enumeration value="python"/>
  52       <xsd:enumeration value="vala"/>
  53     </xsd:restriction>
  54   </xsd:simpleType>
  55
  56
  57   <xsd:element name="sub">
  58     <xsd:annotation>
  59       <xsd:documentation>
  60         Sub tags for the hierachy of the chapters and parts.
  61       </xsd:documentation>
  62     </xsd:annotation>
  63     <xsd:complexType>
  64       <xsd:sequence>
  65         <xsd:element ref="sub" minOccurs="0" maxOccurs="unbounded"/>
  66       </xsd:sequence>
  67        <xsd:attribute name="name" type="xsd:string" use="required"/>
  68        <xsd:attribute name="link" type="xsd:string" use="required"/>
  69     </xsd:complexType>
  70   </xsd:element>
  71
  72   <xsd:element name="chapters">
  73     <xsd:annotation>
  74       <xsd:documentation>
  75         The chapters tag encloses the structure of the reference manual. Each
  76         sub unit is represented by a sub tag.
  77       </xsd:documentation>
  78     </xsd:annotation>
  79     <xsd:complexType>
  80       <xsd:sequence>
  81         <xsd:element ref="sub" minOccurs="0" maxOccurs="unbounded"/>
  82       </xsd:sequence>
  83     </xsd:complexType>
  84   </xsd:element>
  85
  86   <xsd:element name="keyword">
  87     <xsd:annotation>
  88       <xsd:documentation>
  89         The keyword tag points to the documentation of a api symbol.
  90       </xsd:documentation>
  91     </xsd:annotation>
  92     <xsd:complexType>
  93       <xsd:attribute name="type" type="keyword-type" use="required">
  94         <xsd:annotation>
  95           <xsd:documentation>
  96             Type of the keyword.
  97           </xsd:documentation>
  98         </xsd:annotation>
  99       </xsd:attribute>
 100       <xsd:attribute name="name" type="xsd:string" use="required">
 101         <xsd:annotation>
 102           <xsd:documentation>
 103             Keyword name.
 104           </xsd:documentation>
 105         </xsd:annotation>
 106       </xsd:attribute>
 107       <xsd:attribute name="link" type="xsd:string" use="required">
 108         <xsd:annotation>
 109           <xsd:documentation>
 110             Relative link for the keyword.
 111           </xsd:documentation>
 112         </xsd:annotation>
 113       </xsd:attribute>
 114       <xsd:attribute name="since" type="xsd:string">
 115         <xsd:annotation>
 116           <xsd:documentation>
 117             Version since that the keyword is part of the API.
 118           </xsd:documentation>
 119         </xsd:annotation>
 120       </xsd:attribute>
 121       <xsd:attribute name="deprecated" type="xsd:string">
 122       <xsd:annotation>
 123         <xsd:documentation>
 124           Marks the keyword as deprecated.
 125         </xsd:documentation>
 126       </xsd:annotation>
 127       </xsd:attribute>
 128       <xsd:attribute name="stability" type="xsd:string">
 129         <xsd:annotation>
 130           <xsd:documentation>
 131             Document the stability status.
 132           </xsd:documentation>
 133         </xsd:annotation>
 134       </xsd:attribute>
 135     </xsd:complexType>
 136   </xsd:element>
 137
 138   <xsd:element name="functions">
 139     <xsd:annotation>
 140       <xsd:documentation>
 141         The functions tag encloses all api symbols of the reference manual. Each
 142         sub unit is represented by a keyword tag.
 143       </xsd:documentation>
 144     </xsd:annotation>
 145     <xsd:complexType>
 146       <xsd:sequence>
 147         <xsd:element ref="keyword" minOccurs="0" maxOccurs="unbounded"/>
 148       </xsd:sequence>
 149     </xsd:complexType>
 150   </xsd:element>
 151
 152   <xsd:element name="book">
 153     <xsd:annotation>
 154       <xsd:documentation>
 155         Toplevel element of a devhelp book. A devhelp book list the structure of
 156         a developer manual together with development related metadata.
 157       </xsd:documentation>
 158     </xsd:annotation>
 159     <xsd:complexType>
 160       <xsd:sequence>
 161         <xsd:element ref="chapters" minOccurs="1" maxOccurs="1"/>
 162         <xsd:element ref="functions" minOccurs="1" maxOccurs="1"/>
 163       </xsd:sequence>
 164       <xsd:attribute name="title" type="xsd:string" use="required">
 165         <xsd:annotation>
 166           <xsd:documentation>
 167             Title of the reference manual.
 168           </xsd:documentation>
 169         </xsd:annotation>
 170       </xsd:attribute>
 171       <xsd:attribute name="link" type="xsd:string" use="required">
 172         <xsd:annotation>
 173           <xsd:documentation>
 174             Entry point to the manual. Can be given as a relative path to the
 175             location of the devhelp2 file.
 176           </xsd:documentation>
 177         </xsd:annotation>
 178       </xsd:attribute>
 179       <xsd:attribute name="author" type="xsd:string" use="required">
 180         <xsd:annotation>
 181           <xsd:documentation>
 182             Author of the document. Multiple authors are separated by ','.
 183           </xsd:documentation>
 184         </xsd:annotation>
 185       </xsd:attribute>
 186       <xsd:attribute name="name" type="xsd:string" use="required">
 187         <xsd:annotation>
 188           <xsd:documentation>
 189             Short name of the manual.
 190           </xsd:documentation>
 191         </xsd:annotation>
 192       </xsd:attribute>
 193       <xsd:attribute name="version" type="xsd:integer" use="required">
 194         <xsd:annotation>
 195           <xsd:documentation>
 196             Version of the devhelp xml specification (2).
 197           </xsd:documentation>
 198         </xsd:annotation>
 199       </xsd:attribute>
 200       <xsd:attribute name="language" type="language-type">
 201         <xsd:annotation>
 202           <xsd:documentation>
 203             Programing language this manual refers to.
 204           </xsd:documentation>
 205         </xsd:annotation>
 206       </xsd:attribute>
 207     </xsd:complexType>
 208   </xsd:element>
 209 </xsd:schema>