OASIS logo

DITA Language Specification v1.1

Committee Draft 02

8 May 2007

This Version:

http://docs.oasis-open.org/dita/v1.1/CD02/langspec/ditaref-type.html

http://docs.oasis-open.org/dita/v1.1/CD02/langspec/ditaref-type.pdf

http://docs.oasis-open.org/dita/v1.1/CD02/langspec/langspec.zip (DITA source; see ditaref-type.ditamap)

Previous Version:

http://docs.oasis-open.org/dita/v1.0/langspec/ditaref-type.toc.html

http://docs.oasis-open.org/dita/v1.0/dita-v1.0-spec-os-LanguageSpecification.pdf

Latest Version:

http://docs.oasis-open.org/dita/v1.1/CD02/langspec/ditaref-type.html

http://docs.oasis-open.org/dita/v1.1/CD02/langspec/ditaref-type.pdf

http://docs.oasis-open.org/dita/v1.1/CD02/langspec/langspec.zip (DITA source; see ditaref-type.ditamap)

Technical Committee:

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 Specification Version 1.1 Committee Draft (http://docs.oasis-open.org/dita/v1.1/CD02/archspec/archspec.html)

OASIS DITA DTDs Committee Draft Version 1.1 (http://docs.oasis-open.org/dita/v1.1/CD02/dtd/ditadtd.zip)

OASIS DITA Schemas Committee Draft Version 1.1 (http://docs.oasis-open.org/dita/v1.1/CD02/schema/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 OASIS Darwin Information Typing Architecture (DITA) TC on the above date. The level of approval is also listed above. Check the "Latest Version" or "Latest Approved Version" location noted above for possible later revisions of this document.

Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita.

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http://www.oasis-open.org/committees/dita/ipr.php.

The non-normative errata page for this specification is located at http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita.

Notices

Copyright © 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 Intellectual Property 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 that comment 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 notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be 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 successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR 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 would necessarily 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 to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property 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 be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance.

Table of Contents

1.0 Introduction

2.0 Topic elements

    2.01 topic

    2.02 title

    2.03 titlealts

    2.04 navtitle

    2.05 searchtitle

    2.06 abstract

    2.07 shortdesc

    2.08 body

    2.09 section

    2.10 example

    2.11 related-links

3.0 Concept elements

    3.01 concept

    3.02 conbody

4.0 Reference elements

    4.01 reference

    4.02 refbody

    4.03 refsyn

    4.04 properties

    4.05 prophead

    4.06 proptypehd

    4.07 propvaluehd

    4.08 propdeschd

    4.09 property

    4.10 proptype

    4.11 propvalue

    4.12 propdesc

5.0 Task elements

    5.01 task

    5.02 taskbody

    5.03 prereq

    5.04 context

    5.05 steps

    5.06 steps-unordered

    5.07 step

    5.08 cmd

    5.09 info

    5.10 substeps

    5.11 substep

    5.12 stepxmp

    5.13 choicetable

    5.14 chhead

    5.15 choptionhd

    5.16 chdeschd

    5.17 chrow

    5.18 choption

    5.19 chdesc

    5.20 choices

    5.21 choice

    5.22 stepresult

    5.23 tutorialinfo

    5.24 result

    5.25 postreq

6.0 Glossentry elements

    6.01 glossentry

    6.02 glossdef

    6.03 glossterm

7.0 Body elements

    7.01 p

    7.02 note

    7.03 ph

    7.04 keyword

    7.05 xref

    7.06 ol

    7.07 ul

    7.08 li

    7.09 sl

    7.10 sli

    7.11 dl

    7.12 dlhead

    7.13 dthd

    7.14 ddhd

    7.15 dlentry

    7.16 dt

    7.17 dd

    7.18 fig

    7.19 figgroup

    7.20 desc

    7.21 image

    7.22 alt

    7.23 object

    7.24 param

    7.25 pre

    7.26 lines

    7.27 cite

    7.28 lq

    7.29 q

8.0 Table elements

    8.01 table

    8.02 tgroup

    8.03 colspec

    8.04 thead

    8.05 tbody

    8.06 row

    8.07 entry

    8.08 simpletable

    8.09 sthead

    8.10 strow

    8.11 stentry

9.0 Prolog elements

    9.01 prolog

    9.02 audience

    9.03 author

    9.04 brand

    9.05 category

    9.06 component

    9.07 copyright

    9.08 copyrholder

    9.09 copyryear

    9.10 created

    9.11 critdates

    9.12 featnum

    9.13 keywords

    9.14 metadata

    9.15 othermeta

    9.16 permissions

    9.17 platform

    9.18 prodinfo

    9.19 prodname

    9.20 prognum

    9.21 publisher

    9.22 resourceid

    9.23 revised

    9.24 series

    9.25 source

    9.26 vrmlist

    9.27 vrm

10.0 Related links elements

    10.01 link

    10.02 linklist

    10.03 linkpool

    10.04 linktext

    10.05 linkinfo

11.0 Miscellaneous elements

    11.01 dita

    11.02 draft-comment

    11.03 fn

    11.04 indexterm

    11.05 indextermref

    11.06 index-base

    11.07 tm

    11.08 data-about

    11.09 data

    11.10 foreign

    11.11 unknown

12.0 Specialization elements

    12.01 itemgroup

    12.02 no-topic-nesting

    12.03 required-cleanup

    12.04 state

    12.05 term

    12.06 boolean

13.0 Typographic elements

    13.01 b

    13.02 i

    13.03 u

    13.04 tt

    13.05 sup

    13.06 sub

14.0 Programming elements

    14.01 apiname

    14.02 codeblock

    14.03 codeph

    14.04 option

    14.05 parmname

    14.06 parml

    14.07 plentry

    14.08 pt

    14.09 pd

    14.10 synph

    14.11 syntaxdiagram

    14.12 groupseq

    14.13 groupchoice

    14.14 groupcomp

    14.15 fragment

    14.16 fragref

    14.17 synblk

    14.18 synnote

    14.19 synnoteref

    14.20 kwd

    14.21 var

    14.22 oper

    14.23 delim

    14.24 sep

    14.25 repsep

15.0 Software elements

    15.01 msgph

    15.02 msgblock

    15.03 msgnum

    15.04 cmdname

    15.05 varname

    15.06 filepath

    15.07 userinput

    15.08 systemoutput

16.0 User interface elements

    16.01 uicontrol

    16.02 wintitle

    16.03 menucascade

    16.04 shortcut

    16.05 screen

17.0 Utilities elements

    17.01 imagemap

    17.02 area

    17.03 coords

    17.04 shape

18.0 Indexing group elements

    18.01 index-see

    18.02 index-see-also

    18.03 index-sort-as

19.0 Map elements

    19.01 map

    19.02 anchor

    19.03 navref

    19.04 reltable

    19.05 relrow

    19.06 relcell

    19.07 relheader

    19.08 relcolspec

    19.09 topicmeta

    19.10 topicref

20.0 Map group elements

    20.01 topicgroup

    20.02 topichead

21.0 Bookmap content elements

    21.01 bookmap

    21.02 abbrevlist

    21.03 amendments

    21.04 appendix

    21.05 backmatter

    21.06 bibliolist

    21.07 bookabstract

    21.08 booklibrary

    21.09 booklist

    21.10 booklists

    21.11 booktitle

    21.12 booktitlealt

    21.13 chapter

    21.14 colophon

    21.15 dedication

    21.16 draftintro

    21.17 figurelist

    21.18 frontmatter

    21.19 glossarylist

    21.20 indexlist

    21.21 mainbooktitle

    21.22 notices

    21.23 part

    21.24 preface

    21.25 tablelist

    21.26 toc

    21.27 trademarklist

22.0 Bookmap metadata elements

    22.01 bookmeta

    22.02 approved

    22.03 bookchangehistory

    22.04 bookevent

    22.05 bookeventtype

    22.06 bookid

    22.07 booknumber

    22.08 bookowner

    22.09 bookpartno

    22.10 bookrestriction

    22.11 bookrights

    22.12 completed

    22.13 copyrfirst

    22.14 copyrlast

    22.15 day

    22.16 edited

    22.17 edition

    22.18 isbn

    22.19 maintainer

    22.20 month

    22.21 organization

    22.22 person

    22.23 printlocation

    22.24 published

    22.25 publisherinformation

    22.26 publishtype

    22.27 reviewed

    22.28 revisionid

    22.29 started

    22.30 summary

    22.31 tested

    22.32 volume

    22.33 year

23.0 xNAL domain elements

    23.01 xNAL usage guidelines

    23.02 authorinformation

    23.03 addressdetails

    23.04 administrativearea

    23.05 contactnumber

    23.06 contactnumbers

    23.07 country

    23.08 emailaddress

    23.09 emailaddresses

    23.10 firstname

    23.11 generationidentifier

    23.12 honorific

    23.13 lastname

    23.14 locality

    23.15 localityname

    23.16 middlename

    23.17 namedetails

    23.18 organizationinfo

    23.19 organizationname

    23.20 organizationnamedetails

    23.21 otherinfo

    23.22 personinfo

    23.23 personname

    23.24 postalcode

    23.25 thoroughfare

    23.26 url

    23.27 urls

24.0 DITAVAL elements

    24.01 val

    24.02 style-conflict

    24.03 prop

    24.04 revprop

    24.05 startflag

    24.06 endflag

    24.07 alt-text

25.0 Commonly referenced attributes

    25.01 %display-atts;

    25.02 %global-atts;

    25.03 %id-atts;

    25.04 %rel-atts;

    25.05 %select-atts;

    25.06 %localization-atts;

    25.07 %univ-atts;

    25.08 %topicref-atts; and %topicref-atts-no-toc;

    25.09 Other common DITA attributes

    25.10 Complex attribute definitions

        25.10.01 The conref attribute

            25.10.01.01 Using the -dita-use-conref-target value

        25.10.02 The type attribute

        25.10.03 The format attribute

        25.10.04 The role attribute

26.0 Alphabetical listing of DITA elements