topic.mod 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  1. <!-- ============================================================= -->
  2. <!-- HEADER -->
  3. <!-- ============================================================= -->
  4. <!-- MODULE: DITA DITA Topic -->
  5. <!-- VERSION: 1.1 -->
  6. <!-- DATE: November 2006 -->
  7. <!-- -->
  8. <!-- ============================================================= -->
  9. <!-- ============================================================= -->
  10. <!-- PUBLIC DOCUMENT TYPE DEFINITION -->
  11. <!-- TYPICAL INVOCATION -->
  12. <!-- -->
  13. <!-- Refer to this file by the following public identifier or an
  14. appropriate system identifier
  15. PUBLIC "-//OASIS//ELEMENTS DITA Topic//EN"
  16. Delivered as file "topic.mod" -->
  17. <!-- ============================================================= -->
  18. <!-- SYSTEM: Darwin Information Typing Architecture (DITA) -->
  19. <!-- -->
  20. <!-- PURPOSE: Declaring the elements and specialization -->
  21. <!-- attributes for the base Topic type -->
  22. <!-- -->
  23. <!-- ORIGINAL CREATION DATE: -->
  24. <!-- March 2001 -->
  25. <!-- -->
  26. <!-- (C) Copyright OASIS Open 2005, 2006. -->
  27. <!-- (C) Copyright IBM Corporation 2001, 2004. -->
  28. <!-- All Rights Reserved. -->
  29. <!-- -->
  30. <!-- UPDATES: -->
  31. <!-- 2005.11.15 RDA: Corrected the public ID for tblDecl.mod -->
  32. <!-- 2005.11.15 RDA: Removed old declaration for topicreftypes -->
  33. <!-- entity -->
  34. <!-- 2005.11.15 RDA: Corrected the PURPOSE in this comment -->
  35. <!-- 2005.11.15 RDA: Corrected Long Names for alt, indextermref -->
  36. <!-- 2006.06.06 RDA: Bug fixes: -->
  37. <!-- Added xref and fn to fig.cnt -->
  38. <!-- Remove xmlns="" from global-atts -->
  39. <!-- 2006.06.06 RDA: Moved shared items to commonElements file -->
  40. <!-- 2006.06.07 RDA: Added <abstract> element -->
  41. <!-- 2006.06.07 RDA: Make universal attributes universal -->
  42. <!-- (DITA 1.1 proposal #12) -->
  43. <!-- 2006.06.14 RDA: Add dir attribute to localization-atts -->
  44. <!-- 2006.06.20 RDA: defn.cnt now explicitly sets its content -->
  45. <!-- 2006.07.06 RDA: Moved class attributes in from topicAttr -->
  46. <!-- 2006.11.30 RDA: Add -dita-use-conref-target to enumerated -->
  47. <!-- attributes -->
  48. <!-- 2006.11.30 RDA: Remove #FIXED from DITAArchVersion -->
  49. <!-- ============================================================= -->
  50. <!-- ============================================================= -->
  51. <!-- ARCHITECTURE ENTITIES -->
  52. <!-- ============================================================= -->
  53. <!-- default namespace prefix for DITAArchVersion attribute can be
  54. overridden through predefinition in the document type shell -->
  55. <!ENTITY % DITAArchNSPrefix
  56. "ditaarch" >
  57. <!-- must be instanced on each topic type -->
  58. <!ENTITY % arch-atts "
  59. xmlns:%DITAArchNSPrefix;
  60. CDATA #FIXED
  61. 'http://dita.oasis-open.org/architecture/2005/'
  62. %DITAArchNSPrefix;:DITAArchVersion
  63. CDATA '1.1'" >
  64. <!-- ============================================================= -->
  65. <!-- ELEMENT NAME ENTITIES -->
  66. <!-- ============================================================= -->
  67. <!-- Definitions of declared elements -->
  68. <!ENTITY % topicDefns PUBLIC
  69. "-//OASIS//ENTITIES DITA Topic Definitions//EN"
  70. "topicDefn.ent" >
  71. %topicDefns;
  72. <!-- Content elements common to map and topic -->
  73. <!ENTITY % commonElements PUBLIC
  74. "-//OASIS//ELEMENTS DITA Common Elements//EN" "commonElements.mod" >
  75. %commonElements;
  76. <!-- MetaData Elements, plus indexterm -->
  77. <!ENTITY % metaXML PUBLIC
  78. "-//OASIS//ELEMENTS DITA Metadata//EN"
  79. "metaDecl.mod" >
  80. %metaXML;
  81. <!-- ============================================================= -->
  82. <!-- ENTITY DECLARATIONS FOR ATTRIBUTE VALUES -->
  83. <!-- ============================================================= -->
  84. <!-- ============================================================= -->
  85. <!-- COMMON ATTLIST SETS -->
  86. <!-- ============================================================= -->
  87. <!ENTITY % body.cnt "%basic.block; | %required-cleanup; | %data.elements.incl; | %foreign.unknown.incl;">
  88. <!ENTITY % section.cnt "#PCDATA | %basic.ph; | %basic.block; | %title; | %txt.incl; | %data.elements.incl; | %foreign.unknown.incl;">
  89. <!ENTITY % section.notitle.cnt "#PCDATA | %basic.ph; | %basic.block; | %txt.incl; | %data.elements.incl; | %foreign.unknown.incl;">
  90. <!-- ============================================================= -->
  91. <!-- COMMON ENTITY DECLARATIONS -->
  92. <!-- ============================================================= -->
  93. <!-- for use within the DTD and supported topics; these will NOT work
  94. outside of this DTD or dtds that specialize from it! -->
  95. <!ENTITY nbsp "&#xA0;" >
  96. <!-- ============================================================= -->
  97. <!-- NOTATION DECLARATIONS -->
  98. <!-- ============================================================= -->
  99. <!-- DITA uses the direct reference model;
  100. notations may be added later as required -->
  101. <!-- ============================================================= -->
  102. <!-- STRUCTURAL MEMBERS -->
  103. <!-- ============================================================= -->
  104. <!ENTITY % info-types 'topic' >
  105. <!-- ============================================================= -->
  106. <!-- COMMON ATTLIST SETS -->
  107. <!-- ============================================================= -->
  108. <!-- Copied into metaDecl.mod -->
  109. <!--<!ENTITY % date-format 'CDATA' >-->
  110. <!ENTITY % rel-atts
  111. 'type CDATA #IMPLIED
  112. role (parent | child | sibling |
  113. friend | next | previous | cousin |
  114. ancestor | descendant | sample |
  115. external | other |
  116. -dita-use-conref-target) #IMPLIED
  117. otherrole CDATA #IMPLIED' >
  118. <!-- ============================================================= -->
  119. <!-- SPECIALIZATION OF DECLARED ELEMENTS -->
  120. <!-- ============================================================= -->
  121. <!ENTITY % topic-info-types "%info-types;">
  122. <!-- ============================================================= -->
  123. <!-- DOMAINS ATTRIBUTE OVERRIDE -->
  124. <!-- ============================================================= -->
  125. <!ENTITY included-domains "" >
  126. <!-- ============================================================= -->
  127. <!-- ELEMENT DECLARATIONS -->
  128. <!-- ============================================================= -->
  129. <!-- LONG NAME: Topic -->
  130. <!ELEMENT topic ((%title;), (%titlealts;)?,
  131. (%shortdesc; | %abstract;)?,
  132. (%prolog;)?, (%body;)?, (%related-links;)?,
  133. (%topic-info-types;)* ) >
  134. <!ATTLIST topic
  135. id ID #REQUIRED
  136. conref CDATA #IMPLIED
  137. %select-atts;
  138. %localization-atts;
  139. outputclass
  140. CDATA #IMPLIED
  141. %arch-atts;
  142. domains CDATA "&included-domains;">
  143. <!-- LONG NAME: Title Alternatives -->
  144. <!ELEMENT titlealts ((%navtitle;)?, (%searchtitle;)?) >
  145. <!ATTLIST titlealts
  146. %univ-atts; >
  147. <!-- LONG NAME: Navigation Title -->
  148. <!ELEMENT navtitle (%words.cnt;)* >
  149. <!ATTLIST navtitle
  150. %univ-atts; >
  151. <!-- LONG NAME: Search Title -->
  152. <!ELEMENT searchtitle (%words.cnt;)* >
  153. <!ATTLIST searchtitle
  154. %univ-atts; >
  155. <!-- LONG NAME: Abstract -->
  156. <!ELEMENT abstract (%section.notitle.cnt; | %shortdesc;)* >
  157. <!ATTLIST abstract
  158. %univ-atts;
  159. outputclass
  160. CDATA #IMPLIED >
  161. <!-- LONG NAME: Short Description -->
  162. <!--
  163. <!ELEMENT shortdesc (%title.cnt;)* >
  164. <!ATTLIST shortdesc
  165. %univ-atts;
  166. outputclass
  167. CDATA #IMPLIED >
  168. -->
  169. <!-- LONG NAME: Body -->
  170. <!ELEMENT body (%body.cnt; | %section; | %example;)* >
  171. <!ATTLIST body
  172. %univ-atts;
  173. outputclass
  174. CDATA #IMPLIED >
  175. <!-- LONG NAME: No Topic nesting -->
  176. <!ELEMENT no-topic-nesting EMPTY >
  177. <!-- LONG NAME: Section -->
  178. <!ELEMENT section (%section.cnt;)* >
  179. <!ATTLIST section
  180. spectitle CDATA #IMPLIED
  181. %univ-atts;
  182. outputclass
  183. CDATA #IMPLIED >
  184. <!-- LONG NAME: Example -->
  185. <!ELEMENT example (%section.cnt;)* >
  186. <!ATTLIST example
  187. spectitle CDATA #IMPLIED
  188. %univ-atts;
  189. outputclass
  190. CDATA #IMPLIED >
  191. <!-- LONG NAME: Description -->
  192. <!-- Desc is used in context with figure and
  193. table titles and also for content models
  194. within linkgroup and object (for
  195. accessibility) -->
  196. <!--
  197. <!ELEMENT desc (%desc.cnt;)* >
  198. <!ATTLIST desc
  199. %univ-atts;
  200. outputclass
  201. CDATA #IMPLIED >
  202. -->
  203. <!-- ============================================================= -->
  204. <!-- PROLOG (METADATA FOR TOPICS) -->
  205. <!-- TYPED DATA ELEMENTS -->
  206. <!-- ============================================================= -->
  207. <!-- typed content definitions -->
  208. <!-- typed, localizable content -->
  209. <!-- LONG NAME: Prolog -->
  210. <!ELEMENT prolog ((%author;)*, (%source;)?, (%publisher;)?,
  211. (%copyright;)*, (%critdates;)?,
  212. (%permissions;)?, (%metadata;)*,
  213. (%resourceid;)*,
  214. (%data.elements.incl; |
  215. %foreign.unknown.incl;)*) >
  216. <!ATTLIST prolog
  217. %univ-atts; >
  218. <!-- LONG NAME: Metadata -->
  219. <!ELEMENT metadata ((%audience;)*, (%category;)*, (%keywords;)*,
  220. (%prodinfo;)*, (%othermeta;)*,
  221. (%data.elements.incl; |
  222. %foreign.unknown.incl;)*) >
  223. <!ATTLIST metadata
  224. %univ-atts;
  225. mapkeyref CDATA #IMPLIED >
  226. <!-- ============================================================= -->
  227. <!-- BASIC DOCUMENT ELEMENT DECLARATIONS -->
  228. <!-- (rich text) -->
  229. <!-- ============================================================= -->
  230. <!-- ============================================================= -->
  231. <!-- BASE FORM PHRASE TYPES -->
  232. <!-- ============================================================= -->
  233. <!-- ============================================================= -->
  234. <!-- LINKING GROUPING -->
  235. <!-- ============================================================= -->
  236. <!-- LONG NAME: Related Links -->
  237. <!ELEMENT related-links (%link; | %linklist; | %linkpool;)+ >
  238. <!ATTLIST related-links
  239. %rel-atts;
  240. %univ-atts;
  241. format CDATA #IMPLIED
  242. scope (local | peer | external |
  243. -dita-use-conref-target) #IMPLIED
  244. outputclass
  245. CDATA #IMPLIED >
  246. <!-- LONG NAME: Link -->
  247. <!ELEMENT link ((%linktext;)?, (%desc;)?) >
  248. <!ATTLIST link
  249. href CDATA #IMPLIED
  250. keyref CDATA #IMPLIED
  251. query CDATA #IMPLIED
  252. %rel-atts;
  253. %univ-atts;
  254. format CDATA #IMPLIED
  255. scope (local | peer | external |
  256. -dita-use-conref-target) #IMPLIED
  257. outputclass
  258. CDATA #IMPLIED >
  259. <!-- LONG NAME: Link Text -->
  260. <!ELEMENT linktext (%words.cnt;)* >
  261. <!ATTLIST linktext
  262. %univ-atts; >
  263. <!-- LONG NAME: Link List -->
  264. <!ELEMENT linklist ((%title;)?, (%desc;)?,
  265. (%linklist; | %link;)*, (%linkinfo;)?) >
  266. <!ATTLIST linklist
  267. collection-type
  268. (unordered | sequence | choice |
  269. tree | family |
  270. -dita-use-conref-target) #IMPLIED
  271. duplicates (yes | no |
  272. -dita-use-conref-target) #IMPLIED
  273. mapkeyref CDATA #IMPLIED
  274. %rel-atts;
  275. %univ-atts;
  276. spectitle CDATA #IMPLIED
  277. format CDATA #IMPLIED
  278. scope (local | peer | external |
  279. -dita-use-conref-target) #IMPLIED
  280. outputclass
  281. CDATA #IMPLIED >
  282. <!-- LONG NAME: Link Information -->
  283. <!ELEMENT linkinfo (%desc.cnt;)* >
  284. <!ATTLIST linkinfo
  285. %univ-atts; >
  286. <!-- LONG NAME: Link Pool -->
  287. <!ELEMENT linkpool (%linkpool; | %link;)* >
  288. <!ATTLIST linkpool
  289. collection-type
  290. (unordered | sequence | choice |
  291. tree | family |
  292. -dita-use-conref-target) #IMPLIED
  293. duplicates (yes | no |
  294. -dita-use-conref-target) #IMPLIED
  295. mapkeyref CDATA #IMPLIED
  296. %rel-atts;
  297. %univ-atts;
  298. format CDATA #IMPLIED
  299. scope (local | peer | external |
  300. -dita-use-conref-target) #IMPLIED
  301. outputclass
  302. CDATA #IMPLIED >
  303. <!-- ============================================================= -->
  304. <!-- MODULES CALLS -->
  305. <!-- ============================================================= -->
  306. <!-- Table Elements -->
  307. <!-- 2005.11.15 RDA: Corrected the public ID for tblDecl.mod, -->
  308. <!-- from the old value "-//OASIS//ELEMENTS DITA CALS Tables//EN" -->
  309. <!-- Tables are now part of commonElements -->
  310. <!--<!ENTITY % tableXML PUBLIC
  311. "-//OASIS//ELEMENTS DITA Exchange Table Model//EN"
  312. "tblDecl.mod" >
  313. %tableXML;-->
  314. <!-- ============================================================= -->
  315. <!-- SPECIALIZATION ATTRIBUTE DECLARATIONS -->
  316. <!-- ============================================================= -->
  317. <!ATTLIST abstract %global-atts; class CDATA "- topic/abstract " >
  318. <!ATTLIST body %global-atts; class CDATA "- topic/body " >
  319. <!ATTLIST example %global-atts; class CDATA "- topic/example " >
  320. <!ATTLIST link %global-atts; class CDATA "- topic/link " >
  321. <!ATTLIST linkinfo %global-atts; class CDATA "- topic/linkinfo " >
  322. <!ATTLIST linklist %global-atts; class CDATA "- topic/linklist " >
  323. <!ATTLIST linkpool %global-atts; class CDATA "- topic/linkpool " >
  324. <!ATTLIST linktext %global-atts; class CDATA "- topic/linktext " >
  325. <!ATTLIST metadata %global-atts; class CDATA "- topic/metadata " >
  326. <!ATTLIST navtitle %global-atts; class CDATA "- topic/navtitle " >
  327. <!ATTLIST no-topic-nesting
  328. %global-atts; class CDATA "- topic/no-topic-nesting ">
  329. <!ATTLIST prolog %global-atts; class CDATA "- topic/prolog " >
  330. <!ATTLIST related-links
  331. %global-atts; class CDATA "- topic/related-links ">
  332. <!ATTLIST searchtitle
  333. %global-atts; class CDATA "- topic/searchtitle ">
  334. <!ATTLIST section %global-atts; class CDATA "- topic/section " >
  335. <!ATTLIST titlealts %global-atts; class CDATA "- topic/titlealts " >
  336. <!ATTLIST topic %global-atts; class CDATA "- topic/topic " >
  337. <!-- Shortdesc in map uses map/shortdesc so this one must be
  338. included, even though the element is common. -->
  339. <!ATTLIST shortdesc %global-atts; class CDATA "- topic/shortdesc ">
  340. <!-- ================== End DITA Topic ========================== -->