DITA Language Specification V1 - OASIS
DITA Release 1.1 Language SpecificationCommittee Draft 02, 8 May 2007Document identifier:DITA v1.1LangSpecificationIssue02Locations:This ec.zip (DITA source; see ditaref-type.ditamap)Previous n.pdfLatest ec.zip (DITA source; see ditaref-type.ditamap)Technical Committee:OASIS Darwin Information Typing Architecture (DITA) TCChair(s):Don DayEditor(s):Michael PriestleyRobert D. AndersonJoAnn HackosRelated Work:This specification replaces or supercedes:OASIS DITA Language Specification Version 1.0This specification is related to:OASIS DITA Architectural Specification Version 1.1 Committee chspec/archspec.html)OASIS DITA DTDs Committee Draft Version 1.1 adtd.zip)OASIS DITA Schemas Committee Draft Version ma/ditaschema.zip)Declared XML Namespace(s):[none]Abstract:The DITA 1.1 Language Specification describes each element in version 1.1 of the DITA Standard.Status:This document was last revised or approved by the Darwin Information Typing Architecture (DITA) TC onthe above date. The level of approval is also listed above. Check the "Latest Version" or "Latest ApprovedVersion" location noted above for possible later revisions of this document.Technical Committee members should send comments on this specification to the Technical Committee’semail list. Others should send comments to the Technical Committee by using the “Send A Comment”button on the Technical Committee’s web page athttp://www.oasis-open.org/committees/tc home.php?wg abbrev dita.
2 OpenTopic PrefaceFor information on whether any patents have been disclosed that may be essential to implementing thisspecification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights sectionof the Technical Committee web page ).The non-normative errata page for this specification is located athttp://www.oasis-open.org/committees/tc home.php?wg abbrev dita.NoticesCopyright OASIS 1993-2007. All Rights Reserved. OASIS trademark, IPR and other policies apply.All capitalized terms in the following text have the meanings assigned to them in the OASIS IntellectualProperty Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.This document and translations of it may be copied and furnished to others, and derivative works thatcomment on or otherwise explain it or assist in its implementation may be prepared, copied, published,and distributed, in whole or in part, without restriction of any kind, provided that the above copyright noticeand this section are included on all such copies and derivative works. However, this document itself maynot be modified in any way, including by removing the copyright notice or references to OASIS, except asneeded for the purpose of developing any document or deliverable produced by an OASIS TechnicalCommittee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, mustbe followed) or as required to translate it into languages other than English.The limited permissions granted above are perpetual and will not be revoked by OASIS or its successorsor assigns.This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMSALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTYTHAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTSOR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.OASIS requests that any OASIS Party or any other party that believes it has patent claims that wouldnecessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard,to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses tosuch patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee thatproduced this specification. OASIS invites any party to contact the OASIS TC Administrator if it is awareof a claim of ownership of any patent claims that would necessarily be infringed by implementations of thisspecification by a patent holder that is not willing to provide a license to such patent claims in a mannerconsistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASISmay include such claims on its website, but disclaims any obligation to do so. OASIS takes no positionregarding the validity or scope of any intellectual property or other rights that might be claimed to pertainto the implementation or use of the technology described in this document or the extent to which any licenseunder such rights might or might not be available; neither does it represent that it has made any effort toidentify any such rights. Information on OASIS' procedures with respect to rights in any document ordeliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies ofclaims of rights made available for publication and any assurances of licenses to be made available, orthe result of an attempt made to obtain a general license or permission for the use of such proprietaryrights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtainedfrom the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectualproperty rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should beused only to refer to the organization and its official outputs. OASIS welcomes reference to, andimplementation and use of, specifications, while reserving the right to enforce its marks against misleadinguses. Please see http://www.oasis-open.org/who/trademark.php for above guidance.
ContentsChapter 1. Introduction . . . . . . . . 1Chapter 2. Topic elements . . . . . . . 3topic . . .title . . .titlealts . .navtitle . .searchtitle .abstract . .shortdesc .body . .section . .example .related-links.3567891113141516Chapter 3. Concept elements . . . . . 19concept .conbody. 19. 20Chapter 4. Reference elements . . . . 23reference .refbody . .refsyn . .properties .prophead .proptypehdpropvaluehdpropdeschdproperty .proptype .propvalue .propdesc .232425262829293031323334Chapter 5. Task elements . . . . . . . 37task . . . .taskbody . .prereq . . .context . . .steps . . .steps-unorderedstep . . . .cmd . . . .info . . . .substeps . .substep . . .stepxmp . .choicetable .chhead . . .choptionhd .chdeschd . .chrow . . .choption . .chdesc . . .choices . . .3738394041424346474748515253545556575859choice . .stepresult .tutorialinforesult . .postreq . .6061626364Chapter 6. Glossentry elements . . . . 67glossentry .glossdef .glossterm . 67. 68. 69Chapter 7. Body elements . . . . . . 71p. . .note . .ph . .keywordxref . .ol . . .ul. . .li . . .sl . . .sli . .dl. . .dlhead .dthd . .ddhd .dlentry .dt . .dd . .fig . .figgroupdesc . .image .alt . .object .param .pre . .lines .cite . .lq . .q . . 71. 72. 74. 75. 77. 80. 82. 83. 84. 86. 87. 89. 90. 91. 92. 93. 94. 95. 96. 97. 98. . . . . . . . . . . . . . . 101. . . . . . . . . . . . . . . 102. . . . . . . . . . . . . . . 106. . . . . . . . . . . . . . . 107. . . . . . . . . . . . . . . 109. . . . . . . . . . . . . . . 110. . . . . . . . . . . . . . . 111. . . . . . . . . . . . . . . 113Chapter 8. Table elements . . . . . . 115table . .tgroup . .colspec .thead . .tbody . .row . .entry . .simpletablesthead . .strow . .stentry .115118120122124125126129131132133iii
Chapter 9. Prolog elements . . . . . 135prolog . .audience .author . .brand . .category .componentcopyright .copyrholdercopyryearcreated .critdates .featnum .keywords .metadata .othermetapermissionsplatform .prodinfo .prodnameprognum .publisher .resourceidrevised .series . .source . .vrmlist .vrm . .link . .linklist .linkpoollinktextlinkinfo.iv.DITA Language Specification v1.1.215216218219.203Chapter 17. Utilities elements . . . . 289.imagemaparea . .coords . .shape . .167.167169172175176179Chapter 13. Typographic elementsbi.Chapter 12. Specialization elementsitemgroup . .no-topic-nestingrequired-cleanupstate . . . .term . . . .boolean . . .Chapter 11. Miscellaneous elementsdita. . . .draft-commentfn . . . .indexterm .indextermref.index-base .tm . . . .data-about .data . . .foreign . .unknown . .Chapter 10. Related links 152153154155156157158160161162163164165u .tt .sup .sub 10213. 213. 214Chapter 14. Programming elementsapiname . .codeblock .codeph . .option . . .parmname .parml . . .plentry . .pt . . . .pd . . . .synph . . .syntaxdiagramgroupseq . .groupchoice .groupcomp .fragment . .fragref . . .synblk . . .synnote . .synnoteref .kwd . . .var . . . .oper . . .delim . . .sep . . . .repsep . . 45249250251252255257260263266Chapter 15. Software elements . . . . 269msgph . . .msgblock . .msgnum . .cmdname . .varname . .filepath . .userinput . .systemoutput.Chapter 16. User interface elementsuicontrol . .wintitle . .menucascadeshortcut . .screen . . .281.281282284285286. 297. 298. 300Chapter 18. Indexing group elementsindex-see . . .index-see-also .index-sort-as .269270271273274276277279289291292294297
Chapter 19. Map elements . . . . . . 303map . .anchor . .navref . .reltable .relrow . .relcell . .relheader .relcolspec .topicmeta.topicref .303305306307309310311312313314Chapter 20. Map group elements . . . 317topicgroup .topichead . . 317. 318Chapter 21. Bookmap contentelements . . . . . . . . . . . . . 321bookmap . .abbrevlist . .amendments.appendix . .backmatter .bibliolist . .bookabstract .booklibrary .booklist . .booklists . .booktitle . .booktitlealt .chapter . .colophon . .dedication .draftintro . .figurelist . .frontmatter .glossarylist .indexlist . .mainbooktitlenotices . .part . . .preface . .tablelist . .toc . . . ter 22. Bookmap metadataelements . . . . . . . . . . . . . 357bookmeta. . . .approved . . . .bookchangehistorybookevent . . .bookeventtype . .bookid . . . .booknumber . . .bookowner . . .bookpartno . . .bookrestriction . .bookrights . . .completed . . .357358360362364366368370372374376378copyrfirst . . . . .copyrlast . . . . .day . . . . . . .edited . . . . . .edition . . . . .isbn . . . . . .maintainer . . . .month . . . . . .organization . . . .person . . . . . .printlocation . . . .published . . . .publisherinformation .publishtype . . . .reviewed . . . . .revisionid . . . .started. . . . . .summary . . . . .tested . . . . . .volume . . . . .year . . . . . .Chapter 23. xNAL domain elementsxNAL usage guidelines .authorinformation . . .addressdetails . . . .administrativearea . . .contactnumber . . . .contactnumbers . . .country . . . . . .emailaddress . . . .emailaddresses . . . .firstname . . . . . .generationidentifier . .honorific . . . . . .lastname . . . . . .locality . . . . . .localityname . . . . .middlename . . . . .namedetails . . . . .organizationinfo . . .organizationname . . .organizationnamedetails .otherinfo . . . . . .personinfo . . . . .personname . . . . .postalcode . . . . .thoroughfare . . . .url . . . . . . . .urls . . . . . . . apter 24. DITAVAL elements . . . . 459val . . . .style-conflict .prop . . .revprop . .startflag . .endflag . .alt-text . .459459460462463464464Contentsv
Chapter 25. Commonly referencedattributes . . . . . . . . . . . . . 465%display-atts; . . . . . . . . .%global-atts;. . . . . . . . . .%id-atts; . . . . . . . . . . .%rel-atts; . . . . . . . . . . .%select-atts; . . . . . . . . . .%localization-atts; . . . . . . . .%univ-atts; . . . . . . . . . .%topicref-atts; and %topicref-atts-no-toc;Other common DITA attributes . . .viDITA Language Specification v1.1.465466467467468470471474477Complex attribute definitionsThe conref attribute . .The type attribute . . .The format attribute . .The role attribute . . .478478480482482Chapter 26. Alphabetical listing ofDITA elements . . . . . . . . . . . 485Index . . . . . . . . . . . . . . . 489
Chapter 1. IntroductionThe design of the Darwin Information Typing Architecture (DITA) is based on deriving multipleinformation types, or topic types, from a common, generic topic. This language reference describes theelements that comprise the topic DTD and its initial, information-typed descendents: concept, reference,task, and glossentry. It also describes the DITA map DTD and its current specialization (bookmap), aswell as various topic and map based DITA domains.This specification describes specific details of each element in the OASIS DITA language. The separateDITA Architectural Specification includes detailed information about DITA specialization, when to useeach topic type, how topics and maps interact, details of complex behaviors such as conref andconditional processing, and many other best practices for working with DITA.The elements that make up the DITA design represent a set of different authoring concerns, each of whichis grouped into its own chapter. Major sections include:v The main components of a topic, concept, reference, task, document,v The main components of a glossentry document (new for DITA 1.1),v The common elements available for creating content within the body of a topic,v The elements that make up the two types of tables in DITA,v The elements contained in the prolog of a topic (many of these also appear in the topicmeta in a map),v The elements contained in the related-links part of a topic,vvvvElements that appear in many contexts, but do not fit into specific categories,Elements that are available for further specialization,Domain specializations of topic elements that represent different subject domains,Elements that make up a DITA map, followed by the ″mapgroup″ domain specialization,v The bookmap specialization (new for DITA 1.1),v The xNAL domain for describing author information (based on the extensible Name and AddressLanguage standard, and also new for DITA 1.1),v The DITAVAL DTD for flagging and filtering content (formalized for DITA 1.1),v and commonly referenced descriptionsIn addition to glossentry topics, bookmap, the xNAL domain, and the formalized DITAVAL format, DITA1.1 also includes a new indexing domain, clarifications to the image and object elements, new props andbase attributes for attribute specialization, and several new elements:v abstractv data and data-aboutv foreign and unknownv index-baseDITA 1.1 includes a new ″dir″ attribute to aid in localization. This attribute, along with other localizationattributes, is now available on nearly every DITA element. In addition, common metadata and idattributes that were available on many elements in DITA 1.0 are now available on nearly every element.TerminologyThe key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” are to be interpreted as described in[RFC2119].1
Normative References[RFC2119]S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.2DITA Language Specification v1.1
Chapter 2. Topic elementsUse the generic topic structure for untyped topi
OASIS Darwin Information Typing Architecture (DITA) TC Chair(s): Don Day Editor(s): Michael Priestley Robert D. Anderson JoAnn Hackos Related Work: This specification replaces or supercedes: OASIS DITA Language Specification Version 1.0 This specification is related to: OASIS DITA Architectural S
The DITA Open Toolkit (DITA-OT) is an open-source implementation of the OASIS DITA specification, which is developed by the OASIS DITA Technical Committee. The DITA-OT is a set of Java-based, open-source tools and Ant scripts that transform DITA content (maps and topics) into deliverable f
DITA Architectural Specification v1.0 1.1 approved as an OASIS Standard in August 2007. DITA Language Reference v1.1 DITA Architectural Specification v1.1 1.2 approved as an OASIS Standard in December 2010. DITA Specification v1.2 Current version of
DITA technologist should read, not the average writer or manager. The good news is that we’ve designed DITA 101 for writers and managers. We’ve taken our years of expe rience helping organizations to move to DITA a
According to the DITA Exchange product team, the map viewer is the most frequently accessed UI by SMEs and serves as a popular entryway into topic creation, review, and revision. Technically, the map viewer is not part of the DITA Exchange editor, rather it is part of DITA Exchange’s l
LightWeight DITA seems to be quite promising in improving the spread of DITA outside the . Introduction When studying technical writing, authoring in DITA has become an unavoidable course. . (OASIS) to release it to the public. In fact, IBM realized that it “would be more useful if [it] could actually have this spread to other firms that .
Man y DITA authoring and publishing tools come with standard transformers for most common delivery formats, such as PDF, RTF and HTML. The DITA Open Toolkit, an open source collection of utilities and documentation to help writers work with DITA, includes basic transformers for PDF, RTF, HTML, DocBook, Eclipse Help, and Microsoft HTML Help.
OASIS ODF V1.0 Approved Chair OASIS DITA Submitted WS-Addressing to W3C Contributed UML2 to Eclipse IBM named chair IETF IBM commitment to RF in OASIS Lead OASIS standardization of WS-DM and DITA Pledged 500 patents to Open Source 2006 Web Services Reliabil
ASTM STANDARDS IN BUILDING CODES SPECIFICATIONS, TEST METHODS, PRACTICES, CLASSIFICATIONS, TERMINOLOGY VOLUME 1 2007 Forty-fourth Edition ASTM Stock Number: BLDG07 ASTM INTERNATIONAL n 100 BARR HARBOR DRIVE, PO BOX C700, WEST CONSHOHOCKEN, PA 19428-2959 TEL: 610-832-9500 n FAX: 610-832-9555 n EMAIL: service@astm.org n WEBSITE: www.astm.org. Editorial Staff Director: Vernice A. Mayer Editors .
