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.
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:
- <bookmeta>The <bookmeta> element contains information about the book that is not considered book content, such as copyright information, author information, and any classifications.
- <approved>The <approved> element contains information about when and by whom the book was approved during its publication history.
- <bookchangehistory>The <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.
- <bookevent>The <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>, use that element instead.
- <bookeventtype>The <bookeventtype> element indicates the specific nature of a <bookevent>, such as updated, indexed, or deprecated. The required @name attribute indicates the event's type.
- <bookid>The <bookid> element contains the publisher's identification information for the book, such as part number, edition number and ISBN number.
- <booknumber>The <booknumber> element contains the book's form number, such as SC21-1920.
- <bookowner>The <bookowner> element specifies the owner of the book's copyright.
- <bookpartno>The <bookpartno> element contains the book's part number, such as 99F1234. A publisher might use a number like this one to identify a book for tracking purposes.
- <bookrestriction>The <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.
- <bookrights>The <bookrights> element contains the information about the legal rights associated with the book, including copyright dates and owners.
- <completed>The <completed> element indicates a completion date for some type of book event, such as a review, editing, or testing.
- <copyrfirst>The <copyrfirst> element contains the copyright year, or the first copyright year within a multiyear copyright statement.
- <copyrlast>The <copyrlast> element contains the last copyright year within a multiyear copyright statement.
- <day>The <day> element denotes a day of the month.
- <edited>The <edited> element contains information about when and by whom the book was edited during its publication history.
- <edition>The <edition> element contains the edition number information, such as First Edition, or Third Edition, used by a publisher to identify a book.
- <isbn>The <isbn> element contains the book's International Standard Book Number (ISBN).
- <maintainer>The <maintainer> element contains information about who maintains the document; the maintainer might be an organization or a person.
- <month>The <month> element denotes a month of the year.
- <organization>The <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.
- <person>The <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.
- <printlocation>The <printlocation> element indicates the location where the book was printed. Customarily, the content is restricted to the name of the country.
- <published>The <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.
- <publisherinformation>The <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.
- <publishtype>The <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.
- <reviewed>The <reviewed> element contains information about when and by whom the book was reviewed during its publication history.
- <revisionid>The <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".
- <started>The <started> element indicates a start date for some type of book event, such as a review, editing, or testing.
- <summary>The <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.
- <tested>The <tested> element contains information about when and by whom the book was tested during its publication history.
- <volume>The <volume> element contains the book's volume number, such as "2" to represent Volume 2.
- <year>The <year> element denotes a year.
Parent topic: Bookmap elements