Element Reference for bkbook.dtd

Contents
bkbook bkprolog bknotices bkfrontm bkbody bkappendixes bkbackm bktitle bksubtitle bkauthor bkabstract bkcontrolinfo bkpubdate bkprintloc bkcopyr bkspecialnotices bkednotices includetypes bkpart bkchapter bkappendix bkglossary bksection bksubsection bksubsect1 bksubsect2 bksubsect3 bksubsect4 bkpre bkpost topicref

bkbook: book containing element

Purpose

The bkbook element is the top-level element of a DITA book application, or "delivery context." The structures within it represent the setup and organization for a conventional book (at least regarding the general type used by the members of the community that provided requirements for this DTD).

Contained by

None--this is the root element of the bkbook vocabulary.

Contains

bkprolog then bknotices (optional) then bkfrontm (optional) then bkbody then bkappendixes (optional) then bkbackm (optional)


Attributes

NameDescriptionData typeDefault valueRequired?
spec Provides a formal lookup table to enable this element for DITA specialization processing CDATA ' bkbook.bkbook ' no

Examples

The minimal context for a titled cover for a single chapter is:
<bkbook>
  <bkprolog>
    <bktitle>How to unfriz a gromlof</bktitle>
  </bkprolog>
  <bkbody>
    <bkchapter>
      <topicref href="task32.xml"/>
    </bkchapter>
  </bkbody>
</bkbook>

bkprolog: book prolog

Purpose

The bkprolog element sets up the printing context for a DITA book application. This includes the elements used to create the covers and title pages, and the metadata used to produce, track, describe, and register the book for delivery.

Contained by

bkbook

Contains

bktitle then bksubtitle (optional) then bkauthor (0 or more) then bkabstract (optional) then bkcontrolinfo (optional) then prodinfo (optional) then bkpubdate (optional) then bkprintloc then bkcopyr (optional) then ( bibdesc or ldesc ) (0 or more)


Attributes

No author-defined attributes.

Examples

asdf

bknotices: book notices group

Purpose

The bknotices element organizes the two main components of information used on a formal Notices page: the conventional edition notice (bkednotices) and an annotative link to extended, special notices (bkspecialnotices).

Contained by

bkbook

Contains

bkspecialnotices then bkednotices


Attributes

No author-defined attributes.

Examples

asdf

bkfrontm: book front matter

Purpose

The bkfrontm (front matter) element provides a location for prefatory topics that introduce the main chapters or parts of a book. By implication, a table of contents and lists of exhibits are considered front matter, however they are usually automatically generated and therefore their inclusion can also be style-controlled rather than indicated explicitly by an author.
We may need to introduce a different element than bkchapter for the structuring content of the front matter.

Contained by

bkbook

Contains

Any number of bkchapter elements:


Attributes

No author-defined attributes.

Examples

  <bkfrontm>
    <bkchapter>
      <topicref href="task32.xml"/>
    </bkchapter>
  </bkfrontm>

bkbody: book body

Purpose

The bkbody element provides the organizational container for the main body of a book, holding the equivalent of either bkpart or bkchapter content.

Contained by

bkbook

Contains

bkpart or bkchapter


Attributes

No author-defined attributes.

Examples

  <bkbody>
    <bkchapter>
      <topicref href="task32.xml"/>
    </bkchapter>
  </bkbody>

bkappendixes: book appendixes

Purpose

The bkappendixes element...

Contained by

bkbook

Contains

bkappendix


Attributes

No author-defined attributes.

Examples

  <bkappendixes>
    <bkappendix>
      <topicref href="apndx01.xml"/>
    </bkappendix>
  </bkappendixes>

bkbackm: book back matter

Purpose

The bkbackm (back matter) element provides a location for non-mainstream content of a book. By implication, an index is considered back matter, however an index is usually automatically generated and therefore its inclusion can also be style-controlled rather than indicated explicitly by an author. Therefore the only element presently defined as content for the back matter is bkglossary.

Contained by

bkbook

Contains

bkglossary


Attributes

No author-defined attributes.

Examples

  <bkbackm>
    <bkglossary>
      <topicref href="task32.xml"/>
    </bkglossary>
  </bkbackm>

bktitle: book title

Purpose

The bktitle element holds the main title for the book.

Contained by

bkprolog

Contains

text data or basic.ph.nolink

Attributes

No author-defined attributes.

Examples

<bktitle>The Making of "Plan 9 from Outer Space"

