referenceMod.xsd 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- ============================================================= -->
  3. <!-- HEADER -->
  4. <!-- ============================================================= -->
  5. <!-- MODULE: DITA Reference XSD Module -->
  6. <!-- VERSION: 1.1 -->
  7. <!-- DATE: November 2006 -->
  8. <!-- -->
  9. <!-- ============================================================= -->
  10. <!-- ============================================================= -->
  11. <!-- SYSTEM: Darwin Information Typing Architecture (DITA) -->
  12. <!-- -->
  13. <!-- PURPOSE: DTD to describe DITA References -->
  14. <!-- -->
  15. <!-- ORIGINAL CREATION DATE: -->
  16. <!-- March 2001 -->
  17. <!-- -->
  18. <!-- (C) Copyright OASIS-Open.org 2005, 2006 -->
  19. <!-- (C) Copyright IBM Corporation 2001, 2004. -->
  20. <!-- All Rights Reserved. -->
  21. <!-- ============================================================= -->
  22. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/">
  23. <!-- ==================== Import Section ======================= -->
  24. <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="urn:oasis:names:tc:dita:xsd:xml.xsd:1.1"/>
  25. <xs:import namespace="http://dita.oasis-open.org/architecture/2005/" schemaLocation="urn:oasis:names:tc:dita:xsd:ditaarch.xsd:1.1"/>
  26. <xs:element name="reference">
  27. <xs:annotation>
  28. <xs:documentation>
  29. The &lt;<keyword>reference</keyword>&gt; element defines a top-level container
  30. for a reference topic. Reference topics document programming constructs or
  31. facts about a product. Examples of reference topics include language elements,
  32. class descriptions, commands, functions, statements, protocols, types, declarators,
  33. operands, and API information, which provide quick access to facts, but no
  34. explanation of concepts or procedures. Reference topics have the same high-level
  35. structure as any other topic type, with a title, short description, and body.
  36. Within the body, reference topics are typically organized into one or more
  37. sections, property lists, and tables. The reference topic type provides general
  38. rules that apply to all kinds of reference information, using elements like &lt;<keyword>refsyn</keyword>&gt; for
  39. syntax or signatures, and &lt;<keyword>properties</keyword>&gt; for lists of properties
  40. and values.
  41. </xs:documentation>
  42. </xs:annotation>
  43. <xs:complexType>
  44. <xs:complexContent>
  45. <xs:extension base="reference.class">
  46. <xs:attribute ref="class" default="- topic/topic reference/reference "/>
  47. </xs:extension>
  48. </xs:complexContent>
  49. </xs:complexType>
  50. </xs:element>
  51. <xs:element name="refbody">
  52. <xs:annotation>
  53. <xs:documentation>
  54. The &lt;<keyword>refbody</keyword>&gt; element is a container for the
  55. main content of the reference topic. Reference topics limit the body structure
  56. to tables (both simple and standard), property lists, syntax sections, and
  57. generic sections and examples, in any sequence or number.
  58. </xs:documentation>
  59. </xs:annotation>
  60. <xs:complexType>
  61. <xs:complexContent>
  62. <xs:extension base="refbody.class">
  63. <xs:attribute ref="class" default="- topic/body reference/refbody "/>
  64. </xs:extension>
  65. </xs:complexContent>
  66. </xs:complexType>
  67. </xs:element>
  68. <xs:element name="refsyn">
  69. <xs:annotation>
  70. <xs:documentation>
  71. The &lt;<keyword>refsyn</keyword>&gt; element is a special section inside
  72. a reference topic. The section often contains syntax or signature content
  73. (for example, a command-line utility's calling syntax, or an API's signature).
  74. The &lt;<keyword>refsyn</keyword>&gt; contains a brief, possibly diagrammatic
  75. description of the subject's interface or high-level structure.
  76. </xs:documentation>
  77. </xs:annotation>
  78. <xs:complexType mixed="true">
  79. <xs:complexContent>
  80. <xs:extension base="refsyn.class">
  81. <xs:attribute ref="class" default="- topic/section reference/refsyn "/>
  82. </xs:extension>
  83. </xs:complexContent>
  84. </xs:complexType>
  85. </xs:element>
  86. <xs:element name="properties">
  87. <xs:annotation>
  88. <xs:documentation>
  89. The &lt;<keyword>properties</keyword>&gt; element gives a list of properties for
  90. the subject of the current topic, for example whether a class is public or protected.
  91. Each property can include the type, value, and a description. The typical rendering is
  92. usually in a table-like format. To represent multiple values for a type, just create
  93. additional property elements and use only the &lt;<keyword>propvalue</keyword>&gt;
  94. element (and &lt;<keyword>propdesc</keyword>&gt; when needed) for each successive
  95. value.
  96. </xs:documentation>
  97. </xs:annotation>
  98. <xs:complexType>
  99. <xs:complexContent>
  100. <xs:extension base="properties.class">
  101. <xs:attribute ref="class" default="- topic/simpletable reference/properties "/>
  102. </xs:extension>
  103. </xs:complexContent>
  104. </xs:complexType>
  105. </xs:element>
  106. <xs:element name="property">
  107. <xs:annotation>
  108. <xs:documentation>
  109. The &lt;<keyword>property</keyword>&gt; element represents a property
  110. of the current topic's subject. For example, if the current topic is a class,
  111. the property might show that the class is protected rather than public.
  112. It contains three optional elements: type, value, and description.
  113. </xs:documentation>
  114. </xs:annotation>
  115. <xs:complexType>
  116. <xs:complexContent>
  117. <xs:extension base="property.class">
  118. <xs:attribute ref="class" default="- topic/strow reference/property "/>
  119. </xs:extension>
  120. </xs:complexContent>
  121. </xs:complexType>
  122. </xs:element>
  123. <xs:element name="propvalue">
  124. <xs:annotation>
  125. <xs:documentation>
  126. The &lt;<keyword>propvalue</keyword>&gt; element indicates the value or values
  127. for the current property type. You can put values in separate rows if they
  128. need separate descriptions, and just leave the &lt;<keyword>proptype</keyword>&gt; element
  129. blank.
  130. </xs:documentation>
  131. </xs:annotation>
  132. <xs:complexType mixed="true">
  133. <xs:complexContent>
  134. <xs:extension base="propvalue.class">
  135. <xs:attribute ref="class" default="- topic/stentry reference/propvalue "/>
  136. </xs:extension>
  137. </xs:complexContent>
  138. </xs:complexType>
  139. </xs:element>
  140. <xs:element name="propdesc">
  141. <xs:annotation>
  142. <xs:documentation>
  143. The &lt;<keyword>propdesc</keyword>&gt; element is used to provide a short description
  144. of the property type and its listed values (or just the value).
  145. </xs:documentation>
  146. </xs:annotation>
  147. <xs:complexType mixed="true">
  148. <xs:complexContent>
  149. <xs:extension base="propdesc.class">
  150. <xs:attribute ref="class" default="- topic/stentry reference/propdesc "/>
  151. </xs:extension>
  152. </xs:complexContent>
  153. </xs:complexType>
  154. </xs:element>
  155. <xs:element name="proptype">
  156. <xs:annotation>
  157. <xs:documentation>
  158. The proptype element describes the type of property.
  159. </xs:documentation>
  160. </xs:annotation>
  161. <xs:complexType mixed="true">
  162. <xs:complexContent>
  163. <xs:extension base="proptype.class">
  164. <xs:attribute ref="class" default="- topic/stentry reference/proptype "/>
  165. </xs:extension>
  166. </xs:complexContent>
  167. </xs:complexType>
  168. </xs:element>
  169. <xs:element name="prophead">
  170. <xs:annotation>
  171. <xs:documentation>
  172. The prophead element supports regular headings for the properties element.
  173. </xs:documentation>
  174. </xs:annotation>
  175. <xs:complexType>
  176. <xs:complexContent>
  177. <xs:extension base="prophead.class">
  178. <xs:attribute ref="class" default="- topic/sthead reference/prophead "/>
  179. </xs:extension>
  180. </xs:complexContent>
  181. </xs:complexType>
  182. </xs:element>
  183. <xs:element name="propvaluehd">
  184. <xs:complexType mixed="true">
  185. <xs:complexContent>
  186. <xs:extension base="propvaluehd.class">
  187. <xs:attribute ref="class" default="- topic/stentry reference/propvaluehd "/>
  188. </xs:extension>
  189. </xs:complexContent>
  190. </xs:complexType>
  191. </xs:element>
  192. <xs:element name="propdeschd">
  193. <xs:complexType mixed="true">
  194. <xs:complexContent>
  195. <xs:extension base="propdeschd.class">
  196. <xs:attribute ref="class" default="- topic/stentry reference/propdeschd "/>
  197. </xs:extension>
  198. </xs:complexContent>
  199. </xs:complexType>
  200. </xs:element>
  201. <xs:element name="proptypehd">
  202. <xs:complexType mixed="true">
  203. <xs:complexContent>
  204. <xs:extension base="proptypehd.class">
  205. <xs:attribute ref="class" default="- topic/stentry reference/proptypehd "/>
  206. </xs:extension>
  207. </xs:complexContent>
  208. </xs:complexType>
  209. </xs:element>
  210. <xs:group name="reference-info-types">
  211. <xs:choice>
  212. <xs:group ref="reference"/>
  213. <xs:group ref="info-types"/>
  214. </xs:choice>
  215. </xs:group>
  216. <!-- Base type: topic.class -->
  217. <xs:complexType name="reference.class">
  218. <xs:sequence>
  219. <xs:group ref="title"/>
  220. <xs:group ref="titlealts" minOccurs="0"/>
  221. <xs:choice minOccurs="0">
  222. <xs:group ref="shortdesc" minOccurs="0"/>
  223. <xs:group ref="abstract" minOccurs="0"/>
  224. </xs:choice>
  225. <xs:group ref="prolog" minOccurs="0"/>
  226. <xs:group ref="refbody" minOccurs="0"/>
  227. <xs:group ref="related-links" minOccurs="0"/>
  228. <xs:group ref="reference-info-types" minOccurs="0" maxOccurs="unbounded"/>
  229. </xs:sequence>
  230. <xs:attribute name="id" type="xs:ID" use="required"/>
  231. <xs:attribute name="conref" type="xs:string"/>
  232. <xs:attribute ref="ditaarch:DITAArchVersion"/>
  233. <xs:attribute name="outputclass" type="xs:string"/>
  234. <xs:attributeGroup ref="select-atts"/>
  235. <xs:attributeGroup ref="localization-atts"/>
  236. <xs:attributeGroup ref="global-atts"/>
  237. </xs:complexType>
  238. <!-- Base type: body.class -->
  239. <xs:complexType name="refbody.class">
  240. <xs:choice minOccurs="0" maxOccurs="unbounded">
  241. <xs:group ref="refsyn"/>
  242. <xs:group ref="table"/>
  243. <xs:group ref="simpletable"/>
  244. <xs:group ref="properties"/>
  245. <xs:group ref="section"/>
  246. <xs:group ref="example"/>
  247. <xs:group ref="data.element.incl"/>
  248. <xs:group ref="foreign.unknown.incl"/>
  249. </xs:choice>
  250. <xs:attribute name="outputclass" type="xs:string"/>
  251. <xs:attribute name="base" type="xs:string" />
  252. <xs:attributeGroup ref="base-attribute-extensions"/>
  253. <xs:attributeGroup ref="id-atts"/>
  254. <xs:attributeGroup ref="localization-atts"/>
  255. <xs:attributeGroup ref="global-atts"/>
  256. </xs:complexType>
  257. <!-- Base type: section.class -->
  258. <xs:complexType name="refsyn.class" mixed="true">
  259. <xs:choice minOccurs="0" maxOccurs="unbounded">
  260. <xs:group ref="section.cnt"/>
  261. </xs:choice>
  262. <xs:attribute name="spectitle" type="xs:string"/>
  263. <xs:attribute name="outputclass" type="xs:string"/>
  264. <xs:attributeGroup ref="univ-atts"/>
  265. <xs:attributeGroup ref="global-atts"/>
  266. </xs:complexType>
  267. <!-- Base type: simpletable.class -->
  268. <xs:complexType name="properties.class">
  269. <xs:sequence>
  270. <xs:group ref="prophead" minOccurs="0"/>
  271. <xs:group ref="property" maxOccurs="unbounded"/>
  272. </xs:sequence>
  273. <xs:attribute name="relcolwidth" type="xs:string"/>
  274. <xs:attribute name="keycol" type="xs:NMTOKEN"/>
  275. <xs:attribute name="refcols" type="xs:NMTOKENS"/>
  276. <xs:attribute name="outputclass" type="xs:string"/>
  277. <xs:attribute name="spectitle" type="xs:string"/>
  278. <xs:attributeGroup ref="display-atts"/>
  279. <xs:attributeGroup ref="univ-atts"/>
  280. <xs:attributeGroup ref="global-atts"/>
  281. </xs:complexType>
  282. <!-- Base type: sthead.class -->
  283. <xs:complexType name="prophead.class">
  284. <xs:sequence>
  285. <xs:group ref="proptypehd" minOccurs="0"/>
  286. <xs:group ref="propvaluehd" minOccurs="0"/>
  287. <xs:group ref="propdeschd" minOccurs="0"/>
  288. </xs:sequence>
  289. <xs:attribute name="outputclass" type="xs:string"/>
  290. <xs:attributeGroup ref="univ-atts"/>
  291. <xs:attributeGroup ref="global-atts"/>
  292. </xs:complexType>
  293. <!-- Base type: stentry.class -->
  294. <xs:complexType name="proptypehd.class" mixed="true">
  295. <xs:choice minOccurs="0" maxOccurs="unbounded">
  296. <xs:group ref="tblcell.cnt"/>
  297. </xs:choice>
  298. <xs:attribute name="specentry" type="xs:string"/>
  299. <xs:attribute name="outputclass" type="xs:string"/>
  300. <xs:attributeGroup ref="univ-atts"/>
  301. <xs:attributeGroup ref="global-atts"/>
  302. </xs:complexType>
  303. <!-- Base type: stentry.class -->
  304. <xs:complexType name="propvaluehd.class" mixed="true">
  305. <xs:choice minOccurs="0" maxOccurs="unbounded">
  306. <xs:group ref="tblcell.cnt"/>
  307. </xs:choice>
  308. <xs:attribute name="specentry" type="xs:string"/>
  309. <xs:attribute name="outputclass" type="xs:string"/>
  310. <xs:attributeGroup ref="univ-atts"/>
  311. <xs:attributeGroup ref="global-atts"/>
  312. </xs:complexType>
  313. <!-- Base type: stentry.class -->
  314. <xs:complexType name="propdeschd.class" mixed="true">
  315. <xs:choice minOccurs="0" maxOccurs="unbounded">
  316. <xs:group ref="tblcell.cnt"/>
  317. </xs:choice>
  318. <xs:attribute name="specentry" type="xs:string"/>
  319. <xs:attribute name="outputclass" type="xs:string"/>
  320. <xs:attributeGroup ref="univ-atts"/>
  321. <xs:attributeGroup ref="global-atts"/>
  322. </xs:complexType>
  323. <!-- Base type: strow.class -->
  324. <xs:complexType name="property.class">
  325. <xs:sequence>
  326. <xs:group ref="proptype" minOccurs="0"/>
  327. <xs:group ref="propvalue" minOccurs="0"/>
  328. <xs:group ref="propdesc" minOccurs="0"/>
  329. </xs:sequence>
  330. <xs:attribute name="outputclass" type="xs:string"/>
  331. <xs:attributeGroup ref="univ-atts"/>
  332. <xs:attributeGroup ref="global-atts"/>
  333. </xs:complexType>
  334. <!-- Base type: stentry.class -->
  335. <xs:complexType name="proptype.class" mixed="true">
  336. <xs:choice minOccurs="0" maxOccurs="unbounded">
  337. <xs:group ref="ph.cnt"/>
  338. </xs:choice>
  339. <xs:attribute name="specentry" type="xs:string"/>
  340. <xs:attribute name="outputclass" type="xs:string"/>
  341. <xs:attributeGroup ref="univ-atts"/>
  342. <xs:attributeGroup ref="global-atts"/>
  343. </xs:complexType>
  344. <!-- Base type: stentry.class -->
  345. <xs:complexType name="propvalue.class" mixed="true">
  346. <xs:choice minOccurs="0" maxOccurs="unbounded">
  347. <xs:group ref="ph.cnt"/>
  348. </xs:choice>
  349. <xs:attribute name="specentry" type="xs:string"/>
  350. <xs:attribute name="outputclass" type="xs:string"/>
  351. <xs:attributeGroup ref="univ-atts"/>
  352. <xs:attributeGroup ref="global-atts"/>
  353. </xs:complexType>
  354. <!-- Base type: stentry.class -->
  355. <xs:complexType name="propdesc.class" mixed="true">
  356. <xs:choice minOccurs="0" maxOccurs="unbounded">
  357. <xs:group ref="desc.cnt"/>
  358. </xs:choice>
  359. <xs:attribute name="specentry" type="xs:string"/>
  360. <xs:attribute name="outputclass" type="xs:string"/>
  361. <xs:attributeGroup ref="univ-atts"/>
  362. <xs:attributeGroup ref="global-atts"/>
  363. </xs:complexType>
  364. </xs:schema>