BooklistThe <booklist> element is a general purpose element, designed
for use in specializations, that references a list of particular types of
topics within the book. It indicates to the processing software that the author
wants that list of topics generated at the particular location. For example,
it could be used in a specialization to reference the location of a list of
program listings or of authors of topics.
[edit] Contains
| Doctype
| Content model
|
| bookmap
| no content
|
[edit] Contained by
[edit] Inheritance:
- map/topicref bookmap/booklist
[edit] 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
| Points to a manual listing for the current element. If no href is
specified, processors may choose to generate an appropriate listing for this
element. All of the book listings operate in a similar manner; for example, <toc href="toc.dita"/> points to
a topic which contains a manual table of contents, while <toc/> indicates
that a processor should generate the table of contents. References to content
other than DITA topics should use the format attribute to identify the kind
of resource being referenced.
| 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
|
|
|
|
TOC: Language Specification 1.1
Parent topic: Bookmap content elements
Previous topic: booklibrary
Next topic: booklists
|
|
