3.2.5.1.10 booklist

The <booklist> element is a general purpose element, designed for use in specializations, that references a topic or map containing a list of items within the book. For example, it could be used to reference a topic that contains a list of authors for the book. When a more specific element is already available, such as <tablelist> for a list of tables, that element should be used instead.

Contains

Doctype

Content model

bookmap, learningBookmap

no content

Contained by

Doctype

Content model

bookmap, learningBookmap

booklists

Inheritance

- map/topicref bookmap/booklist

Example

In this case the <booklist> element references a topic that contains a list of authors of topics in this document.

<booklists>
  <toc/>
  <tablelist/>
  <booklist href="authors.dita" navtitle="List of authors"/>
</booklists>
Attributes

Name

Description

Data Type

Default Value

Required?

navtitle

Specifies the title of the topic as it will appear in the navigation or tables of contents that are generated from the map. Beginning with DITA 1.2, the preferred way to specify the navigation title in a map is with the navtitle element, available inside the topicmeta element.

CDATA

#IMPLIED

No

href

Points to a manual listing for the current element. See 3.4.2.1 The href attribute for detailed information on supported values and processing implications. 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.

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 attribute group (collection-type, processing-role, type, scope, locktitle, format, linking, toc, print, search, chunk)

A set of related attributes. See 3.4.1.8 topicref-atts, topicref-atts-no-toc, and topicref-atts-without-format attribute groups.

     

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-atts attribute group

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class, outputclass, keyref

Class and outputclass are described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.2.5.1.9 booklibrary

Next Topic:  3.2.5.1.11 booklists

Parent Topic:  3.2.5.1 Bookmap content elements

Sibling Topics:

3.2.5.1.1 bookmap

3.2.5.1.2 abbrevlist

3.2.5.1.3 amendments

3.2.5.1.4 appendices

3.2.5.1.5 appendix

3.2.5.1.6 backmatter

3.2.5.1.7 bibliolist

3.2.5.1.8 bookabstract

3.2.5.1.9 booklibrary

3.2.5.1.11 booklists

3.2.5.1.12 booktitle

3.2.5.1.13 booktitlealt

3.2.5.1.14 chapter

3.2.5.1.15 colophon

3.2.5.1.16 dedication

3.2.5.1.17 draftintro

3.2.5.1.18 figurelist

3.2.5.1.19 frontmatter

3.2.5.1.20 glossarylist

3.2.5.1.21 indexlist

3.2.5.1.22 mainbooktitle

3.2.5.1.23 notices

3.2.5.1.24 part

3.2.5.1.25 preface

3.2.5.1.26 tablelist

3.2.5.1.27 toc

3.2.5.1.28 trademarklist