bksubtitle: book subtitle

Purpose

The bksubtitle element holds the subtitle for the book.

Contained by

bkprolog

Contains

text data or basic.ph.nolink

Attributes

No author-defined attributes.

Examples

<bksubtitle>or, Making something out of almost nothing</bksubtitle>

bkauthor: book authors

Purpose

The bkauthor element is used to indicate the authors of a book.
Perhaps we should consider also introducing the bio element which is in the metadata portion of topic dtd, as a peer in this dtd with bibdesc, ldesc, and other definitional elements. This would provide additional associative data about the author, useful for cover liner notes, etc..

Contained by

bkprolog

Contains

text data or author

Attributes

No author-defined attributes.

Examples

<bkauthor>John Doe</bkauthor>

bkabstract: book abstract

Purpose

The bkabstract element permits a brief description of the book, useful for indexing services such as IBM's book serving repositories.

Contained by

bkprolog

Contains

text data or full.phandblock or txt.incl

Attributes

No author-defined attributes.

Examples

<bkabstract>
<p><q>It leaps, it creeps, it glides and slides across the floor.</q></p>
<p>These words introduce the world's most chilling lyrics, the subject of
this novel you won't want to put down until you have read every last word!</p>
</bkabstract>

bkcontrolinfo: book control information

Purpose

The bkcontrolinfo element provides document tracking information for the book.
The copyright portion may be considered as either document tracking info or as a top level property in itself (possible a direct child of <prolog>).

Contained by

bkprolog

Contains

critdates (0 or more) then permissions (optional) then status (0 or more) then copyright (0 or more)


Attributes

No author-defined attributes.

Examples

No example presently.

bkpubdate: book publication date

Purpose

The bkpubdate element represents the expected publication date of a book; it is reused in constructing the title of an edition notice, and in other cover locations.
It might also contain the date element from topic dtd as a form of typed data. For now, a purely string value happens to match usual practice.

Contained by

bkprolog

Contains

text data

Attributes

No author-defined attributes.

Examples

<bkbpubdate>March 2000</bkpubdate>

bkprintloc: book print location

Purpose

The bkprintloc element defines the printing location for a particular hardcopy production of a book. This value must be printed on the back cover of books that conform to the guidelines of many companies.
The value in it should be a grammatically proper continuation of the lead-in prompt, "Printed in"... (closing punctuation will be style-controlled depending on localization rules).

Contained by

bkprolog

Contains

text data

Attributes

No author-defined attributes.

Examples

<bkprintloc>the United Stated of America</printloc>

bkcopyr: book copyright notices

Purpose

The bkcopyr element allows logging of the copyright year or years for the content.
This information is mapped into the copyright portion of the edition notices page.

Contained by

bkprolog

Contains

text data

Attributes

No author-defined attributes.

Examples

<bkcopyr>2001</bkcopyr>

bkspecialnotices: book special notices

Purpose

The bkspecialnotices element allows the introduction to more extensive special notices that will be located elsewhere in the book (typically in the back matter), such as safety notices, RF emission notices, fair use advisories, etc..

Contained by

bknotices

Contains

text data or full.phandblock or title or txt.incl

Attributes

No author-defined attributes.

Examples

<bkspecialnotices>
  <title>Please note!</title>
    <p>Information that could save your life probably can't
    be found in this book.</p>
</bkspecialnotices>

bkednotices: book edition notice

Purpose

The bkednotices element provides a formal location for edition notice information, including publication dates, contact information, disclaimers, and additional copyright notices.

Contained by

bknotices

Contains

text data or full.phandblock or title or txt.incl

Attributes

No author-defined attributes.

Examples

Not defined yet...

%includetypes;: allowed topic inclusions

Purpose

Parameter Entity defining element content.
The includetypes parameter entity defines the content model for the elements that directly contain topics.
For authoring a "book shell," only the topicref element should be defined in this parameter entity. For validating an intermediate file comprise of the replacement content of the topicref elements, this value should include the topic types that are expected in the result document. Also, any DTDs representing those topics types should also be included into the bkbook dtd in the same manner as the compulsory topic dtd (which defines some of the prolog elements used within bkbook).

Contained by

any element that can contain topicref.

Contains

Declarations for content model: ( topicref or topic ) (0 or more)

Attributes

NA

Examples

NA

bkpart: book part

Purpose

The bkpart element...

Contained by

bkbody

