preface

The <preface> element references introductory information about a book, such as the purpose and structure of the document.

Contains

Doctype Content model
bookmap ( ( topicmeta) (optional) then ( topicref or topichead or topicgroup) (any number) )

Contained by

Doctype Parents
bookmap frontmatter

Inheritance:

- map/topicref bookmap/preface

Attributes

Name Description Data Type Default Value Required?
navtitle Specifies the title of the topic as it will appear in navigation or tables of contents generated from the map. CDATA #IMPLIED No
href A hyperlink to an external Web page (URL) or other non-DITA resource, or to another DITA topic in the same file or in another file. The format attribute identifies the format of the target. Non-DITA targets use standard URL syntax. DITA topics are targetted as follows:
Target elsewhere in the same file:
  href="#topicid"
First topic in different file:
  href="filename.dita"
Specific topic in different file:
  href="filename.dita#topicid"

If the URL contains an ampersand character, the ampersand symbol (&amp;) should be used to indicate that character

 CDATA #IMPLIED No
copy-to Use the copy-to attribute on the <topicref> element to provide a different file name for a particular instance of the topic in the map (for example, to separate out the different versions of the topic, rather than combining them on output). The links and navigation associated with that instance will point to a copy of the topic with the file name you specified.

Use the <linktext> and <shortdesc> in the <topicref>'s <topicmeta> to provide a unique name and short description for the new copy.

 CDATA #IMPLIED No
%topicref-atts; (collection-type, type, scope, locktitle, format, linking, toc, print, search, chunk) A set of related attributes. See %topicref-atts; and %topicref-atts-no-toc;. parameter entity PE not applicable Not applicable
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass, keyref Common attributes described in Other common DITA attributes      
Parent topic: Bookmap content elements
Previous topic: part
Next topic: tablelist

Return to main page.

OASIS DITA Version 1.1 Language Specification -- OASIS Standard, 1 August 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.