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