Contains

title (optional) then bkpre (optional) then topicref (optional) then bkpost (optional) then bkchapter (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bkchapter: book chapter

Purpose

The bkchapter element provides a formal nesting structure for topics within the body of a book.

Contained by

bkfrontm , bkbody , bkpart

Contains

title (optional) then bkpre (optional) then includetypes then bkpost (optional) then bksection (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bkappendix: book appendix

Purpose

The bkappendix element provides a formal nesting structure for topics within the body of a book.

Contained by

bkappendixes

Contains

title (optional) then bkpre (optional) then includetypes then bkpost (optional) then bksection (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bkglossary: book glossary

Purpose

The bkglossary element provides a formal nesting structure for topics within the body of a book.

Contained by

bkbackm

Contains

title (optional) then bkpre (optional) then includetypes then bkpost (optional) then bksection (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bksection: section of a chapter

Purpose

The bksection element provides a formal nesting structure for topics within the body of a book.

Contained by

bkchapter , bkappendix , bkglossary

Contains

title (optional) then bkpre (optional) then includetypes then bkpost (optional) then bksubsection (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bksubsection: subsection of a chapter

Purpose

The bksubsection element provides a formal nesting structure for topics within the body of a book.

Contained by

bksection

Contains

title (optional) then bkpre (optional) then topicref (optional) then bkpost (optional) then bksubsect1 (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bksubsect1: 1st-level subsection

Purpose

The bksubsect1 element provides a formal nesting structure for topics within the body of a book.

Contained by

bksubsection

Contains

title (optional) then bkpre (optional) then topicref (optional) then bkpost (optional) then bksubsect2 (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bksubsect2: 2nd-level subsection

Purpose

The bksubsect2 element provides a formal nesting structure for topics within the body of a book.

Contained by

bksubsect1

Contains

title (optional) then bkpre (optional) then topicref (optional) then bkpost (optional) then bksubsect3 (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bksubsect3: 3rd-level subsection

Purpose

The bksubsect3 element provides a formal nesting structure for topics within the body of a book.

Contained by

bksubsect2

Contains

title (optional) then bkpre (optional) then topicref (optional) then bkpost (optional) then bksubsect4 (0 or more)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bksubsect4: 4th-level subsection

Purpose

The bksubsect4 element is the deepest of the allowed nesting within the book delivery context. This limit enforces a general guideline for authors and prevents arbitrarily deep nesting.

Contained by

bksubsect3

Contains

title (optional) then bkpre (optional) then topicref (optional) then bkpost (optional)

Attributes

NameDescriptionData typeDefault valueRequired?
id Description for element id ID #IMPLIED no

Examples

asdf

bkpre: pre-topic discourse

Purpose

The bkpre element provides a location for initial discourse leading up to the first instance of a topic reference.

Contained by

bkpart , bkchapter , bkappendix , bkglossary , bksection , bksubsection , bksubsect1 , bksubsect2 , bksubsect3 , bksubsect4

Contains

text data or full.phandblock or txt.incl

Attributes

No author-defined attributes.

Examples

asdf

bkpost: post-topic discourse

Purpose

The bkpost element provides a location for closing discourse following a topic reference.

Contained by

bkpart , bkchapter , bkappendix , bkglossary , bksection , bksubsection , bksubsect1 , bksubsect2 , bksubsect3 , bksubsect4

Contains

text data or full.phandblock or txt.incl

Attributes

No author-defined attributes.

Examples

asdf

topicref: topic reference

Purpose

The topicref element provides a way to name a topic that is intended to be referenced as content in place of this element. The effect is equivalent to an "external entity reference."
Topicref must always refer to a valid DITA topic or specialization thereof.

Contained by

bkpart , bksubsection , bksubsect1 , bksubsect2 , bksubsect3 , bksubsect4

Contains

no content

Attributes

NameDescriptionData typeDefault valueRequired?
href Description for element href CDATA #REQUIRED yes
parse Description for element parse (xml | parse | cdata) xml yes
%univ-atts; A set of related attributes, described at %univ-atts; parameter entity See the extended discussion in the Topic DTD Reference. NA

Examples

Given the need to imbed the local topic file, task32.xml:
<topicref href="task32.xml"/>
This example refers to a file nested within a parent topic. The reference is to the nested file's id, which in this case might be the id of the same topic as referenced literally in the previous example.
<topicref href="mastertasks.xml#task32"/>