softwareDomain.xsd 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- ============================================================= -->
  3. <!-- HEADER -->
  4. <!-- ============================================================= -->
  5. <!-- MODULE: DITA Software Domain -->
  6. <!-- VERSION: 1.1 -->
  7. <!-- DATE: November 2006 -->
  8. <!-- -->
  9. <!-- ============================================================= -->
  10. <!-- ============================================================= -->
  11. <!-- SYSTEM: Darwin Information Typing Architecture (DITA) -->
  12. <!-- -->
  13. <!-- PURPOSE: Define elements and specialization attributes -->
  14. <!-- for Software Domain -->
  15. <!-- -->
  16. <!-- ORIGINAL CREATION DATE: -->
  17. <!-- March 2001 -->
  18. <!-- -->
  19. <!-- (C) Copyright OASIS-Open.org 2005, 2006 -->
  20. <!-- (C) Copyright IBM Corporation 2001, 2004. -->
  21. <!-- All Rights Reserved. -->
  22. <!-- ============================================================= -->
  23. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
  24. <!-- 20021227 EAS: Use xml:space (preserve) for pre derivs: codeblock, msgblock, screen -->
  25. <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="urn:oasis:names:tc:dita:xsd:xml.xsd:1.1"/>
  26. <xs:group name="sw-d-ph">
  27. <xs:choice>
  28. <xs:element ref="msgph" />
  29. <xs:element ref="filepath" />
  30. <xs:element ref="userinput" />
  31. <xs:element ref="systemoutput" />
  32. </xs:choice>
  33. </xs:group>
  34. <xs:group name="sw-d-keyword">
  35. <xs:choice>
  36. <xs:element ref="msgnum" />
  37. <xs:element ref="varname" />
  38. <xs:element ref="cmdname" />
  39. </xs:choice>
  40. </xs:group>
  41. <xs:group name="sw-d-pre">
  42. <xs:choice>
  43. <xs:element ref="msgblock" />
  44. </xs:choice>
  45. </xs:group>
  46. <xs:group name="msgblock">
  47. <xs:choice>
  48. <xs:element ref="msgblock"/>
  49. </xs:choice>
  50. </xs:group>
  51. <xs:group name="msgnum">
  52. <xs:choice>
  53. <xs:element ref="msgnum"/>
  54. </xs:choice>
  55. </xs:group>
  56. <xs:group name="varname">
  57. <xs:choice>
  58. <xs:element ref="varname"/>
  59. </xs:choice>
  60. </xs:group>
  61. <xs:group name="msgph">
  62. <xs:choice>
  63. <xs:element ref="msgph"/>
  64. </xs:choice>
  65. </xs:group>
  66. <xs:group name="filepath">
  67. <xs:choice>
  68. <xs:element ref="filepath"/>
  69. </xs:choice>
  70. </xs:group>
  71. <xs:group name="userinput">
  72. <xs:choice>
  73. <xs:element ref="userinput"/>
  74. </xs:choice>
  75. </xs:group>
  76. <xs:group name="systemoutput">
  77. <xs:choice>
  78. <xs:element ref="systemoutput"/>
  79. </xs:choice>
  80. </xs:group>
  81. <xs:group name="cmdname">
  82. <xs:choice>
  83. <xs:element ref="cmdname"/>
  84. </xs:choice>
  85. </xs:group>
  86. <xs:element name="msgph">
  87. <xs:annotation>
  88. <xs:documentation>
  89. The message phrase (&lt;msgph&gt;) element contains the text content
  90. of a message produced by an application or program. It can also contain the
  91. variable name (varname) element to illustrate where variable text content
  92. can occur in the message. This element is part of the DITA software domain,
  93. a special set of DITA elements designed to document software tasks, concepts
  94. and reference information.
  95. </xs:documentation>
  96. </xs:annotation>
  97. <xs:complexType mixed="true">
  98. <xs:complexContent>
  99. <xs:extension base="msgph.class">
  100. <xs:attribute ref="class" default="+ topic/ph sw-d/msgph "/>
  101. </xs:extension>
  102. </xs:complexContent>
  103. </xs:complexType>
  104. </xs:element>
  105. <xs:complexType name="msgph.class" mixed="true">
  106. <xs:choice minOccurs="0" maxOccurs="unbounded">
  107. <xs:group ref="words.cnt"/>
  108. </xs:choice>
  109. <xs:attribute name="outputclass" type="xs:string"/>
  110. <xs:attributeGroup ref="univ-atts"/>
  111. <xs:attributeGroup ref="global-atts"/>
  112. </xs:complexType>
  113. <xs:element name="msgnum">
  114. <xs:annotation>
  115. <xs:documentation>
  116. The message number (&lt;<keyword>msgnum</keyword>&gt;) element contains the number
  117. of a message produced by an application or program. This element is part of
  118. the DITA software domain, a special set of DITA elements designed to document
  119. software tasks, concepts and reference information.
  120. </xs:documentation>
  121. </xs:annotation>
  122. <xs:complexType mixed="true">
  123. <xs:complexContent>
  124. <xs:extension base="msgnum.class">
  125. <xs:attribute ref="class" default="+ topic/keyword sw-d/msgnum "/>
  126. </xs:extension>
  127. </xs:complexContent>
  128. </xs:complexType>
  129. </xs:element>
  130. <xs:complexType name="msgnum.class" mixed="true">
  131. <xs:attribute name="keyref" type="xs:string"/>
  132. <xs:attribute name="outputclass" type="xs:string"/>
  133. <xs:attributeGroup ref="univ-atts"/>
  134. <xs:attributeGroup ref="global-atts"/>
  135. </xs:complexType>
  136. <xs:element name="varname">
  137. <xs:annotation>
  138. <xs:documentation>
  139. The variable name (&lt;<keyword>varname</keyword>&gt;) element defines a variable
  140. that must be supplied to a software application. The variable name element
  141. is very similar to the variable (var) element, but variable name is used outside
  142. of syntax diagrams, possibly within a message or API description to describe
  143. a system variable or environment variable. This element is part of the DITA
  144. software domain, a special set of DITA elements designed to document software
  145. tasks, concepts and reference information.
  146. </xs:documentation>
  147. </xs:annotation>
  148. <xs:complexType mixed="true">
  149. <xs:complexContent>
  150. <xs:extension base="varname.class">
  151. <xs:attribute ref="class" default="+ topic/keyword sw-d/varname "/>
  152. </xs:extension>
  153. </xs:complexContent>
  154. </xs:complexType>
  155. </xs:element>
  156. <xs:complexType name="varname.class" mixed="true">
  157. <xs:attribute name="keyref" type="xs:string"/>
  158. <xs:attribute name="outputclass" type="xs:string"/>
  159. <xs:attributeGroup ref="univ-atts"/>
  160. <xs:attributeGroup ref="global-atts"/>
  161. </xs:complexType>
  162. <xs:element name="msgblock">
  163. <xs:annotation>
  164. <xs:documentation>
  165. The message block (&lt;<keyword>msgblock</keyword>&gt;) element contains a multi-line
  166. message or set of messages. The message block can contain multiple message
  167. numbers and message descriptions, each enclosed in a &lt;<keyword>msgnum</keyword>&gt; and &lt;<keyword>msgph</keyword>&gt; element.
  168. It can also contain the message content directly. This element is part of
  169. the DITA software domain, a special set of DITA elements designed to document
  170. software tasks, concepts and reference information.
  171. </xs:documentation>
  172. </xs:annotation>
  173. <xs:complexType mixed="true">
  174. <xs:complexContent>
  175. <xs:extension base="msgblock.class">
  176. <xs:attribute ref="class" default="+ topic/pre sw-d/msgblock "/>
  177. </xs:extension>
  178. </xs:complexContent>
  179. </xs:complexType>
  180. </xs:element>
  181. <xs:complexType name="msgblock.class" mixed="true">
  182. <xs:choice minOccurs="0" maxOccurs="unbounded">
  183. <xs:group ref="words.cnt"/>
  184. </xs:choice>
  185. <xs:attribute name="outputclass" type="xs:string"/>
  186. <xs:attribute name="spectitle" type="xs:string"/>
  187. <xs:attribute ref="xml:space" fixed="preserve"/>
  188. <xs:attributeGroup ref="display-atts"/>
  189. <xs:attributeGroup ref="univ-atts"/>
  190. <xs:attributeGroup ref="global-atts"/>
  191. </xs:complexType>
  192. <xs:element name="cmdname">
  193. <xs:annotation>
  194. <xs:documentation>
  195. The command name (&lt;cmdname&gt;) element specifies the name of a command
  196. when it is part of a software discussion. This element is part of the DITA
  197. software domain, a special set of DITA elements designed to document software
  198. tasks, concepts and reference information.
  199. </xs:documentation>
  200. </xs:annotation>
  201. <xs:complexType mixed="true">
  202. <xs:complexContent>
  203. <xs:extension base="cmdname.class">
  204. <xs:attribute ref="class" default="+ topic/keyword sw-d/cmdname "/>
  205. </xs:extension>
  206. </xs:complexContent>
  207. </xs:complexType>
  208. </xs:element>
  209. <xs:complexType name="cmdname.class" mixed="true">
  210. <xs:attribute name="keyref" type="xs:string"/>
  211. <xs:attribute name="outputclass" type="xs:string"/>
  212. <xs:attributeGroup ref="univ-atts"/>
  213. <xs:attributeGroup ref="global-atts"/>
  214. </xs:complexType>
  215. <xs:element name="filepath">
  216. <xs:annotation>
  217. <xs:documentation>
  218. The &lt;<keyword>filepath</keyword>&gt; element indicates
  219. the name and optionally the location of a referenced file by specifying the
  220. directory containing the file, and other directories that may precede it in
  221. the system hierarchy. This element is part of the DITA software domain, a
  222. special set of DITA elements designed to document software tasks, concepts
  223. and reference information.
  224. </xs:documentation>
  225. </xs:annotation>
  226. <xs:complexType mixed="true">
  227. <xs:complexContent>
  228. <xs:extension base="filepath.class">
  229. <xs:attribute ref="class" default="+ topic/ph sw-d/filepath "/>
  230. </xs:extension>
  231. </xs:complexContent>
  232. </xs:complexType>
  233. </xs:element>
  234. <xs:complexType name="filepath.class" mixed="true">
  235. <xs:choice minOccurs="0" maxOccurs="unbounded">
  236. <xs:group ref="words.cnt"/>
  237. </xs:choice>
  238. <xs:attribute name="outputclass" type="xs:string"/>
  239. <xs:attributeGroup ref="univ-atts"/>
  240. <xs:attributeGroup ref="global-atts"/>
  241. </xs:complexType>
  242. <xs:element name="userinput">
  243. <xs:annotation>
  244. <xs:documentation>
  245. The user input (&lt;<keyword>userinput</keyword>&gt;) element represens the text
  246. a user should input in response to a program or system prompt.
  247. This element is part of the DITA software domain, a special set of DITA elements
  248. designed to document software tasks, concepts and reference information.
  249. </xs:documentation>
  250. </xs:annotation>
  251. <xs:complexType mixed="true">
  252. <xs:complexContent>
  253. <xs:extension base="userinput.class">
  254. <xs:attribute ref="class" default="+ topic/ph sw-d/userinput "/>
  255. </xs:extension>
  256. </xs:complexContent>
  257. </xs:complexType>
  258. </xs:element>
  259. <xs:complexType name="userinput.class" mixed="true">
  260. <xs:choice minOccurs="0" maxOccurs="unbounded">
  261. <xs:group ref="words.cnt"/>
  262. </xs:choice>
  263. <xs:attribute name="outputclass" type="xs:string"/>
  264. <xs:attributeGroup ref="univ-atts"/>
  265. <xs:attributeGroup ref="global-atts"/>
  266. </xs:complexType>
  267. <xs:element name="systemoutput">
  268. <xs:annotation>
  269. <xs:documentation>
  270. The system output (&lt;<keyword>systemoutput</keyword>&gt;) element
  271. represents computer output or responses to a command or situation.
  272. A generalized element, it represents any kind of output from the computer,
  273. so the author may wish to choose more specific markup, such as msgph, for
  274. messages from the application. The system output element is part of the DITA
  275. software domain, a special set of DITA elements designed to document software
  276. tasks, concepts and reference information.
  277. </xs:documentation>
  278. </xs:annotation>
  279. <xs:complexType mixed="true">
  280. <xs:complexContent>
  281. <xs:extension base="systemoutput.class">
  282. <xs:attribute ref="class" default="+ topic/ph sw-d/systemoutput "/>
  283. </xs:extension>
  284. </xs:complexContent>
  285. </xs:complexType>
  286. </xs:element>
  287. <xs:complexType name="systemoutput.class" mixed="true">
  288. <xs:choice minOccurs="0" maxOccurs="unbounded">
  289. <xs:group ref="words.cnt"/>
  290. </xs:choice>
  291. <xs:attribute name="outputclass" type="xs:string"/>
  292. <xs:attributeGroup ref="univ-atts"/>
  293. <xs:attributeGroup ref="global-atts"/>
  294. </xs:complexType>
  295. </xs:schema>