Bookmap metadata elements
The Bookmap specialization of ditamap supports standard
book production for collections of DITA topics. This section contains
the metadata elements used by bookmap to store book-related metadata.
Note
The OASIS document type for the bookmap specialization includes
the xNAL domain specialization for describing the author or authors
of a document. All elements that appear in that domain (the authorinformation
element and all of its descendants) are described in the xNAL domain
section, rather than in this bookmap metadata section.
In this section:
- bookmetaThe <bookmeta> element contains information about the book that is not considered book content, such as copyright information, author information, and any classifications.
- approvedThe <approved> element contains information about when and by whom the book was approved during its publication history.
- bookchangehistoryThe <bookchangehistory> element contains information about the history of the book's creation and publishing lifecycle, including who wrote, reviewed, edited, and tested the book. It also specifies when these events took place.
- bookeventThe <bookevent> element indicates a general event in the publication history of a book. This is an appropriate element for specialization if the current set of specific book event types does not meet your needs. If an element already exists to describe a specific type of event, such as <reviewed>, <edited>, or <approved>, that element should be used instead.
- bookeventtypeThe <bookeventtype> element indicates the specific nature of a <bookevent>, such as updated, indexed, or deprecated. The required name attribute indicates the event's type.
- bookidThe <bookid> element contains the publisher's identification information for the book, such as part number, edition number and ISBN number.
- booknumberThe <booknumber> element contains the book's form number, such as SC21-1920.
- bookownerThe <bookowner> element contains the owner of the copyright.
- bookpartnoThe <bookpartno> element contains the book's part number, such as 99F1234. A publisher may use a number like this one to identify a book for tracking purposes.
- bookrestrictionThe <bookrestriction> element indicates whether the book is classified or restricted in some way. The value attribute indicates any restrictions on the use of the material, such as declaring the information confidential or for licensed use only.
- bookrightsThe <bookrights> element contains the information about the legal rights associated with the book, including copyright dates and owners.
- completedThe <completed> element indicates a completion date for some type of book event, such as a review, editing, or testing.
- copyrfirstThe <copyfirst> element contains the first copyright year within a multiyear copyright statement.
- copyrlastThe <copylast> element contains the last copyright year within a multiyear copyright statement.
- dayThe <day> element denotes a day of the month.
- editedThe <edited> element contains information about when and by whom the book was edited during its publication history.
- editionThe <edition> element contains the edition number information, such as First Edition, or Third Edition, used by a publisher to identify a book.
- isbnThe <isbn> element contains the book's International Standard Book Number (ISBN).
- maintainerThe <maintainer> element contains information about who maintains the document; the maintainer may be an organization or a person.
- monthThe <month> element denotes a month of the year.
- organizationThe <organization> element contains the name of an organization. Note that unlike <organizationname>, the <organization> element is not restricted to use within <authorinformation>; it does not have to contain the name of an authoring organization.
- personThe <person> element contains information about the name of a person. Note that unlike the <personname> element, the <person> element is not restricted to describing the names of authors.
- printlocationThe <printlocation> element indicates the location where the book was printed. Customarily, the content is restricted to the name of the country.
- publishedThe <published> element contains information about the person or organization publishing the book, the dates when it was started and completed, and any special restrictions associated with it.
- publisherinformationThe <publisherinformation> contains information about what group or person published the book, where it was published, and certain details about its publication history. Other publication history information is found in the <bookchangehistory> element.
- publishtypeThe <publishtype> element indicates whether the book is generally available from the publisher or is restricted in some way. The value attribute indicates the restrictions, such as beta release, limited availability, or general availability.
- reviewedThe <reviewed> element contains information about when and by whom the book was reviewed during its publication history.
- revisionidThe <revisionid> element indicates the revision number or revision ID of the book. The processing implementation determines how the level is displayed. Common methods include using a dash, for example "-01", or a period, such as ".01".
- startedThe <started> element indicates a start date for some type of book event, such as a review, editing, or testing.
- summaryThe <summary> element contains a text summary associated with a book event (such as <approved> or <reviewed>) or with the list of copyrights for the book.
- testedThe <tested> element contains information about when and by whom the book was tested during its publication history.
- volumeThe <volume> element contains the book's volume number, such as Volume 2.
- yearThe <year> element denotes a year.
Previous topic: Bookmap content elements
Parent topic: Bookmap elements