Bloomsbury DocBook XML Data Specification v2.3.4
Bloomsbury DocBook XML Data Specification v2.3.4
Titles with associated Studio Resource(s) must be flagged as such in the XML, see Section 7.5.7, “Studio
content”.
Looseleaf content must be identified as such in the volume metadata, see Section 32.16.1.1, “Looseleaf content”.
Schematron version is now incremented to 8 and this value MUST be used from now on.
Biographical information for contributors is now also required at the chunk level, where available.
Schematron version is now incremented to 7 and this value MUST be used from now on. The previous
instructions regarding alt text are now DEPRECATED with this release. The instructions given in Chapter 34,
Accessibility MUST be used instead.
Embedded videos.
Support for LaTeX equations (see LaTeX equations) where specified via additional biblioid otherclass
value latexEquations (see Section 7.5.11, “Other biblioids”).
Important
As of this release, the documentation will follow the standard versioning scheme
(MAJOR.MINOR.PATCH), as described at https://semver.org/. This version number will
now appear as the filename suffix for the PDF version of this document.
• Schematron version is now incremented to 6 and this value MUST be used from now on.
Note also that the instructions on identifier persistence, previously supplied separately, are now incorporated
unchanged into this document.
Processing instruction to insert end-of-chapter notes disallowed within footnote, see Section 18.2.1, “End of
chapter notes”.
No MathML required in equations on Bloomsbury Collections, see Section 23.3, “More complex equations”.
No extraneous XML files to be present in the zip, see Chapter 3, Deliverables and file-naming conventions.
pagenums pattern, see Section 9.3.2, “Page range”; links in chunk titles, see Section 9.2, “Chunk and section
titles and numbering”
Note to clarify check-label-3 (re full points in @label). Updated series titles.
Cross-references in titles: Section 9.2, “Chunk and section titles and numbering”; format of nested section
labels.
Updated series titles: Bloomsbury Family Law, Critiquing Religion: Discourse, Culture, Power, Cornerstone
on..., Social Theory and Methodology in Education Research.
Updated series titles: 1 KBW on, Arden Studies in Early Modern Drama, Bloomsbury Studies in Critical
Poetics, Animation: Key Films/Filmmakers.
Dedications are allowed directly within book; additional sidebar role values
Added support for annotated legislation: Section 7.5.11, “Other biblioids”; Section 14.3, “@role attributes”;
Section 14.13, “Notes”; examples in: Section 32.16.8, “Annotated legislation” with an Implementation Note
Added support for legal Case Reports Section 7.5.11, “Other biblioids”; Section 14.3, “@role attributes”;
Section 14.13, “Notes” And examples in: Section 32.16.7, “Case Reports” with an Implementation Note +
Added support for @label on informalexample (DocBook extension) + Implementation Note: Chapter 28,
Examples
Amended instructions for bridgehead markup: Section 7.5.15, “Other prelim content”
Processing instructions must not contain markup or character references: Section 18.2.1, “End of chapter
notes” A book or chunk title must not end with a colon: Section 7.5.1, “Title group”; Section 9.2, “Chunk and
section titles and numbering” Bibliography style (initials with/without stops) can apply at the chunk level:
Section 17.1, “Initials in biblio names”
schematronVersion MUST = 5, and all IDs MUST now have predictable, consistent structure:Section 5.2, “ID
structure” Block images/tables/sidebars MUST NOT occur within a paragraph:Section 21.4, “Image placement”
A break PI must contain a type: Section 14.5, “Column and line breaks” Notes sections must not have a title in
the end-ch-notes PI: Section 18.2.1, “End of chapter notes” A footnote must not occur within a link: Chapter 18,
Footnotes, endnotes and other notes Rarely, DOIs may not be required: Section 7.5.11, “Other biblioids”
'Law as stated at date' required for legal texts: Section 32.16.3, “Law stated at date” Numbered lists in legal
texts MUST use variablelist:Section 32.16.6, “Numbered lists in legal books” Small caps must not contain only
upper case content: Section 14.2, “Font styles and font weight” New bibliographic item types: Section 16.13,
“Recordings”, Section 16.14, “Films” 'info' paragraphs: see end of Section 14.1.2, “Paragraphs, vertical white
space and other text separators” Additional clarification on taxon name markup: Section 32.17.3, “Biology-
specific markup” Additional conformancy tests for copyright and ISBNs: Section 7.5.9, “Copyright/CC details”,
Section 7.5.10, “ISBNs, DOI and CIP information”
Support for set, pack and other volumes ISBNs: Section 7.5.10, “ISBNs, DOI and CIP information”
Handling of end-of-paragraph notes (eg as used in legal texts): Section 18.2.3, “End of paragraph notes” New
biblioid (legalContentType) REQUIRED for legal books: Section 7.5.11, “Other biblioids”
Tests specifically for biological works comprising taxonomic content (eg Mammals of Africa): Section 14.11,
“Natural history and biology content”; Section 32.17, “Biology and natural history works with taxonomic
content” Tests specifically for Fashion Photography Archive articles
Improved processing instruction testing (Section 14.10.6, “Processing instructions”) Usually more than one
ISBN is required, and added more clarification about CIP markup (7.5.9 ISBNs, DOI) Clarification about end-
bk-note insert PIs (Section 18.2.2, “End of book notes”)
Start and end chunk pagenums must match equivalent values in the page PI (Section 9.3.2, “Page range”)
Various minor tests in bibliography content
The series name MUST exactly match the standard form (Section 7.5.4, “Series”) Abstracts must not contain
indexterms (Section 29.4, “Positioning of index terms”)
schematronVersion MUST = 4, and chunks and formalparas MUST now have predictable, consistent ID
(Section 5.2.3, “IDs for chunks”) Tests for formalpara//title content (Section 5.2.6, “IDs for formal paragraphs”)
Drama and poetry should usually occur in a blockquote (Section 24.3, “Poetry”) Possible attributions in
lines (Section 24.3.1, “Simple poem”) Paras should not usually start with lower case (see example at end
of Section 14.1.1, “Block elements within paragraphs etc”) Possible missing space (Section 16.16, “Inline
bibliographic references”) Legal monograph examples (Section 32.16, “Hart and Bloomsbury legal texts”)
Pubdate can take @condition Tests specific to Geographers Biobibliographical series (examples in Section 32.15,
“Geographers Biobibliographical Studies”) New biblioid/@otherclass value of ‘allBiblioItemsUnlinked’ Warns
if there is no series data for academic books
Chunk IDs MUST begin with the book/@xml:id and schematronVersion MUST equal 3 See: Section 5.2.3, “IDs
for chunks” and Section 7.5.11, “Other biblioids”
Legal texts. These require careful attention, and include the following features: Numbered paras: Section 14.1.3,
“Formal paragraphs” Special front matter content: Section 10.5, “Tables of cases and statutes” Other, more
complex, features of legal texts remain to be modelled and MUST be referred to Bloomsbury
Support for bibliographies with no initials in names: biblioType in Section 7.5.11, “Other biblioids” Anchors:
Section 14.12, “Anchors” Special sidebars in some reference content: Section 26.3, “Embedded articles” New
section: Section 9.5.1, “Article @roles”
How to handle bibliographies with no full stops after the initials: Section 16.1, “Bibliography type”;
Section 17.1, “Initials in biblio names”
Slightly more fine grained markup and other features for reference works and dictionaries: 9.5.6 Article
components (dictionary-type content) Description of document or chunk keywords: Section 7.5.14,
“Keywords” New @role values for sections and sidebars for special units of content in textbooks: Chapter 26,
Sidebars
New section to record document revisions: Section 7.5.12, “Revisions” Simple mechanism for indicating that
no digital rights are available for a specific piece of content: Section 14.8, “Rights” New support for sources in
figure captions: Section 21.3, “Image sources” New @role for bibl sections in A-Z articles: Section 9.5.3, “More
complex article and dummy entry” New @role for container for ancillary material: 12.3 Additional media files
(ancillary back-of-book CD content) Outline section on image display: Section 21.1, “Image display” Support
for linking between sections: Section 15.9, “Linking sections and bibliographies”
Other files that could be within the data package must be within a media directory: Chapter 3, Deliverables and
file-naming conventions. A special back matter container for additional content files: 12.3 Additional media files
(ancillary back-of-book CD content). Linking to such files: Section 15.7, “Links to content in the data package”
(and new implementation note). New section and element (olink): Section 15.8, “Links to other books” (and
new implementation note). Major new worked examples: Section 32.14, “Heavily-designed books”. New
section Section 14.10.5, “Print- or web-only content”, where @outputformat is used for format-specific content.
Updated the list of elements on which @outputformat is permitted: Section 14.7, “@outputformat”. Worked
examples: Section 32.1.1, “Title page and contributors”; Section 32.2.3, “Slightly complex chapter opener style”.
More robust tests for end-bk-note and end-ch-note footnotes and corresponding processing instructions; and
for book and chunk contributors
Includes refs to three schematron tests, the most important being end-bk-notes-target
Example for Section 32.2.5, “Chapter Outlines and Abstracts”, and note especially that Chapter Outlines are
NOT to be included in the data if only a ToC: Section 9.4.1, “Chapter Outlines” Asterisks, daggers etc probably
need to be links: Section 14.10.4, “Asterisks etc” Clarification on use of bibliolist[@role=inline]: Section 16.4,
“Bibliographic items” Untagged biblio content: Section 16.6, “Untagged bibliographic content” More examples
added to: Section 14.10.1, “Spaces and emphasis”; Section 21.2, “Image captions”; Section 32.6.2, “Firstname/
surname issues”; Section 32.6.3, “Sibling elements of bibliomset”
Extended the tests for page break placement: Section 14.4, “Page breaks”, and examples in Section 32.13,
“Page break placement” Additional examples: Section 32.2.4, “Non-sequential heading style”; Section 32.6.1,
“Inconsistent biblio style” Bibliography examples: Section 16.8.3.5, “Book reviews”, Section 16.15.3, “DVDs”
IMPORTANT: New @role on link now REQUIRED for all new books (but not necessarily for retrospective
conversion projects). This is to support better testing for internal link targets and for which setting
schematronVersion=”2” is REQUIRED. See sections Section 15.1, “Simple internal links” and Section 7.5.11,
“Other biblioids” Restructured section Chapter 17, Names, and added Section 17.3.1, “Confusion between
surnames and firstnames”, which includes a test for strings that look like firstnames encoded as surname; this
will give false positives, and will be refined, but does give a useful means of checking some more complex
bibliographic markup. Worked examples: Section 32.3, “Chapters with appendices etc”; Section 32.5.2, “Same
work in multiple bibliomixeds” Comments are to be avoided: Section 14.10.3, “Comments” Schematron
includes count and percentage of unlinked biblio items: Section 16.3.1, “Standard short form references” Page
break markers must be between sections not in section titles: Section 14.4, “Page breaks”
Handling of impression numbers in prelims: Section 10.2.1, “Impressions” Initial proposal for some video
support, though this is not yet ready for use: Chapter 22, Other media content Added refs to new tests.
Blockquote attributions must be within attribution not para[@role=right]: see section Section 24.1,
“Blockquotes”. Inline abbreviations may be marked up with abbrev: see at the end of section Section 10.8,
“Glossaries and abbreviations lists” Title page logo: Section 7.5.8, “Imprint logo” New bibliography example:
Section 16.10, “Email messages” More examples of short-form links: section Section 32.5.1, “Short-form
bibliographic references” An example of archival lists within a bibliography: Section 32.12.1, “Archive list”
New major section: 9.5 A-Z (reference) content Minor notes for new schematron tests
Permitted @mark=none for itemizedlists, see section 19.2 Unordered (bulleted) lists New worked examples:
Section 32.1, “Front matter”; Section 32.2.2, “More unusual structure and labels”; Section 32.7, “Lists”;
Section 32.9, “Appendices”; Section 32.10.1, “Different fonts in fiction” Minor notes documenting new
schematron tests, especially for bibliographic items and names
New major section: Chapter 32, Worked examples A new DocBook extension: Section 2.1.1, “Extensions to
DocBook Publishers schema” Further clarifications and examples with refs to additional tests: Chapter 4,
Encoding; Section 4.1, “Right-to-left writing systems”; Section 7.4, “Digital-only books”; Section 7.5.2,
“Author group”; Section 7.5.6, “Publisher details”; Section 7.5.11, “Other biblioids”; Section 9.2, “Chunk and
section titles and numbering”; Section 9.2.1, “Chunks with no titles”; Section 9.3.7, “Running headers and
footers”; Section 11.4, “General use of @label”; Section 14.1.2, “Paragraphs, vertical white space and other
text separators”; Section 14.7, “@outputformat”; Section 14.10, “General text issues”; Section 16.5, “Dates
in bibliographies”; Chapter 17, Names; Section 21.6, “Plate sections”; more bibliography examples: Play
performances,radio broadcasts etc, Section 16.9.2, “Personal communications”, Section 16.9.4, “Conference
papers, other meetings and reports” (including document reference numbers),
Expanded Chapter 29, Indexes and index terms, and numerous Schematron cross references. Added new @role
on end book and end chapter Notes sections (Section 18.2, “Note placement”)
Simplified options for internal linking, so now only use link, not biblioref and xref, see Chapter 15, Cross
references and linking and Section 16.3, “Inline citations”. Added Section 15.6, “DOI links”; Section 5.2.5, “IDs for
bibliographic items”; Section 16.19, “Non-permitted content of bibliographic items”; Chapter 31, Schematron.
Changed title of prelims chunk (Section 10.3, “Prelims chunk”). Modified requirements for Section 7.5.2,
“Author group”. Minor revisions to: Section 7.5.6, “Publisher details” (more examples); Section 10.4, “Table
of contents” (needs further expansion); Section 14.4, “Page breaks” (more detail on placement); Section 16.4,
“Bibliographic items” (many examples have more detail and links to tests); Chapter 21, Figures and images
(@outputformat); Chapter 29, Indexes and index terms (needs further expansion). Added many more cross refs to
the Schematron tests, and expanded test coverage.
Added journal issue example in Section 16.8, “Journals” and conference example in Section 16.9,
“Unpublished”; new section Section 14.9, “Addresses”; added xrefs in Section 14.3, “@role attributes”; + other
bibliography examples: Section 16.7.7, “Anonymous items and “et al””, Section 16.7.11, “Ibid, loc cit, and op.
cit.”, Section 16.8.3.3, “Newspaper item”, Section 16.11.2, “Minimal web site reference”;
Revision 0.10 3 September 2013 Brad Scott
New section Section 7.5.11, “Other biblioids”. Added clarification to [deleted sections]. Added bibliosource to
Chapter 30, Elements we might not need we might not need.
Added clarification on Bloomsbury Open legalnotice markup (Section 7.5.9, “Copyright/CC details”); case
regularisation (Section 8.1, “Case regularisation”)
Beta release to supplier. Added note on @condition, updated ID requirements, added more detail on chunking,
minor bibliography-related revisions
Released for supplier review. Taken in feedback from Propagator/editorial. Added material on blockquotes,
drama, poetry, and moved epigraphs to same section. Updated ID requirements, and book/info, edition, series.
Small-scale restructuring, amending.
Released for Propagator and internal review. Added/extended sections on: inline bibliographies; footnotes/end
notes; equations; deliverables
First release
Created
Table of Contents
Release notes: Schematron schema version 8 ............................................................................ xviii
1. Background ............................................................................................................................. 1
1.1. Principles ...................................................................................................................... 2
2. Schema .................................................................................................................................... 3
2.1. Local modifications ....................................................................................................... 3
2.1.1. Extensions to DocBook Publishers schema ........................................................... 3
2.1.2. Constraints on the DocBook Publishers schema .................................................... 3
3. Deliverables and file-naming conventions ................................................................................. 4
3.1. Platform-specific considerations ..................................................................................... 4
4. Encoding ................................................................................................................................. 6
4.1. Right-to-left writing systems .......................................................................................... 6
5. Identifiers ................................................................................................................................ 7
5.1. Where IDs are required ................................................................................................. 7
5.2. ID structure .................................................................................................................. 7
5.2.1. Previous instructions .......................................................................................... 8
5.2.2. IDs for the book and set ..................................................................................... 8
5.2.3. IDs for chunks .................................................................................................... 8
5.2.4. IDs for glossary terms ......................................................................................... 9
5.2.5. IDs for bibliographic items ................................................................................ 10
5.2.6. IDs for formal paragraphs ................................................................................. 10
5.2.7. IDs for annotated legislation .............................................................................. 11
5.3. Identifier Persistence .................................................................................................... 11
5.3.1. Chunks ............................................................................................................. 12
5.3.2. Tables and figures ............................................................................................. 12
5.3.3. ID report on re-supply ...................................................................................... 12
6. Root elements ........................................................................................................................ 18
7. Book and set metadata ........................................................................................................... 19
7.1. The relationship between the prelims and book metadata .............................................. 19
7.2. Language metadata ..................................................................................................... 19
7.3. Content type ............................................................................................................... 19
7.4. Digital-only books ....................................................................................................... 20
7.5. Metadata ..................................................................................................................... 20
7.5.1. Title group ....................................................................................................... 21
7.5.2. Author group ................................................................................................... 22
7.5.3. Edition ............................................................................................................. 25
7.5.4. Series ................................................................................................................ 25
7.5.5. Publication date ................................................................................................ 26
7.5.6. Publisher details ............................................................................................... 26
7.5.7. Studio content ................................................................................................... 29
7.5.8. Imprint logo ..................................................................................................... 29
7.5.9. Copyright/CC details ........................................................................................ 29
7.5.10. ISBNs, DOI and CIP information ...................................................................... 31
7.5.11. Other biblioids ................................................................................................ 33
7.5.12. Revisions ........................................................................................................ 36
7.5.13. Blurb/abstract .................................................................................................. 37
7.5.14. Keywords ....................................................................................................... 37
7.5.15. Other prelim content ....................................................................................... 37
8. Editorial standardisation ........................................................................................................ 40
8.1. Case regularisation ...................................................................................................... 40
9. Chunking and high-level structure ......................................................................................... 41
9.1. Chunking example ...................................................................................................... 41
9.2. Chunk and section titles and numbering ...................................................................... 44
9.2.1. Chunks with no titles ........................................................................................ 46
9.3. Chunk metadata .......................................................................................................... 46
9.3.1. Chunk author(s) ................................................................................................ 46
xi
Bloomsbury DocBook XML
xii
Bloomsbury DocBook XML
xiii
Bloomsbury DocBook XML
xiv
Bloomsbury DocBook XML
xv
Bloomsbury DocBook XML
xvi
List of Examples
5.1. ID change report ................................................................................................................. 14
5.2. Structural change ................................................................................................................. 15
5.3. Textual change ..................................................................................................................... 16
34.1. Table ................................................................................................................................ 258
34.2. Informal table .................................................................................................................. 258
34.3. Display images ................................................................................................................ 259
34.4. Inline images ................................................................................................................... 259
34.5. Equations ......................................................................................................................... 259
34.6. Informal equations ........................................................................................................... 259
34.7. Video ............................................................................................................................... 259
34.8. Audio .............................................................................................................................. 259
xvii
Release notes: Schematron schema
version 8
This version of the schema, which MUST be used for all new supplies, requires:
xviii
Chapter 1. Background
This document specifies the usage of the DocBook Publishers schema within Bloomsbury.
It substantially draws on and replaces the existing Bloomsbury DocBook documentation1, and
• indicates where previous usage is now DEPRECATED and what the new REQUIREMENT is
In the past, the DocBook Publishers schema was used at Bloomsbury for the Bloomsbury Academic
website content, which contained Open Access (Bloomsbury Open) content, using this model. The
model was subsequently also utilised for the non play text content in Bloomsbury’s Drama Online.
The model as now described by this document updates the previous usage, and is also to be used for
the new Bloomsbury Collections site.
The revised schema as described in this document is a true subset of the previous instance of the
DocBook Publishers schema in use at Bloomsbury2. However, data captured using the previous
version will not validate against the new version because the new version includes:
Furthermore, these new instructions include places where elements MUST be used, though may
not previously have been so in the past (for example, the addition of chunk metadata as described in
Section 9.3, “Chunk metadata”).
This document notes the corresponding paragraph number in the previous Bloomsbury DocBook
documentation, and particularly notes where this document departs from it. References to the
previous documentation is in the form “§1.2”. See also the Index to locate references to the previous
documentation.
Sections that were not covered at all in the previous documentation (even if they are completely
standard DocBook) are:
1
Background
• Section 14.1.2, “Paragraphs, vertical white space and other text separators”
This document also includes several “Implementation notes”; these are for the benefit of suppliers
who will consume data provided to this specification, and note where extensions and modifications
will be required to the standard DocBook XSL toolkit. They are listed in the Index.
1.1. Principles
The following guiding principles have been adopted in compiling these data instructions and
examples:
1. Adopt standard DocBook practice as is supported by the latest DocBook XSL tools as much as
possible, and document any deviations from such usage
2. Broadly speaking, all text, punctuation and formatting (italicisation, bold, small caps etc) within a
book MUST be captured within the XML so that the data as it appeared in print can be reproduced
exactly. However, the following items MUST NOT be captured in the data and will be generated
by the application UNLESS otherwise instructed for a specific book:
b. List labels
3. The previous item does not mean that we should slavishly attempt to replicate the book in the
exact data order as was manifested in the print edition, especially in respect of the metadata/
prelims content, since the print edition is just one manifestation of how the book data can be
presented. The requirement is that the printed edition can be generated from the data.
4. Adopt previous Bloomsbury usage if it does not conflict with the previous items. Where the new
instructions deviate from previous usage, this will be clearly indicated
5. If there is more than one way a specific feature could be marked up with standard DocBook, these
instructions will provide the REQUIRED form
2
Chapter 2. Schema
Ref: §1.2
All files MUST validate against the DocBook Publishers schema (rnc format), version 5.1CR (25 June
2013),1 with the local modifications as defined in the latest version of bloomsbury-mods.rnc.
In addition, a Schematron is provided, which extends the tests for the data. This builds on the
previously available suite, and this document also records where such tests have been provided.
Such Schematron tests are recorded in the footnotes and the index.
1
Available from http://www.docbook.org/xml/publishers/5.1CR1/. See also the documentation (not quite for the
same version): http://www.docbook.org/tdg5/publishers/5.1b3/en/html/docbook.html
3
Chapter 3. Deliverables and file-
naming conventions
Ref: §3.1, §1.21
Books MUST be supplied as a single XML file, named [ISBN13]_txt_xml.xml, where the ISBN
is the eISBN for the XML format and MUST match the //biblioid[@role=xml] (though without
spaces/hyphens) for the book.
Important
Other than XML files referenced by means of XInclude from this file, there MUST NOT
be any other XML files present anywhere in the zip.
Book data packages MUST be supplied in the following structure within a zip file
([ISBN13]_txt_xml.zip):
• [ISBN13]_txt_xml.xml
• images/
• pdfs/
• media/
All images files of whatever format called from within the XML file MUST be within the images/
directory, including the cover image (with filename [XML-ISBN13].jpg [specify size]); and all pdf
chunk files MUST be within the pdfs/ directory. Other media files (eg audio, video, Excel, Word,
any of which could potentially be bundled with a book, ie if it is otherwise bundled on a back-of-the
book CD) MUST be within the media/ directory.
PDF files of each chunk MUST usually follow the following numbering sequence:
[ISBN13]-nnn1.pdf
where the ISBN is the eISBN of the XML format (same as the book), followed by a zero-padded
number, which matches the chunk DOI (for those chunks that have DOIs; note that not all chunks
require a DOI, see Section 9.3.4, “Chunk DOI”, though all chunks REQUIRE a PDF). Chunks with
@labels MUST follow the numbering scheme as laid out in Section 9.1, “Chunking example”, eg:
[ISBN13].ch-nnn1.pdf
Where this is the case, the XML MUST contain the following metadata flag:
4
Deliverables and file-
naming conventions
This ensures that further checks are performed on the digital bundle. See also
Section 7.5.11, “Other biblioids”.
5
Chapter 4. Encoding
Ref: §1.22, §1.23, §1.24
Since the content is to be encoded using Unicode encoding, character or numeric entities MUST NOT
be used. All characters should be marked-up directly.
When ligatures are used in the text for AE, ae, OE, and oe these MUST be entered using the Unicode
characters: Æ, æ, Œ and œ. Ligatures introduced as part of typesetting, such as ff, fi, fl, ffi, and ffl,
MUST be encoded using the individual letters and not the Unicode characters for these ligatures.1
Occasionally, as a result of conversion (especially from data derived from Biblio), some escaped
entities, encoding and characters may be inadvertently introduced into the data. These MUST be
cleaned up and correct Unicode used.2
Tip:
When keying right-to-left text, it can be easier if you use character references though you MUST
put them in left-to-right sequence, which means that the rendering engine (HTML etc) will
reverse the entire sequence and hence display them correctly. For example, here is an example
which starts with an alef character (א -- )א, and when it is rendered it is at the right-
hand end of the string:
Implementation note: Ensure that @dir is supported in any downstream processing, and that
the default DocBook styling of foreignphrase is switched off
1
Tested in Schematron: ligature-ff and accompanying rules
2
Tested in Schematron: ampersand, less-than, greater-than, em-ghost [and related tests for strong, div, b, i,
br and common HTML entities]
3
Tested in Schematron: hebrew, arabic
4
Tested in Schematron: foreignphrase-lang, foreignphrase-he, foreignphrase-ar
5
Tested in Schematron: rtl-scripts, non-rtl-scripts
6
Chapter 5. Identifiers
5.1. Where IDs are required
Ref: §1.14
The following elements MUST have IDs (@xml:id) (though if any occur within a bibliomixed
they are NOT REQUIRED therein):1
5.2. ID structure
Ref: §1.15, §1.17, §1.18, §1.19, §1.20
Other than as described in the following sections, all identifiers simply need to be XML IDs (ie unique
within the document), which is enforced in the schema.
1
Tested in Schematron: missing_id_rule
7
Identifiers
[book/@xml:id]-uniqueValue
and schematronVersion must be set to '5' (see Section 7.5.11, “Other biblioids”).2
This section is included for reference only, for existing works with schematronVersion < 5.
FOR ALL NEW DATA THIS SECTION IN GREY IS NOW INVALID.
THIS INSTRUCTION HAS BEEN SUPERSEDED It is preferable that IDs are not over-long, so
that the text is more readable. Other than as detailed in below, it is suggested that IDs take the
following form:
b-0000001
THIS INSTRUCTION HAS BEEN SUPERSEDED Note that, for books that are to be converted
from an existing XML form with IDs, it is NOT REQUIRED to convert all the IDs to the form as
specified herein. The only REQUIREMENT is that the IDs are valid XML IDs.
Note that identifiers should not normally change once created. If corrections to a title are required,
any existing identifiers MUST be retained unchanged. Deletions are allowed as are insertions. If
elements are added or deleted it is NOT REQUIRED to maintain the increasing numeric sequence of
the IDs.
The ID for the book element must consist solely of the prefix and the XML ISBN:3
• chapter
• acknowledgements
• book/glossary
• book/part/glossary
2
Tested in Schematron: all-id-test
3
Tested in Schematron: book-id-start, book-id-end
8
Identifiers
• preface
• index
• book/bibliography
• part/bibliography
• appendix
• part[partintro]
• toc
• dedication
• article
[book/@xml:id]-uniqueValue
For chapter chunks with a numeric @label value, this MUST be:
b-9781501312076-chapter15
b-9781501312076-partII
b-9781501312076-appendixA
where the end part of the ID string comprises the element name followed by the @label value.4 If
chapter, part or appendix elements do not have a numeric @label, their ID MUST follow the
form for all other chunks:
b-9781501312076-0000067
However, for all chunk IDs the key requirement is that they start with the book XML ID and a
hyphen.5
This does not apply to some chunks within annotated legislation. See Section 5.2.7, “IDs for annotated
legislation”.
See also Section 7.5.11, “Other biblioids” for further details about schematronVersion.
<glossentry xml:id="b-9781234567897-Skt">
<glossterm>Skt.</glossterm>
<glossdef><para>Sanskrit</para></glossdef>
</glossentry>
4
Tested in Schematron: enforce-id-1 through enforce-id-6, for which schematronVersion = 4 is REQUIRED. See
Section 7.5.11, “Other biblioids”.
5
Tested in Schematron: chunk-id, chunk-id2
9
Identifiers
This section is included for reference only, for existing works with schematronVersion < 5.
FOR ALL NEW DATA THIS SECTION IN GREY IS NOW INVALID.
THIS INSTRUCTION HAS BEEN SUPERSEDED Where there is a glossary within the book
and the glossary markup is used (see Section 10.8, “Glossaries and abbreviations lists”), the
glossentry ID MUST be the same as the text content of the glossterm with spacing and
punctuation removed. This is to make it easier to predict the target ID in the data processing.
<glossentry xml:id="Skt">
<glossterm>Skt.</glossterm>
<glossdef><para>Sanskrit</para></glossdef>
</glossentry>
Or, a more complex example:
<glossentry xml:id="BṛUB">
<glossterm><emphasis role="italic">Bṛ. UB.</emphasis></glossterm>
<glossdef><para>Bṛhad-āraṇyaka Upaniṣadbhāṣya</para></glossdef>
</glossentry>
This section is included for reference only, for existing works with schematronVersion < 5.
FOR ALL NEW DATA THIS SECTION IN GREY IS NOW INVALID.
This instruction has been supersededSince many links will be REQUIRED to point to
bibliographic items, if it makes it easier to create accurate data, it MAY be useful to use some
sort of human-readable ID structure for bibliomixed items. The precise details of this can
be up to the data supplier, though IDs should ideally not be too long, and must obviously be
unique. For example:
b-9781501312076-fp1.1
where the final numeric part exactly matches the number in the title element:6
<formalpara xml:id="b-9781234567897-fp1.01">
6
Tested in Schematron: enforce-id-7 and enforce-id-8
10
Identifiers
<info xml:id="djdid">
<title xml:id="lk98">1.01</title>
</info>
<para xml:id="dj87"><emphasis role="bold">Subject matter of the book.</emphasis> The subject matter of this
book is the rules governing the voluntary inter vivos assignment of contractual rights. Such transactions
involve the transfer ....</para>
</formalpara>
Various divisions within a piece of legislation will be within a DocBook section and MUST have IDs
related to the parent chapter ID:9
PCTA1927s4A
Part part [chapterID]pt[section/@label]
TCA1997pt1
Chapter chapter [chapterID]pt[PartSection/
@label]ch[section/@label]
TCA1997pt1ch4
Schedule schedule [chapterID]sch[section/@label]?
PCTA1927sch
Bloomsbury requires that the identifier of certain key elements does not alter between deliveries of
the XML.
More specifically, the identifiers described below MUST NOT change after initial supply.
Initial supply is defined as the first point XML is delivered to Bloomsbury. This MAY vary from project
to project and MAY include, but is not limited to, work that is at the proofing stage.
7
Tested in Schematron: formalpara-title, formalpara-title2
8
Tested in Schematron: legislation-ids
9
Tested in Schematron: legal-section-ids1, legal-section-ids2, legal-section-ids3
11
Identifiers
Note
Bloomsbury MAY request proof at any time that these identifiers have not changed.
5.3.1. Chunks
The xml:id of all elements identified by the XPaths below MUST remain the same each time the
XML is supplied to Bloomsbury.
Note that this list may change over time, or per specific project. Bloomsbury will advise where this is
the case.
/book/part/bibliography
Chapter /book//chapter
Dedication /book//dedication
Glossary /book/glossary | /book/part/glossary
Index /book//index
Part introduction /book/part[partintro]
Preface /book//preface
Sub-article /book//section[@role=’subArticle’]
Table of contents /book//toc
Note
Only changes affecting chunks, tables and figures, as listed above, need be recorded.
12
Identifiers
For example, where a change takes place which influences the number or sequence of images, only
the IDs of the affected (informal~)figures should change: it is NOT acceptable for a significant
change to an element to affect all subsequent IDs.
This will reduce the amount of reporting work at the supplier and subsequent verification at
Bloomsbury.
13
Identifiers
<revhistory role="revisionReport">
14
Identifiers
</revhistory>
Important
The changes above MUST be recorded using /book/info/
revhistory/revision as shown, and <biblioid class='other'
otherclass='revisionReportRequired'> MUST be present.
Here, the structure is altered by renaming an element (an informalfigure). This element is one
for which changes MUST be recorded (see Section 5.3.2, “Tables and figures”), so this change also
appears in the revision report.
Note that the IDs shown in bold have not changed here; only the highlighted element name differs.
BEFORE:
AFTER:
REPORT:
<revhistory role="revisionReport">
15
Identifiers
<date>2019-05-14</date>
<author><orgname>[name of supplier]</orgname></author>
<revremark xlink:href="b-9781474218405-0000109" xlink:role="contentIdentifier"/>
</revision>
</revhistory>
Important
A textual change is defined as a significant editorial change to the text, either by addition
or deletion of text. Typographic corrections are NOT significant and MUST NOT be
reported.
BEFORE:
AFTER:
16
Identifiers
REPORT:
<revhistory role="revisionReport">
</revhistory>
17
Chapter 6. Root elements
Ref: §1.9
The root element MUST be book, unless it is a multi-volume work, in which case set MUST
normally be used. See Chapter 13, Multi-volume works for further information on handling multi-
volume works.
Validation: The schema does not enforce this; it also allows other root elements
18
Chapter 7. Book and set metadata
7.1. The relationship between the prelims and
book metadata
Ref: §1.32, §1.33
See also Section 7.5.15, “Other prelim content”, Chapter 10, Front matter, and especially Section 10.3,
“Prelims chunk”.
In the DocBook model, most of the content within the preliminary material within a book (ie the half
title, half title verso, title page, and title verso (copyright page) MUST be encoded within specific
elements within the book metadata (book/info), along with some additional metadata that does
not occur in the print edition.1 In addition, a small amount of the content on the title verso MUST be
encoded within the book/colophon (see Section 7.5.15.3, “Colophon”). The table below summarises
the mapping between the print source and the main DocBook targets, and the following sections
provide further detail and examples.
Component Elements
Half title title
Half title verso cover
Title page title, subtitle, author | authorgroup,
pubdate, biblioset [and others? Check some
of the more irregular title pages]
Title verso biblioset, copyright, legalnotice +
book/colophon
All xml files MUST have an @xml:lang attribute on the root element to specify the (human)
language of the text, the value of which MUST be from the ISO 639 code set, and will typically be
“en”.2
When the text includes content in a different language to the default, that text MUST be marked up
with an @xml:lang attribute to indicate the language of that text. If there is no element that spans all
of the text then the phrase element should be used as the container to mark up the text language.3
The ISO 639 two-letter code values MUST be used if one exists. If no two-letter code exists for a given
language, the three-letter code MUST be used (eg for Ancient Greek “grc”).4
1
See generally the tests in the Schematron pattern: book_metadata
2
Tested in Schematron: lang-attribute
3
Occurrences reported in Schematron: non-english-text
4
Tested in Schematron: lang-attribute-value
19
Book and set metadata
Each book MUST have a @role, with the value of either fullText or pdfOnly, the latter being for
backlist titles for which only a pdf version is available.
In such books, pagenums, page break markers and pdf chunks are not required.6
7.5. Metadata
Ref: §1.34
• Title group
• Author group
• Publication date
• Publisher details
• Copyright/CC details
• ISBNs
• Edition
• Series
It is preferable that book metadata components are included in book/info in a consistent, standard
sequence, as follows (some components may not be required for all books):
1. title
2. subtitle
4. edition
5. biblioset[@role="series"]
6. publisher
7. pubdate
9. biblioset[@role="isbns"]
5
Tested in Schematron: outputformat-e-only, page-breaks-present
6
Tested in Schematron: pagenums-e-only
20
Book and set metadata
10.biblioid[@class="doi"]
11.biblioid[@otherclass="schemaVersion"]
12.biblioid[@otherclass="schematronVersion"]
13.cover
14.abstract
15.keywords
This sequence broadly follows data order in the prelims, but moves the half title and half title verso
content (if any) to the end.7
The title (and subtitle, if one exists) of a book must be marked up using title and subtitle
elements.8
Italicisation/bold etc MUST NOT be encoded in the title group in the book metadata, if that is how
it was styled in the print edition.9 However, if the book title includes names of works (eg books) that
are rendered differently, their formatting MUST be captured:
Occasionally a book may have a previous title that MUST be recorded.11 This could be where the
content remains unchanged, but the title has changed due to an acquisition and it will be useful for
search for the previous title to be included, for example:
<info>
<title>The Bloomsbury Guide to Aquinas</title>
<bibliomisc role="previousTitle">The Continuum Guide to Aquinas</bibliomisc>
Footnotes MAY occur in chunk titles, though not in that for the book itself:
7
See generally the tests in the Schematron pattern: book_metadata
8
Tested in Schematron: title-present
9
Tested in Schematron: title-not-all-emphasis
10
Tested in Schematron: chunk-colon
11
Occurrences reported in Schematron: previous-title
21
Book and set metadata
Implementation note: Where footnotes occur in titles the footnote label must not be displayed
in generated tables of contents
The value of sortas is the string of the title text following any (for English-language titles) definite
or indefinite articles (i.e. the words "A" or "The"), with whitespace normalized:
See also the REQUIREMENT in Section 8.1, “Case regularisation”, and the details on name components
in Chapter 17, Names.
DocBook requirements for contributor mark up are relatively simple. If a title has a single author (or
editor) then a single author or editor element must be used to mark up the information.
<info>
<title>Globalizing Cricket</title>
<subtitle>Englishness, Empire and Identity</subtitle>
<author>
<personname role="first-last">
<firstname>Dominic</firstname>
<surname>Malcolm</surname>
</personname>
</author>
Note that within an info element, names are invariably in the order firstname followed by
surname.13
Note also that if there are multiple authored chunks within the book, then it is very likely that the
book will need an editor.14
If multiple contributors are present, then they MUST be wrapped in an authorgroup element.15
Comma and other separators between names MUST NOT be included. Note that for edited books,
the text “Edited by” etc that appears on the title page MUST NOT be included:
12
Tested in Schematron book-title-sort-key-test
13
Tested in Schematron: name-order-info
14
Tested in Schematron: possible-edited-book, authorgroup-required-1, authorgroup-required-2,
authorgroup-required-3, othercredit-class-required
15
Tested in Schematron: no-contributor-in-book
22
Book and set metadata
</personname>
</editor>
<editor>
<personname role="first-last">
<firstname>Sarah</firstname>
<surname>Chan</surname>
</personname>
</editor>
</authorgroup>
Occasionally, books may be authored by an organisation, in which case the organisation name MUST
be encoded within the orgname element within author:
<author>
<orgname>Food and Agriculture Organization of the United Nations</orgname>
</author>
Translators, General editors etc: Contributors other than authors and editors who appear on the title
page of the book MUST be marked up using the othercredit element. Their contribution as stated
in the text MUST be marked up using a child contrib element, which follows the personname in
the data, even if it precedes it in the print edition.
It is often appropriate to indicate the role played by an editor within contrib since there may be
more than one type of editor (e.g. series and general editors). A contrib is not permissible on an
author or editor element;16 if a contrib is required it suggests that the parent element should be
othercredit. Note that othercredit takes a @class attribute, which should not be confused with
@role.17
Note in the example below that the author is separate from the othercredits, ie the three are
NOT included in an authorgroup, since the translator and general editor are not authors of this
work.
<info>
<title><emphasis role="italic">To Gaurus On How Embryos are Ensouled</emphasis> and <emphasis
role="italic">On What is in Our Power</emphasis></title><author>
<personname role="first-last"><surname>Porphyry</surname></personname>
</author>
<othercredit class="translator">
<personname role="first-last">
<firstname>James</firstname>
<surname>Wilberding</surname>
</personname>
<contrib>Translated by</contrib>
</othercredit>
<othercredit>
<personname role="first-last">
<firstname>Richard</firstname>
<surname>Sorabji</surname>
</personname>
<contrib>General Editor</contrib>
</othercredit>
However, sometimes it may be necessary to have multiple authorgroups if there are multiple
contributors in one or more role. For example, this title page author information:
<authorgroup>
16
Tested in Schematron: contrib-present
17
Tested in Schematron: role-or-class
23
Book and set metadata
</authorgroup>
Note that the first othercredit within an authorgroup contains the contrib that defines the role
of all the contributors in the authorgroup.18 No other othercredits within the authorgroup
have a contrib.19 Note also that all othercredits within an authorgroup should share the same
@class.20
In this final example, only one person is named on the title page, but is neither the author nor simply
“editor” so othercredit MUST be used:
See also the example in Section 32.1.1, “Title page and contributors”.
Finally, book-level contributors (ie author, editor and othercredit in book/info), MUST
include a single short biographical statement in personblurb, together with the corresponding
Bloomsbury Biblio person ID:21
It is unusual for a personblurb to contain more than one paragraph, and for multiple
personblurbs in the same book to be identical.22
18
Tested in Schematron: contrib-required
19
Tested in Schematron: multiple-othercredits-1
20
Tested in Schematron: multiple-othercredits-2
21
Tested in Schematron: personblurb-present, author-id-present, au-id-marker, multiple-personblurb
22
Tested in Schematron: personblurb-para, personblurb-duplicate
24
Book and set metadata
This is likely to occur in e.g. edited volumes and where a "Notes on Contributors" section appears in
the prelims or at the end of a work.
7.5.3. Edition
If present, the edition data MUST be recorded exactly as it appears in the book.
Typically, for editions other than the first, this should appear on the title page, though may only
appear on the title verso page within the publisher details and print history block (see Section 7.5.6,
“Publisher details”). In any event, there MUST be a separate statement of the edition number.23
Typically, for first editions no edition statement is mentioned in the prelims at all. Even if this is so, an
edition statement MUST be included, with standard text content:
For all editions, the @role MUST take a numeric value equal to the edition number.24
7.5.4. Series
Most often, if the book is in a series, such details MUST be placed within a biblioset, and may
contain several data components:25
• Series title
• A series ISSN
A very high proportion of academic titles will be in a series, so it is relatively unusual for a book not
to have one.27 The text string in the title MUST exactly match the standard form of the series
name.28
23
Tested in Schematron: edition-present
24
Tested in Schematron: edition-role-present
25
Basic tests in Schematron pattern: series
26
Tested in Schematron: See all the tests in the group previous-series-*
27
Tested in Schematron: no-series
28
Tested in Schematron: series-name-list. The complete list of permissible series names is given in section Chapter 33,
Series names
25
Book and set metadata
Alternatively, some series data may be presented on the half title, for which see Section 7.5.15.1, “Half
title”.
The series data will normally be included as a child of book/info. Occasionally, it MAY occur within a
cover (see Section 7.5.15, “Other prelim content”).29
Implementation note: Whether series data is in biblioset or cover, the key data
components are:
book/info//title[@role="series"]
book/info//volumenum[@role="series"]
etc
If the publication date is present it must be marked up using a pubdate element with a @role
attribute set to the value published.30 This is typically a year and matches that on the title or
imprint page.31
<pubdate role="published">2013</pubdate>
The DocBook model does not have a specific imprint element, so the imprint information MUST be
bundled in a biblioset with the publisher details.
The bibliomisc[@role="imprint"] SHOULD be the same as that on the title page AND on the
title verso. If the two do not match, please inform Bloomsbury.33 The imprint is usually distinct from
the publisher name. For example, Bloomsbury Academic is an imprint of Bloomsbury Publishing,34
and (for backlist books) Continuum may be the imprint while Continuum International Publishing
Group is publishername;35 however, this MUST follow usage in the book prelims. Typically, an
imprint must have initial capitals and should not contain emphasis.36
29
Tested in Schematron: series-location
30
Tested in Schematron: pubdate-present
31
Tested in Schematron: pubdate-four-digits
32
Tested in Schematron: publisher-no-biblioset; publisher-biblioset; biblioset-publisher; publisher-
address
33
Tested in Schematron: imprint-present; imprint-in-biblioset; imprint-position
34
Tested in Schematron: imprint-bloomsbury-publishing
35
Tested in Schematron: imprint-continuum
36
Tested in Schematron: imprint-emphasis, lower-case-imprint
26
Book and set metadata
The biblioset publisher block should just contain details of the publisher of the current edition.
For that purpose it MAY need to include printhistory relating to the current edition, but NOT
historical editions and printings.37
<biblioset role="publisher">
<printhistory><para>First published 2013 by</para></printhistory>
<bibliomisc role="imprint">Bristol Classical Press</bibliomisc>
<phrase>An imprint of</phrase>
<publisher>
<publishername>Bloomsbury Publishing Plc</publishername>
<address><street>50 Bedford Square</street> <city>London</city> <postcode>WC1B 3DP</postcode> <country>UK</
country></address>
<address><street>175 Fifth Avenue</street> <city>New York</city> <state>NY</state> <postcode>10010</
postcode> <country>USA</country></address></publisher>
</biblioset>
Note that, the publishername MUST just contain the name of the publisher (hence “An imprint of”
is within a preceding phrase),38 and that within the book/info the address MUST include the
granular component markup.39 Typically, a publishername should not contain emphasis.40
Furthermore, the address MUST be within the publisher, and the address[1] must contain a
city, as in the example above.41
The example below shows a slightly more complicated print history for a second edition. Note that
though both lines from the imprint page are included in a printhistory element, only the current
edition has the imprint encoded, ie this is the imprint that appears on the title page, and only this
one MUST be marked as the imprint. That is, there MUST only be one imprint in the publisher
biblioset.42
<printhistory xml:id="w1">
<para xml:id="w2">First published in 1965 by<?break type='line'?>Methuen & Co. Ltd</para>
<para xml:id="w3">Reprinted 1968</para>
<para xml:id="w4">Second edition 1971</para>
<para xml:id="w5">Reprinted five times</para>
<para xml:id="w6">Third edition 1983</para>
</printhistory>
<biblioset role="publisher" xml:id="sw1">
<printhistory xml:id="w7">
<para xml:id="w8">Reprinted in 1988, 1992, 1994 by</para>
</printhistory>
<bibliomisc role="imprint">Bloomsbury Academic</bibliomisc>
<publisher>
<publishername>Bloomsbury</publishername>
<address xml:id="w9"><street>50 Bedford Square</street> <city>London</city> <postcode>WC1B 3DP</postcode>
<country>UK</country></address>
<address xml:id="w10"><street>175 Fifth Avenue</street> <city>New York</city> <state>NY</state>
<postcode>10010</postcode> <country>USA</country></address>
<address xml:id="m65">
<link xlink:href="http://www.bloomsbury.com">
<uri>www.bloomsbury.com</uri>
</link>
</address>
</publisher>
</biblioset>
37
See also: Bob Stayton. ‘Chapter 29. Revision control’ in DocBook XSL. Sagehill. http://www.sagehill.net/
docbookxsl/RevisionControl.html
38
Tested in Schematron: phrase-in-publishername
39
Tested in Schematron: address-components, unmarked-address
40
Tested in Schematron: publishername-emphasis
41
Tested in Schematron: pub-address-location, pub-address-missing, pub-city-missing, pub-city-content
42
Tested in Schematron: imprint-count
27
Book and set metadata
Note also how the publisher web address is marked up within the publisher address block.43
The examples above include a printhistory within the publisher biblioset where it makes most
sense (grammatically) to group them together. Other more complex histories and layouts on the title
verso may require a separation, eg where the copyright line is in the middle of the block, in which
case multiple printhistory elements may be required:
<biblioset role="publisher">
<bibliomisc role="imprint"><emphasis role="bold">Continuum</emphasis></bibliomisc>
<address>
<otheraddr>The Tower Building</otheraddr>
<street>11 York Road</street>
<city>London</city> <postcode>SE1 7NX</postcode>
</address>
</biblioset>
<printhistory>
<para>First published in Great Britain, 1987<?break type="line"?>by The Athlone Press</para>
</printhistory>
<printhistory>
<para>This edition 2004</para>
</printhistory>
<copyright>
<year>1987</year>
<holder>The Athlone Press</holder>
</copyright>
<printhistory>
<para>Originally published as <emphasis role="italic">Critique et Vérité</emphasis>,<?break type="line"?>by
Editions de Seuil, Paris, 1966</para>
</printhistory>
<printhistory>
<para>The Publishers wish to acknowledge the financial assistance of the French Ministry of Culture and
Communications in the translation of this work.</para>
</printhistory>
28
Book and set metadata
7.5.9.1. Copyright
Copyright information must be marked up in the metadata. The copyright element MUST be used
for this purpose.46 The copyright symbol (©) and the word “Copyright” MUST NOT be included in
the XML.47
If multiple contributors are mentioned in a single copyright line, this MUST be marked up as a single
copyright statement.
<copyright>
<year>2011</year>
<holder>Jonathan Bate and contributors</holder>
</copyright>
These may also be slightly more complicated, with indications of the responsibilities of the copyright
holders. The text sequence MUST follow that in the print edition:
46
Tested in Schematron: copyright-present; info-copyright
47
Tested in Schematron: copyright-holder, copyright-year
29
Book and set metadata
<copyright>
<year>2012</year>
</copyright>
Note also that the copyright year MUST NOT be in the holder element;48 it belongs in year.
Furthermore, assertions of moral rights etc belong in a legalnotice element, not within copyright.49
Bloomsbury Open Access content is that which is freely available to users online. As of this version
of the schema, open-access content MUST include a Creative Commons licence, of which there are
currently four allowed types:
In addition, the attribute oa:licenceVersion is now provided to indicate the version of the CC
licence.
<book>
<info><legalnotice role="CC-BY-ND" xml:id="b-9781838606947-0000020"><para xml:id="b-9781838606947-1000020"/
></legalnotice></info></book><
48
Tested in Schematron: holder-year
49
Tested in Schematron: holder-act
50
Tested in Schematron open-access-2
30
Book and set metadata
</info></chapter>
Note
In this version of the schema, the wording of the particular Creative Commons licence is
NOT required to be captured in the markup. The para within legalnotice is required,
and is therefore allowed to be empty in this context.
Note that the funder information should be captured using orgname only, and no other punctuation
or text should be included.52 The rendering application is expected to supply any delimiting text or
punctuation.
<legalnotice>
<para>All rights reserved. No part of this publication may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopying, recording, or any information storage or
retrieval system, without prior permission in writing from the publishers.</para>
<para>Seán Sheehan has asserted his right under the Copyright, Designs and Patents Act, 1988, to be
identified as Author of this work.</para>
</legalnotice>
The list of ISBN(s) associated with the book MUST be included, and contained within using a
biblioset element with a @role attribute set to the value isbns.53
Such list will usually be preceded or followed by the CIP (Cataloguing in Publication) statement(s)
from the British Library and/or the Library of Congress, which MUST be included within separate
legalnotice[@role="CIP"].54 (See below.)
The XML ISBN provided by Bloomsbury must always be inserted into the document markup. This
ISBN must be marked with a @role attribute value of xml.55
Important
XML ISBNs MUST NOT contain spaces.56
51
Tested in Schematron funder-para-orgnames
52
Tested in Schematron funder-para-only-orgnames
53
Tested in Schematron: isbn-present; isbns-in-biblioset; biblioset-isbns; isbns-role
54
Tested in Schematron: bl-cip, loc-cip, loc-cip2
55
Tested in Schematron: xml-isbn
56
Tested in Schematron: xml-isbn-format
31
Book and set metadata
The SBNs MUST be correctly formatted, i.e. include hyphens or spaces as presented on the imprint
page of the book.57
If any other ISBN values are available (either supplied by Bloomsbury or within the prelims of an
existing text or PDF), these MUST be marked up and have the correct @role.58 Duplicate ISBNs are
NOT permitted.59
Note that as of Schematron version 6, an ePDF ISBN is mandatory for Open Access titles (see
Section 7.5.9.2.1, “Open Access: books and chapters”) appearing on the Bloomsbury Collections
platform (see Section 3.1, “Platform-specific considerations”).60
The @class attribute of each ISBN’s biblioid MUST be set to the correct value (which for ISBNs
this MUST always be isbn). If additional information is provided that provides the print format
associated with a given ISBN then this must be indicated using the @role attribute. Permitted values
are given below, should match those in the prelims, and there MUST be no more than one of each
@role, with the exception of otherHardback, which MAY appear more than once.61 All ISBNs
in the prelims MUST be captured; if there is no apparent @role which is suitable, please contact
Bloomsbury.
ISBNs of other volumes MUST be marked up as follows, with the value of @xlink:label being the
volume number:62
The book DOI MUST also be included in the metadata, which MUST have @class="doi", and
use the biblioid[@class="isbn"][@role="xml"] as its root.63 DOIs within a book MUST be
unique:64
57
Tested in Schematron: isbn-length; isbn-format
58
Tested in Schematron: insufficient-isbns, isbn-role
59
Tested in Schematron: dupe-isbns
60
Tested in Schematron: open-access-4
61
Tested in Schematron: isbn-types
62
Tested in Schematron : resource-required, label-required
63
Tested in Schematron: doi-present; info-doi; book-doi-isbn; doi-format; doi-isbn
64
Tested in Schematron: duplicate-doi
32
Book and set metadata
On rare occasions, DOIs are not required within a book. Bloomsbury will instruct if this is the case.
If so, the book/info MUST contain a biblioid with DOInotRequired (see Section 7.5.11, “Other
biblioids”).
Note that there are distinct legalnotice elements for each of the two CIP items:
The order of items in the Library of Congress CIP data follows a standard pattern, so it should be
straightforward to determine where it starts and ends.
65
Tested in Schematron: non-permitted-otherclass
33
Book and set metadata
34
Book and set metadata
eg: CA
eg: 2015-06-15
eg: Re X
35
Book and set metadata
7.5.12. Revisions
Once a document is released, from time to time it may be necessary to make some revisions to it. If
this is so, it is recommended that a revision history is maintained in the book metadata.66
Such a revision history MUST be in date order (most recent first), record the name of the person or
organisation responsible for the revision, and a brief description of the change.67 It is possible to link
to specific targets within the content from such revision description:
<revhistory>
<revision xml:id="rev1">
<date>2014-05-21</date>
<author><personname>Brad Scott</personname></author>
<revremark>Corrected typos in Preface</revremark>
</revision>
<revision xml:id="rev">
66
Tested in Schematron: revhistory-location
67
Tested in Schematron: revision-sequence, revisions-date-format, revision-author, revision-revremark
36
Book and set metadata
<date>2014-05-20</date>
<author><personname>Brad Scott</personname></author>
<revremark>Added @role to the <link linkend="ki1" role="xref">appendix of the ancillary materials</link></
revremark>
</revision>
<revision xml:id="rev2">
<date>2014-05-19</date>
<author><orgname>NewGen</orgname></author>
<revremark>Fixed layout of Table 1</revremark>
</revision>
</revhistory>
Implementation note: The default behaviour of DocBook XSL is to render the revisions in the
header, which may need to be suppressed by a downstream processor
<revhistory>
<revision xml:id="xyz987">
<date>2022-10-06</date>
<author><orgname>NewGen</orgname></author>
<revremark>Initial supply</revremark>
</revision>
</revhistory>
7.5.13. Blurb/abstract
The book blurb data MUST be added to the book/info with correct markup for italicisation etc.69
In the event that lists etc are required within the blurb, these MUST be added within a para, since
the content model of abstract does not allow them as direct child elements.
<abstract role="blurb">
<para>Gilles Deleuze is without question one of the most influential thinkers of the twentieth century.
<emphasis role="italic">Difference and Repetition</emphasis> is a classic work of contemporary philosophy
and a key text in Deleuze's oeuvre, a brilliant exposition of the critique of identity that develops two
key concepts: pure difference and complex repetition. <emphasis role="italic">Deleuze's 'Difference and
Repetition': A Reader's Guide</emphasis> offers a concise and accessible introduction to this hugely
important and yet notoriously demanding work.</para>
</abstract>
7.5.14. Keywords
Keywords can occur at the book or chunk level, and occur within a keywordset:
<keywordset xml:id="ki9876">
<keyword xml:id="d5">Word</keyword>
<keyword xml:id="d4">Another key word</keyword>
</keywordset>
37
Book and set metadata
However, in a small number of cases, the half title page MAY contain other information such as
review quotes, or even extensive series information, which MUST be captured within a cover
element.
These will typically have @role=halfTitle, and may require a bridgehead element for titles
(which MUST take a @renderas=sect1 | sect2 | sect3 | sect4 | sect5 to specify
heading level style, where the attribute value corresponds with the nested section style).70 This
example contains quotes and endorsements (which may also occur on the half title verso):
<cover role="halfTitle">
<bridgehead renderas="sect1">Advance Praise for Norbert Elias and Modern Sociology: Knowledge,
Interdependence, Power, Process</bridgehead>
<blockquote>
<para>This is an engagingly written book by two of the world’s leading experts on the work of Norbert
Elias. Focusing on Elias’s sociology of knowledge they show how this might bring sociologists nearer to a
cumulative theoretical and empirical science of human social relations. Indispensable.</para>
<para role="right"><emphasis role="bold">– Ian Burkitt, Reader in Social Science, University of Bradford,
UK</emphasis></para>
</blockquote>
<blockquote>
<para>A state-of-the-art assessment of the significance of Norbert Elias’s contribution to sociological
knowledge and thought.</para>
<para role="right"><emphasis role="bold">– Professor Johan Goudsblom, University of Amsterdam, The
Netherlands</emphasis></para>
</blockquote>
</cover>
Rarely, half titles may contain rather more complex data, such as series bibliographic data:
which would be marked up as follows (some content removed for clarity). Note the use of @role
attributes for controlling aspects of style and for differentiating content:
70
Tested in Schematron: bridgehead-renderas, bridgehead-role
38
Book and set metadata
<bibliolist xml:id="id0253">
<bibliomixed xml:id="aa1" role="series">
<title role="series">Library of Hebrew Bible/Old Testament Studies</title>
<volumenum role="series">567</volumenum>
<bibliomisc role="previousTitle">Formerly Journal for the Study of the Old Testament Supplement Series</
bibliomisc>
<bibliomisc role="heading1">Editors</bibliomisc>
<othercredit>
<personname role="first-last"><firstname>Claudia V.</firstname> <surname>Camp</surname></personname>
<affiliation><orgname>Texas Christian University</orgname></affiliation>
</othercredit>
<bibliomisc role="heading2">Founding Editors</bibliomisc>
<phrase><personname>David J. A. Clines</personname>, <personname>Philip R. Davies</personname> and
<personname>David Gunn</personname></phrase>
<title>Playing the Texts</title>
<volumenum>17</volumenum>
<bibliomisc role="heading1">Editor</bibliomisc>
<othercredit>
<personname role="first-last"><firstname>George</firstname> <surname>Achiele</surname></personname>
<affiliation><orgname>Adrian College, Michigan</orgname></affiliation>
</othercredit>
</bibliomixed>
</bibliolist>
</cover>
<cover role="halfTitleVerso">
<bridgehead renderas="sect2">Also available from Continuum</bridgehead>
<simplelist xml:id="id0256">
<member xml:id="f5"><emphasis role="italic">Charisma and Myth</emphasis>, Raphael Falco</member>
<member xml:id="f6"><emphasis role="italic">Edward Said’s Rhetoric of the Secular</emphasis>, Mathieu E.
Courville</member>
</simplelist>
</cover>
7.5.15.3. Colophon
The only remaining content within the prelims is usually the typesetting and printing information.
For the treatment of this see Section 10.2, “Colophon”.
39
Chapter 8. Editorial standardisation
8.1. Case regularisation
Ref: §1.31
Where titles or contributor (author, editor or other contributor) names are presented in upper case,
the text must be captured in sentence case.1
• //info/title
• //info/subtitle
• //info//author
• //info//editor
• //info//othercredit
• book/info/biblioset[@role=’publisher’]/bibliomisc[@role=’imprint’]
That is, there MUST be capitalisation of only the first word, proper nouns and as dictated by other
specific English rules.
Furthermore, acronyms in a title/subtitle MUST NOT be converted to Title Case, eg Using IT in the
Classroom.
For example:
4. Maria Montessori
1
Tested in Schematron: case-regularisation
40
Chapter 9. Chunking and high-level
structure
Ref: §1.10
When considering the high-level structure of a book, it is important to think about the book as a pdf,
as well as a structured piece of XML.
Each page of the printed pdf MUST have some representation within the body of the XML (however
simple), with a discrete non-overlapping range of pdf pages that correspond to it. Such unit will
typically be a chapter, preface, appendix etc, but will also include the prelims (typically pp i-iv)
and the contents page(s), etc, and each ALWAYS starts on a new page. Such units are called content
“chunks” in this document.
• the page range of the chunk (see Section 9.3.2, “Page range”),
• a file reference to the corresponding chunk of the print pdf (see Section 9.3.3, “PDF file reference and
file naming”),
• AND that such separate pdf is supplied with the XML (see Chapter 3, Deliverables and file-naming
conventions).
Chunks MAY also require other metadata components as detailed later in this section.
Other elements that are usually technically permissible in a DocBook chunk info will generate a
warning in this instance of DocBook, since they are unusual: date.1
The following elements are content chunks where they occur as children of book or part:
1
Tested in Schematron : date-in-info
41
Chunking and high-
level structure
Label Title
Prelims (pp i-iv in the current book)
Contents page
List of Contributors
PART I LEIBNIZ’S TIMES AND PHILOSOPHICAL
PRECURSORS
1 INTRODUCTION: LEIBNIZ’S LIFE AND
WORKS
2 DESCARTES AND LEIBNIZ
3 LEIBNIZ AND HOBBES
4 LEIBNIZ’S FASCINATION WITH SPINOZA
5 MALEBRANCHE AND LEIBNIZ
PART II LEIBNIZ’S PHILOSOPHY
6 LEIBNIZ’S METAPHYSICS: THE PATH TO THE
MONADOLOGY
42
Chunking and high-
level structure
Label Title
7 LOGICAL THEORY IN LEIBNIZ
8 LEIBNIZ’S THEORY OF COGNITION
9 LEIBNIZ’S THEORY OF MODALITY
10 LEIBNIZ’S THEORY OF CAUSATION
11 LEIBNIZ’S PHILOSOPHICAL THEOLOGY
12 LEIBNIZ ON FREE WILL
13 LEIBNIZ’S MORAL PHILOSOPHY
14 LEIBNIZ’S CONTRIBUTION TO NATURAL
PHILOSOPHY
15 LEIBNIZ AND THE LIFE SCIENCES
16 LEIBNIZIAN MATHEMATICS
PART III THE AFTERMATH
17 KANT, THE LEIBNIZIANS AND LEIBNIZ
Bibliography
Index of Names
The following table shows how this maps to the XML structure and the pdf chunks.
43
Chunking and high-
level structure
Note that it is an ERROR for a book to only contain front and back matter (ie with no body content)
and for a body part to contain no chapters or articles,2 and that it is highly irregular for a book
to contain only one part (over and above front/back).3
See also Chapter 10, Front matter and Chapter 12, Back matter.
Content chunks MUST contain a title within an info metadata container.4 If the chunk has a
clearly typographically differentiated subtitle, that MUST be contained within a subtitle element.
2
Tested in Schematron: front-back-only, no-chs-in-part
3
Tested in Schematron: only-one-part
4
Tested in Schematron: title-within-info, title-required
44
Chunking and high-
level structure
Ordinarily, content chunks with a colon-separated title MUST NOT be split into title and
subtitle elements, since it is not a completely reliable means of doing so.
In addition, a book or chunk title MUST NOT end with a colon.5 A chunk title MUST NOT contain a
cross-reference to an item in the bibliography.6
If a chunk also has a label (eg “Chapter 1”, “PART II”), its numeric value MUST be captured using
the @label and MUST NOT be included in the title.7 The numeric value MUST follow the style
as used in the print, ie use Roman or Arabic numbers as appropriate. (In the event that the print style
is to deviate from this (eg “chapter three”), use Arabic numbers for the value of @label.)8
If a chunk title ONLY comprises the number (“3”) or with a label (“Part III”), that MUST be within
the title, NOT included in the @label. Empty title elements are NOT ALLOWED.9 Typically,
therefore, if a chunk title begins with the words “chapter”, “part”, “appendix” etc that is an error if
there is also a numeric value and a more expansive, descriptive title.10 (See also Section 7.5.11, “Other
biblioids”.)
This use of @label is also REQUIRED for all other elements that can take title and a @label
attribute, ie section, figure, table, example, glossdiv, bibliodiv, etc.
Occasionally, non-standard labels may be required, ie a division may be called a “Section”, even
though it is structurally a DocBook part. In such cases, the entire label (eg “Section 1”) MUST
be included in @label, TOGETHER WITH @role=labelOverRide.12 This is so that the usual
processing rules for @label will not be applied:
On online platforms, full points SHOULD NOT be included in the value of @label in nested
sections, as these will be provided by the renderer.13 If there is no alternative to including a full point
– for instance if the numbering system is non-standard – then this warning can be avoided, again by
using @role=labelOverRide:
<section label='1'>
<section label='1.a' role='labelOverRide'>[...]
See also examples in Section 11.4, “General use of @label” and Chapter 11, Introductions, chapters, parts,
titles and @labels
5
Tested in Schematron: chunk-colon
6
Tested in Schematron: link-in-title
7
Tested in Schematron: chunk-title-starts-with-number
8
Tested in Schematron: one-in-label and related tests
9
Tested in Schematron: impermissible-empty-element
10
Tested in Schematron: check-title, part-label-issue, chapter-label-issue, appendix-label-issue
11
Tested in Schematron: xreflabel-not-required
12
Tested in Schematron: label-required2
13
Tested in Schematron : check-label-3
45
Chunking and high-
level structure
Implementation note: For elements that may include @label, an autogenerated title (“Chapter
2”) must only be added if an @label value is present. If there is no @label, no autogenerated
text or number is to be added in the output.
A dedication page is a typical example; they usually do not include any title at all. The only content
is the dedication text. In such cases, a title MUST be added with an @outputformat attribute,14
and then the dedication content will be included in regular paras or other appropriate elements:
<dedication xml:id="b-0022">
<info xml:id="b-0023">
<title xml:id="b-0024" outputformat="e-Only">Dedication</title>
Other cases where this may be required include illustrations sections, which may not have any title.
The book’s table of contents may be a useful guide here, since that may include a heading, even if it
does not appear on the printed page:
Several of these chunk metadata components are not permitted anywhere other than in chunk
blocks.15
Monograph books with single or multiple authors MUST NOT have their book/info author details
added to every content chunk. Author details are only REQUIRED for chunks for edited books and
for other chunks with named authors (eg a Foreword).
14
Tested in Schematron: dedication-in-title, epigraph-in-title
15
Tested in Schematron: doi-not-req, pagenums-not-req, mediaobject-not-req
46
Chunking and high-
level structure
Note that occasionally the style of the work may be to include the chunk author name at the end
of the chunk. In such cases, the chunk author MUST still be included within the chunk info, and
MUST NOT be located in the data at the end of the chunk (the assumption being that the processing
application will place it there. However, this only applies to chapter content, not to signed prefaces
etc.
Note that within an info element, names are invariably in the order firstname followed by
surname.16
As with author details for the book, multiple authors MUST be within an authorgroup:17
<chapter xml:id="b-00002">
<info xml:id="b-0019">
<title xml:id="b-0020">Introduction</title>
<authorgroup>
<author>
<personname role="first-last">
<firstname>Hans</firstname>
<surname>Geybels</surname>
</personname>
</author>
<author>
<personname role="first-last">
<firstname>Walter</firstname>
<surname>Van Herck</surname>
</personname>
</author>
</authorgroup>
For content chunks, most of the names will be within author elements, but occasionally a translator or
other name container may be required:
In this particular case, because the way the authorship of the chunk is presented in the print edition
departs from normal practice, a distinct contributor statement is also included. If the presentational
style of the names of the author(s) and other contributors is non-standard, such a contributor
statement MUST be included.18
It is very unlikely that an editor will be REQUIRED within a chunk.19 However, complex contributor
groups may require multiple containers:
16
Tested in Schematron: name-order-info
17
Tested in Schematron: authorgroup-required-1, authorgroup-required-2, authorgroup-required-3
18
Tested in Schematron: contrib-statement-location and presence reported in: contrib-statement-present
19
Tested in Schematron: chunk-editor-present
47
Chunking and high-
level structure
<authorgroup>
<author>
<personname role="first-last"><firstname>Éric</firstname><surname>Alliez</surname></personname>
</author>
<author>
<personname role="first-last"><firstname>Jean-Claude</firstname><surname>Bonne</surname></personname>
</author></authorgroup>
<authorgroup>
<othercredit>
<personname role="first-last"><firstname>Rafael</firstname><surname>Winkler</surname></personname>
<contrib>Translated by</contrib>
</othercredit>
</authorgroup>
<authorgroup>
<othercredit>
<personname role="first-last"><firstname>Robin</firstname><surname>Mackey</surname></personname>
<contrib>Revised by</contrib>
</othercredit>
</authorgroup>
The start and end page number MUST be separated by an en dash (Unicode &#–;), be
composed of letters and digits only,22 and MUST NOT contain any leading or trailing spaces.23
Start pages MUST be before end pages,24 and if there is only one page, only a single number is
REQUIRED.25
However, ALL pages within the printed book MUST be represented within the page ranges for the
book, so blank pages MUST be added to the end of the preceding chunk (NOT to the beginning of
the following one),26 eg for this one page acknowledgement:
<acknowledgements xml:id="b-0000044">
<info xml:id="b-0000045">
20
Tested in Schematron : contributor-in-title
21
Tested in Schematron : pagenums-present, pagenums-count
22
Tested in Schematron: pagenums-must-match
23
Tested in Schematron: pagenums-spaces, pagenums-ndash-1, pagenums-ndash-2
24
Tested in Schematron: endp-before-startp
25
Tested in Schematron: single-page
26
Tested in Schematron: pagenums-sequence
48
Chunking and high-
level structure
<title xml:id="b-0000046">Acknowledgements</title>
<pagenums>xv–xvi</pagenums>
Page ranges for part divisions MUST only include the physical pages for the division itself, not the
child chapters within it. For example, though this Part includes chapter content up to page 268, its
own page range is just limited to the Part cover page(s):
Finally, the first and last page number in the pagenums MUST match the equivalent values in that
chunk’s page PIs (see Section 14.4, “Page breaks”).27
Implementation note: The display of chunk pagenums is not supported in DocBook XSL
<chapter xml:id="b-0038">
<info xml:id="b-0039">
<title xml:id="b-0040">Introduction</title>
<pagenums>1–2</pagenums>
<mediaobject xml:id="b-0041">
<imageobject xml:id="b-0042"><imagedata format="application/pdf" fileref="pdfs/9781472554871.0006.pdf"/></
imageobject>
</mediaobject>
Chunk filenames MUST have the XML ISBN as its root and follow a sequential pattern. It is
recommended that numbered chapter, part and appendix chunks have a numbering style that
is predictable based on their chapter/part/appendix number. An element is “numbered” if it has
@label numbered as described in Section 11.3, “Chapter and Part labelling”. (See also the table of
filenames in Section 9.1, “Chunking example”, and note the relationship between the pdf filename and
the DOI in Section 9.3.4, “Chunk DOI”29 )
Note that if the numbering of the chunk uses Roman numbers, the pdf file name MUST use Arabic
numbers:
27
Tested in Schematron : page-no-match1, page-no-match2
28
Tested in Schematron : chunk-pdf-present
29
Tested in Schematron: ch-doi-no-label, part-no-label, part-filename-no-label
49
Chunking and high-
level structure
<info xml:id="b-0025">
<title xml:id="b-0026">Religious Laughter</title>
<pagenums>239–240</pagenums>
<mediaobject xml:id="b-0027">
<imageobject role="suppressPDF" xml:id="b-9781474208482-0003050">
<imagedata fileref="pdfs/9781472549075.pt-003.pdf" format="application/pdf"
/>
</imageobject>
</mediaobject>
Note also the presence of @role=suppressPDF in this example. If a content chunk part container
contains no content other than child chapters (or parts), this attribute MUST be applied.30
This is to identify instances where the part divider only contains the title and it may be desirable to
treat the behaviour of such nodes differently in a processing application.
Note though that if the part contains any content at all (most likely within a partintro), this
@role MUST NOT be applied.31
Implementation note: The display and handing of chunk pdfs is not supported in DocBook XSL
• chapter
• part[partintro]
the form of which MUST exactly match the chunk filename with a prefix = 10.5040/,33 and DOIs
within a book MUST be unique.34 Furthermore, if a chunk DOI has a numbered chapter or part, its
DOI/filename structure MUST match the label numbering.35
Other content chunks MUST NOT have a DOI.36 However, note that articles in A-Z reference content
MUST have DOIs (see Section 9.5, “A-Z (reference) content”).
Also note that sub-articles in reference content (see Section 9.5.6, “Article components (dictionary-type
content)”) MAY require DOIs: Bloomsbury will instruct if this is the case.
30
Tested in Schematron: suppress-pdf-required, part-suppress-pdf
31
Tested in Schematron : pdf-suppress-incorrect, suppress-pdf-abstract, suppress-pdf-partintro
32
Tested in Schematron : chunk-doi-present, part-doi-required, part-no-doi
33
Tested in Schematron : non-matching-doi-pdf
34
Tested in Schematron : duplicate-doi
35
Tested in Schematron : ch-doi-no-label, part-no-label, part-filename-no-label
36
Tested in Schematron: doi-not-required
50
Chunking and high-
level structure
On rare occasions, DOIs are not required within a book. Bloomsbury will instruct if this is the case.
If so, the book/info MUST contain a biblioid with DOInotRequired (see Section 7.5.11, “Other
biblioids”).
Implementation note: The display of chunk DOIs is not supported in DocBook XSL
Author abstracts will only be supplied for new (front list) books. Older titles and those that are to be
converted will almost certainly not have such content. For full text chunks, only authorAbstracts
are permissible.37
If a book contains a section headed “Abstract” that MUST be contained within an abstract
element in the info (not a section) and MUST NOT have a title containing just the word
“Abstract” (since that can be autogenerated by a downstream application.38
Parts (ie part) with no content other than child chapters or articles, or partintro MUST NOT
contain an abstract.39
Backlist books which are to be created as pdf-only metadata files (ie book[@role=pdfOnly])
(see Section 7.3, “Content type”) MUST include a text extract.40 An extract is the first 150 words of
the chunk content, excluding epigraph(s), headings, footnote refs,41 and will be displayed to non-
authenticated users of the online service. This does not apply to full text XML titles.
See also the example in Section 32.2.5, “Chapter Outlines and Abstracts”
9.3.6. Keywords
Keywords may occur in a chunk; as with keywords at the book level, they belong in the chunk info.
See Section 7.5.14, “Keywords”.
51
Chunking and high-
level structure
However, some chunk or section titles may be very long and the most common occurrence is to have
a short form of the title specifically for the header. If that is required (and most chunks and sections
will not need it), then a titleabbrev MUST be added to the info. DocBook’s default behaviour is
to use that for the running header if present, otherwise the title will be used.
<printhistory xml:id="ph5">
<para xml:id="id01001837"><emphasis role="bold">Source:</emphasis> <emphasis role="italic">Fragments for a
History of the Human Body, Part 2</emphasis> (New York: Zone Books, 1989), 148–99.</para>
<para xml:id="id01001838">From <emphasis role="italic">Le corps redressé: Histoire d'un pouvoir
pédagogique,</emphasis> Paris, Editions Delarge, 1978. <emphasis role="bold">Translated by Ughetta Lubin</
emphasis>.</para>
</printhistory>
Implementation note: This will need to be handled in the site code since it is not supported in
DocBook XSL. Display as block with border
There are some other specific features that A-Z content has, which are best illustrated with a series of
examples.
43
Tested in Schematron: only-blockquote-content
52
Chunking and high-
level structure
This work has clear letter divisions, and then all the articles within the chunk run on in sequence.
Note also the position of the article authors and the ‘see also’ list:
53
Chunking and high-
level structure
Points to note:
1. The “F” part has the pagenums range for the entire chunk (ie all the “F” articles)
2. It also has a DOI44 and PDF file reference, just like all chunks
3. The container part imageobject MUST not have @role=suppressPDF45 (compare with Section 9.3.3,
“PDF file reference and file naming”)
4. The image on the part opener is simply an informalfigure with a caption for the copyright
line
6. The article’s title is in mixed case, not all upper case (see Section 8.1, “Case regularisation”)
7. The article authors are placed within the article/info NOT at the end of the article. This is
identical to the situation where chapter authors are placed at the chapter end; it is assumed that the
placement of the authors is controlled by the a template style
8. Each article MUST include a pagenums range for that article.46 These are excluded from the
regular sequential pagenums test
9. Each article MUST include a DOI,47 but NOT a file reference, since it is not a chunk
44
Tested in Schematron: part-article-doi
45
Tested in Schematron : suppress-pdf-article
46
Tested in Schematron : article-pagenums
47
Tested in Schematron : article-doi
54
Chunking and high-
level structure
10.The ‘see also’ references are in a para[@role=see] at the end of the article48
<part xml:id="f-1">
<info xml:id="f-2">
<title xml:id="f-3">F</title>
<pagenums>81–86</pagenums>
<biblioid class="doi">10.5040/9781609032229.011</biblioid>
<mediaobject xml:id="w1"><imageobject xml:id="w2"><imagedata fileref="pdfs/9781609032229.011.pdf"
format="application/pdf"/></imageobject></mediaobject>
</info>
<partintro xml:id="f-4">
<informalfigure xml:id="f-5">
<mediaobject xml:id="f-6"><imageobject xml:id="f-7"><imagedata fileref="images/f.png" format="image/png"/
></imageobject></mediaobject>
<caption xml:id="f-8">
<para xml:id="f-9">Farming © Angela Meah</para>
</caption>
</informalfigure>
</partintro>
<article xml:id="f-10">
<info xml:id="f-11">
<title xml:id="f-12">Farming</title>
<authorgroup>
<author><personname role="first-last"><firstname>Peter</firstname><surname>Jackson</surname></personname></
author>
<author><personname role="first-last"><firstname>Richard</firstname><surname>Lee</surname></personname></
author>
</authorgroup>
<pagenums>82–83</pagenums>
<biblioid class="doi">10.5040/9781609032229.012</biblioid>
</info>
<para xml:id="f-13">Farming encompasses a wide range of organized land- or marine-based activities intended
to produce food and other materials for domestic consumption or for sale through a market mechanism....</
para>
<para xml:id="f14" role="see"><emphasis role="bold"><emphasis role="italic">See also</emphasis></emphasis>
<link role="xref" linkend="a1">ecology</link>, <link role="xref" linkend="a1">governance</link>, <link
linkend="a1">security</link>, <link role="xref" linkend="a1">sustainability</link>.</para>
</article>
</part>
48
Tested in Schematron: article-para-links
55
Chunking and high-
level structure
Points to note:
1. The dummy entry comprising just cross references MUST have @role=xref49
2. The bibliography is within a section (with @role=bibliography)50 in this case because the
data here cannot be modelled within a bibliography, though in principle an article MAY
have a bibliography
<part xml:id="s1">
<info xml:id="s2">
<title xml:id="s3">S</title>
<pagenums>496–544</pagenums>
<biblioid class="doi">10.5040/9781609032229.0037</biblioid>
<mediaobject xml:id="s3a"><imageobject xml:id="s3b"><imagedata fileref="pdfs/9781609032229.0037.pdf"
format="application/pdf"/></imageobject></mediaobject>
</info>
<article xml:id="s4" role="xref">
<info xml:id="s5">
<title xml:id="s6">Satisfaction</title>
<pagenums>496</pagenums>
<biblioid class="doi">10.5040/9781609032229.0038</biblioid>
</info>
49
Tested in Schematron : article-xref
50
Tested in Schematron: article-section-role
56
Chunking and high-
level structure
<affiliation><orgname>University of Warerloo</orgname></affiliation>
</author>
<pagenums>496–497</pagenums>
<biblioid class="doi">10.5040/9781609032229.0039</biblioid>
</info>
<para xml:id="s11">Classical Utilitarianism is a consequentialist moral theory. ...</para>
<section xml:id="s12" role="bibliography">
<info xml:id="s13">
<title xml:id="s13a">Bibliography</title>
</info>
<bibliolist xml:id="s14">
<bibliomixed role="article" xml:id="b-9781474208482-0003344"><bibliomset
relation="article"><author><personname role="last-first"><surname>Bradley</surname><firstname>Ben</
firstname></personname></author>. "<title>Against Satisficing Consequentialism</title>,"</bibliomset>
<bibliomset relation="journal"><title><emphasis role="italic">Utilitas</emphasis></title>, <volumenum>18</
volumenum>, no. <issuenum>2</issuenum> (<pubdate>2006</pubdate>): <pagenums>97–108</pagenums>.</
bibliomset></bibliomixed>
</bibliolist>
<bibliolist xml:id="s16">
<info xml:id="s17">
<title xml:id="s18">Further reading</title>
</info>
<bibliomixed role="monograph" xml:id="s19"><editor><personname role="last-first"><surname>Byron</
surname><firstname>Michael</firstname></personname></editor>, ed. <title><emphasis
role="italic">Satisficing and Maximizing</emphasis></title> (<address><city>Cambridge</city></address>,
<pubdate>2004</pubdate>).</bibliomixed>
</bibliolist>
<para xml:id="s20" role="see"><emphasis role="italic">See also</emphasis> <link role="xref"
linkend="a3">Consequentialism</link>; <link role="xref" linkend="a16">Maximization</link>; <link
role="xref" linkend="a17">Supererogation</link>.</para>
</section>
</article>
</part>
57
Chunking and high-
level structure
<part xml:id="k1">
<info xml:id="k2">
<title xml:id="k3" role="keepWithNext">The Key Thinkers</title>
</info>
<part xml:id="k4">
<info xml:id="k5">
<title xml:id="k6" outputformat="e-Only">A</title>
<pagenums>160</pagenums>
<biblioid class="doi">10.5040/9781609032229.012</biblioid>
<mediaobject xml:id="b1"><imageobject xml:id="b2"><imagedata fileref="pdfs/9781609032229.012.pdf"
format="application/pdf"/></imageobject></mediaobject>
</info>
<article xml:id="k7">
<info xml:id="k8">
<title xml:id="k9">Louis Althusser</title>
<pagenums>160</pagenums>
<biblioid class="doi">10.5040/9781609032229.013</biblioid>
</info>
<para xml:id="k9a">An Algerian philosopher, Althusser was influenced by Marx as well as the psychoanalysts
Freud and Lacan. ...</para>
</article>
<article xml:id="k10">
<info xml:id="k11">
<title xml:id="k12">J.L. Austin</title>
<pagenums>160</pagenums>
<biblioid class="doi">10.5040/9781609032229.014</biblioid>
</info>
<para xml:id="k13">A British philosopher of language who developed the concept of speech act and its
associated theory. ...</para>
</article>
<article xml:id="k14">
<info xml:id="k15">
58
Chunking and high-
level structure
Points to note:
1. The heading “The Key Thinkers” refers to the entire A-Z division, but happens to be placed at the
beginning of the “A” section. The latter is a chunk, so the parent heading (“The Key Thinkers”)
needs to have a special attribute on its title since it is not serving as a chunk itself.51
2. The “A” chunk doesn’t actually have a heading in the printed book, but it MUST have one in the
data. Because it is not presented in the print edition it MUST have @outputformat=e-Only.
<part xml:id="z1">
<info xml:id="z2">
<title xml:id="z3" outputformat="e-Only">A-Z</title>
</info>
<part xml:id="a">
<info xml:id="a1">
<title xml:id="a2" outputformat="e-Only">A</title>
<pagenums>203–222</pagenums>
<biblioid class="doi">10.5040/9781609032229.010</biblioid>
<mediaobject xml:id="a3">
<imageobject xml:id="a4"><imagedata fileref="pdfs/9781609032229.010.pdf" format="application/pdf"/></
imageobject>
</mediaobject>
</info>
<article xml:id="a5">
<info xml:id="a6">
<title xml:id="a7">verb</title>
<pagenums>203</pagenums>
<biblioid class="doi">10.5040/9781609032229.011</biblioid>
</info>
<para xml:id="a8">Words which relate to actions, occurrences or states of being. Different languages
can modify verb forms according to tense, aspect, mood and voice. Verbs may also need to agree with
the person, gender and number that they refer to. See also <emphasis role="bold"><link role="xref"
linkend="a16">agency</link></emphasis>, <emphasis role="bold"><link role="xref" linkend="a19">ergativity</
link></emphasis>.</para>
</article>
Note also that inline cross references within an A-Z work MUST be linked.52
51
Tested in Schematron: keep-with-next, keep-with-next-pagenums, keep-with-next-mediaobject
52
Tested in Schematron: possible-article-link
59
Chunking and high-
level structure
The dictionary above contains several features that may occasionally be seen:
<article xml:id="dict1">
<info xml:id="qwe1"><title xml:id="qwe2">aoudad sheep</title>
<pagenums>2</pagenums>
<biblioid class="doi">10.5040/9781609032229.045</biblioid>
</info>
<para xml:id="qw3">1. <link role="xref" linkend="a"><emphasis role="smallcaps">Argali sheep</emphasis></
link>. Synonym: <phrase role="synonym"><emphasis role="italic">bearded argali</emphasis></phrase>.
2. Such wild sheep as the bighorn of North America. Also known as <phrase role="synonym"><emphasis
role="italic">barbary sheep</emphasis></phrase>, which predominate in Tunisia, Libya, and Algeria.</para>
</article>
<article xml:id="dict2">
<info xml:id="qwe4"><title xml:id="qwe5">appliqué</title>
<pagenums>2</pagenums>
<biblioid class="doi">10.5040/9781609032229.046</biblioid>
</info>
<para xml:id="qw6"><phrase role="pronunciation">[ap-luh-kay']</phrase> Material that is cut out
and sewn, embriodered, or fastened to a fabric. See <link role="xref" linkend="a1"><emphasis
role="smallcaps">Appliqué lace</emphasis></link>.</para>
60
Chunking and high-
level structure
</article>
(c) Word origins: in this dictionary in round brackets at the beginning of the item:
<article xml:id="dict4">
<info xml:id="qwe10"><title xml:id="qwe11">apret de laine</title>
<pagenums>2</pagenums>
<biblioid class="doi">10.5040/9781609032229.048</biblioid>
</info>
<para xml:id="qw12"><phrase role="origin">(French)</phrase> A soft, permanent finish used for Italian
cloth.</para>
</article>
(d) Article type: In this dictionary a special symbol is used to indicate an archaic word. Rather than
include the symbol in the headword, it is preferable to include a category in the article metadata,
which can then be used by a downstream processor. If this approach is required for a given book a
special instruction will be received from Bloomsbury.
<article xml:id="dict3">
<info xml:id="qwe7"><title xml:id="qwe8">appret guignet</title>
<pagenums>2</pagenums>
<biblioid class="doi">10.5040/9781609032229.047</biblioid>
<bibliomisc role="category">archaic</bibliomisc>
</info>
<para xml:id="qw9">As used in Great Britain, a finish formerly used to waterproof fabrics. The cloth was
soaked in a bath of alumina and iron sulfate. The finish supposedly imparted resistance to rot and mold.</
para>
</article>
Very occasionally, one book may implicitly link to another. This book uses the dagger (†) to indicate
that a fuller definition is available in a companion dictionary. For such cases, the article should
be linked to the target article as well. This will rarely be required, and if it is, Bloomsbury will
61
Chunking and high-
level structure
provide additional instructions. In this example {targetdocid} is the xml:id of the target book, and the
{targetid} is the id of the target article:
More explicit inline linking to other books is available using olink. See Section 15.8, “Links to other
books”.
In this case, the article ‘academic costume’ would follow on directly from the article ‘abstract’:
62
Chunking and high-
level structure
See also Section 26.3, “Embedded articles”, where ‘sub-articles’ may occur anywhere within a parent
article and require the use of a sidebar.
63
Chapter 10. Front matter
‘Front matter’ is here defined as all of that content of the book which typically precedes the content
starting on page 1 (ie all the content that is conventionally numbered within Roman numbers).1
• info
• colophon
• part[@role=’front’]
˚preface[@role=’prelims’]
˚dedication
˚toc
˚acknowledgements
˚preface
˚glossary
˚chapter
The glossary element may not always be in the front matter. Such content may also occur in the
back matter or even within other content chunks.
Introductory chapters MAY occur within the front matter, though it is very unusual for numbered
chapters to do so.4 The most reliable guide as to whether a chunk is to be included in front or not is
whether it has Roman pagination.
All the front matter not included within book/info (see Section 7.1, “The relationship between the
prelims and book metadata” and Section 7.2, “Language metadata”) or colophon(see Section 10.2,
“Colophon”) MUST be contained within a part[@role=’front’]. The front matter content
will variously be derived from material within book/info, as well as any child elements of
part[@role=’front’].
Though each of the child chunks within the front matter container MUST contain key metadata, the
front part container itself MUST NOT contain: pagenums;5 a DOI;6 or a pdf file reference.7
64
Front matter
Implementation note: Such ‘front’ (or ‘back’) part container is included so it is possible to
easily hide the sections in the early part of the book (or the appendices etc) from the ToC, if
necessary, and only reveal the structured ToC for the main parts and chapters.
10.2. Colophon
The only content within the prelims material that does not reside in the book/info should just be
the details of the typesetter and printer. These MUST appear within the colophon, which MUST be
the first element after book/info.9
<colophon>
<para>Typeset by Newgen Imaging Systems Pvt Ltd, Chennai, India</para>
<para>Printed and bound in Great Britain by the MPG Books Group</para>
</colophon>
10.2.1. Impressions
If a book contains information about the impression number on the imprint page, this belongs in
the colophon.10 Such data is typically a string of numbers, the lowest of which is the number of the
current impression:
Consequently, the prelims stub content MUST be located within a preface element with
@role=prelims, and a title with content “Title Pages” and no subtitle,11 MUST
be the first child element of the front matter,12 and MUST contain a remark element with
@condition=hidden as in the example below. The latter is REQUIRED so that the file parses:
9
Tested in Schematron: first-element-after-info
10
Tested in Schematron: colophon-impressions
11
Tested in Schematron : prelims-title, prelims-subtitle
12
Tested in Schematron : first-element-front
65
Front matter
<mediaobject xml:id="b-0017">
<imageobject xml:id="b-0018">
<imagedata fileref="pdfs/9781780930114.0001.pdf" format="application/pdf"/>
</imageobject>
</mediaobject>
</info>
<remark condition="hidden">Note that this is a placeholder for the pdf of the prelims and no full text
content is included at this point</remark>
</preface>
See also Section 7.1, “The relationship between the prelims and book metadata” and Section 14.6, “Conditional
processing with @condition”
All contents lists in the front matter MUST be represented by a toc element (eg for “Lists of
Illustrations”, as well as the “Table of Contents”). It is an ERROR for other container elements to be
used for this content14 (other than tables of cases and statutes etc in legal texts for which a preface is
REQUIRED (see Section 10.5, “Tables of cases and statutes”)).
The table(s) of contents MUST be represented within the XML structure in the toc element(s), and
the target chapter/part numbers MUST NOT be included within the data.15
The only location where a toc MAY occur is within the front matter; if a book appears to require a
toc in any other location, please contact the publisher.16
<toc xml:id="ba-9781849666336-toc-001">
<info xml:id="ba-9781849666336-toc-001a">
<title xml:id="ba-9781849666336-toc-001b"><?page value="vii"?>Contents</title>
<pagenums>vii</pagenums>
<mediaobject xml:id="ba-9781849666336-toc-001c">
<imageobject xml:id="ba-9781849666336-toc-001d">
<imagedata fileref="pdfs/9781849666336.0003.pdf" format="application/pdf"/>
</imageobject>
</mediaobject>
</info>
</toc>
This is because most applications can generate a fully structured table of contents from the data; the
pdf is also included so that the pages of the print edition can correspond with the relevant node in the
data.
Different book style templates may adopt different levels of structure in a table of contents; this is
application-dependent and does not need to be captured in the toc.
However, there are some occasions when it is REQUIRED that the table of contents is modelled in the
data:
66
Front matter
For example, in this book the headings “French”, “Russian” and “German” are not part dividers in
the body of the book and only appear in the table of contents:
The preface element MUST be used with @role=legalContents, the content MUST be in a
variablelist (which may require nesting, as in this example), and the targets MUST be linked:18
17
Tested in Schematron: legal-toc
18
Tested in Schematron: legal-contents, legal-preface, legal-contents-links
67
Front matter
<info xml:id="v-2">
<title xml:id="v-3">Statutory Instruments</title>
<pagenums>vii–x</pagenums>
<mediaobject xml:id="v-4">
<imageobject xml:id="v-5"><imagedata fileref="pdfs/9781609032229.001b.pdf" format="application/pdf"/></
imageobject>
</mediaobject>
</info>
<variablelist xml:id="v-6">
<varlistentry>
<term xml:id="v-7">SR & O 1912/348 Public Trustee</term>
<listitem xml:id="v-9"><para xml:id="v-10">[<link linkend="p13_12" role="xref">13.12</link>]</para></
listitem>
</varlistentry>
<varlistentry>
<term xml:id="v-11">SR & O 1925/857 LRR 192</term>
<listitem xml:id="v-12"><para xml:id="v-13">[<link linkend="p25_09" role="xref">25.09</link>]</para>
<variablelist xml:id="v-14">
<varlistentry>
<term xml:id="v-15">r 14</term>
<listitem xml:id="v-16"><para xml:id="v-17">[<link linkend="p11_45" role="xref">11.45</link>]</para></
listitem>
</varlistentry>
<varlistentry>
<term xml:id="v-18">r 16</term>
<listitem xml:id="v-19"><para xml:id="v-20">[<link linkend="p20_12" role="xref">20.12</link>]</para></
listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</preface>
In some cases, for example where the entry is a cross-reference to another entry in the table, no second
portion present, and the listitem may be left empty:
<varlistentry>
<term>A (A Child) (Rev 1), Re. See A (A Child) (FGM: Appeal), Re</term>
<listitem>
<para/>
</listitem>
19
</varlistentry>
10.6. Dedication
Ref: §1.50
Dedications MAY appear in the front matter, most often on a separate page (usually p. v, sometimes p.
i), though may also appear on the title verso. [How best to indicate location where it occurs, and if not
in front matter (ie in prelims) then where does it live in the data?]
In all but exceptional cases, dedications SHOULD normally be the first element in the
part[@role=’front’].
In Memoriam
19
See Schematron : empty-context.
68
Front matter
1930–1987
<dedication xml:id="id3">
<info><title>In Memoriam</title>
</info><para>Patricia Mary Davis</para>
<para>1930–1987</para>
</dedication>
<dedication xml:id="ded1">
<info xml:id="d1"><title xml:id="e1" outputformat="e-Only">Dedication</title><!-- and other chunk content
--></info>
<para><emphasis role="italic">For My Beloved Wife<?break type="line"?>Angie Ahn</emphasis></para>
<para><emphasis role="italic">To My Former Colleagues at<?break type="line"?>Århus University</emphasis></
para>
</dedication>
Note the additional title and attribute, even though it does not appear on the printed page.
In the rare case where a dedication appears immediately before the back matter, it MUST be
positioned there in the markup, directly within book:20
For backlist books supplied as pdf-only content, only the standard remark content MUST be
included; it is NOT REQUIRED to include the dedication content.21
See also Section 9.2.1, “Chunks with no titles” and Section 14.5, “Column and line breaks”.
10.7. Acknowledgements
Ref: §1.91
<acknowledgements xml:id="b-0000100">
<info>
<title>Acknowledgements</title>
</info>
20
Tested in Schematron : book-level-dedication
21
Tested in Schematron: para-dedication-pdfonly
22
Tested in Schematron: acknowledgements-present
69
Front matter
<para xml:id="b-0000103">This book is the product of around sixteen years of work so there are many people
to thank who have helped along the way. In particular, I am grateful to the small number of people with
whom I have collaborated on cricket-related research over the years: Alan Bairner, Graham Curry, Jon
Gemmell, Nalin Mehta, Matt Parry and Phillipa Velija.</para>
<para xml:id="b-0000104">I would also like to thank John Wiley and Sons for kind permission to reprint
aspects of <link role="bib" linkend="b-0003496">Dominic Malcolm, ‘The Diffusion of Cricket to America:
A Figurational Sociological Examination’, <emphasis role="italic">Journal of Historical Sociology</
emphasis>, June 2006, pp. 151–173</link>; Dominic Malcolm, ‘It's Just Not Cricket: Colonial Legacies and
Contemporary Inequalities’, <emphasis role="italic">Journal of Historical Sociology</emphasis>, September
2001, pp. 253–275, and Taylor & Francis for kind permission to reprint excerpts from Dominic Malcolm,
Jon Gemmell and Nalin Mehta, ‘Cricket and Modernity: International and Interdisciplinary Perspectives on
the Study of the Imperial Game’, <emphasis role="italic">Sport in Society</emphasis>, May 2009, vol. 12,
Issue 4–5.</para>
<para xml:id="b-0000105">Thanks also go to colleagues both at Leicester and Loughborough universities
who have been happy to chat about cricket and who I have mined for ideas over the years, especially
Eric Dunning. Most of all, though, I would particularly like to thank my family who firstly fostered my
fascination with cricket and who subsequently have had to learn to tolerate it.</para>
</acknowledgements>
Acknowledgements sections may end with a sign-off by the author. For examples on how these are to
be marked up see Section 10.9, “Prefaces”.
Glossaries and abbreviation lists SHOULD usually be contained within a glossary. The only
exception to this MAY be where the chunk also contains other more complex structural divisions for
which multiple nested sections may be needed, in which case preface may be most suitable.
Chronology sections in the front matter or elsewhere MUST NOT be contained within a
glossary; the preface element SHOULD normally be used for such content if in the front
matter (or an appendix if in the back matter), normally within a variablelist, or possibly a
table/informaltable for multi-column chronologies. See Section 10.9, “Prefaces” and Section 19.4,
“Variable lists”.
All glossary/abbreviation items MUST be within a glossentry, and each glossentry MUST
have an ID, as described in Section 5.2.4, “IDs for glossary terms”. The formatting of terms and their
definitions (ie italicisation etc) MUST be preserved.
<glossary xml:id="b-001">
<info xml:id="b-0002168">
<title xml:id="b-0003219"><?page value="ix"?>Abbreviations</title>
<pagenums>ix–x</pagenums>
<mediaobject xml:id="b-glossary-001c">
<imageobject xml:id="b-glossary-001d">
<imagedata fileref="pdfs/9781849664554.0004.pdf" format="application/pdf"/>
</imageobject>
</mediaobject>
</info>
<glossentry xml:id="b-0000036">
<glossterm>AARP</glossterm>
<glossdef xml:id="b-0000037">
<para xml:id="b-0000038">American Association of Retired Persons</para>
</glossdef>
</glossentry>
<glossentry xml:id="b-0000039">
<glossterm>AFL-CIO</glossterm>
<glossdef xml:id="b-0000040">
<para xml:id="b-0000041">American Federation of Labor/Congress of Industrial Organizations</para>
</glossdef>
70
Front matter
</glossentry>
If there are headings within the glossary, glossdiv sections MUST be used.
Note also that, for glossary lists with other content (paragraphs and floating headings etc) or if there
is a space between two lists of abbreviations/terms, the lists MUST be in a separate glosslist (see
example below):
<glossary xml:id="id4">
<info>
<title>Abbreviations and Conventions</title>
</info>
<glosslist>
<glossentry xml:id="BṛUB">
<glossterm><emphasis role="italic">Bṛ. UB.</emphasis></glossterm>
<glossdef><para>Bṛhad-āraṇyaka Upaniṣadbhāṣya</para></glossdef>
</glossentry>
<glossentry xml:id="GK">
<glossterm><emphasis role="italic">GK</emphasis></glossterm>
<glossdef><para>Kārikās on the Māṇdūkya Upaniṣad a.k.a. the Gauḍapādīya-kārikā</para></glossdef>
</glossentry>
</glosslist>
<glosslist>
<glossentry xml:id="C">
<glossterm>C.</glossterm>
<glossdef><para>Chinese</para></glossdef>
</glossentry>
<glossentry xml:id="Skt">
<glossterm>Skt.</glossterm>
<glossdef><para>Sanskrit</para></glossdef>
</glossentry>
</glosslist>
Cross references within the body text to terms in the glossary SHOULD be explicitly linked23:
<para>‘Then there is only one way left, viz., to describe It as “Not this, Not this,” by eliminating
all possible specifications of It that have been known’ (<glossterm linkend="BṛUB"><emphasis
role="italic">Bṛ.UB.</emphasis></glossterm> 2.3.6).</para>
However, note that some instances of abbreviations may be in a plural form; these still MUST be
linked:
<para xml:id="b-0000264">The willingness to recognize and acknowledge the complexity of relationships that
extend beyond traditional nuclear family boundaries is an important feature of Adrienne Asch's concept
of ‘parental fitness’, in <link role="xref" linkend="b-chapter-009">Chapter 9</link>. Asch revisits
the idea of licensing parenthood, particularly in relation to the provision of assisted reproductive
technologies (<glossterm linkend="ART">ART</glossterm>s), and argues that parental responsibility, rather
than procreative liberty, is a better criterion upon which to base access to assisted reproduction. The
creation of children via the use of <glossterm linkend="ART">ART</glossterm>s has implications <?page
value="10"?>for the special responsibilities imposed upon parents in this situation, including obligations
of openness about children's origins.</para>
Implementation note: The default DocBook stylesheets render glossterm as italic (at least in
the pdf output). This is WRONG, and the style of the text MUST be preserved.
In those cases where abbreviations are included in the text, but only defined on their first occurrence
(ie there is no glossary or abbreviations list), it is desirable that each subsequent instance of the
abbreviation in the text includes an expansion within an alt element:
23
Bob Stayton ‘Linking to a glossary entry’ DocBook XSL. Sagehill. http://www.sagehill.net/docbookxsl/
LinkToGlossary.html
71
Front matter
10.9. Prefaces
Ref: §1.51
The preface element MUST be used to contain front matter content that does not otherwise belong
in one of the other front matter-type elements (see Section 10.1, “Front matter container”, though note
also that occasionally an introduction MAY occur within the front matter, for which see Section 11.2,
“Introductions”).
Typically a preface will have a title of “Preface”, though a range of other front matter content MAY
be contained within this element, eg:
• A table
• Series preface
• Foreword
<preface xml:id="b-preface-001">
<info>
<title>Globalizing Sport Studies Series Editor's Preface</title>
</info>
<para xml:id="b-0000093">There is now a considerable amount of expertise nationally and internationally
in the social scientific and cultural analysis of sport in relation to the economy and society more
generally. Contemporary research topics, such as sport and social justice, science and technology and
sport, global social movements and sport, sports mega-events, sports participation and engagement and the
role of sport in social development, suggest that sport and social relations need to be understood in non-
Western developing economies, as well as European, North American and other advanced capitalist societies.
The current high global visibility of sport makes this an excellent time to launch a major new book series
that takes sport seriously, and makes this research accessible to a wide readership.</para>
<!--content omitted for clarity -->
<para role="right" xml:id="b-9781474208482-0000099">John Horne, Preston and Edinburgh 2012</para>
</preface>
Occasionally, Prefaces or Forewords may be signed, ie include the author’s name, city, date etc at the
end of the text, which may also be right aligned, as in the example above. [Signed Forewords at top of
page need to have author in info]
The example above shows that it may be permissible to use the para element, when the signature
statement runs on. However, it is PREFERABLE to use address, whether or not a place is actually
mentioned eg:
Note that, in this context, personname does not require a @role or name components within it.
72
Chapter 11. Introductions, chapters,
parts, titles and @labels
11.1. Usage of chapter and part elements
The chapter and part elements are the primary containers for the bulk of the content within any
book.
• The front matter container (see Section 10.1, “Front matter container”)
• Numbered (or occasionally, unnumbered) Part divisions, containing child chapters or other
parts
• Other numbered (or unnumbered) grouping containers within a Part (eg Sections containing
chapters)[include example in the labelling section below, since auto-generated label may be
affected]
• The back matter container (see Section 12.1, “Back matter container”)
• Introductions
• Numbered chapters
• Other content chunks in the body text or back matter for which no other element is appropriate
[OK? Give examples]
11.2. Introductions
Ref: §1.51
The Introduction is a chapter at the beginning of the book, usually titled “Introduction” or
related, and without a chapter number. If an Introduction exists, it will usually be the chapter
on page 1 (Arabic numeration), though occasionally an Introduction may have Roman numerals
and contained within the front matter. In the latter such cases, they MUST be contained within
part[@role=’front’] (see Section 10.1, “Front matter container”).
The title of the Introduction MUST be included within the title exactly as it appears in the
book, and MAY also have a subtitle. Introductions MUST NOT have a @label, unless they are
explicitly numbered as a chapter:
<chapter xml:id="b-0061">
<info>
<title>Introduction</title>
<subtitle>Sociology and its discontents</subtitle>
It is possible that some books may have a numbered chapter with a title “Introduction”. Such items
would be marked up as a regular numbered chapter (see Section 11.3, “Chapter and Part labelling”):
73
Introductions, chapters,
parts, titles and @labels
If there is no number for the content (eg for unnumbered Introductions, see Section 11.2,
“Introductions”), there MUST NOT be a @label on the element.
See also Section 9.2, “Chunk and section titles and numbering”.
Typically, therefore, if a title begins with the words “chapter”, “equation”, “figure” etc that is an error
if there is also a numeric value and a more expansive, descriptive title.3 In addition, the @label
should not start with similar words,4 nor should it – in the context of a nested section – contain a
full point.5
1
Tested in Schematron : one-in-label and related tests
2
Tested in Schematron : xreflabel-not-required
3
Tested in Schematron : check-title, appendix-tests
4
Tested in Schematron : check-label
5
Tested in Schematron : check-label-3
74
Introductions, chapters,
parts, titles and @labels
If non-standard labels are required (eg “Section 1” for a part element), use @role=labelOverRide
and add the entire label content to @label.
See also Section 7.5.11, “Other biblioids”, Section 9.2, “Chunk and section titles and numbering”.
75
Chapter 12. Back matter
The back matter is here defined as containing any or all of the following chunks:
• Afterword
• Conclusion
• Postscript
• Acknowledgements
• Appendix
• Addendum
• Notes
• Bibliography
• Index
In addition, the back matter MAY contain a web-only container for content that appears in print in a
back-of-book CD or other media insert.
Though each of the child chunks within the back matter container MUST contain key metadata, the
back container itself MUST NOT contain: pagenums;1 a DOI;2 or a pdf file reference.3
Element Section
chapter
appendix
glossary Section 10.8, “Glossaries and abbreviations lists”
bibliography Section 16.2, “Bibliography container”
1
Tested in Schematron :no-pagenums-back
2
Tested in Schematron :no-doi-back
3
Tested in Schematron :no-pdf-back
4
Tested in Schematron: back-matter-title
5
Tested in Schematron: back-chunk
76
Back matter
Element Section
Index Chapter 29, Indexes and index terms
If that is the case, there MUST be a container within the back matter that contains links to all the extra
media files. This MUST have an @role=ancillary, and text for the content will be provided by
Bloomsbury.
77
Chapter 13. Multi-volume works
[add details and examples]
78
Chapter 14. Common components
14.1. Paragraphs
[Intro]
Implementation note: para[1] within any block should be full out, and then subsequent ones
should have first line indented as is usual in the printed book.
Block elements within paragraphs or inline elements (such as inlinemediaobject) which are
the only child of a paragraph are generally ERRORS.1 The containing para element is NOT
REQUIRED in such circumstances. Inline elements MUST be replaced with block equivalents and
block elements such as itemizedlist must replace their containing paragraph if they are the only
child element.2
The only occasion when block elements SHOULD appear within a para is when it forms a
grammatical part of the text and typically the following text after the block is full out (see also the
next section):
It would be an ERROR to encode the text starting “which only makes sense” in the preceding
example as a new para. Consequently, a para SHOULD NOT start with a lower case letter, unless it
is part of a list of some sort.4 For example, the following is INCORRECT:
1
Tested in Schematron: convert-inline-to-block
2
Tested in Schematron: para-single-block
3
The single exception to this rule is where a list may be required within an abstract; since abstract has a limited content
model, it is permissible to include a list within a para in this context, though that is likely to be very rare.
4
Tested in Schematron: para-lower-case
79
Common components
place, the present during the murder, and the past afterwards, as it acts as a reminder of the murder that
has happened. The linearity of time is</para>
<?page value="67"?>
<para xml:id="b-9781408174654-0001086">abolished, the materiality of the tapestry is defamiliarised as
Polonius’
place, the present during the murder, and the past afterwards, as it acts as a reminder of the murder that
has happened. The linearity of time is
<?page value="67"?>abolished, the materiality of the tapestry is defamiliarised as Polonius’
(Note the use of the @label on section, see Section 9.2, “Chunk and section titles and numbering”)
However, if a para needs to be full out in another context, use @role with either:
• fullOut
• spaceBefore
The @role=fullOut is simply for when paragraphs must not be indented for whatever reason, yet
have otherwise the same styling as regular paragraphs.
[add examples]
80
Common components
However, @role=spaceBefore is for when the flow of text is broken either by some white space:
in which case we need to add a @role to the para to indicate that it is separated off from the
preceding one:
<section xml:id="s5">
<info xml:id="s6">
<title xml:id="s7">Method</title>
</info>
<para xml:id="s8">The heart of the instructional process is the matching of the predispositions and
expectancies of the child to the demands of the new content. Bruner’s preferred means for achieving that
match are through the process of discovery....</para>
<para xml:id="s9" role="spaceBefore">Bruner cited some evidence produced by his wife and collaborator Carol
Feldman that nicely illustrated the common absence of the hypothetical mode in most classroom contexts.
Feldman had recorded the teacher’s use</para>
A similar example is here, where some text has been omitted by the editor:
81
Common components
<para xml:id="s10">... between two ways of not being a being (<emphasis role="italic">Nichtseiendem</
emphasis>) (<emphasis role="italic">ouk on</emphasis> and <emphasis role="italic">me on</emphasis>) it is,
on the contrary, Schelling who can help Sartre make important distinctions.</para>
<para xml:id="s11" role="spaceBefore">[...]</para>
<para xml:id="s12" role="spaceBefore">Gerhard Seel, in what is currently the best German-language book on
Sartre's philosophy, suggested that Sartre's method be interpreted as dialectical.</para>
However, note that full out paragraphs after blockquotes suggest that the blockquote should be
contained within the paragraph:
as follows:
<para xml:id="s13">It is this joint or shared attention and sensitivity to the meanings and intentions of
others that makes the acquisition of language possible, Bruner argued. Although Bruner was an enthusiastic
supporter of Chomsky’s notion of a generative grammar, a kind of linguistic competence unique to human
beings, Bruner thought Chomsky attributed too much of language learning to an innate grammar. On the basis
of his observations of children he wrote:
<blockquote xml:id="s14">
<para xml:id="s15">What was very soon plain was that mother and child were negotiating their respective
intentions through communication: using whatever conventional means could be brought to bear and inventing
conventions where none had yet been established. The <emphasis role="italic">last</emphasis> thing our
children were doing, it seemed to me, was concentrating on literal utterances, extracting deep rules of
universal grammar from them. And the last thing our mothers seemed concerned about was giving ‘grammar
lessons’. (Bruner 1983a, p. 167; 1983b)</para>
</blockquote>
The pragmatics of language, its use for communication and for elaborating subjectivity, was seen as
primary; acquiring the structure of language was the byproduct of shared meanings.</para>
Occasionally there may be some separator between paragraphs, eg asterisks as in the example below:
82
Common components
<para xml:id="s16">... Vater's conclusion is that Schelling cannot avoid this; but it is only by renouncing
a philosophical enterprise that the Buddhist tradition succeeds.</para>
<para xml:id="s17" role="center">* * *</para>
<para xml:id="s18" role="spaceBefore">The heterogeneity of the articles collected in this volume is
testimony to the diversity and fruitfulness of Schelling's thought ...</para>
Finally, if a paragraph is separated from the main flow of text, often following a title, as here:
<article xml:id="b-9781609032227-e1">
<info xml:id="b-9781609032227-e2">
<title xml:id="b-9781609032227-e3">United States of America</title>
<pagenums>1–26</pagenums>
<biblioid class="doi">10.5040/9781609032227.051</biblioid>
</info>
83
Common components
In short, empty para elements MUST NOT be used to add extra vertical white space between
paragraphs, and filling them with a non-breaking space character isn’t allowed either.5
<formalpara xml:id="b-9781234567890-fp4.03">
<info xml:id="n1">
<title xml:id="n2">4.03</title>
</info>
<para xml:id="n3">By virtue of Article 256 TFEU, the General Court has first-instance jurisdiction over
direct actions brought by <emphasis role="italic">individuals</emphasis> who seek:</para>
<orderedlist xml:id="n4" numeration="loweralpha">
<listitem xml:id="n5"><para xml:id="n6">to challenge the validity of legislative acts and other acts
intended to produce
legal effects <emphasis role="italic">vis-a-vis</emphasis> third parties (Article 263 TFEU);</para></
listitem>
<listitem xml:id="n7"><para xml:id="n8">to review the lawfulness of failures to act on the part of the
institutions of the
Union (Article 265 TFEU)...</para></listitem>
</orderedlist>
</formalpara>
For works other than Case Reports, it is REQUIRED to use predictable IDs for the formalpara since
such texts often have extensive internal cross references that use them (see Section 5.2.6, “IDs for formal
paragraphs”).
Note that the inclusion of other block content is an extension to DocBook; multiple paras are
permissible since they do sometimes occur within a single numbered item.
See also the different style in the following example, where the brackets around the para number
MUST also be retained in the title, and the formalpara would contain both these paragraphs. Note
also the internal links to numbered paragraphsin the footnotes:
5
Tested in Schematron: impermissible-empty-element, only-contains-nbsp
84
Common components
If footnotes occur at the end of the paragraph, a specific @role is REQUIRED. See Section 18.2.3, “End
of paragraph notes”.
Inline emphasis MUST be preserved using the emphasis element. Emphasis on elements such as
title need not be preserved if the emphasis can be predicted from the markup. For example, if
all B-heads are fully italicised then the emphasis MUST NOT be marked up. The @role value is
REQUIRED and MUST take one of the following values:
• italic
• bold
• underline
• line-through
• roman
• monospace
• smallcaps
• larger
• smaller
• sans-serif
85
Common components
• serif
J. Arthur Rank
Similarly,
<emphasis role="smallcaps">weight</emphasis>
WEIGHT
In addition, making all of a title italic, simply to follow the print style is WRONG:7
whereas the following example correctly uses emphasis in a title since the emphasised text are
work titles:
Note that “superscript” and “subscript” are not valid values for @role; use the corresponding
elements instead.8
Implementation note: Only italic and bold appear to work in the current DocBook XSL
The @role attribute MAY occur on a number of elements to provide additional semantic information.
The standard DocBook schema does not mandate any specific usage, though some are implied in the
DocBook XSL tools.
Our approach here is to enforce defined lists of @role values within the local customisation of the
DocBook Publishers schema. If values are implied by the DocBook XSL tools we will use those,
possibly with some extensions; otherwise, we will mandate specific values for @role and when they
are to be used.9
6
Tested in Schematron: smallcaps-test
7
Tested in Schematron: title-not-all-emphasis
8
Tested in Schematron: superscript, subscript
9
Tested in Schematron: test-role-attribute
86
Common components
The following table summarises all such values, and provides cross references to the corresponding
sections elsewhere in this document where their usage is discussed:
87
Common components
88
Common components
89
Common components
architect
buildingType
date
geolocation
material
peoplesCultures
placeRegion
structuralFeature
style
incompleteXref
preface contributors Section 10.3, “Prelims chunk”; [add section on
legalContents contributor]; Section 10.5, “Tables of cases and
prelims statutes”
pubdate published Section 7.5.5, “Publication date”
section bibliography Section 18.2.1, “End of chapter notes”;
exercises-activities Section 9.2, “Chunk and section titles and
labelOverRide numbering”; Section 9.5.3, “More complex
notes article and dummy entry”; Section 9.5.6,
overview-objectives “Article components (dictionary-type content)”
recipe
subArticle
terms
sidebar embeddedArticle Chapter 26, Sidebars; Section 21.6, “Plate
exercises-activities sections”
overview-objectives
plateSection
sidebar1
sidebar2
sidebar3
sidebar4
sidebar5
sidebar6
sidebar7
sidebar8
sidebar9
terms
title keepWithNext Section 7.5.4, “Series”; Section 9.5.4, “Article
series parts and dummy headings”
translation
volumenum series Section 7.5.4, “Series”
a
This value is now deprecated and should not be used. Reported by Schematron stageDirectionDeprecated
90
Common components
<?page value="2"?>
These MUST be inserted where they occur in the text and MUST be sequential; where chunk
elements start a new page, they MUST be inserted at the beginning of the text in the title
element:11
</chapter>
<chapter xml:id="c1" label="2">
<info>
<title><?page value="36"?>The reign of Victoria</title>
</info>
<?page value="36"?></para></chapter>
<chapter xml:id="c1" label="2">
<info>
<title>The reign of Victoria</title>
</info>
Similarly, placing the page break marker within the text of the previous chunk is also WRONG.
It is also an error for a page break to be the first node before an info, and it is usually wrong for it to
immediately follow and info.12
Where page breaks occur between paragraphs or items in a bibliography etc, the marker MUST be
placed between those elements, NOT as the first or last child of one of them:13
Similarly, page break markers must be placed between sections when a section starts a new page;
placing the PI within the section title is WRONG:14
question, nevertheless, remains as to how long microfinance can continue to provide consumption-smoothing
support or extending the payments schedule. To be able to serve as a viable poverty reduction strategy,
micro-credit financed enterprises must expand and create decent jobs for the growing labour force.</para>
10
Tested in Schematron : page-breaks-missing, page-breaks-missing-2, page-break-format
11
Tested in Schematron : page-break-sequence, page-break-pos-1. Page breaks are not permitted as direct children of:
set, book, info, part, mediaobject, imageobject, videoobject, audioobject, primary, secondary, tertiary,
see, seealso, alt, inlinemediaobject, remark, indexterm, itermset, varlistentry, figure, informalfigure
12
Tested in Schematron : info-before-pb, info-after-pb
13
Tested in Schematron : page-break-pos-2, page-break-pos-3
14
Tested in Schematron: pb-section-title
91
Common components
</section>
<?page value="178"?>
<section xml:id="ba-9781849664530-0003700">
<info xml:id="ba-9781849664530-0003701">
<title xml:id="ba-9781849664530-0003702">Concluding Remarks</title>
</info>
<para xml:id="ba-9781849664530-0003703">It is often claimed that the greatest discovery of the Grameen-led
microfinance movement has been the credit worthiness of the poor. Related to this has been the discovery
of the dynamism of Microenterprises. In reality, however, neither is new. The poor have been borrowing
from money lenders (landlords) from time immemorial. Microenterprises have been operating for a long time
in many poor societies, and form the vast informal sector
Furthermore, a sequence of page break markers grouped together is usually WRONG, unless there is
a sequence of blank pages ending a chunk, and page break markers are not permitted as a child of a
footnote.15
Finally, the first and last page number in the page PI MUST match the equivalent values in that
chunk’s pagenums.16
Implementation note: Page break markers may need to have a subtle indicator in the text of
some applications, and also be an anchor point for any page-based navigation that the site will
support.
Page break markers must not be displayed if they occur in title elements (see examples),
though hidden anchors must be retained.
<?break type="column"?>
For multi-column page layouts, this break PI is sufficient since the previous and following page break
markers show the start and end point of the columns. However, for other text presented in columns it
is necessary to use start and end point markers as well:17
<?break type="column-start"?>
<glossentry xml:id="b-0000042">
<glossterm>BBVA</glossterm>
<glossdef xml:id="b-0000043">
<para xml:id="b-0000044">Banco Bilbao Vizcaya Argentaria</para>
</glossdef>
</glossentry>
<glossentry xml:id="b-0000045">
<glossterm>BIEN</glossterm>
<glossdef xml:id="b-0000046">
<para xml:id="b-0000047">Basic Income Earth Network</para>
</glossdef>
</glossentry>
<glossentry xml:id="b-0000048">
<glossterm>CBT</glossterm>
<glossdef xml:id="b-0000049">
<para xml:id="b-0000050">Cognitive behavioural therapy</para>
</glossdef>
</glossentry>
<glossentry xml:id="b-0000051">
<glossterm>CCT</glossterm>
<glossdef xml:id="b-0000052">
15
Tested in Schematron : page-break-sequence, pb-in-footnote
16
Tested in Schematron : page-no-match1, page-no-match1
17
Presence reported in Schematron : columns-present
92
Common components
Line breaks MUST only be used sparingly; ordinarily, if there is a line break in the print layout, it will
be effected by regular markup. However, very rarely, some formatting MAY be necessary to force a
line break other than simply to replicate page layout. In such cases the following PI MUST be used:18
<?break type="line"?>
The break PI MUST contain a type, which MUST be one of the values described above.19
See examples in Section 10.6, “Dedication” and Section 16.2, “Bibliography container”.
[Add section]
18
Presence reported in Schematron : line-break-present
19
Tested in Schematron : break-type, break-typology
20
Presence reported in Schematron : condition-present
93
Common components
The following elements are most likely to require @condition for one of these uses:21
14.7. @outputformat
The @outputformat attribute is available on some elements to control the conditions when its
content is to be used. Typically, this is used for figures where different versions of an image are
supplied for print or web use (see Chapter 21, Figures and images).
In addition, @outputformat may be used for specifying which output formats should display a
chunk title or when a book has only a digital (no-print) manifestation. See Section 9.2.1, “Chunks
with no titles” and Section 7.4, “Digital-only books”.
Or, this attribute may also be used for other content which should only be displayed for a specific
output type. See Section 14.10.5, “Print- or web-only content” and the example in Section 32.14.5, “Print-
specific content”.
The following elements are likely to require @outputformat for one of these uses:22
14.8. Rights
Most of the time rights will have been cleared for all uses of a particular piece of content. However,
if digital rights are not available for an image or data chunk, this can be indicated in the metadata for
that item.
Implementation note: Such content will need to be suppressed for digital usage, perhaps with a
textual indicator to note that something is not present. Not supported in standard DocBook XSL
14.9. Addresses
Address components typically occur in:
21
Tested in Schematron: test-condition-attribute
22
Tested in Schematron: outputformat-attribute
94
Common components
• book/info
• bibliomixed
• chapter/info
• street
• city
• state
• country
• postcode
• pob
• otheraddr
<publisher>
<publishername>Bloomsbury Publishing Plc</publishername>
<address xml:id="b-0000078"><street>50 Bedford Square</street> <city>London</city> <postcode>WC1B 3DP</
postcode> <country>UK</country></address>
This can be where there is an indexterm and no space between, in which case add a space before the
indexterm(if it is added after the indexterm there is a possibility that the wrong page number will
get added when the DocBook autogenerated index is created:
23
Tested in Schematron : bibliomixed-address, country-name-test, address-components
24
Tested in Schematron : possible-missing-space, possible-missing-space2
95
Common components
However, the gravity of the charge and its potential impact on <emphasis role="italic">Prevent</emphasis>‘s
success means that it must be analysed in greater depth, and that is what this chapter attempts to do.
In this case, the apostrophe s has the wrong character; it should be ’ (right single quote) but
we have ‘ (left single quote).
A space is also REQUIRED before an inline bibliolist (see Section 16.16, “Inline bibliographic
references”).
14.10.3. Comments
Though there MAY be a case for including XML comments in a text, as a rule they are to avoided.26
and then individual items within the bibliography have asterisks which are linked back to this text:
Note that the asterisk is not within any of the name components, which is NOT ALLOWED.28
96
Common components
Here, it is desirable to add a ‘print-only’ indicator on the containing member element so that text can
be suppressed online, and also to ensure that the the textual quote is itself a link back to its source
on page 1:
<simplelist>
<member xml:id="a1" outputformat="print"><emphasis role="bold">Page 1</emphasis></member>
<member xml:id="a2"><link linkend="t1">"For as long as I can remember"</link></member>
<member>From acceptance speech for Screen Actors Guild Award for Outstanding Performance by a Male Actor
in a Leading Role (<emphasis role="italic">There Will Be Blood</emphasis>, Daniel Day-Lewis, January 27,
2008.</member>
</simplelist>
Furthermore, on page 1, the actual quote needs to point to the above target in the Textual References:
97
Common components
<chapter>
<info>
<title><phrase role="taxonEnglish">Bullfinch</phrase></title>
<subtitle><phrase role="taxonName">Pyrrhula pyrrhula</phrase></subtitle>
<biblioid class="other" otherclass="taxonRank">species</bibliomisc>
</info>
For further detail and examples see Section 32.17, “Biology and natural history works with taxonomic
content”.30
14.12. Anchors
For the most part, if internal links are required there will normally be a block element that contains a
suitable @xml:id that can form the target. In very rare circumstances, there might not be an element
in the target location, in which case the DocBook anchor element MUST be used. In the following
example, a paragraph is broken by a very long sidebar, and there is text which alerts the reader to
this:
<para>...Trainees are most often recent college graduates and are viewed by <phrase
role="continuation">(continued on <link role="xref" linkend="X"><phrase outputformat=print>page 13</
phrase><phrase outputformat="online">below</phrase></link>)</phrase>
<sidebar>
<info><title>Careers Up Close</title></info>
<!—content omitted for clarity -->
</sidebar>
<?page value=13?>
<anchor id="X"/>the company as potential buyers or managers. Because the competition for department
store training programs is stiff, a bachelor’s degree is necessary, as is a high grade
point average and prior retail experience.</para>
In the print edition of this example, the text within the phrase[@role=continuation] is
displayed as a catchword-type feature, outside of the main flow of the text, so containing it within this
element allows it to be located specially, if required.
Note also the alternatives for print and online usage within the link.
14.13. Notes
The note element MAY be needed in some specialised content, namely legal Case Reports
and annotated legislation. In such content it is used as a container for specific components, and
MUST have a @role.31 Note that, if headings are needed within a note, then the bridgehead
element MUST be used, and for @role=annotations, such bridgehead MUST have
@renderas=sect3.32
For annotated legislation, the note/@role MUST take the value 'annotations'; other values are those
permitted in a Case Report.33
30
Tested in Schematron : taxon-siblings, taxon-rank-check, taxonRank-test
31
Tested in Schematron: note-cases, note-role
32
Tested in Schematron: bridgehead-annotations
33
Tested in Schematron: leg-note, leg-case
98
Common components
See also Section 14.3, “@role attributes”, and examples in Section 32.16.7, “Case Reports” and
Section 32.16.8, “Annotated legislation”.
99
Chapter 15. Cross references and
linking
Ref: §1.79, §1.80, §1.81, §1.82, §1.83, §1.84, §1.85
There are several types of link available in DocBook and it can normally be difficult to determine
which linking element should be used in a given context. Additionally, DocBook 5.0 allows almost
any element to be the source of a link by use of XLink; however, such linking is NOT PERMITTED.
This document takes a simple and consistent approach to linking and specifies how linking elements
MUST be used for Bloomsbury content.
<para xml:id="id0082">Paragraphs can have internal links, which contain <link linkend="c2"
role="xref">inline text</link>.</para>
The link element MUST have either a @linkend OR @xlink:href (for the latter see Section 15.5,
“External links”),1 and MUST have content (ie empty link elements are NOT ALLOWED).2
In addition, for internal links (ie when link[@linkend]), the link MUST also have a @role to
indicate the nature of the link target:3
IMPORTANT: This use of @role is REQUIRED for all new books (though MAY NOT be for data
conversion projects), and to activate it the book’s schematronVersion MUST be set to 2 (or
greater).4 See Section 7.5.11, “Other biblioids”.
Note also that Section 5.2.5, “IDs for bibliographic items” suggests that it MAY be desirable to adopt a
more human-readable form of ID for bibliomixed (or indeed for any often-used link target) if that
makes it easier to resolve the links.
See some examples of links to bibliographic items using this method in Section 16.3.2, “Irregular cross
references”.
100
Cross references and linking
<para xml:id="si31">In <link role="xref" linkend="ch2">Chapter 2</link>, I surveyed the main currents of
Shakespeare criticism from 1904 to the 1970s. One of the most obvious differences between the critics we
looked at in that chapter and the new ...</para>
<para xml:id="sb1">... which is supported by a Higher Education Academy grant (see <link role="xref"
linkend="sb2">Vignette 1</link>). He argues that involving students as co-producers, more properly perhaps
co-participants in teaching, is the route to excellence. It is also much more appropriate to the ‘wicked
problems’ that exist outside Oxford’s dreaming spires: its Fellows may continue to dream while the rest of
the world accelerates into potential nightmares.</para>
Furthermore, note that not all textual references to “chapter 3” may be to the chapter 3 in the current
book. Please check all cross references for context to ensure that the link target implied by the author
is the one in the current book. For example, in this text the chapter references are to the cited work,
though the Appendix is in the current book, so only the short form reference and the Appendix
reference should be links:
An excellent meta-analysis is provided in VLRC (2007), especially chapters 2 and 12, and
Appendix 1.
The span included within the link MUST NOT include unbalanced brackets.5
Furthermore, if a link span includes quotes and brackets, or is particularly long, it is likely that the
span is too long and the wrong component MAY be included.6
In addition, if a name is followed by a date in brackets, it is the date only that MUST be linked:
Note that xref and biblioref, and @endterm7 are NOT TO BE USED.
See also Section 16.3, “Inline citations” for further information on linking to bibliographic items.
Finally, note that links in titles which are only one character long may need to be rendered as a
superscript.8
For a full description and examples see Section 10.8, “Glossaries and abbreviations lists”.
5
Tested in Schematron : unbalanced-brackets-1 and unbalanced-brackets-2
6
Tested in Schematron : suspicious-link-content and long-link-content
7
Tested in Schematron : endterm-present
8
Tested in Schematron : short-link-text
101
Cross references and linking
<para xml:id='b-0017'>A picture captures the point much better than words. Using data provided (generously
for free) by BigChampagne Online Media Measurement, we can graph the average number of p2p users from
August 2002 to October 2006 (see <link role="xref" linkend='b-1023'>pages 112–13</link>). The gray bar
indicates when the Supreme Court decided <emphasis role="italic"> MGM v. Grokster, </emphasis>holding p2p
file sharing to be illegal… </para>
15.4.1. footnoteref
The footnote element generates or includes the actual footnote number/marker that is displayed
in the text. However, if a subsequent reference to the same footnote target is required, this MUST be
achieved using the footnoteref element, the @linkend of which MUST be the ID of the target
footnote element.9
<footnoteref linkend="a1"/>
A @label on footnoteref should not be required, since that will be derived from the footnote
target.10
As the example below illustrates, the link MAY contain text, though normally will contain a web or
email address. When web addresses are included in the text, they MUST also be included within a
uri element12 which must not contain spaces,13 and the @xlink:href MUST be a valid URL14
and include the http:// protocol, even if the URL in the text does not. Email addresses MUST also
be included within an email element, and the @xlink:href MUST have a mailto: prefix15 :
<para xml:id="id0084">The link element must be used for links to external sites, using <emphasis
role="monospace">@xlink:href</emphasis>. The link element can <link xlink:href="http://
www.bloomsbury.com">contain text</link> though normally will contain a URL, as here: <link
9
Tested in Schematron : footnoteref-target
10
Tested in Schematron : footnoteref-label
11
Tested in Schematron : linkend-or-href
12
Tested in Schematron : external-link-content, untagged-url, empty-href
13
Tested in Schematron : uri-spaces
14
Tested in Schematron : whitespace-in-href, uri-check
15
Tested in Schematron : email-tests
102
Cross references and linking
<link xlink:href="http://databank.worldbank.org/data/embed/CountryProfile/id/b450fd57/wd/0/ht/0/tbar/y/dd/
y" xlink:show="embed">
<uri>http://databank.worldbank.org/data/embed/CountryProfile/id/b450fd57/wd/0/ht/0/tbar/y/dd/y</uri>
</link>
The expected rendering here might be to use the URL as the src attribute of an HTML5 iframe.
Note that the relevant URI is still included as the content of the element; this may be suppressed by
the renderer.
Note that where a DOI is present not in a URL form (as in the example above), its textual value
MUST stay the same, but the prefix “http://dx.doi.org/” MUST be added to the @xlink:href.19
For example, here is a reference to one such file with the book body text:
<simplelist xml:id="qw1">
16
See Schematron xlink-testing-4
17
Tested in Schematron : biblio-id-present, biblio-id-format, and patterns: xlink-testing-1, xlink-
testing-2, xlink-testing-3, xlink-testing-4
18
Tested in Schematron: unlinked-doi, external-link-content, untagged-doi
19
Tested in Schematron : doi-href
103
Cross references and linking
These links to files within the data package MUST have @role=relative AND @xlink:href; and
their targets MUST be within one of the directories within the package (images, pdfs, media).20
The @conformance attribute MUST also be present, and its value MUST be the MIME type of the
target file.21 Permissible values are:
Implementation note: This may need an extension to regular link processing to ensure such
links are handled appropriately.
There are two methods available: for inline linking (see this section); and other (implied) links, for
which see Section 9.5.6, “Article components (dictionary-type content)”: Section 9.5.6.2, “Linking to other
books”
The element for such inline links is olink, which MUST only be used for this specific purpose.
Typical cases where this might be required are in reference works, where works may cite material in
other books.
104
Cross references and linking
Occasionally, olink may have @type=glossary, in order to drive presentation of online glossary entries.
Bloomsbury will specify for which books this value MUST be applied.
Implementation note: This is not supported in standard DocBook XSL and will need
downstream support.
See also the example in Section 32.15.2, “Cross references to other books in the series”.
The example below illustrates how a section in the text body can use @linkend to point to a
corresponding section elsewhere in the text, in this case to explicitly link to the bibliographic items
that relate to the section:
105
Cross references and linking
</info>
<bibliolist xml:id="ytre">
<bibliomixed role="monograph" xml:id="k85"><!-- Biblio content here --></bibliomixed>
</bibliolist>
</section>
</section>
Implementation note: This is not supported in standard DocBook XSL and will need
downstream support.
23
Tested in Schematron: test-linkend-attribute
106
Chapter 16. Bibliographies and
components
Ref: §1.56, §1.57
Bibliographies may be divided using bibliodiv elements, which MUST have a title. If the
bibliography is divided up using white space as in this example:
this can be achieved using (preferably) a sequence of bibliolists, or a Processing Instruction (see
Section 14.5, “Column and line breaks”):
<?break type="line"?>
<bibliomixed role="monograph" xml:id="beau-001"><author><personname role="last-first"><surname>Beaumont</
surname> <firstname>Francis</firstname></personname></author> and <author><personname role="last-
first"><surname>Fletcher</surname> <firstname>John</firstname></personname></author>, <title><emphasis
role="italic">The Dramatic Works</emphasis></title>, ed. <editor><personname role="first-
last"><firstname>Fredson</firstname> <surname>Bowers</surname></personname></editor>, 9 vols,
107
Bibliographies and components
Implementation note: Display of bibliodiv titles when they are within info is not
supported in DocBook XSL
The old order has the picks of a hundred rebellions thrust into its hide. (Gouldner 1970: vii)
these MUST be linked using the link element (with @role; see Section 15.1, “Simple internal links”):
<para>The old order has the picks of a hundred rebellions thrust into its hide. (<link role="bib"
linkend="b-0003692">Gouldner 1970</link>: vii)</para>
The target MUST be the bibliomixed.2 It is an ERROR for the target to be one of the child
elements of bibliomixed.3
Here is another standard short form reference in the form “Surname YYYY”:
The bibliographic item itself (ie the target of the short form reference) would be marked as follows:
1
Tested in Schematron: bibliomixed-referenced, unlinked-bibliomixed-count. If no biblio items in the book are
cross referenced at all, these tests can be switched off with the allBiblioItemsUnlinked flag. See Section 7.5.11, “Other
biblioids”.
2
Tested in Schematron: link-target-bibliomixed
3
Tested in Schematron: link-target-title
108
Bibliographies and components
<footnote xml:id="fn1"><para xml:id="fn2">The Star and Garter Club in London also played a key role in the
foundation of horse racing’s Jockey Club (<link role="bib" linkend="bir">Birley 1999</link>: 31).</para></
footnote>
11 See discussion of income differences in the United States in Paul Krugman, The Conscience of a
Liberal, W.W. Norton and Company, New York, 2009 and 2007, Chapter 1.
Such short form cross references MUST NOT be included within a bibliomixed.4 For example, the
following is WRONG:
Note also that note content of the form “See ...” may well be followed by material that needs to be
linked or converted to a full bibliographic reference. In addition, references to “Chapter” etc may
also need to be linked to targets elsewhere in the current book, though as the example above shows
that care MUST be taken in doing so since the context is important and the text may be pointing
to a different book entirely.5 Such cross references are NOT REQUIRED in works of fiction (see
Section 7.5.11, “Other biblioids”).
<footnote xml:id="bai"><para xml:id="bai1">This chapter builds on prior collaborative work with Alan
Bairner. I am grateful to him for allowing me to draw on ideas we discussed in previous conference papers
(eg <link role="bib" linkend="bi1">Bairner <emphasis role="italic">et al.</emphasis> 2007</link>). Any
errors in the current analysis are of course my own.</para></footnote>
See also Section 16.3.2, “Irregular cross references”, and further examples in Section 32.5.1, “Short-form
bibliographic references”.
4
Tested in Schematron: short-biblio
5
Tested in Schematron: possible-chapter-link, possible-appendix-link
109
Bibliographies and components
In addition, see Section 32.5.2, “Same work in multiple bibliomixeds” for an example where the same
work may appear multiple times in bibliographies in a book, so it is important that each cross
reference points to the correct target instance.
A number of excellent introductory texts on the work of Norbert Elias have already been
published. Central among them are Stephen Mennell’s seminal Norbert Elias: an Introduction
(1998); Richard Kilminster’s pathbreaking The Sociological Revolution (1998) and Norbert Elias:
Post-Philosophical Sociology (2007);
these MUST be cross referenced using a link around the date to the expanded form in the
bibliography (or elsewhere):
<para xml:id="b-0000055">A number of excellent introductory texts on the work of Norbert Elias have already
been published. Central among them are Stephen Mennell’s seminal <emphasis role="italic">Norbert Elias:
an Introduction</emphasis> (<link role="bib" linkend="b-0003857">1998</link>); Richard Kilminster's
path-breaking <emphasis role="italic">The Sociological Revolution</emphasis> (<link role="bib"
linkend="b-0003738">1998</link>) and <emphasis role="italic">Norbert Elias: Post-Philosophical Sociology</
emphasis> (<link role="bib" linkend="b-0003748">2007</link>);
Note also the placement of the link container elements; link elements MUST NOT straddle one of
a pair of brackets6 , so here only the year MUST be within the link element:
Major (2007: 42) concludes, ‘a rough and tumble, or an illegal affray, was a frequent
accompaniment to a competitive game or an unsettled bet, and in a violent age that may have
been an added attraction’.
If this reference had been of the form “Major (2007) concludes...”, then the string “2007” would have
been within the link.
6
Tested in Schematron: unbalanced-brackets-1; unbalanced-brackets-2
110
Bibliographies and components
In 1970, a highly influential book by Alvin Gouldner was published with the title, The Coming
Crisis of Western Sociology. Gouldner’s central thesis in that book was that America was then in
the throes of a multi-layered rebellion in which the black civil rights movement, the women’s
movement, and protest against the Vietnam War were central. It was a rebellion mainly of
younger people which spread widely through the West, with university campuses forming
major sites of resistance to the status quo. In such a context, Gouldner argued rhetorically that:
Social theorists today work within a crumbling social matrix of paralyzed urban centers and
battered campuses. Some may put cotton in their ears, but their bodies still feel the shock
waves. It is no exaggeration to say that we theorize today within the sound of guns. The old
order has the picks of a hundred rebellions thrust into its hide. (Gouldner 1970: vii)
In such a context, Gouldner maintained, sociologists were becoming increasingly drawn into
‘the coalescing military-industrial-welfare complex’ with the consequence that it was becoming
‘unthinkingly evident that sociology has become dangerously dependent on the very world
it has pledged to study objectively’ (1970: 511). In short, sociologists were being increasingly
incorporated into the status quo and used as instruments of management and social control.
They were, Gouldner proposed, producing ‘interested’ accounts of the social world and, in that
way, becoming both part of the problem and of the forthcoming sociological crisis as Gouldner
envisaged it. His solution was to call for the development of a ‘radical’ and ‘reflexive’ sociology
practised by self-aware and critical sociologists dedicated to gathering knowledge which could
be used in ushering in a new era.
The full title of the book does not need to be linked to the bibliography. The two others (“Gouldner
1970” and “1970: 511”) MUST be linked, using link.
Full bibliographic citations tend to occur at the end of chapters or at the back of books.
These MUST use bibliomixed as their container, ie biblioentry is NOT PERMITTED. The
content of the bibliomixed element MUST represent the appearance of the content in the original
text as far as possible. All formatting, spacing and punctuation MUST be present in the marked up
text, as far as is possible with the content model. For example, there MUST be a space between the
word “in” and the following element:7
And there MUST be space between successive contributors,8 between an author/editor and a
following title9 or a following opening bracket.10 Similarly, beware of missing spaces before, or
brackets immediately following an address,11 and a space before a title12 or publishername.13
7
Tested in Schematron: space-before-bibliomset-required
8
Tested in Schematron: bibliomixed-successive-contributors
9
Tested in Schematron: author-title-space
10
Tested in Schematron: name-bracket
11
Tested in Schematron: no-space-before-address, bracket-following-address, bibliomixed-address-space
111
Bibliographies and components
The only elements which can’t take PCDATA content (and hence have punctuation and spacing
controlled by the downstream processing) are:
The components of the bibliographic reference MUST be marked up using the correct semantic
elements.
Numerous examples are included below, and draw on the usage for @relation specified on the
DocBook wiki and ISO 690.15
16.4.1. Language
If a bibliographic entry is not in English, the language MUST be marked up using the @xml:lang
attribute.
16.4.2. @xml:id
All bibliomixed items MUST have an id.
16.4.3. @role
All bibliomixed MUST have a @role. This indicates the type of bibliographic item it is, and can
take one of the following values:
Value Usage
monograph All books, where the citation is to the complete
book
serial Journals and magazines, where the reference is to
the title only (eg for references to a complete issue
or volume, rather than a specific item therein)
contribution A chapter or other contribution to a monograph
article An article of other contribution in a serial
message An email message
website Content on a website
12
Tested in Schematron: no-space-before-title
13
Tested in Schematron: bibliomixed-publishername-space
14
Tested in Schematron: xreflabel-not-required
15
Jana Dvoráková. ‘Bibliography according to ISO 690 and ISO 690-2 standards.’ 8 March 2012. DocBook wiki. http://
wiki.docbook.org/ISO690Bibliography?action=AttachFile&do=view&target=doc.html#d4e309 (includes
numerous examples)
112
Bibliographies and components
Value Usage
unpublished Material that is otherwise unpublished (eg from
an archive, or a thesis)
case A legal case (eg in the form Smith v. Jones, 1994)
legislation A statute, regulation, directive, treaty or similar
legal instrument
other Any other type of cited material. See Section 16.15,
“Other items”
which will result in the output stylesheet adding a comma+space after the surname.
Therefore, it is very important that the order of the name components in personname exactly
follows that in the original print. It is an ERROR for name components to be the direct children of
bibliomixed or bibliomset; they MUST occur within a personname.18
Note that, except in very unusual circumstances, any bibliographic list (bibliography, bibliodiv
or bibliolist) SHOULD have the same personname @role style for the first-named person in all
items.19 (See example and XPaths for testing this in Section 32.6.1, “Inconsistent biblio style”)
16
Tested in Schematron: first-last-1, first-last-2
17
Tested in Schematron: last-first-1
18
Tested in Schematron: bibliomixed-name
19
Tested in Schematron: mixed-personname-style
20
Tested in Schematron: untagged-month
113
Bibliographies and components
Description: Possible untagged content in biblio item. percent = 31.606217616580310881% [untagged content =
(). (Publications of the American Dialect Society, 84). : .] untaggedLength = 61; total = 193
If untagged content is just punctuation and strings like “ed.” etc, these can be ignored, but it is very
desirable that the other content has some markup.
If these warnings occur, it can also reveal instances of biblio items that are generally incorrectly
marked up, anyway.
Typical content and elements for this untagged content is given in the table below:
bibliomisc[@role="description"]
<bibliomixed role="article"
xml:id="b-0001592"><bibliomset
relation="article"><author><personname role="last-
first"><surname>Labov</surname><firstname
role="initials">W.</firstname></personname></
author> (<pubdate>1963</pubdate>). “<title
xml:id="b-0001593">The social motivation of
a sound change</title>.”</bibliomset>
<bibliomset relation="journal"><title
xml:id="b-0001594"><emphasis role="italic">Word</
emphasis></title>, <volumenum>19</
volumenum>, <pagenums>273–309</
pagenums>. Reprinted in W. Labov (<link
linkend="ba-9781472541673-0001607">1972b</link>).</
bibliomset></bibliomixed>
bibliomisc[@role="description"]
<bibliomixed role="monograph"
xml:id="b-0001788"><author><personname role="last-
21
Tested in Schematron: untagged-biblio-content
114
Bibliographies and components
Orgname
<bibliomixed role="article"
xml:id="ba-9781472555564-0000649"><bibliomset
relation="article"
xml:id="ba-9781472555564-0000650"><author><personname
role="last-first"><surname>Ashizu</
surname><firstname>Kaori</firstname></personname></
author> (<pubdate>1995</pubdate>), ‘<title
xml:id="ba-9781472555564-0000651">Kurosawa’s
<emphasis role="italic">Hamlet</
emphasis>?</title>’</bibliomset>.
<bibliomset relation="journal"><title
xml:id="ba-9781472555564-0000652"><emphasis
role="italic">Shakespeare Studies</emphasis></
title>, Shakespeare Society of Japan,
<volumenum>33</volumenum>, <pagenums>71–99</
pagenums>.</bibliomset></bibliomixed>
16.7. Books
16.7.1. Single author book
Books (as opposed to chapters in books) have @role=monograph. They MUST have a title and
an author/editor.22 Note that, if the title is rendered in italic, an emphasis MUST be present and
typically that includes all of the title content.23
Note also in this example that the pubdate belongs around the date of the edition cited, not the
original date of publication:
Formally published items (including books, journals, newspapers etc) MUST have a pubdate.24
22
Tested in Schematron: monograph-title, monograph-authors, and more generally in bibliomixed-author
23
Tested in Schematron: title-emphasis
24
Tested in Schematron: bibliomixed-pubdate, bibliomixed-multiple-pubdate
115
Bibliographies and components
If a bibliomixed item does not have a publishername or address and occurs in a footnote or
other inline location, it is possible that it is not a full biblio reference and should be a link to the full
reference elsewhere in the document.25 See also Section 16.3.2, “Irregular cross references”.
A ‘monograph’ will never need a child bibliomset;26 if a bibliomset is REQUIRED and the item
is a book, it is most likely to be a Section 16.7.4, “Chapter in edited book”.
In any bibliographic reference, a title should never contain an author, publishername, pubdate
etc.27
A @role=monograph is for the book as a whole (as in the example above). If a component of the
book is cited use the form in the following example.30
25
Tested in Schematron: possible-short-form-ref
26
Tested in Schematron: mono-book
27
Tested in Schematron: bad-title-content
28
Tested in Schematron: bibliomixed-authorgroup
29
Tested in Schematron: bibliomixed-successive-authors, bibliomixed-successive-editors
30
Tested in Schematron: mono-not-article, mono-not-journal
31
Tested in Schematron: contribution-not-article, contribution-not-journal, contribution-
partcontribution-book
32
Tested in Schematron: part-author, part-editor
33
Tested in Schematron: book-contribution, part-contribution
116
Bibliographies and components
Generally, a bibliomset MUST contain a title,34 and MUST NOT contain another bibliomset
itself.35 Where bibliomsets occur they tend to be in pairs.36 Note also that, if the book title is
rendered in italic, an emphasis MUST be present and typically that includes all of the title
content.37
The use of the word “in” is a good indicator that the first part of the item is a component of a larger
work and suggests that a bibliomset is REQUIRED.38 Furthermore, when any bibliomixed
contains bibliomset, all the other elements should be within a bibliomset; it is almost inconceivable
that any other bibliographic components would be siblings of a bibliomset (see also examples in
Section 32.6.3, “Sibling elements of bibliomset”).39
Note that any quotes surrounding a chapter/part title MUST be outside the title:40
But note that sometimes it is legitimate to have quotes within a title or subtitle:
Note that this is a revised edition, which is therefore substantively different from a reprint, so the
revised date is the pubdate. Compare the situation with a Section 16.7.13, “Reprint” below.
34
Tested in Schematron: bibliomset-title
35
Tested in Schematron: nested-bibliomset
36
Tested in Schematron: single-bibliomset
37
Tested in Schematron: title-emphasis
38
Tested in Schematron: in-sans-bibliomset
39
Tested in Schematron: element-not-bibliomset
40
Tested in Schematron: bib-title-start-quote, bib-title-end-quote
117
Bibliographies and components
Note that volumenum contains just the volume number, not the text “vol.” etc.41
Note also that “et al.” MUST NOT be captured within one of the name elements.43
However, if the translator is not marked up with name components, it MUST just be text within the
bibliomixed (or bibliomset).44 It is an ERROR to include the translator in other content:
118
Bibliographies and components
case, the author details MUST be added in with @condition=hidden, and the long dashes included
within phrase[@condition=display]:
or, (b) where there is a list of works by a named individual (eg the subject of the book etc) and the
editorial style in the book is to omit the repetition of the author’s name. For example, in this list of
“Works by Brecht”:
See also Section 14.6, “Conditional processing with @condition”, and the example in Section 32.15.3,
“Implied authors in bibliographies”.
Joel Schechter, ‘Beyond Brecht: New Authors, New Spectators’. In Fuegi et al., Beyond Brecht,
op.cit., pp. 43–53
Vittorio Felaco, ‘New Teeth for an Old Shark’. In John Fuegi et al. (eds.), Beyond Brecht: Brecht
Yearbook, vol. 11, 1982, Detroit, Wayne State University Press, 1983, pp. 57–71
Then, in the former we need to include text for display as well as the more detailed bibliographic data
that needs to be hidden for use in the creation of an OpenURL query by a downstream processor. As
elsewhere, this is achieved using @condition:
45
Tested in Schematron: op-cit-present, ibid-present, loc-cit-present
119
Bibliographies and components
Note that the pagination in this example is outside the hidden bibliomset, since it is displayed to
all users.
See also Section 14.6, “Conditional processing with @condition” and Section 18.1.4, “Ibids, loc cits and op cits
in footnotes”
16.7.13. Reprint
For works that are marked as a reprint, rather than a different edition, the original publication date is
best marked with pubdate and the reprint date can be left untagged (or tagged with date):
Compare this with the example of a revised edition above (Section 16.7.5, “Multiple editions”).
120
Bibliographies and components
Then, subsequent items from the collected works are cited with an author name, so an implied
name MUST be added, and the individual volume bibliographic details are given for both
the original language edition, and an English translation, so this is a rare occasion when other
bibliomset[@relation] values are REQUIRED:47
It is rare for a biblio item to have more than one publishername, though if this example had
included the publisher name of the original language edition it would have been permissible.
Ordinarily, though, multiple publishername is an ERROR.48
16.8. Journals
16.8.1. Journal issue
If a journal issue is cited, there will not be an author,49 so the @role MUST be set to serial:
47
This and the follow example are reported in Schematron: other-editions-etc
48
Tested in Schematron: bibliomixed-multiple-publishername
49
Tested in Schematron: serial-author
121
Bibliographies and components
Note that no child bibliomset is required in this instance.50 In addition, if the jounal title is
rendered in italic, an emphasis MUST be present and typically that includes all of the title
content.51
Note that the volumenum and issuenum MUST surround the number only, and not include text55
and that, if the journal title is rendered in italic, an emphasis MUST be present and typically that
includes all of the title content.56 In addition, any quotes surrounding an article title MUST be
outside the title (see example in Section 16.7.4, “Chapter in edited book” above).57
It is also very unlikely that a journal article item will contain a publishername; if such occurs, it is
likely an ERROR.58
122
Bibliographies and components
16.8.3.2. Magazine
Treated exactly as an academic journal, though here there is a full date:
60
Tested in Schematron: bibliomixed-other-test
123
Bibliographies and components
16.9. Unpublished
The number of “unpublished” and “other” bibliomixed items is usually relatively small, so if a
large proportion of them are so tagged it suggests that many of them may be mis-categorised.61 The
word “unpublished” in a bibliomixed can be a useful clue for some of them.62
Note also the use of orgname rather than publishername,63 and date rather than pubdate.
16.9.1. Thesis
Note the use of date, rather than pubdate, and the presence of the text “PhD”:64
16.9.3. Interviews
Unpublished interviews may also appear in a bibliography.66 Note that these too have a date rather
than pubdate, and use bibliomisc[@role=description] for the general contextual details.
61
Tested in Schematron: proportion-unpublished-other
62
Tested in Schematron: possible-unpublished
63
Tested in Schematron: unpublished-publishername
64
Tested in Schematron: unpublished-pubdate, possible-unpublished-2
65
Tested in Schematron: possible-unpublished-3
66
Tested in Schematron: possible-unpublished-4
67
Tested in Schematron: confgroup-present
124
Bibliographies and components
Note that there are two confgroup wrappers in there because confgroup does not allow text as a
direct child node.68
Finally, here is confgroup used for minutes of a meeting, and note also that it uses biblioid for the
document reference number (which would also be used for documents from archives):
Implementation note: conftitle and related elements are not handled in the DocBook XSL
Smith, J. Re: Biodiversity management. [email] Message to Brown, J. Sent 12 January 2013.
Note that this can be distinguished from a book online (@role=monograph) since it just has an
article title (in single quotes in this case) and no other title.
68
Tested in Schematron: possible-conference, which identifies conference-like words in a title
69
Tested in Schematron: possible-message, biblio-message
70
Tested in Schematron: accessed-date, possible-access-date
71
Tested in Schematron: possible-missing-space3
125
Bibliographies and components
Here is a slightly longer one, with the website name marked with publishername:
16.11.3. Music
This particular example is from a web source so can be treated as any other web resource:
For legal items in a bibliography, ie cases, statutes etc, the bibliomixed element MUST be used. The
@role attribute must be set to an appropriate value from the list below:
1. case
2. legislation
An item marked “legislation” includes statutes, Acts, treaties, EU Directives, Regulations, Orders
and any other statutory instrument.
Within a legal citation, only light markup of the component parts is REQUIRED, at most a title, date
and some reference number, and possibly a URL. It is normally unlikely that they contain an author.
In most books it is unlikely that there will be many legal references, so a high proportion of them can
suggest that some items may be incorrectly marked up.73
16.12.1. Cases
<bibliomixed xml:id="bibl27a" role="case"><title><emphasis role="italic">Leeds Teaching Hospital NHS Trust
v A and B</emphasis></title> [<date>2003</date>] <bibliomisc role="legalRef">1 FLR 412</bibliomisc>.</
bibliomixed>
72
Tested in Schematron: bibliomixed-website
73
Tested in Schematron: proportion-case-legislation
126
Bibliographies and components
The bibliomisc[@role=legalRef] is a general container for any identifier, and could even
contain the relevant court:
Note that, though most cases have a “v” within them, some may begin “Re”:
<bibliomixed xml:id="bibl27h" role="legislation"><title>Value Added Tax (Buildings and Land) Order 2010</
title>, <bibliomisc role="legalRef">SI 2010/485, art 4(2)</bibliomisc></bibliomixed>
This EU Directive reference doesn’t obviously have a title,76 so only the reference number has been
tagged:
A legislation item can also include such things as Agreements, Treaties, etc:77
74
Tested in Schematron: legalref-present
75
Tested in Schematron: v-present, biblioentry-collab-vs and related tests
76
Presence of titles in non-legal items tested in Schematron: non-legal-biblio-title
77
Tested in Schematron: possible-legislation
127
Bibliographies and components
Or, additionally:
16.13. Recordings
A recording MUST take @role=recording, and the artist encoded using
othercredit[@otherclass=artist] (ie NOT author) (and not that orgname is used for
bands). It should also contain a date and title:78
16.14. Films
A film MUST take @role=film, and MUST include a title and MAY include a date:79
78
Tested in Schematron: artist-required, recording-date, recording-title, poss-recording
79
Tested in Schematron: film-date, film-title, poss-film
80
Tested in Schematron: bibliomixed-other-test
81
Tested in Schematron: bibliomixed-other-issue1, bibliomixed-other-issue2
128
Bibliographies and components
16.15.3. DVDs
Note how the performers’ names don’t need to be marked up and that bibliomisc is used for many of
the components:
which includes some complexity, and it is worth reviewing the markup in detail:
<para xml:id="b-9012785">For selections from these and other earlier critical responses, see <bibliolist
xml:id="b-9002785" role="inline"><bibliomixed role="monograph" xml:id="b-9002752"><editor><personname
role="first-last"><firstname>Brian</firstname> <surname>Vickers</surname></personname></editor>
(ed.), <title><emphasis role="italic">Shakespeare: The Critical Heritage</emphasis></title> 6 vols
(<publishername>Routledge</publishername>, <pubdate>1976-96</pubdate>); </bibliomixed> <bibliomixed
129
Bibliographies and components
Points to note:
• Not all items have enough components to require bibliographic markup (the three examples are
book series, not individual titles)
However, if there is a separate bibliography, either in the back of the book or at the end of the chapter,
items mentioned in the text MUST be linked to them rather than being encoded inline. For example,
the following is WRONG:
<para xml:id="id0199">John Gielgud, who praised Stanislavski’s ‘practical wisdom’ in his preface to
<bibliolist role="inline" xml:id="g5"><bibliomixed xml:id="hg6" role="monograph"><author><personname
role="first-last"><firstname>Sonia</firstname> <surname>Moore</surname></personname></author>’s
<title><emphasis role="italic">The Stanislavski System</emphasis></title> (<publishername>Viking
Press</publishername>, <pubdate>1965</pubdate>); and </bibliomixed> <bibliomixed xml:id="d4"
role="monograph"><author><personname role="first-last"><firstname>Michael</firstname> <surname>Redgrave</
surname></personname></author>, who called himself ‘a disciple of Stanislavsky’ in his autobiography
(<title><emphasis role="italic">In My Mind’s Eye</emphasis></title>, <publishername>Weidenfeld &
Nicolson</publishername>, <pubdate>1983</pubdate>)</bibliomixed></bibliolist>.</para>
<para xml:id="id0199">John Gielgud, who praised Stanislavski’s ‘practical wisdom’ in his preface to Sonia
Moore’s <link role="bib" linkend="bibl11"><emphasis role="italic">The Stanislavski System</emphasis></
link> (Viking Press, 1965); and Michael Redgrave, who called himself ‘a disciple of Stanislavsky’ in his
autobiography (<link role="bib" linkend="bibl12"><emphasis role="italic">In My Mind’s Eye</emphasis></
link>, Weidenfeld & Nicolson, 1983).</para>
82
Tested in Schematron: inline-bibliolist
130
Bibliographies and components
It is also an ERROR for there to be punctuation at the end of the last bibliomixed AND for the text
after the bibliolist to start with punctuation.83
Furthermore, an inline bibliolist MUST have a space between it and any preceding word.84 The
following is an ERROR:
The expanded form MUST be included within the bibliomixed as well as the displayed form, each
with a different @condition:
this REQUIRES that the entire bibliography in which this occurs be within a general container
element (eg chapter and sections) and the bibliographic references contained within
bibliolist/bibliomixed, so that they can be interleaved with paras:
83
Tested in Schematron: bibliomixed-punc
84
Tested in Schematron: possible-missing-space4
131
Bibliographies and components
<section xml:id="ba4">
<info xml:id="ba5">
<title xml:id="ba6">Further Reading</title>
</info>
<bibliolist xml:id="bl2">
<bibliomixed role="monograph" xml:id="ba7"><author><personname role="last-first"><surname>Abbott</
surname> <firstname>H. P.</firstname></personname></author> (<pubdate>1973</pubdate>), <title><emphasis
role="italic">The Fiction of Samuel Beckett: Form and Effect</emphasis></title>. <address><city>Berkeley</
city></address>: <publishername>University of California Press</publishername>.</bibliomixed>
</bibliolist>
<para xml:id="bl3">Abbott’s introduction to Beckett’s prose ranges from the early fiction through the
major novels: <emphasis role="italic">Murphy</emphasis>, <emphasis role="italic">Watt</emphasis>,
<emphasis role="italic">Molloy</emphasis>, <emphasis role="italic">Malone Dies</emphasis>, <emphasis
role="italic">The Unnamable</emphasis>, <emphasis role="italic">How It Is</emphasis>. He also gives
important attention to <emphasis role="italic">Texts for Nothing</emphasis> and the neglected <emphasis
role="italic">Mercier and Camier</emphasis>. An analysis of what Abbott calls ‘imitative form’, the book
looks at how the form of the fiction works particular effects on the reader.</para>
• publisher: This element does not permit PCDATA between components, so use publishername
etc directly where needed;86
85
Tested in Schematron: bibliomixed-biblioid
86
Tested in Schematron: bibliomixed-publisher
132
Chapter 17. Names
Ref: §1.92, §1.93, §1.94, §1.95
It is not necessary to mark up person or organisation names within paragraph text. Names MUST
be correctly marked up when they occur within structured content such as front material and
bibliographic entries.1 The names of people must be marked up using the personname element. The
names of organisations must be marked up using the orgname element.
Personal name must be marked up using the structured field variant of the personname element.
That is, it may only have element children, not text. A personname MUST also have a @role.2
The orgname element has no internal structure and must contain text only.
This will ensure that the regular tests for stops in bibliographies are switched off, and a few others
applied instead.3
This can also take the value ‘initials-with-stops’, though that is the assumed default value.
Name Markup
John Smith <personname role="first-last" ><firstname>John</
firstname> <surname>Smith</surname></personname>
Mr. John Smith <personname role="first-last" ><honorific>Mr.
</honorific> <firstname>John</firstname>
<surname>Smith</surname></personname>
J. Smith <personname role="first-last" >< first name
role='initials'>J </othername> <surname>Smith</
surname></personname>
John Robert Smith <personname role="first-last" ><firstname>John</
firstname> <othername role='middle'>Robert</
othername> <surname>Smith</surname></personname>
John R. Smith <personname role="first-last" ><firstname>John</
firstname> <othername role='middle-initials'>R </
othername> <surname>Smith</surname> </personname>
1
Tested in Schematron: personname-components
2
Tested in Schematron: personname-role-present
3
Tested in Schematron: biblioType-test; firstname-one-char-2; firstname-stop-3; firstname-stop-4
133
Names
Name Markup
The Honourable J.R. Smith the <personname role="first-last" > <honorific>The
Third Honourable</honorific> < first name
role='initials'>J. R </othername>
<surname>Smith</surname> <lineage>the Third</
lineage></personname>
Mitford, Rev. J. <personname role="last-first"><surname>Mitford</
surname> <honorific>Rev.</honorific> <firstname
role="initials">J.</firstname></personname>
W.N. Price, Jr <personname role="first-last"><firstname
role="initials">W.N.</firstname> <surname>Price</
surname> <lineage role="comma-before" >Jr</
lineage></personname>
John K. Smith III <personname role="first- last"><firstname >
John </firstname> < other name role=" middle-
initials"> K. </firstname> <surname> Smith </
surname> <lineage> III </lineage></personname>
The values that may be used in the @role attributes of the various name elements are:
134
Names
Spaces within a firstname normally suggest that there are multiple name components that should
be marked up separately.5
Double-barrelled surnames MUST be included within a single surname; full stops are rarely allowed
in surnames;8 and multiple surnames within a personname is an ERROR.9
Furthermore, it is unusual for a personname ONLY to contain a surname;10 if that is the case, it is
likely that the item may be a short form reference that simply needs to be a link to the full reference
elsewhere. Usually, only ancient authors (eg “Plato” and “Aristotle”) havea single name, which
MUST be contained within surname (even though it is semantically incorrect).
It is an ERROR for a single character or full stops to occur within such elements without the @role,
and there MUST NOT be an additional stop in untagged text after the name,12 ie the following is
WRONG (but see also Section 17.1, “Initials in biblio names”):
Surname1, Firstname1, surname2, firstname2, and surname3, firstname3 (2002) ‘article title’ in
surname4, firstname4 and firstname5 and surname5 (eds.) Book Title, Place: Publisher
In such cases it can be hard to programmatically determine which is the surname and which the
firstname(see examples in Section 32.6.2, “Firstname/surname issues”).13
4
Tested in Schematron: givenname-not-allowed
5
Tested in Schematron: space-firstname
6
Tested in Schematron: name-initials
7
Tested in Schematron: stop-firstname, comma-firstname
8
Tested in Schematron: surname-with-stop
9
Tested in Schematron: multiple-surnames
10
Tested in Schematron: surname-only
11
Tested in Schematron: firstname-one-char, firstname-stop
12
Tested in Schematron: firstname-stop-2
13
Tested in Schematron: surname-is-firstname
135
Names
The honorific element typically includes such content preceding the name such as “Sir” or for
other designations after the name;15 it is very unusual for it to include “Dr” or other academic titles
on the title pages of academic books. The example below shows a honorific after the name:
<personname role="first-last">
<firstname>Arthur</firstname>
<surname>Madigan</surname>
<honorific>S.J.</honorific>
</personname>
14
Tested in Schematron: jr-present, sr-present, II-present, III-present, IV-present
15
Tested in Schematron: honorific-start, honorific-end. Typical post-nominal abbreviations that should be in honorific
include: (Hon); BA; B.A.; BDS; B.D.S.; BEd; B.Ed.; BEng; B.Eng.; BSc; B.Sc.; Bart; Bart.; Bt; Bt.; CBE; C.B.E.; CH; C.H.; DD; D.D.;
DLitt; D.Litt.; DPhil; D.Phil.; Esq; Esq.; FBA; F.B.A.; FRCP; F.R.C.P.; FRCS; F.R.C.S.; FRS; F.R.S.; Kt; Kt.; LLB; LL.B.; LLD; LL.D.;
MA; MBA; M.B.A.; MBE; M.B.E.; MD; M.D.; MEP; M.E.P.; MEd; M.Ed.; MLitt; M.Litt.; MP; M.P.; MRCP; M.R.C.P.; MRCS;
M.R.C.S.; MSP; M.S.P.; MSc; M.Sc.; MSci; M.Sci.; OM; O.M.; OSB; O.S.B.; PhD; Ph.D.; QC; Q.C.; SJ; S.J. In addition, some text
strings such as “Dir.” should not be in honorific (honorific-dir)
16
Tested in Schematron: surname-apos1 surname-apos2
136
Chapter 18. Footnotes, endnotes and
other notes
Ref: §1.75, §1.76, §1.77, §1.78
The footnote element MUST be used for all note types, ie:
All notes marked with a number, letter or symbol (for example with *, †; or ‡) MUST be marked up
using footnote elements. Footnotes and notes must be inserted into the text at the point of first
reference to the note. The symbol (or numeric marker) MUST be replaced by the footnote element,
which MUST contain the content of the note.
The @role attribute MUST be used if the note is to be rendered other than at the foot of the page in
print. If a note is to be rendered at the end of the chapter then the @role attribute must be given the
value ‘end-ch-note’1 and if a note is to be rendered at the end of the book then the @role attribute
must be given the value ‘end-bk-note’.2 If a note is to be placed after a paragraph (as in some
legal books) the @role attribute must be given the value ‘end- para -note’. See Section 18.2.1,
“End of chapter notes”, Section 18.2.2, “End of book notes” and Section 18.2.3, “End of paragraph notes” for
placement of these notes.
Notes in the margins (and marginal line numbers) MUST take the @role values ‘margin1 |
margin2’. See Section 18.3, “Marginal notes” for more details.
DocBook convention is to auto-generate numeric labels for footnotes and end notes. However, in the
following cases a footnote MUST have a @label:
1. When the footnote uses a symbol or letter and is separate from the regular numeric flow of the
rest of the notes. This primarily affects actual footnotes at the foot of the page, or may affect notes
in tables.
2. For retrospective data conversion where a single note has a value that is not in the (alpha)numeric
sequence, ALL footnotes in the work MUST have their values stored within @label(eg the
numbering sequence runs... 34, 35, 35A, 36,...), so that the original footnote numbering can be
preserved.
3. Works where the footnotes were originally numbered per page must also have all the numbers
stored as @label, ie the first note on each page is numbered “1”
Note also that it is an ERROR if a footnote is the only content of a para3 , and if a footnote is within a
link.4
1
Tested in Schematron: end-ch-note-footnote, missing-processing-instruction2, end-ch-notes-item
2
Tested in Schematron: missing-processing-instruction, duplicate-end-bk-notes, end-bk-notes-item
3
Tested in Schematron: footnote-para
4
Tested in Schematron: footnote-link
137
Footnotes, endnotes
and other notes
where this is a short form reference to a contribution in a book, so the text in the title (“The Making of
Godot”) would be within the link.
5
Tested in Schematron: possible-link-biblio-1, possible-link-biblio-2, possible-link-biblio-3,
possible-link-biblio-4
138
Footnotes, endnotes
and other notes
In the preceding example the footnote contains only the bibliographic reference, so its direct child
can be a bibliolist(but NOT with @role=inline, which is an ERROR, since that can only occur
within a para).6
In contrast, if the text contains more than just the biblio reference the bibliolist MUST also be
within a para, and consequently also have @role=inline.
Implementation note: alt does not appear to be supported in this context in standard
DocBook XSL
A later footnote also refers to the same work, but in a somewhat abbreviated form (no publisher
details or date, so this requires a link back to the preceding reference:
Finally, the next note is just an Ibid, which points back to the first full reference and has the alt text:
6
Tested in Schematron: inline-bibliolist-footnote
7
Tested in Schematron: alt-required
139
Footnotes, endnotes
and other notes
note 2 starts off with text, followed by single reference (bibliomixed) within an inline
bibliolist; note 3 is a full bibliomixed(in this case a website); notes 4-6 need to be links back
to the bibliomixed in note 3, etc.
140
Footnotes, endnotes
and other notes
but all of the references in the notes are in fact listed in a back of book bibliography as well. In this
case the title of the reference MUST be a link(“Rene Wellek, Concepts of Criticism(New Haven, CT:
Yale University Press, 1963)”) pointing to the relevant bibliomixed, ie references in footnotes
should only be marked up in bibliomixed if there is no corresponding item in the bibliography for
it to point to.
In 1592 a Latin translation of the prototypal such work, the Characters of Theophrastus
of Lesbos (371–287 BC), was published. There followed Joseph Hall's Characters of Virtues
and Vices1608, The Man in the Moon1609, Thomas Overbury's Characters 1614, John Earle's
Microcosmographie1628
ie, the following is WRONG. We do not need such extreme markup in such cases:
<footnote xml:id="b-9005762">
<para xml:id="b-1200823">In 1592 a Latin translation of the prototypal such work, the <emphasis
role="italic">Characters</emphasis> of Theophrastus of Lesbos (371–287 BC), was published.
There followed <bibliolist xml:id="b-9002779" role="inline"><bibliomixed role="monograph"
xml:id="b-9800016"><author><personname><firstname>Joseph</firstname><surname>Hall</surname></
personname></author>'s <title>Characters of Virtues and Vices</title> <pubdate>1608</pubdate>,
<title>The Man in the Moon</title> <pubdate>1609</pubdate>, <author><personname><firstname>Thomas</
firstname><surname>Overbury</surname></personname></author>'s <title>Characters</title> <pubdate>1614</
pubdate>, <author><personname><firstname>John</firstname><surname>Earle</surname></personname></author>'s
<title>Microcosmographie</title> <pubdate>1628</pubdate>. </bibliomixed></bibliolist></para>
141
Footnotes, endnotes
and other notes
</footnote>
Required handling is for the note refs to be links to the end notes, which are displayed at the
end of the chapter/chunk/book as in the print.
1. “You'll need to mark all the elements that you want handled in a special way with role
attributes.
2. You should process those special elements with templates in a mode different from the
default, applying templates in that mode.
3. You will need to include empty templates that match on those elements with those roles, but
in default mode (no mode attribute) to prevent them from being processed normally along
with other text.
4. You'll need to customize certain DocBook templates to place the special text, triggering
processing of them in the new modes. For example, customize the book template to call
a template named something like "process.endnotes" and placed at the end of the book
template to trigger end note processing there.”
<title xml:id="en13">Bibliography</title>
</info>
<bibliomixed role="article" xml:id="en14"><bibliomset relation="article"><author><personname role="last-
first"><surname>Weinstock</surname> <firstname>D.J.</firstname></personname></author> (<pubdate>1981</
pubdate>), ‘<title>“Say not we are on a darkling plain”: Clough’s response to “Dover Beach”</title>’,</
bibliomset> <bibliomset relation="journal"><title><emphasis role="italic">Victorian Poetry</emphasis></
title>, <volumenum>19</volumenum>.</bibliomset></bibliomixed>
However, if there is no title for the notes section, or if there is other content in the notes section, the PI
MUST simply call in the list of notes within a correctly-structured division of text, and MUST have a
@role:10
8
Tested in Schematron: ch-insert-missing
9
Tested in Schematron: pi-markup, ampersand-in-pi-insert
10
Tested in Schematron: possible-notes-section
142
Footnotes, endnotes
and other notes
<info xml:id="notes1">
<title xml:id="notes2">Notes</title>
</info>
<para xml:id="notes3">Introductory paragraph before the end chapter notes, etc</para>
<?insert item="end-ch-notes"?>
</section>
Note that the following, with a 'Notes' section/info/title and a title in the PI is WRONG (all
structurally equivalent notes sections in a book must be handled similarly, but it is most likely that the
insert PI simply needs to be like that in the previous example):11
<section xml:id="b-9780857854049-0000158">
<info xml:id="b-9780857854049-0000159"><title xml:id="b-9780857854049-0000160">Notes</title></info>
<?insert item="end-ch-notes" title="Notes"?>
</section>
As with the end of chapter notes, a processing instruction MUST call in the list of notes, where
“chunk” has the value of the chunk @xml:id of the notes to be included (ie chapter by chapter).15
A chapter [@role=notes] MUST include at least one end- bk -notes processing instruction16
, and the chunk IDs in the processing instruction MUST point to a valid chunk id in the data.17
Note that the remark element is included with standard content simply so that the file will parse,
otherwise the chapter would not have any valid content.
The value of the ‘title’ string in the processing instruction MUST match that as it appears on the
printed page where the notes are to be inserted.18
143
Footnotes, endnotes
and other notes
Implementation note: Default numbering style must be to start from 1 within each chunk, as
called.
These texts contain numbered paragraphs, which use the formalpara container element. Such notes
MUST have a @role='end-para-note' and the placement is determined by the location of an
insert PI.19
<formalpara xml:id="b-9781234567897-fp2.9">
19
Tested in Schematron: end-para-notes-item, para-insert-missing, end-para-note-footnote
144
Footnotes, endnotes
and other notes
<info xml:id="q1">
<title xml:id="q2">2.9</title>
</info>
<para xml:id="q3">The law relating to the circumstances in which minority shareholders may maintain
an action on behalf of their company in the face of opposition from the management and majority
shareholders has, over the years, attracted a great deal of comment and discussion.<footnote label="1"
role="end-para-note" xml:id="q4"><para xml:id="q5">See the so called rule in <bibliolist role="inline"
xml:id="q6"><bibliomixed role="case" xml:id="q7"><emphasis role="italic">Foss v Harbottle</emphasis>
(1843) 2 Hare 461</bibliomixed></bibliolist>.</para></footnote> While the courts have been prepared
to assist shareholders to bring derivative actions based on the company’s cause of action against
persons who have seemingly engaged in fraud and misappropriation of the company’s property, there
has been uncertainty as to what amounts to fraud and what can be regarded as corporate property.
For example, some of the cases involving allegations of equitable fraud include misconduct, such
as the taking of a secret profit, in circumstances where there is no dishonesty in the common law
sense.<footnote label="2" xml:id="q8" role="end-para-note"><para xml:id="q9">See <bibliolist role="inline"
xml:id="q10"><bibliomixed xml:id="q11" role="case">Armitage v Nurse [1998] Ch 241 at 252</bibliomixed></
bibliolist>. Millett LJ stated that equitable fraud included ‘breach of fiduciary duty, undue influence,
abuse of confidence, unconscionable bargains and fraud in powers’. See also for an early discussion
of this <bibliolist xml:id="q12" role="inline"><bibliomixed xml:id="q13" role="article"><bibliomset
relation="article"><author><personname role="first-last"><firstname role="initials">B.</firstname>
<surname>Rider</surname></personname></author> ‘<title>Amiable Lunatics and the Rule in Foss v
Harbottle</title>’ (<pubdate>1978</pubdate>)</bibliomset> <bibliomset relation="journal"><title><emphasis
role="italic">Cambridge Law Journal</emphasis></title> <volumenum>270</volumenum></bibliomset></
bibliomixed></bibliolist>. In <bibliolist role="inline" xml:id="q14"><bibliomixed xml:id="q15"
role="case"><emphasis role="italic">Item Softwear (UK) Ltd v Fassihi</emphasis> [2005] 2 BCLC 91</
bibliomixed></bibliolist>, it was held that a director is under a duty derived from his obligation
of loyality to disclose to his company his own wrongdoing even if it does not amount to fraudulent
misconduct. The dishonest failure to do this, might well render the law of fraud relevant. See <emphasis
role="bold">6.14</emphasis>.</para></footnote>...</para>
<?insert item="end-para-notes"?>
</formalpara>
Implementation note: This placement is not supported in standard DocBook XSL. The default
numbering style must be to start from 1 within each formalpara.
See also Section 14.1.3, “Formal paragraphs” and Section 32.16.5, “Numbered paragraphs”.
Two values of @role are allowed: margin1and margin2. These are to indicate to which series
of marginal notes a specific item belongs. Note that this does not mean ‘left’ or ‘right’ since the
placement is dependent on the processing application. For example, if a work has both line numbers
and some authorial textual notes in the margin, all of the former would be margin1 and the latter
margin2.
See also Section 24.3.4, “More complex poems, and line numbers”
Implementation note: This is not supported in DocBook XSL. These footnotes MUST NOT be
included in the auto-generated numbered sequence that is used for other footnotes; indeed, they
MUST NOT have an auto-generated number. If a number marker is required in the text, that
MUST be provided by the @label only, though in many cases (and especially where used for
line numbers) @label is NOT REQUIRED.
145
Chapter 19. Lists
Lists are (usually) block items, and should be siblings of para. It is usually an ERROR for a list to be
the sole child of a para element, other than in the abstract(the content model of which does not
allow them). 1
Generally, the only occasion when it is permissible (and REQUIRED) that lists occur within
paragraphs is where the sentence continues after the list:
<para xml:id="id0076">Sometimes it may be necessary to have a list within a paragraph, such as here:
<itemizedlist xml:id="id0077">
<listitem xml:id="id0078"><para xml:id="id0079">Item 1</para></listitem>
<listitem xml:id="id0080"><para xml:id="id0081">Item 2</para></listitem>
</itemizedlist>
which only makes sense if the sentence continues after the list. Otherwise, the lists must be siblings of
the paras.</para>
<simplelist>
<member>Item 1</member>
<member>Item 2</member>
<member>Item 3</member>
</simplelist>
<itemizedlist xml:id="id0060">
<listitem xml:id="id0061"><para xml:id="id0062">First item</para></listitem>
1
Tested in Schematron: list-para-test
2
Tested in Schematron: single-list-item and single-list-item-2
3
Presence reported in Schematron: nested-list
146
Lists
The style of the bullet can be controlled to a limited extent, by using the @mark attribute, which
normally takes values of disc (default), square and circle:4
However, @mark=none is permissible for occasions when what would otherwise be a simplelist
has a title, or if any of the list items contain multiple para s, or nested lists etc. See also the worked
example in Section 32.7.1, “A simple list with title, columns and notes”.
http://www.sagehill.net/docbookxsl/Itemizedlists.html
Implementation note: The @mark appears to have partial supported in DocBook XSL
Implementation note: Display of list titles when they are within info is not supported in
DocBook XSL
<orderedlist xml:id="id0069">
<listitem xml:id="id0070"><para xml:id="id0071">First item</para></listitem>
<listitem xml:id="id0072"><para xml:id="id0073">Second item</para></listitem>
<listitem xml:id="id0074"><para xml:id="id0075">Third item</para></listitem>
</orderedlist>
DocBook also supports more complex numbering patterns and options, such as continuation of
numbering:5
<itemizedlist xml:id="id0077">
<listitem xml:id="id0078"><para xml:id="id0079">Item 1</para></listitem>
<listitem xml:id="id0080"><para xml:id="id0081">Item 2</para></listitem>
</itemizedlist>
<para xml:id="id0082">The list is then followed by any other content. It may also end a chapter and a new
one start. If the next list includes the continuation attribute then the numbering will continue the
sequence:</para>
<orderedlist continuation="continues" xml:id="id0086">
<listitem xml:id="id0087"><para xml:id="id0088">Item 3</para></listitem>
<listitem xml:id="id0089"><para xml:id="id0090">Item 4</para></listitem>
<listitem xml:id="id0091"><para xml:id="id0092">Item 5</para></listitem>
</orderedlist>
In addition, the numbering style can be set to be other than Arabic,6 items can be forced to start with
a particular number (and note that the value is a number, irrespective of the numeration type),7 and
when there are nested lists, they may inherit the parent numbering:8
4
Tested in Schematron: list-mark
5
Presence reported in Schematron: continuation-present
6
Presence reported in Schematron: numeration-present
7
Presence reported in Schematron: startingnumber-present
8
Presence reported in Schematron: inheritnum-present
147
Lists
• http://www.docbook.org/tdg5/publishers/5.1b3/en/html/orderedlist.html
• http://www.sagehill.net/docbookxsl/Orderedlists.html
<variablelist>
<info><title xml:id="pti-0">Film production</title></info>
<varlistentry>
<term xml:id="pt-001">1899</term>
<listitem xml:id="pl-001"><para xml:id="pp-001">First films shot and screened in Korea by Burton Holmes</
para></listitem>
</varlistentry>
<varlistentry>
<term xml:id="pt-002">1903</term>
<listitem xml:id="pl-002"><para xml:id="pp-002">First public film screening announced in a newspaper
(<emphasis role="italic">Hwangsong sinmun</emphasis>)</para></listitem>
</varlistentry>
<varlistentry>
<term xml:id="pt-003">1903</term>
<listitem xml:id="pl-003"><para xml:id="pp-003">Tongdaemun Motion Picture Studio, the first motion picture
theater in Korea, opens</para></listitem>
</varlistentry>
</variablelist>
Note that a variable list may contain multiple terms for each entry.9 See http://
www.sagehill.net/docbookxsl/Variablelists.html, and also for further information about
variablelist formatting and indentation: it is assumed that all variablelists will be formatted
as tables (ie with terms and entrys on the same line); if this is not the case for a specific list, follow
the instructions as described using the relevant DocBook processing instructions.
9
Tested in Schematron: multi-terms
148
Chapter 20. Tables
There are two sorts of table in DocBook:
It is an ERROR to have a table with an empty title element.1 A title in the print edition will
usually be preceded by “Table n” etc. As with Chapter and Part titles, the string “Table n” MUST
NOT be encoded in the title,2 but the alphanumeric value of n MUST be captured as @label.
It is important that all style information as used in the print MUST be retained, ie table, row, column
and cell borders, vertical alignment, column widths, etc all match exactly the format in the book.
This is the default informaltable style, ie with no attributes controlling borders and layout:
<informaltable xml:id="id0116">
<tgroup cols="2">
<thead>
<row><entry xml:id="id0117">Column 1</entry><entry xml:id="id0118">Column 2</entry></row>
</thead>
<tbody>
<row><entry xml:id="id0119">Item 1</entry><entry xml:id="id0120">1</entry></row>
<row><entry xml:id="id0121">Item 2</entry><entry xml:id="id0122">2</entry></row>
<row><entry xml:id="id0123">Item 3</entry><entry xml:id="id0124">3</entry></row>
</tbody>
</tgroup>
</informaltable>
The number of entrys in a row MUST be equal to the cols value in tgroup,3 apart from where
there are column and row spans.
In the following example, setting @colsep to “0” switches off the column separator, the @frame
value adds a border on the top and bottom of the table as a whole, and @rowheader treats the first
column as the row header, which is important for accessibility:
This next example spans the entire page width (@pgwide), with no column separators, frame on the
sides, and only one row separator under the first body row. It also uses @colwidth to control the
relative widths of the two columns:
1
Tested in Schematron: impermissible-empty-element
2
Tested in Schematron: table-in-label
3
Tested in Schematron: row-cols-count
149
Tables
Now we have a table with no column or row separators, frame on the bottom, and one cell that spans
two rows (which means that tbody/row[2] only has one entry within it):4
</tgroup>
</informaltable>
Now here is a table with cells that span multiple rows and columns:5
This is a table (ie not an informal one), which has a tfoot, alt and caption as well. Note that the
tfoot content appears before the tbody in the content model. In practice, it is unlikely that any alt
content will be available.
<table xml:id="id0163">
<info xml:id="id0164"><title xml:id="id0165">A simple table</title></info>
<alt>This is the content of the alt element</alt>
<tgroup cols="2">
<thead>
<row><entry xml:id="id0166">Column 1</entry><entry xml:id="id0167">Column 2</entry></row>
</thead>
<tfoot>
<row><entry xml:id="id0168">Foot</entry><entry xml:id="id0169">Content</entry></row>
</tfoot>
<tbody>
<row><entry xml:id="id0170">Item 1</entry><entry xml:id="id0171">1</entry></row>
<row><entry xml:id="id0172">Item 2</entry><entry xml:id="id0173">2</entry></row>
<row><entry xml:id="id0174">Item 3</entry><entry xml:id="id0175">3</entry></row>
</tbody>
</tgroup>
<caption xml:id="id0176"><para xml:id="id0177">The is the content of the caption, which is inside a
paragraph</para></caption>
</table>
4
Presence reported in Schematron: table-row-col-att
5
Tested in Schematron: namest-present, nameend-present, nameend-present-2, namest-and-end, col-span-
test, namest-required
150
Tables
Implementation note: CALS table alignment mechanisms are not supported in DocBook XSL
151
Chapter 21. Figures and images
Ref: §1.52, §1.53, §1.54, §1.55
Block images MUST be marked up within a mediaobject element, almost invariably within a
figure or informalfigure.1 Images that are not within the body of the book, eg title page logo,
are most likely NOT to require a containing figure or informalfigure element (see Section 7.5.8,
“Imprint logo”). Inline images MUST be marked up within a inlinemediaobject element (see
Section 23.3, “More complex equations”). The image itself MUST be marked up using an imageobject
element2 containing at least one imagedata element. The @fileref attribute MUST be used to
store a reference to the relative location of the image file, with the following options:
The imageobject element MUST contain one imagedata element for each format provided. An
imageobject MUST contain an image in a web format, ie it is an ERROR if only a print format (eps/
tiff) is present.5 If multiple image formats are provided then multiple imagedata elements MUST
be present with an appropriate @ outputformat value.6 (See also Section 14.7, “@outputformat”.)
The @format attribute7 must contain the MIME type appropriate to the file referenced by @fileref
attribute, eg:8
<mediaobject xml:id='b-0111'>
<imageobject>
<imagedata fileref='images/example.png' outputformat='web' format='image/png'/>
</imageobject>
<imageobject>
<imagedata fileref='images/example.tiff' outputformat='print' format='image/tiff'/>
</imageobject>
</mediaobject>
Ordinarily a block image will be contained within a figure or informalfigure. These containers
provide a limited number of attributes for controlling the layout and alignment of the image display.
152
Figures and images
It is an ERROR to have a figure with an empty title element.10 A title in the print edition will
usually be preceded by “Figure n” etc. As with Chapter and Part titles, the string “Figure n” MUST
NOT be encoded in the title,11 but the alphanumeric value of n MUST be captured as @label.
153
Figures and images
<caption xml:id="id0031">
<para xml:id="casp001">Michelangelo Merisi da Caravaggio (1571-1610) <emphasis role="italic">The Conversion
of St Paul</emphasis>, 1601 (oil on canvas). <phrase role="source">Santa Maria del Popolo, Rome, Italy/
Bridgeman Art Library.</phrase></para>
</caption>
If a figure is encoded with a very long title, it is possible that some of its content may need to
belong in a caption.12
The boundary between what constitutes a figure title and what is a caption is arguably a bit
vague, but in a case like this, where we have some text that all runs on, is fairly long, doesn’t have
components that are especially typographically distinct as a “title”, and also includes permissions
information (example includes WRONG markup):
then, this is more likely a caption than a title. In which case the containing element need to be an
informalfigure.
These are often spotted via the warning mentioned in the preceding footnote:
Description: The figure title is 141 characters long, should some of it be in a caption? check element with
id "ba-9781472543356-0000082cc"
<caption xml:id="id0031">
<para xml:id="casp001">Michelangelo Merisi da Caravaggio (1571-1610) <emphasis role="italic">The Conversion
of St Paul</emphasis>, 1601 (oil on canvas). <phrase role="source">Santa Maria del Popolo, Rome, Italy/
Bridgeman Art Library.</phrase></para>
</caption>
Or they may be presented in a different font, size or location compared with the rest of the caption
content, in which case they MUST be within a distinct para:13
<caption xml:id="ij86f">
<para xml:id="fc86k">In 2002, a replica of the “Leave It to Beaver house” is again seen on Colonial Street,
this time cast as part of a middle-class African-American neighborhood, “Nellyville, U.S.A.,” in the music
video for Nelly’s single, “Dilemma.” Featuring R&B singer Kelly Rowland as new to the established,
12
Tested in Schematron: figure-title-length
13
Tested in Schematron: source-in-caption
154
Figures and images
vibrant suburban neighborhood, she and her mother (Patti Labelle) move into the Cleaver’s old home across
the street from rapper-resident Nelly.</para>
<para xml:id="ygtf6" role="source">© 2002, Universal Records</para>
</caption>
Note also that block images MUST NOT be between a para and an attribution in a
blockquote.16
Note the difference between the caption (the default behaviour of which is to appear below the
image) and textobject/phrase, which is not used in print but is the OPTIONAL means of
creating HTML alt text.
14
Tested in Schematron: object-in-para
15
Tested in Schematron: anchor-role, anchor-id, object-role, object-id, object-target-id, impermissible-
href-location
16
Tested in Schematron: object-in-blockquote
155
Figures and images
</imageobject>
<textobject>
<phrase>Picture of Leonardo DiCaprio kissing Claire Danes</phrase>
</textobject>
<caption>
<para>This scene is at the end of the film</para>
</caption>
</mediaobject>
</figure>
The informalfigure example shows that @valign can be used, and it can also have a
textobject/phrase for alt text, or a caption. This example also shows how long descriptions
for accessibility can be added to mediaobject s, also using the textobject, but NOT within a
phrase.[Practically it is unlikely that we will be able to support this editorially]
<informalfigure xml:id="b-fig1">
<mediaobject>
<imageobject>
<imagedata align="left" valign="bottom" fileref="images/virtuousCircle.png"/>
</imageobject>
<textobject>
<phrase>Diagram illustrating film programming connections</phrase>
</textobject>
<textobject>
<formalpara>
<info>
<title>The virtuous circle in film programming</title>
</info>
<para>The diagram shows that, as film programming improves, it enhances audience development, which can
in turn promote community engagement and participation. That, in turn, can help support film education
activities, which feeds into the programming.</para>
</formalpara>
</textobject>
<caption>
<para>Film programming, audience development, community engagement, and film education are all connected.</
para>
</caption>
</mediaobject>
</informalfigure>
156
Chapter 22. Other media content
22.1. Video
22.1.1. Embedded video
Where the expected rendering behaviour is that a video be displayed embedded (e.g. online, in a
player directly embedded in the current web page) this markup MUST be used:
<mediaobject xml:id='b-9781350970809-a123'>
<videoobject xlink:show="embed">
<videodata fileref="123456789" role="brightcoveID" classid="somePlayerID"
xml:id="b-9781350970809-b456"/>
</videoobject>
</mediaobject>
where
• @classid optionally specifies the player ID; a default player should be used if absent.
22.1.2. Reference by ID
For video assets held by Bloomsbury (we will instruct where this is the case), include the asset ID in
the xlink:href of a phrase[@role='videoID'], as follows:1
<phrase role="videoID"
xlink:role="http://docbook.org/xlink/role/olink"
xlink:href="5987882506001">Jean Paul Gaultier SS 1988 (B0370)</phrase>
Here, the rendering expectation is that a URL for the asset will either be constructed on export from
the CMS where the XML resides, for use by the platform, or directly by the target platform itself.
22.2. Audio
Audio content may also be included using the reference by ID mechanism described in Section 22.1.2,
“Reference by ID”.
22.2.1. Reference by ID
In the case of audio content assets held by Bloomsbury (we will instruct where this is the case),
phrase[@role='audioID'] should be used to include the asset ID:2
<phrase role="audioID"
xlink:role="http://docbook.org/xlink/role/olink"
xlink:href="4595718792345">The Sound of Silence</phrase>
As for video assets, the rendering expectation is that a URL for the asset will either be constructed on
export from the CMS for use by the platform, or directly by the target platform itself.
1
Tested in Schematron: video-rule-1
2
Tested in Schematron: audio-rule-1
157
Chapter 23. Equations
23.1. Equation basics
The DocBook equation container elements are:1
Element Usage
Equation Displayed equations with titles
informalequation Displayed equations without titles
inlineequation Inline equations
Item Usage
mathphrase For simple equations that can be represented
with text, numbers, symbols, superscripts and
subscripts
mml: MathML markup for more complex equations
Media objects Graphics of the equation, often in multiple
formats for different outputs
As with other elements for which formal and informal versions are available, equations can be
referenced by link s, and the auto-generated numbering scheme can be overridden using @label.
<para xml:id="id0211">Here are a variety of equation options. First a mathphrase within an inlineequation:
<inlineequation xml:id="eq1"><mathphrase xml:id="eq2">E = mc<superscript>2</superscript></mathphrase></
inlineequation>, and the text can just follow on.</para>
• MathML
158
Equations
[Need to specify image specification, including baseline etc, font etc) SVG?]
Two equation containers MUST be provided: one for processing by a MathML tool
(@condition=mathml); and the other for an image renderer (@condition=non-mathml),4
UNLESS the title bears a metadata flag indicating that it targets the Bloomsbury Collections platform
(see Section 7.5.11, “Other biblioids”), in which case only non-MathML equations are required.5 Only
one of these elements MUST be used in the output processing. These values of @condition are only
permissible on the following elements:6
• equation
• informalequation
• inlineequation
In addition, the images MUST contain versions for both print and web usage:
</mml:mrow>
</mml:mrow>
<mml:mo>=</mml:mo>
<mml:mrow>
<mml:msub>
<mml:mo>∫</mml:mo>
<mml:mrow>
<mml:mo>∂</mml:mo>
<mml:mi>D</mml:mi>
</mml:mrow>
</mml:msub>
<mml:mrow>
<mml:mtext> </mml:mtext>
<mml:mi>F</mml:mi>
<mml:mo>⋅</mml:mo>
<mml:mi>n</mml:mi>
</mml:mrow>
<mml:mi>d</mml:mi>
<mml:mi>S</mml:mi>
</mml:mrow>
</mml:mrow>
</mml:math>
</informalequation>
<informalequation xml:id="eq13a" condition="non-mathml">
<mediaobject xml:id="eq14">
<imageobject xml:id="eq15">
<imagedata xml:id="eq16" outputformat="web" fileref="images/equation1.png" format="image/png"
align="center"/>
</imageobject>
<imageobject xml:id="eq15a">
<imagedata xml:id="eq16q" outputformat="print" fileref="images/equation1.tiff" format="image/tiff"
align="center"/>
4
Tested in Schematron: eqn-condition-required
5
Tested in Schematron: no-mathml-on-BC-platform
6
Tested in Schematron: math-condition-attribute
159
Equations
</imageobject>
</mediaobject>
</informalequation>
The same approach MUST also be adopted for inline complex equations, and note that mml:math
within an inlineequation MUST have @display=’inline’.7 (In practice most inline equations
should be able to be rendered within mathphrase):
<mml:mi>φ</mml:mi>
<mml:mo>)</mml:mo>
</mml:mrow>
<mml:mo>−</mml:mo>
<mml:mi>sin</mml:mi>
<mml:mo>⁡</mml:mo>
<mml:mrow>
<mml:mo>(</mml:mo>
<mml:mi>θ</mml:mi>
<mml:mo>)</mml:mo>
</mml:mrow>
<mml:mi>sin</mml:mi>
<mml:mo>⁡</mml:mo>
<mml:mrow>
<mml:mo>(</mml:mo>
<mml:mi>φ</mml:mi>
<mml:mo>)</mml:mo>
</mml:mrow>
</mml:mrow></mml:math></inlineequation>
<inlineequation xml:id="iee9" condition="non-mathml">
<inlinemediaobject xml:id="eq18">
<imageobject xml:id="eq19">
<imagedata outputformat="web" fileref="images/equation2.png" format="image/png"/>
</imageobject>
<imageobject xml:id="eq19a">
<imagedata outputformat="print" fileref="images/equation2.tiff" format="image/tiff"/>
</imageobject>
</inlinemediaobject></inlineequation> with text following on, and shows how hard it will be to get the
baseline correct so it sits neatly in the text.</para>
23.4. equations
In some cases, equations in LaTeX are also required.
7
Tested in Schematron: inline-math-attribute
160
Equations
Important
Bloomsbury will advise if this is the case.
8
Tested in Schematron mathphrase-latex
161
Chapter 24. Blockquotes, epigraphs,
poetry and drama
This section describes the various block extracts and related elements.
Note that quote (for inline quotations) is NOT REQUIRED in this instance of DocBook.
Implementation note: Processing and display of the DocBook Publishers poetry and drama
components is not supported in DocBook XSL (though blockquote and epigraphs are)
24.1. Blockquotes
Whereas epigraphs are quotations at the beginning of a chapter or section (see next section), a
blockquote is any other displayed text set apart from the main flow, usually indented relative to
the main text. If a blockquote occurs as the first element in a chunk or section it should almost
certainly be an epigraph.1
<blockquote xml:id="sb6"><para xml:id="sb7">We are the leading partner in a Government project which
enables students to learn through hands-on experience. Through practise and primary engagement with
research, students build and improve their critical skills...</para></blockquote>
However, a blockquote may also contain poetry or drama, and may also include an attribution:
<blockquote xml:id="gk5a">
<attribution>Archilochus fr. 48.5-7 W</attribution>
<poetry xml:id="gk6">
<line xml:id="gk7">τροφὸ.ς κατ.[         ἐσμυριχμένας κόμην</line>
<line xml:id="gk8">καὶ στῆθος, ὡς ἂν καὶ γέρων ἠράσσατο.</line>
<line xml:id="gk9">ὦ Γλαῦκ.[</line>
</poetry>
</blockquote>
24.2. Epigraphs
Ref: §1.12, §1.86, §1.87, §1.88
Chunks MAY begin with one or more epigraph (a phrase, quotation, or poem that is set at
the beginning of a document or component, usually inset or typographically distinct from the
surrounding text).3
Such content MUST be marked up within an epigraph element (NOT a blockquote, which is for
quoted text within the body of the content), and will be the first element(s) within the content chunk.
Note also that the DocBook schema REQUIRES that the attribution is the first element within the
epigraph, irrespective of where it appears in the print edition. However, the DocBook stylesheets
include a parameter to allow for the placement of the attribution after the epigraph text, if required:
<chapter xml:id="b-chapter-001">
1
Tested in Schematron: possible-epigraph
2
Tested in Schematron: possible-attribution
3
Tested in Schematron: para-before-epigraph
162
Blockquotes, epigraphs,
poetry and drama
<info xml:id="b-0000109">
<title xml:id="b-0000110">Introduction</title>
<subtitle xml:id="b-0000111">Globalizing cricket</subtitle>
</info>
<epigraph>
<attribution>Sir Laurence Olivier</attribution>
<para><emphasis role="italic">I have often thought of how much better a life I would have had, what a
better man I would have been, how much healthier an existence I would have led, had I been a cricketer.</
emphasis></para>
</epigraph>
<epigraph>
<attribution>Robert Mugabe</attribution>
<para><emphasis role="italic">Cricket civilizes people and creates good gentlemen. I want everyone to play
cricket in Zimbabwe; I want ours to be a nation of gentlemen.</emphasis>
</para>
</epigraph>
<epigraph>
<attribution>Bill Bryson</attribution>
<para><emphasis role="italic">It is not true that the English invented cricket as a way of making all other
human endeavours look interesting and lively; that was merely an unintended side effect. I don't wish to
denigrate a sport that is enjoyed by millions, some of them awake and facing the right way, but it is an
odd game.</emphasis>
</para>
</epigraph>
<para>Cricket polarizes opinion. To some it holds quasi-religious status; to others it is a point of
fun. Despite their obvious devotion, some (particularly English) cricket spectators are remarkably
impassive. Inextricably linked to what defines Englishness, cricket is also venerated by those who have
publicly and vigorously fought against imperial oppression. It has the aura of a genteel game which builds
character, yet it is amongst the most injurious sports played in the United Kingdom (<link role="bib"
linkend="b-0003848">Smith 2012</link>)....</para>
The attribution MAY take @role (left | right | center), if required. Note the use of the
attribution element rather than para[@role=right].4
24.3. Poetry
Ref: §1.89, §1.90
Poetry in the text may occur within a blockquote or epigraph, or neither. A poem must be placed
within a blockquote or epigraph if it is so quoted and (usually) inset relative to the usual flow
of text.5 It will certainly require a parent blockquote or epigraph if it has an attribution.6
<poetry xml:id="po5">
<line xml:id="po6">The languages, especially the dead,</line>
<line xml:id="po7">   The sciences, and most of all the abstruse,</line>
<line xml:id="po8">The arts, at least all such as could be said</line>
<line xml:id="po9">   To be the most remote from common use,</line>
<line xml:id="po10">In all these he was much and deeply read:</line>
<line xml:id="po11">   But not a page of anything that’s loose,</line>
<line xml:id="po12">Or hints continuation of the species,</line>
<line xml:id="po13">Was ever suffer’d, lest he should grow vicious.</line>
</poetry>
Note also that content in brackets at the end of the last line of a poem is almost certainly an attribution
and MUST be marked up accordingly,7 ie the following is WRONG:
<poetry xml:id="b-9781408174654-0000456">
<linegroup xml:id="b-9781408174654-0000457">
<line xml:id="b-9781408174654-0000458">the midnight bell</line>
<line xml:id="b-9781408174654-0000459">Did, with his iron tongue and brazen mouth,</line>
4
Tested in Schematron: possible-attribution
5
Tested in Schematron: drama-poetry-parent
6
Presence reported in Schematron: poetry-drama-present
7
Tested in Schematron: line-attribution
163
Blockquotes, epigraphs,
poetry and drama
<blockquote xml:id="b-9781408174654-0000454">
<attribution xml:id="b-9781408174654-0000455">(3.2.47-9)</attribution>
<poetry xml:id="b-9781408174654-0000456">
<linegroup xml:id="b-9781408174654-0000457">
<line xml:id="b-9781408174654-0000458">the midnight bell</line>
<line xml:id="b-9781408174654-0000459">Did, with his iron tongue and brazen mouth,</line>
<line xml:id="b-9781408174654-0000460">Sound one into the drowsy race of night.</line>
</linegroup>
</poetry>
</blockquote>
<poetry xml:id="po17">
<linegroup xml:id="po18">
<line xml:id="po19">Juan was taught from out the best edition,</line>
<line xml:id="po20">Expurgated by learned men, who place</line>
<line xml:id="po21">Judiciously, from out the schoolboy’s vision,</line>
<line xml:id="po22">The grosser parts; but, fearful to deface</line>
<line xml:id="po23">Too much their modest bard by this omission,</line>
<line xml:id="po24">And pitying sore his mutilated case,</line>
<line xml:id="po25">They only add them all in an appendix,</line>
<line xml:id="po26">Which saves, in fact, the trouble of an index;</line>
</linegroup>
<linegroup xml:id="po27">
<line xml:id="po28">For there we have them all ‘at one fell swoop,’</line>
<line xml:id="po29">Instead of being scatter’d through the pages;</line>
<line xml:id="po30">They stand forth marshall’d in a handsome troop,</line>
<line xml:id="po31">To meet the ingenuous youth of future ages,</line>
<line xml:id="po32">Till some less rigid editor shall stoop</line>
<line xml:id="po33">To call them back into their separate cages,</line>
<line xml:id="po34">Instead of standing staring all together,</line>
<line xml:id="po35">Like garden gods – and not so decent either.</line>
</linegroup>
</poetry>
<poetry xml:id="po37">
<linegroup xml:id="po38">
<line xml:id="po39">He sat in a wheeled chair, waiting for dark,</line>
<line xml:id="po40">And shivered in his ghastly suit of grey,</line>
<line xml:id="po41">Legless, sewn short at elbow. Through the park</line>
<line xml:id="po42">Voices of boys rang saddening like a hymn,</line>
<line xml:id="po43">Voices of play and pleasure after day,</line>
<line xml:id="po44">Till gathering sleep had mothered them from him.</line>
<line role="center" xml:id="b-9781474208482-0007719">*    *    *</
line>
<line xml:id="po46">About this time Town used to swing so gay</line>
<line xml:id="po47">When glow-lamps budded in the light-blue trees</line>
<line xml:id="po48">And girls glanced lovelier as the air grew dim,</line>
<line xml:id="po49">— In the old times, before he threw away his knees.</line>
<line xml:id="po50">Now he will never feel again how slim</line>
<line xml:id="po51">Girls' waists are, or how warm their subtle hands,</line>
<line xml:id="po52">All of them touch him like some queer disease.</line>
</linegroup></poetry>
164
Blockquotes, epigraphs,
poetry and drama
<poetry xml:id="po54">
<line role="center" xml:id="po55"><emphasis role="italic">To the happy memory of five Franciscan Nuns
exiles by the Falk Laws drowned between midnight and morning of Dec. 7th. 1875</emphasis></line>
<linegroup xml:id="po56">
<line role="center" xml:id="po57">PART THE FIRST</line>
</linegroup>
<linegroup xml:id="po58">
<line role="center" xml:id="po59">1</line>
<line
xml:id="po60">                THOU
mastering me</line>
<line xml:id="po61">            God! giver of
breath and bread;</line>
<line xml:id="po62">        World’s strand, sway of the sea;</line>
<line xml:id="po63">            Lord of living
and dead;</line>
<line xml:id="po64">    Thou hast bound bones and veins in me, fastened me flesh,
<footnote role="margin1" xml:id="po65"><para xml:id="po66">5</para></footnote></line>
<line xml:id="po67">    And after it almost unmade, what with dread,</line>
<line xml:id="po68">        Thy doing: and dost thou touch me
afresh?</line>
<line xml:id="po69">Over again I feel thy finger and find thee.</line></linegroup>
<linegroup xml:id="po70">
<line role="center" xml:id="po71">2</line>
<line
xml:id="po72">                I
did say yes</line>
165
Blockquotes, epigraphs,
poetry and drama
<poetry xml:id="po85">
<info xml:id="po86"><title xml:id="po87">The Show</title></info>
24.4. Drama
The text of dramatic works in the text may occur within a blockquote or epigraph, or neither. A
dramatic work must be placed within a blockquote or epigraph if it is so quoted and (usually)
inset relative to the usual flow of text.8
8
Tested in Schematron: drama-poetry-parent. Presence reported in Schematron: poetry-drama-present
166
Blockquotes, epigraphs,
poetry and drama
<drama xml:id="dr-019">
<dialogue xml:id="dr-020" role="line-below-speaker">
<linegroup xml:id="dr-021"><speaker xml:id="dr-022">BEATRICE</speaker>
<line xml:id="dr-023">Oh, there’s one above me, sir. [<emphasis role="italic">Aside</emphasis>] For
five days past</line>
<line xml:id="dr-024">To be recall'd! Sure, mine eyes were mistaken;</line>
<line xml:id="dr-025">This was the man was meant me. That he should come</line>
<line xml:id="dr-026">So near his time, and miss it!</line>
</linegroup>
</dialogue>
</drama>
<drama xml:id="dr-005">
<dialogue xml:id="dr-006" role="line-follows-speaker">
<linegroup xml:id="dr-007"><speaker xml:id="dr-008">THERIDAMAS.</speaker> <line xml:id="dr-009">Then now,
my lord, I humbly take my leave.</line></linegroup>
<linegroup xml:id="dr-010"><speaker xml:id="dr-011">MYCETES.</speaker> <line xml:id="dr-012">Theridamas,
farewell ten thousand times.</line>
<line xml:id="dr-013"><emphasis role='italic'>[Exit THERIDAMAS.]</emphasis></line>
<line xml:id="dr-014">Ah, Menaphon, why stay'st thou thus behind,</line>
<line xml:id="dr-015">When other men press forward for renown?</line>
<line xml:id="dr-016">Go, Menaphon, go into Scythia,</line>
<line xml:id="dr-017">And foot by foot follow Theridamas.</line>
</linegroup></dialogue></drama>
Katherina
Petruchio
Katherina
A joint-Stool.
Petruchio
9
Note that phrase role='stageDirection' is deprecated for drama excerpts (by Schematron
stageDirectionDeprecated), but see Section 24.4.5, “Screenplay excerpts” and note, for allowed usage.
167
Blockquotes, epigraphs,
poetry and drama
<dialogue xml:id="b-9000394">
<linegroup xml:id="b-9000598">
<speaker xml:id="b-9002870">Katherina</speaker>
<line xml:id="b-9001167">Mov'd, in good time! Let him
that mov'd you hither</line>
<line xml:id="b-9001168">Remove you hence. I knew you at
the first</line>
<line role="partInitial" xml:id="b-9001169">You were a
movable.</line>
</linegroup>
<linegroup xml:id="b-9000599">
<speaker xml:id="b-9002871">Petruchio</speaker>
<line role="partFinal" xml:id="b-9001170">Why, what's a
movable?</line>
</linegroup>
<linegroup xml:id="b-9000600">
<speaker xml:id="b-9002872">Katherina</speaker>
<line role="partInitial" xml:id="b-9001171">A
joint-Stool.</line>
</linegroup>
<linegroup xml:id="b-9000601">
<speaker xml:id="b-9002873">Petruchio</speaker>
<line role="partFinal" xml:id="b-9001172">Thou hast hit
it. Come, sit on me.</line>
</linegroup>
</dialogue>
Value Usage
partInitial The first line in any split line group
partMedial Any intermediate line(s) in a split line group
partFinal The final line in any split line group
<drama xml:id="dr-029">
<dialogue xml:id="dr-039">
<linegroup xml:id="dr-031">
<speaker xml:id="dr-031a"><person><personname><emphasis role="smallcaps">livia</emphasis></personname></
person></speaker><line xml:id="dr-032">[<emphasis role="italic">Aside</emphasis>.]: I am as dumb to any
language now</line>
<line xml:id="dr-033">But love's, as one that never learn'd to speak.</line>
<line xml:id="dr-034">I am not yet so old, but he may think of me.</line>
<line xml:id="dr-035">My own fault, I have been idle a long time;</line>
<line xml:id="dr-036"><footnote role="margin1" xml:id="dr-036a"><para xml:id="dr-036b">140</para></
footnote>But I'll begin the week, and paint to-morrow,</line>
<line xml:id="dr-037">So follow my true labour day by day.</line>
<line xml:id="dr-038">I never thriv'd so well as when I us'd it.</line>
<poetry xml:id="dr-039a">
<info xml:id="dr-040"><title xml:id="dr-041"><emphasis role="smallcaps">the song</emphasis> [<emphasis
role="italic">sung by</emphasis> <emphasis role="smallcaps">isabella</emphasis>]</title></info>
<line xml:id="dr-042">What harder chance can fall to woman,</line>
<line xml:id="dr-043">Who was born to cleave to some man, </line>
<line xml:id="dr-044">Than to bestow her time, youth, beauty,</line>
<line xml:id="dr-045">Life's observance, honour, duty,</line>
<line xml:id="dr-046">On a thing for no use good,</line>
<line xml:id="dr-047">But to make physic work, or blood</line>
<line xml:id="dr-048">Force fresh in an old lady's cheek?</line>
<line xml:id="dr-049"><footnote role="margin1" xml:id="dr-036d"><para xml:id="dr-036c">150</para></
footnote>She that would be</line>
<line xml:id="dr-050">Mother of fools, let her compound with me.</line>
</poetry>
</linegroup>
<linegroup xml:id="dr-051">
10
Tested in Schematron: part-initial, part-medial, part-final
168
Blockquotes, epigraphs,
poetry and drama
<blockquote xml:id="b-9780571343713-1002297">
<drama xml:id="b-9780571343713-1002298" role="screenplay">
<dialogue role="line-below-speaker" xml:id="b-9780571343713-0002317">
<info xml:id="b-9780571343713-0002314a">
<title xml:id="b-9780571343713-0002314">3. MEDIUM SHOT – GIRL</title>
</info>
<linegroup xml:id="b-9780571343713-0002318">
<line xml:id="b-9780571343713-0002319" role="stageDirection">The <emphasis role="smallcaps">girl</
emphasis>, taking initiative at once, is already snatching up his trousers that are on a chair, picking up
his watch from the table beside the bed.</line>
</linegroup>
</dialogue>
<informalfigure xml:id="b-9780571343713-1002347">
<mediaobject xml:id="b-9780571343713-1002348">
<imageobject xml:id="b-9780571343713-1002349">
<imagedata fileref="images/sn4.jpg" format="image/jpeg"/>
</imageobject>
</mediaobject>
</informalfigure>
<dialogue role="line-below-speaker" xml:id="b-9780571343713-1002317">
<linegroup xml:id="b-9780571343713-0002320">
<speaker xml:id="b-9780571343713-0002321">Boy’s voice</speaker>
<line xml:id="b-9780571343713-0002322" role="stageDirection">(<emphasis role="italic">overscene,
continuing</emphasis>)</line>
<line xml:id="b-9780571343713-0002323">I thought it was this afternoon.</line>
<line xml:id="b-9780571343713-0002324">Camera pans back with the <emphasis role="smallcaps">girl</emphasis>
as she thrusts the trousers into the <emphasis role="smallcaps">boy</emphasis>’s hands and gives him his
watch.</line>
</linegroup>
<linegroup xml:id="b-9780571343713-0002325">
<speaker xml:id="b-9780571343713-0002326">GIRL</speaker>
<line xml:id="b-9780571343713-0002327">No. I told you I changed it. It’s at ten-fifteen. We’ve got twenty
minutes.</line>
</linegroup>
</dialogue>
</drama>
</blockquote>
Note
Note the use of line role='stageDirection' here to capture the stage direction.
<blockquote xml:id="b-0002538">
<para xml:id="b-0002539">Cricket</para>
<para xml:id="b-0002540">as explained to a foreign visitor</para>
11
Tested in Schematron: possible-poem
169
Blockquotes, epigraphs,
poetry and drama
170
Chapter 25. Interviews, questions/
answers
Occasionally, a book may include text which takes the form of an interview, where paragraphs are
preceded by the name of the person speaking (for instance). For such content, the dialogue element
MUST NOT be used. Instead, these MUST utilise the specific DocBook Q&A elements, with the
label to contain the name of the speaker:
<qandaset xml:id="qa1a">
<qandaentry xml:id="qa1b">
<question>
<label><emphasis role="italic">Interviewers</emphasis>:</label>
<para xml:id="qa1">During the last ten years, following the controversial popularity of <emphasis
role="italic">Sopyonje</emphasis>, you emerged as the most prominent film director in Korea. How has this
recognition affected your sensibility as a filmmaker?</para>
</question>
<answer>
<label><emphasis role="italic">Im Kwon-Taek</emphasis>:</label>
<para xml:id="qa2">Since the 1980s, I have been considering my films with these matters in mind...</para>
</answer>
</qandaentry>
</qandaset>
Implementation note: Default DocBook behaviour is to add a ToC for the Q&As; this must be
suppressed in the XSLT. Automatic styling for label must also be turned off (see http://
www.sagehill.net/docbookxsl/QandAtoc.html).
171
Chapter 26. Sidebars
The DocBook spec defines a sidebar as “A portion of a document that is isolated from the main
narrative flow.” This may be a block of text in a box, or similar feature.
In addition, sidebars MAY be used as a container for plate sections. See Section 21.6, “Plate sections”
Other content that is like a sidebar are procedures, which are also typically set apart from the main
flow of a text and probably typographically distinct. For such features, see Chapter 27, Steps and
procedures.
<info xml:id="si2">
<title xml:id="si3">Theory in focus</title>
<pagenums>9–10</pagenums>
<biblioid class="doi">10.5040/9781234567096.0003</biblioid>
<mediaobject xml:id="id0046mad">
<imageobject xml:id="id0047mad"><imagedata fileref="filename.pdf" format="application/pdf"/></imageobject>
</mediaobject>
</info>
<epigraph xml:id="si4"><para xml:id="si5">Men make their own history, but they do not make it just as they
please; they do not make it under circumstances chosen by themselves, but under circumstances directly
encountered, given, and transmitted from the past.<footnote xml:id="si6" label="1"><para xml:id="si7">Karl
Marx, ‘The Eighteenth Brumaire of Louis Bonaparte’, in <emphasis role="italic">Karl Marx:
Selected Writings</emphasis>, ed. David McLellan (New York and Oxford: Oxford University Press, 1977), p.
300.</para></footnote></para></epigraph>
172
Sidebars
<sidebar xml:id="si8">
<info xml:id="si9"><title xml:id="si10">Objective</title></info>
<para xml:id="si11">To establish and analyse the key theoretical concepts necessary for understanding new
historicism and cultural materialism</para>
</sidebar>
<section xml:id="si12">
<info xml:id="si13">
<title xml:id="si14">Clifford Geertz: Culture, thick description and local knowledge</title>
</info>
<sidebar xml:id="si15">
<info xml:id="si16"><title xml:id="si17">Summary</title></info>
<itemizedlist xml:id="si18">
<listitem xml:id="si19"><para xml:id="si20">Anti-humanism versus essentialist humanism</para></listitem>
<listitem xml:id="si21"><para xml:id="si22">Clifford Geertz’s definition of culture</para></listitem>
<listitem xml:id="si23"><para xml:id="si24">‘Thick description’</para></listitem>
<listitem xml:id="si25"><para xml:id="si26">‘Local knowledge’</para></listitem>
<listitem xml:id="si27"><para xml:id="si28">Criticisms of Geertz</para></listitem>
<listitem xml:id="si29"><para xml:id="si30">Summary of Geertz’s theory</para></listitem>
</itemizedlist>
</sidebar>
<para xml:id="si31">In Chapter 2, I surveyed the main currents of Shakespeare criticism from 1904 to
the 1970s. One of the most obvious differences between the critics we looked at in that chapter and the
new...</para>
If a book contains differently-styled sidebars, each sidebar type can take a different @role:
• sidebar1
• sidebar2
• sidebar3
• sidebar9
NOTE: values sidebar4 to sidebar9 should only be used for exceptional cases, and MUST NOT be
used without prior authorisation from Bloomsbury.
in which the sidebar is inserted directly in the para at the point at which it occurs in the text. Note
also that the “label” text is within the title since sidebar does not support an @label attribute:
173
Sidebars
which is supported by a Higher Education Academy grant (also see <link role="bib"
linkend="bibl6">Hammerstein 1999</link>, and see <emphasis role="bold"><link role="xref"
linkend="sb2">Chapter 3</link></emphasis>). He argues that involving students
<sidebar xml:id="sb2">
<info xml:id="sb3"><title xml:id="sb4">Vignette 11 University of Lincoln ‘Students as
Producers’</title></info>
<para xml:id="sb5">The University of Lincoln describes the initiative as follows:</para>
<blockquote xml:id="sb6"><para xml:id="sb7">We are the leading partner in a Government project which
enables students to learn through hands-on experience. Through practise and primary engagement with
research, students build and improve their critical skills...
Implementation note: The sidebars may need some light styling, and for each @role type
See also the Section 9.5.6.3, “Article Groups” in Section 9.5.6, “Article components (dictionary-type
content)”, where sections may be used for sub-articles.
174
Chapter 27. Steps and procedures
Occasionally, some books may contain features which are best described as a procedure, with
numbered or un-numbered steps. Typically, they will be typographically distinct from the
surrounding text, and can be thought of as a special type of sidebar. Most often these occur in specific
sorts of textbooks with a more practical dimension, eg Designing and Patternmaking for Stretch Fabrics:
<procedure xml:id="pr1">
<info xml:id="pr2"><title xml:id="pr3">Making a marker for cutting</title></info>
<step xml:id="pr4">
<para xml:id="pr5">Once you have a final pattern and fabric ready, it is time to lay out the pattern
pieces, make a marker, and cut out your garment. All garments, including first samples, should be cut out
using a marker. A marker is a tracing of the pattern on special marking paper that has printed lines and/
or numbers used for lining up the grainline.</para>
<para xml:id="pr6">Preparing the marker paper:</para>
<simplelist xml:id="pr7">
<member xml:id="pr8">Draw a line across the top edge of the marker 1" below the cut edge. This is in case
the fabric, which will be underneath, is not straight.</member>
<member xml:id="pr9">Draw a line 1/2" in from the sides of the marker paper. This is so that the selvedge
will not be in the final garment.</member>
<member xml:id="pr10">All markers waste 1" of fabric at each end of the marker, and 1/2" on each side.</
member>
</simplelist>
</step>
<step xml:id="pr11">
<para xml:id="pr12">Tracing the pattern pieces:</para>
<para xml:id="pr13">Trace all the pattern pieces (right side up), making sure to include every notch and
any drill marks.</para>
</step>
</procedure>
Implementation note: Default DocBook styling is for each step to be numbered; downstream
applications should support a slightly different rendering relative to base text, and support
[new method for suppressing numbering]
175
Chapter 28. Examples
As with tables and figures, examples can occur either with or without a title, for which the example
and informalexample elements MUST be used, respectively.
As with other numbered blocks, if the label "Example 1" is required, the "1" is stored as @label on
the containing element. Note that @label on informalexample is an extension of DocBook.
Implementation note: Default DocBook XSL does not support @label on informalexample
176
Chapter 29. Indexes and index terms
Ref: §1.70, §1.71, §1.72, §1.73, §1.74
If a book has an index, the terms MUST be marked up inline rather than as entities in themselves.
The terms MUST be positioned at the location in the text where they occur AND include an index
element to indicate the correct location of the index within the work.1
<index xml:id="b-0002163">
<info xml:id="b-0002163a">
<title xml:id="b-0002163b"><?page value="127"?>Index</title>
<pagenums>127–129</pagenums>
<mediaobject xml:id="b-ind-001">
<imageobject xml:id="b-ind-002">
<imagedata fileref="pdfs/9781849666565.0009.pdf" format="application/pdf"/>
</imageobject>
</mediaobject>
</info>
</index>
If the index includes some introductory text, this MUST be included, most likely as a para:
<index xml:id="b-0000707">
<info xml:id="b-0000708">
<title>Index</title>
<pagenums>129–131</pagenums>
<mediaobject xml:id="b-0000710">
<imageobject xml:id="b-0000711"><imagedata fileref="pdfs/9781472541697.0007.pdf" format="application/pdf"/
></imageobject>
</mediaobject>
</info>
<para xml:id="b-0000712">Although there is some overlap, this index generally omits entries for material
that is easily found under a heading or sub-heading shown in the table of contents.</para>
<index type="NameIndex">
<info xml:id="b-1001702-index1">
<title xml:id="b-4001702">Name Index</title>
If there are multiple index @types, where an indexterm has @class=endofrange (see next
section) such indexterm does NOT REQUIRE @type (since it is implied by the corresponding
indexterm[@class=startofrange]).5
1
Tested in Schematron: index-missing, indexterms-missing
2
Tested in Schematron: index-not-back
3
Tested in Schematron: missing-index-type
4
Tested in Schematron: wrong-index-type
5
Tested in Schematron: type-endofrange
177
Indexes and index terms
An indexterm can mark either a single point or a range, and MUST have a @class to indicate such
type.6 Terms can be up to three levels: primary, secondary and tertiary:
He believes that education is about the transmission of facts, which he confounds with knowledge<indexterm
class="singular" type="SubjectIndex" xml:id="b-0000511"><primary>knowledge</primary><secondary>as
commodity</secondary></indexterm>.
Index terms can also have ranges, but such ranges MUST NOT be within a itermset,7 they MUST
start before they end,8 have a start and end point,9 and MUST NOT occur within footnotes.10 The
@zone attribute is NOT TO BE USED in this instance of DocBook.11
And, of course, in the hands of those who describe and manipulate ‘the student experience<indexterm
class="startofrange" type="SubjectIndex" xml:id="b-0000620"><primary>authority</primary><secondary>and
experience</secondary></indexterm>’, it really does have nothing whatsoever to do with this.
...
Such a transaction is anathema to the very idea of experience itself: it denies experience while promising
to provide it.<indexterm class="endofrange" startref="b-0000620"/></para>
If an index term should be alpha-sorted differently from its content (eg ‘Mac’ surnames), the
@sortas MUST be used:
Furthermore, if some index terms are more important than others (usually rendered in bold in an
output format), use @significance:
To avoid downstream processing issues with whitespace, there MUST NOT be any space between
the term and the indexterm.
In addition, indexterms MUST NOT be between block elements, ie in practice all indexterms
MUST be within:13
• attribution
• emphasis
6
Tested in Schematron: indexterm-class-missing
7
Tested in Schematron: itermset-with-range
8
Tested in Schematron: end-before-start
9
Tested in Schematron: no-end-range
10
Tested in Schematron: range-in-footnote-1, range-in-footnote-2
11
Tested in Schematron: zone-present
12
See http://www.docbook.org/tdg5/publishers/5.1b3/en/html/indexterm.singular.html
13
Tested in Schematron: indexterm-location
178
Indexes and index terms
• entry
• itermset
• line
• member
• para
Occasionally,indexterms MAY appear within an index, but ONLY for retrospective data
conversion projects, if that approach is approved by Bloomsbury.
An indexterm MUST NOT appear within a title.14 If a term needs to be so placed, it MUST be
within an itermset within the division’s info. An indexterm is not permitted in an abstract,
either.15
<itermset xml:id="b-0000025">
<indexterm class="singular" xml:id="b-0000026"><primary>financial shock 2008–9</primary><see>Great
Recession</see></indexterm>
<indexterm class="singular" xml:id="b-0000027"><primary>recession</primary><see>Great Recession</see></
indexterm>
</itermset>
Note that, if a see reference is included within a book, it is an error to use the same primary term in
another index item.18 For example, given the following indexterms:
There is no way to construct a logical index because an entry in the index should never have both a
see and other content.
<itermset xml:id="b-0000275">
<indexterm class="singular" xml:id="0000276"><primary>leisure</primary><seealso>play</seealso></indexterm>
</itermset>
14
Tested in Schematron: indexterm-in-title
15
Tested in Schematron: abstract-indexterm
16
Tested in Schematron: see-seealso-target
17
Tested in Schematron: see-in-itermset
18
Tested in Schematron: see-mismatch
19
Tested in Schematron: see-seealso-target
179
Chapter 30. Elements we might not
need
At the present time it is unlikely that the following elements will be required at all, so their occurrence
is likely to be an error.1 If the data is likely to require one of these elements, please contact the
publisher.
acronym area
areaset areaspec artpagenums
bibliocoverage biblioentry biblioref bibliorelation
bibliosource citebiblioid citetitle collab
contractnum contractsponsor givenname literal
optional orgdiv
productname productnumber quote simpara
simplesect stepalternatives substeps
task taskprerequisites taskrelated tasksummary
trademark wordasword xref
1
Tested in Schematron: non-required-elements
180
Chapter 31. Schematron
This accompanying Schematron includes several hundred tests, most of which are cross-referenced
within this text, the main exceptions being numerous DocBook standard tests for element positions,
eg equation not allowed within equation etc.
In addition, the following tests are applied to report Information for each book to support spot checks
and additional QA:
• The proportion of unpublished and other bibliomixed items (if any) [proportion-unpub-other]
• The proportion of legal and case bibliomixed items (if any) [proportion-case-leg]
181
Schematron
182
Chapter 32. Worked examples
32.1. Front matter
32.1.1. Title page and contributors
<info>
<title>Brecht, Music and Culture</title>
<authorgroup>
<author><personname role="first-last"><firstname>Hans</firstname><surname>Eisler</surname></personname></
author>
<othercredit class="other" otherclass="other"><personname role="first-last"><firstname>Hans</
firstname><surname>Bunge</surname></personname><contrib>in Conversation with</contrib></othercredit>
</authorgroup>
<bibliomisc role="contributorStatement">Hans Eisler in Conversation with Hans Bunge</bibliomisc>
<authorgroup>
<othercredit class="other" otherclass="editorTranslator"><personname role="first-last"><firstname>Sabine</
firstname><surname>Berendse</surname></personname>
Notes:
183
Worked examples
Commentary:
2. The centering in the print is assumed to be handled by the print style template so does not need to
be reproduced here
3. The list of books is a list, not separate paragraphs, so needs to be grouped together in a
simplelist. These do not need to be in a bibliolist, which is only required for book lists that
need full biblio markup, ie bibliographies
Notes:
• On title verso
Commentary:
3. The centering of the content is assumed to be handled by the print style template so is not needed
here
184
Worked examples
Notes:
• The ‘normal’ heading “Part 5” does not actually appear (though it does on the table of contents)
185
Worked examples
</info>
<partintro xml:id="pt5-2">
<epigraph xml:id="e1">
<attribution role="right"><emphasis role="smallcaps">R. Murray Schafer</emphasis></attribution>
<para xml:id="ep1" role="center"><emphasis role="italic">Sounds cannot be known the way sight can be
known...</emphasis></para>
</epigraph>
</partintro>
<chapter xml:id="cp5" role="labelOverRide" label="Introduction to Part 5">
<info xml:id="cp5-1">
<title xml:id="cp5-2">Soundmarks: Environments and Aural Geography</title>
<pagenums>197–200</pagenums>
<biblioid class="doi">10.5040/9781609032229.009</biblioid>
<mediaobject xml:id="if3">
<imageobject xml:id="if4"><imagedata fileref="pdfs/9781609032229.009.pdf" format="application/pdf"/></
imageobject>
</mediaobject>
</info>
<para xml:id="cp1-10">The works of sound installation seek out a specificity of sound in which location and
listening intersect. The place of sound becomes as much a...</para>
</chapter>
</part>
Commentary:
1. This is part 5, so the @label value is included, even though the style of the print edition is to omit
it
2. The pagenums for the part title page are just for this page and the following blank one, not the
entire part
3. The quotes on the part title page MUST be contained within a partintro
4. The quotes are both epigraphs, since they occur at the beginning of the chunk; blockquote
would not be correct in this context
5. The attribution occurs first in the data, even though it may appear after the quote in the
rendered form; indeed, the DocBook default behaviour is to place it after the quote, though that
can be controlled in the DocBook customisation layer
6. The attribution takes a @role to indicate the alignment; DocBook default behaviour is to left
align an attribution
7. The dash before the name in the attribution should not be included, since that is a template
style
10.The content of the epigraph is styled with emphasis. There could be a case for the styling of
both this and the previous item to be implied by the template style
11.The next section starts a new page which is stylistically (and structurally) identical to a chapter
elsewhere in the book, so is contained within a chapter
12.The default labelling and numbering style for parts, chapters etc is “[element name] @label” if a
@label is present, so typically <chapter label="1"> would have a label “Chapter 1” or “1”
before the title (depending on the style template). In this case, the text “Introduction to Part 5” is
in the same style as “Chapter 13” which follows it. Therefore, that text is included as the @label,
but also includes the @role=labelOverRide to indicate that this chapter has non-standard
@label behaviour
13.The opening word has a drop cap in the print, but that is not replicated in the XML
186
Worked examples
Notes:
• This book is organised into “Sections” which contains numbered “Ideas”, each of which happens to
occupy a single page
• The book’s table of contents lists all the Ideas as if they were chapters
187
Worked examples
<biblioid class="doi">10.5040/9781609032229.0006</biblioid>
<mediaobject xml:id="h4">
<imageobject xml:id="h5"><imagedata fileref="pdfs/9781609032229.0006.pdf" format="application/pdf"/></
imageobject>
</mediaobject>
</info>
<partintro xml:id="h6">
<para xml:id="h7">While generally happy to be looked after by anyone who is competent, warm and caring,
newborn and very young babies already show...</para>
</partintro>
<chapter xml:id="h8" label="Idea 1" role="labelOverRide">
<info xml:id="h9">
<title xml:id="h10">Snug as a Bug</title>
<pagenums>2</pagenums>
<biblioid class="doi">10.5040/9781609032229.0007</biblioid>
<mediaobject xml:id="ha4">
<imageobject xml:id="ha5"><imagedata fileref="pdfs/9781609032229.0007.pdf" format="application/pdf"/></
imageobject>
</mediaobject>
</info>
<informaltable xml:id="h11" frame="none">
<tgroup cols="3">
Commentary
The Section is encoded as a part with “Section 1” as its @label and, because it is a non-
standard label, must have @role=labelOverRide
The pagenums for the Section 1 introductory text just takes the page it occupies
Its text is encoded within partintro
Then the Idea content is within a chapter, with “Idea 1” as its @label and because it is a non-
standard label, must take @role=labelOverRide
The Idea occupies a single page, which is recorded in pagenums
The first item of text is a simple table, using informaltable and @frame=none
The header of which has a row below, so has @rowsep=1
Other rows do not have a separator so need @rowsep=0
The Safety Note is styled differently so can be placed in a sidebar (in this case with
@role=sidebar1 so all such Notes can be styled the same)
The Safety Note icon is encoded as a mediaobject directly in the text; it is not a figure or
informalfigure since it is simply serving as an icon; its position is to be controlled by the
downstream style template
188
Worked examples
Note:
Commentary:
1. Note use of @role=labelOverRide; see elsewhere in this document for further description of its
use.
2. It makes most sense to make "14 Ways of Describing Rain" etc the title since it is in bigger type
than the date
4. Include @label on all the footnotes since they are numbered sequentially throughout the book;
the only occasion when you don't need to add @label to footnotes is when they are numbered 1-n
within a single chapter.
5. There is a titleabbrev too, which is where you can store the running head since it is not
necessarily straightforward to generate it from the text.
189
Worked examples
Here is an example:
190
Worked examples
Within the style of this book, the heading “Beyond Cultural Industries” is level 1, and “Integrated
development” is level 2. This can only be achieved using the floating bridgehead element with
appropriate @renderas:
</figure>
China reached 1.13 billion including 300 million landline users and 830 million
mobile phone users. Broadband users increased to 110 million in 2010.<footnote
xml:id="ba-9781849666565-0000854"><para xml:id="ba-9781849666565-0000855"><bibliolist
role="inline" xml:id="ba-9781849666565-0002048zz"><bibliomixed role="website"
xml:id="ba-9781849666565-0002049yy"><author><orgname>Statistics from the Ministry of Industry and
Information Technology of P.R.China</orgname></author>. <title><emphasis role="italic">China Daily</
emphasis></title>, <pubdate>29 June 2010</pubdate>. <link xlink:href="http://www.chinadaily.com.cn/
hqgj/jryw/2010-06-29/content_512367.html"><uri>http://www.chinadaily.com.cn/hqgj/jryw/2010-06-29/
content_512367.html</uri></link> [accessed <date role="accessed">8 March 2011</date>]</bibliomixed></
bibliolist>.</para></footnote></para>
<bridgehead renderas="sect2" xml:id="ba-9781849666565-0000867">Integrated development</bridgehead>
<para xml:id="ba-9781849666565-0000868">In a 2002 research paper I identified three development trends of
modern industries: industrial clusters, industrial convergence and industrial ecology.
191
Worked examples
The Chapter Outline is only a table of contents. As such it can be generated entirely from the XML
structure, should it be required, so MUST NOT have a separate representation in the data.1
The Abstract MUST be within an abstract element in the chunk info, and take
@role=authorAbstract:
1
Tested in Schematron: remove-chapter-outline
192
Worked examples
193
Worked examples
Notes:
• This would ordinarily be a normal chapter with sections, bibliography and then notes (see
Section 18.2.1, “End of chapter notes”), but the material at the end (the appendix) causes issues since
the schema does not permit appendix within a chapter
194
Worked examples
Commentary:
2. However, because it ends with an appendix, all of the child units MUST be within a section,
even if a more semantically correct element would normally be used (such as here, where
bibliography would be more typical)
4. The Notes section is called in using the processing instruction in the usual way
32.4. Glossary
Many glossaries occur as chunks at the beginning or end of books; alternatively, they may occur at the
end of a chapter or as part of an appendix etc. In such cases, the glossary MAY be a child element
of a chunk, or the glossary content may simply be within a glosslist. This example illustrates how
general layout is not encoded within the glossary elements:
195
Worked examples
Notes:
<glossentry xml:id="consideration">
<glossterm><emphasis role="bold">consideration</emphasis></glossterm>
<glossdef xml:id="g4"><para xml:id="g6">something of value offered in order to persuade another party to
enter a <link role="xref" linkend="contract"><emphasis role="smallcaps">contract</emphasis></link>.</
para></glossdef>
</glossentry>
<!-- Text omitted for clarity -->
<glossentry xml:id="contract">
<glossterm><emphasis role="bold">contract</emphasis></glossterm>
<glossdef xml:id="g7"><para xml:id="g8">a legally enforceable agreement.</para></glossdef>
</glossentry>
Commentary:
1. Term IDs can use the term itself, if that makes it easier to construct internal cross references
2. The definition is within a para, even though in this case the print edition renders it as following on
from the term
32.5. Linking
32.5.1. Short-form bibliographic references
All bibliomixed should usually be referenced at least once in the text. Sometimes it can be difficult
to find the referring string in the text, and these examples illustrate some of the issues.
Here, the author is mentioned, but the date of the article cited is right at the end of the following
blockquote:
Baroness Tessa Blackstone, Vice-Chancellor of the University of Greenwich, commented in the short debate in
the House of Lords:</para>
<blockquote xml:id="ba-9781849666459-0000112">
<para xml:id="ba-9781849666459-0000113">No-one could have predicted that such a review would double the
fees then proposed and assume that the public funding of 80 per cent of undergraduate tuition would be
abandoned. Nor would anyone have predicted that this review would be based on a commitment to the free
market that is so extreme that it abandons, to quote Sir Peter Scott, a much respected vice-chancellor and
former member of the HEFCE board, ‘the very idea of a public system of higher education, built with
such care and effort since Robbins’. (<link role="bib" linkend="ba-9781849666459-0002171">2010</
link>)</para>
196
Worked examples
</blockquote>
which then references the following bibliomixed:
<bibliomixed role="article" xml:id="ba-9781849666459-0002171"><bibliomset relation="article"
xml:id="ba-9781849666459-0002172"><author><personname role="last-first"><surname>Blackstone</
surname><honorific>Baroness</honorific></personname></author> (<pubdate>2010</pubdate>),
‘<title xml:id="ba-9781849666459-0002173">House of Lords Debate, 27 October 2010</
title>’</bibliomset>, <bibliomset relation="journal" xml:id="ba-9781849666459-0002174"><title
xml:id="ba-9781849666459-0002175"><emphasis role="italic">Hansard</emphasis></title>, <address
xml:id="ba-9781849666459-0002176"><city>London</city></address>: <publishername>Hansard</publishername>.
col. 1238. Available at: <link xlink:href="http://www.publications.parliament.uk/pa/ld201011/ldhansrd/
text/101027-0001.htm#10102762000053"><uri>http://www.publications.parliament.uk/pa/ld201011/ldhansrd/
text/101027-0001.htm#10102762000053</uri></link> [<date role="accessed">27 July 2011</date>].</
bibliomset></bibliomixed>
each vice-chancellor and pro-vice chancellor in the UK should be obligated to read and reflect on Boulton
and Lucas's words on the societal role of the university:</para>
<blockquote xml:id="ba-9781849666459-0001056">
<para xml:id="ba-9781849666459-0001057">Universities are not just supermarkets for a variety of public
and private goods that are currently in demand, and whose value is defined by their <?page value="73"?
>perceived aggregate financial value. We assert that they have a deeper, fundamental role that permits
them to adapt and respond to the changing values and needs of successive generations, and from
which the outputs cherished by governments are but secondary derivatives. To define the university
enterprise by these specific outputs, and to fund it only through metrics that measure them, is to
misunderstand the nature of the enterprise and its potential to deliver social benefit. (<link role="bib"
linkend="ba-9781849666459-0002192">2008</link>: 17)</para>
</blockquote>
Alternatively, the author’s name and the date to be linked may simply be some distance away in the
same paragraph:
In 2010 George Monbiot wrote: ‘Through networking, confidence, unpaid internships, and
most importantly attendance at top universities, the privately educated upper middle classes run
politics, the civil service, the arts, the city, law, medicine, big business, the armed forces,
even, in many cases, the protest movements challenging these powers’ (<link role="bib"
linkend="ba-9781849666459-0002625">2010</link>).
For example:
The short form reference in each chapter MUST link to the correct target for that chapter. It is an
ERROR if the short form references for a particular chapter resolve to the bibliomixed for that
book but belonging to the bibliography of another chapter. In such a case, there will be lots of
warnings of unresolved bibliomixed items, which MUST be checked.2
2
See in Schematron: bibliomixed-referenced
197
Worked examples
32.6. Bibliographies
32.6.1. Inconsistent biblio style
This warning highlights a case where there is an inconsistent style in a bibliography. Typically a
bibliography is ordered by the surname of the first-named author, and this test identifies if there is a
mixture of such items.3
Description: Not all of the biblio items have the same personname @role style [first-last=1 / last-
first=56]
So, to find the odd one out, use these two XPath queries:
• bibliomixed/element()/personname[1][@role='first-last']
• bibliomixed/bibliomset[1]/element()/personname[1][@role='first-last']
The first one doesn’t retrieve any results, but the second one identifies the incorrect item. Note that in
this case there is just one personname[@role=first-last] as the first name in the bibliography,
whereas all others are last-first:
198
Worked examples
Description: Should the surname element be a firstname? Its content = Kevin, + also check sibling firstname
element and that parent personname[@role] is correct
And notice also that there is a name in the middle with only a surname (which also generates a
warning).
Wetmore, Kevin (2009), ‘“The amazing adventures of superbard”: Shakespeare in comics and
graphic novels’, in Jennifer Hulbert, Kevin J. Wetmore and Robert L. York (eds), Shakespeare and
Youth Culture. Houndmills: Palgrave, pp. 171–98.
Correct markup, in which all the components that have been modified in some way are highlighted:
In this example, the editors of the book must be in the bibliomset[@relation=book] (the
following example includes INCORRECT markup):
199
Worked examples
Description: Biblio item contains editor element that is not in a bibliomset, which is very unusual. Is
that correct?
32.7. Lists
32.7.1. A simple list with title, columns and notes
Notes:
5
See in Schematron: element-not-bibliomset
200
Worked examples
• At first sight, this looks like section headings and footnotes, but that is not the case
<para xml:id="o10">* Date of program initiation: Queens College [CUNY], 2007; Rutgers University of Newark,
2007;...</para>
Commentary:
1. The text could in principle be modelled as two sections, though since all the notes have
to be in a para, that would result in the notes not belonging in the section to which they
belonged, so it makes most sense for this to be treated as a list; and importantly, this is an
itemizedlist[@mark=none] because it has a title
2. The notes are not footnotes as they simply appear in the text below the lists, so are simply
captured as paras, with a link
4. This means that items that run over two lines in print are encoded within a single listitem
5. The link target is includes the note label (asterisk) in the text
32.8. Tables
32.8.1. A relatively simple table
201
Worked examples
Notes:
<para xml:id="t1">While the reasons for such differences are not well understood, one possible explanation
lies in the distance the
<table xml:id="t2" label="2.1" frame="topbot">
<info xml:id="t3">
<title xml:id="t4">Average slave mortality in the Middle Passage, 1590–1867C</title>
</info>
<?dbhtml table-width="80%"?>
<?dbfo table-width="80%"?>
<tgroup cols="3">
<colspec align="left" colnum="1" colname="col1" colwidth="1*"/>
Commentary:
2. The label “TABLE 2.1” is assumed to be autogenerated and triggered by the presence of @label.
Style of the “TABLE 2.1” label is a design template issue, not to be captured in the data
3. The @frame attribute gives a reasonable amount of control of the table borders and should reflect
what is required in the print edition. Here the option is to have a top and bottom rule
4. Table width MUST be specified using both the processing instructions (for HTML and pdf output)
as illustrated (see Bob Stayton DocBook XSL: The Complete Guide)
5. The number of columns MUST be specified, since this helps downstream processing
7. Column alignment is controlled via @align, and can be overridden at the row and entry level as
well
9. It is prudent to add a @colname, though these are only used for spans
10.The column width is controlled with @colwidth, and MUST take relative values only
202
Worked examples
12.The table head MUST be in a thead. The style of the head in print is controlled via design
template and is not encoded in the data
13.An entry can take a different @align to override that specified in the colspec
14.The rowsep adds a border to the bottom of the row, though the last row does not need one since
table[@frame=topbot]
15.The source data at the foot of the table is in caption; it MUST NOT be in tfoot
Notes:
• There are notes in the table with their targets at the bottom of the page
203
Worked examples
• The borders are significant and add clarity to the content so MUST be encoded
204
Worked examples
</row>
<row xml:id="b652" rowsep="0">
<entry xml:id="b654"><para xml:id="b655">Graduates</para></entry>
<entry xml:id="b656" align="left" namest="col3" nameend="col5"><para xml:id="b657">48.7 million (2005)<link
role="xref" linkend="b550"><superscript>f</superscript></link></para></entry>
</row>
</tbody>
</tgroup>
<caption xml:id="c1">
<para xml:id="b545"><superscript>a</superscript> ‘Census Data 2001: India at a Glance:
Population’, <!-- Text omitted for clarity -->
</para>
<para xml:id="b546"><superscript>b</superscript> <!-- Text omitted for clarity -->
</para>
<para xml:id="b547"><superscript>c</superscript> <!-- Text omitted for clarity -->
</para>
<para xml:id="b548"><superscript>d</superscript> <!-- Text omitted for clarity -->
</para>
<para xml:id="b549"><superscript>e</superscript> <!-- Text omitted for clarity -->
</para>
<para xml:id="b550"><superscript>f</superscript> <!-- Text omitted for clarity -->
</para>
</caption>
</table>
Commentary:
2. The @pgwide makes the table occupy the full width of the page
5. This table does not have a thead, since there isn’t a row that serves that purpose
6. The @rowsep is used on all the rows to determine if a border should be below it or not
7. The @morerowsspecifies how many extra rows the cell must span
8. The content of the cells is in a para, which can be useful for controlling aspects of the alignment
and other features of the content
11.The cell at row 1, col 3 spans three columns using the @namest and @nameend, the values of
which MUST match the corresponding colspec[@colname] (alternatively, you can use a
spanspec at the top of the table and reference that)
12.Where the is a row span using @morerows, the rows below MUST have a correspondingly
reduced number of entrys
15.The notes are all separate paras in the caption, with the para[@xml:id] being the target of the
link[@linkend]
16.The label of the note is encoded in the data within a superscript, with a space afterwards
32.9. Appendices
Appendices can often contain a rag-bag of content which has irregular layout and structure. Some
examples are given below.
205
Worked examples
Notes:
206
Worked examples
Commentary:
1. The first block is effectively a nested list, for which we have to use itemizedlist with
@mark=none
2. Subsequent paragraphs are full out and separate from their siblings, so have
@role=spaceBefore
Notes:
• Groups of text
<section xml:id="r1">
<info xml:id="r2">
<title xml:id="r3">Week Six: The makings of character #3: Talk to me—character dialogue</title>
</info>
<simplelist xml:id="r4">
<member xml:id="r5">Teacher: Eric Fershtman</member>
<member xml:id="r6">Location: Lakeside Behavioral Healthcare, Orlando, FL</member>
</simplelist>
<simplelist xml:id="r7">
<member xml:id="r8"><emphasis role="bold">Warm-up exercise:</emphasis> (5 minutes)</member>
<member xml:id="r9">At the top of our page we'll complete the prompt:...</member>
</simplelist>
</section>
Commentary:
1. In this instance there are no nested lists, so each group can be accommodated within a
simplelist
207
Worked examples
Notes:
208
Worked examples
Commentary:
1. All Level 2 headings in this book are italicised so we don’t need to capture that style information in
the title
2. All the data in list can be modelled with the project name as the top level item, and the child
components within a nested list, with the uri in one para and and other information in a sibling
para within the same listitem (ie rather than treat the uri and following para as separate
listitems, which effectively ungroups their relationship)
209
Worked examples
Notes:
Commentary:
1. Font differences are encoded using emphasis[@role]. Note that this starts both italic and sans-
serif, and that the question mark is included within the span
210
Worked examples
Notes:
<para xml:id="l4">... is not surprising. The negative marker does not scope either over the N-word or its
copy as shown in (<link role="xref" linkend="l5">61</link>).</para>
<orderedlist xml:id="l5" startingnumber="61">
<listitem xml:id="l7a"><para xml:id="l8">[TP personn [vP <emphasis role="line-through">personn</emphasis>
le [TP mo pa ale]]]</para></listitem>
</orderedlist>
Commentary:
1. Where there are numbered examples, the cross references to them throughout the text are linked
2. We have used orderedlist here. The example element has not been used because that is for
more formal examples with titles. However, the default DocBook behaviour for orderedlist
numbering is to have just the number followed by a stop (“61.”); the output can be changed in
the DocBook customisation layer so it could be rendered as “(61)”. Consequently, it would also be
permissible to mark this up as an informaltable with two cells, one for the number and one for
the content. See also the next example.
3. With orderedlist, it is possible to specify the starting number, or if the numeration continues
from the previous orderedlist, an alternative is to use @continuation="continues"
4. For strike-through, the emphasis element has been used with an appropriate @role
Notes:
211
Worked examples
Commentary:
1. As in the previous example, we have used orderedlist for the example, though it could have
been contained within an informaltable; for a given book, the approach adopted for all such
examples MUST be the same; it would not be right to mix the two
2. There are two examples, numbered “a” and “b”, so we need another orderedlist within the top-
level one, this time with @numeration=lower-alpha to specify the numbering style
3. Then, within each listitem, the layouts are managed within an informaltable, which has all
the row and cell borders switched off
5. The second row in each item has a final entry with a column span; since there aren’t any borders
on the cells it would have been permissible to have an empty entry following it instead
6. However, the third row of each listitem must have a column span since its content runs across
the table underneath the content above
7. The second listitem starts and will trigger the automatic numeration (“b.”)
212
Worked examples
32.11. Poetry
32.11.1. Marginal line numbers, spacing and translation
Notes:
• There is a translation
<para xml:id="q1">In place of the biblical "Song of the Sea" we find the following injunction to the
Israelites, and to his listening and reading audience:</para>
<blockquote xml:id="q2">
<poetry xml:id="q3">
<line xml:id="q4">Wile nu gelæstan      þæt he lange gehet</line>
<line xml:id="q5">mid aðsware,      engla Drihten,</line>
<line xml:id="q6">in fyrndagum      fæderyncynne,<footnote role="margin1"
xml:id="b-9781474208482-0009553"><para xml:id="q8">560</para></footnote></line>
<!-- Text omitted for clarity -->
</poetry>
<para xml:id="q9">The Lord of Angels wishes to fulfill now what He had promised long ago in days of old to
our forefathers...</para>
<!-- Text omitted for clarity -->
</blockquote>
<para xml:id="q10">The passage reiterates the terms of the Sinai Covenant (updated...</para>
Commentary:
1. The text is inset relative to the margin since it is quoted, so is in a blockquote. If this chapter only
contained poetry (ie was not quoted), there would not be a blockquote container
213
Worked examples
3. Unicode non-breaking space characters are used for standard gaps and spaces within text
4. The footnote[@role=margin1] is used for all marginal line numbers. If there were marginal
notes on both sides of the page @role=margin2 would be used for the second series of notes. The
assumption is that no traditional footnote or endnote numbering is automatically generated with
these values of @role
5. The translation text is still within the blockquote container since it is indented and is part of the
quoted text
32.12. References
32.12.1. Archive list
A bibliographic section may sometimes contain a list of archives which have been consulted,
in addition to the books and journals. The contents of such a list are not bibliographic items in
themselves, so bibliomixed MUST NOT be used for this content.
Notes:
• There are two sections in the References chunk: Archival Sources, and then Secondary Sources, the
latter containing the books and journals
• Each archive group starts with the name of the archive, and then the following lines list the
collections referenced from that archive
<chapter xml:id="ba-9781849662932-bibliography-0008">
<info xml:id="ba-9781849662932-0015154">
<title xml:id="ba-9781849662932-0015155"><?page value="358"?>References</title>
<pagenums>358–384</pagenums>
<biblioid class="doi">10.5040/9781472544216.0008</biblioid>
<mediaobject xml:id="ba-9781849662932-0008-001">
<imageobject xml:id="ba-9781849662932-0008-002">
<imagedata fileref="pdfs/9781472544216.0008.pdf" format="application/pdf"/>
</imageobject>
</mediaobject>
</info>
<section xml:id="ba-9781849662932-0015157">
<info xml:id="ba-9781849662932-0015158">
<title xml:id="ba-9781849662932-0015159">Archival Sources</title>
</info>
<para xml:id="ba-9781849662932-0015156">Archives are listed below. Reference details for particular archive
documents are given in the footnotes only.</para>
<itemizedlist xml:id="il1" mark="none">
214
Worked examples
<info xml:id="il2"><title xml:id="il3">Archiv für die Geschichte der Soziologie in Österreich, Universität
Graz:</title></info>
<listitem xml:id="il4"><para xml:id="il5">Else Frenkel-Brunswik Papers</para></listitem>
<listitem xml:id="il6"><para xml:id="il7">Interview Collection</para></listitem>
<listitem xml:id="il8"><para xml:id="il9">Marie Jahoda Papers</para></listitem>
<listitem xml:id="il10"><para xml:id="il11">Paul F. Lazarsfeld, Microfilms</para></listitem>
</itemizedlist>
<itemizedlist xml:id="ba-9781849662932-0015162" mark="none">
<info xml:id="il12"><title xml:id="il13">Columbia University, Rare Book and Manuscript Library, New York:</
title></info>
<listitem xml:id="il14"><para xml:id="il15">Paul F. Lazarsfeld Papers</para></listitem></itemizedlist>
<!-- Text omitted for clarity -->
</section>
<section xml:id="ba-9781849662932-0015180"><info xml:id="ba-9781849662932-0015181"><title
xml:id="ba-9781849662932-0015182">Secondary Sources</title>
</info>
<bibliolist xml:id="bl1">
<bibliomixed role="monograph" xml:id="ba-9781849662932-0015183"><editor><personname role="last-
first"><surname>Abb</surname><firstname>Gustav</firstname></personname></editor> (ed.) (<pubdate>1930</
pubdate>), <title xml:id="ba-9781849662932-0015184"><emphasis role="italic">Aus fünfzig Jahren
deutscher Wissenschaft. Die Entwicklung ihrer Fachgebiete in Einzeldarstellungen</emphasis></title>,
<address xml:id="ba-9781849662932-0015185"><city>Berlin</city></address>: <publishername>de Gruyter</
publishername>.</bibliomixed>
Commentary:
1. Because the section “Archival Sources” does not contain any bibliographic items (bibliomixed)
the schema does not permit the container element to be a bibliodiv. Therefore, because this
bibliography contains mixed content (ie lists AND bibliographic references) the container element
for the chunk as a whole has to be within a chapter NOT a bibliography so that the necessary
elements are available.
2. This now allows us to use sections for each of the major divisions within the chunk
3. Each archive list needs to be within an itemizedlist, and can take @mark=none, and the
archive name can be within a title in the list
5. This means that the biblio items have to be contained within a bibliolist
Because back of book and end of chapter notes are placed where the note is called, this means that
there is often no place to put these page breaks that is strictly accurate, since page break markers are
NOT permitted in footnote elements (since it will overly complicate the other tests). So, for this
example:
215
Worked examples
the page break markers are placed before the corresponding processing instruction insertion point,
which may mean in this case that some page break markers are missing:
<?page value="262"?>
<?insert item="end-bk-notes" chunk="ba-9781849662192-chapter-008" title="Conclusion"?>
</chapter>
216
Worked examples
<para xml:id="ba-9781472542069-0000398">The chapters that follow reflect the progression we have adopted
in this review chapter. We began with a micro-level focus on laughs themselves, attending to their
commonalities and their varieties. We considered their placements: freestanding, within turns at talk
in different locations, or following talk. We have given considerable attention to laugh sequences
including laughables, laugh invitations, shared laughter, and resistance. We have discussed the ways
that laugh sequences contribute to displays of alignment or resistance, affiliation or disaffiliation.
Finally, attention has been given to the ways that laughter plays a part in the construction of contexts
and identities. Through the organization of laughter, people show themselves to be participating in
different kinds of events and settings. Whether conceived of in terms of institutional role, individual
difference, gender, or nationality, who we are is in no small measure built out of small moments
of laughter—distinctively produced, precisely placed, systematic, and specific in what it
accomplishes.</para>
</section>
<?insert item="end-ch-notes" title="Notes"?>
<?page value="22"?>
</chapter>
<part label="1" xml:id="ba-9781472542069-0000406">
<info xml:id="ba-9781472542069-0000175v">
<title xml:id="ba-9781472542069-0000176v"><?page value="23"?>Varieties of Laughter</title>
217
Worked examples
Commentary
1. Note that the attribution is always the first element (if present) in an epigraph, irrespective of
where it is actually placed in the layout.
218
Worked examples
These are the pages following on from the previous example, and complete the partintro.
Commentary:
• The image will also require an @outputformat to determine that it is for web use, and note that it
has a @contentwidth to specify the display width in pixels
219
Worked examples
This is the style of the main content chunks within each part, and follows on from the previous
example. The header at the top of page 21 provides pointers for the related chunks about the same
piece of work in the other parts of the book. Similarly, the Process box on page 20 summarises the
keywords relating to the chunk in bold, and includes the keywords for the related items from the
other chunks in a lighter font.
The background image on page 20 is decorative only and is not included in the XML.
<chapter>
<info>
<title>Hope for the Future</title>
<subtitle>An investigation into movement and dance, using zero-waste and sustainable methods.</subtitle>
<othername class="other" otherclass="contributor"><personname role="first-last"><firstname>Janelle</
firstname><surname>Abbott</surname></personname></author>
</info>
<sidebar>
<info>
<title>Process</title></info>
<informaltable frame="none"colsep="0" rowsep="0">...</>
</sidebar>
<para>This was Janelle’s final project within her ‘Concepts’ course during her third year of
study in pursuit of her BFA degree in Fashion Design at Parsons The New School for Design.</para>
Commentary:
1. The chunk title is taken from the right hand page, but the subtitle is on the left
2. The name is not strictly the author of the text, though is the subject of the discussion and the author
of the design works, so othername is used
3. The Process block is set apart from the text in a sidebar. If there are multiple sidebars in a book
that have different semantic function, they can be differentiated using @role
220
Worked examples
4. The items within the Process sidebar are just a list; and simplelist is adequate for each of the
three columns (so, the informaltable has one row, containing three cells, each of which contains
a simplelist)
Again, this follows on from the text in the previous example, and is regular text with some figures:
Commentary:
1. There is only one title for all three figures on the page, so that is contained within a figure//
title, and the other images are just contained within informalfigure, each with @label
221
Worked examples
Commentary:
1. The phrase elements ( , ) have been added to enable the switching off of print-
only content for online usage, and some new textual content has been added (within
phrase[@outputformat=web] ), so that the text makes sense for online usage
3. For new books it is preferable if the text can be authored in such a way as to be format-neutral
1. Series data
</biblioset>
During the first decade of his publishing career extending from 1882 to 1892, de Margerie
placed his articles, critical notes and reviews almost exclusively in geological journals, but
in 1894 he was invited by Paul Vidal de la Blache (Geographers Vol. 12) to join the editorial
board of the fledgling Annales de Géographie in place of the colonial geographer Marcel
Dubois (Geographers Vol. 30) who had been its co-founder in 1891. Lucien Gallois, a disciple and
colleague of Vidal’s, also joined the board in 1894 and was an obvious choice (Claval 1998, 80)
(on Gallois, see Geographers Vol. 24).
222
Worked examples
Where the targetdoc is the target book ID, and the targetptr is the target chunk ID:
<para xml:id="k8">During the first decade of his publishing career extending from 1882 to 1892, de Margerie
placed his articles, critical notes and reviews almost exclusively in geological journals, but in 1894 he
was invited by <olink type="otherBook" targetdoc="b-9780987654321" targetptr="b-9780987654321-001">Paul
Vidal de la Blache</olink> (<emphasis role="italic">Geographers</emphasis> Vol. <olink type="otherBook"
targetdoc="b-9780987654321" targetptr="b-9780987654321-001">12</olink>) to join the editorial
board of the fledgling <emphasis role="italic">Annales de Géographie</emphasis> in place of
the <?page value="36"?>colonial geographer <olink type="otherBook" targetdoc="b-9780987654321"
targetptr="b-9780987654322-002">Marcel Dubois</olink> (<emphasis role="italic">Geographers</emphasis>
Vol. <olink type="otherBook" targetdoc="b-9780987654321" targetptr="b-9780987654322-002">30</
olink>) who had been its co-founder in 1891. <olink type="otherBook" targetdoc="b-9780987654321"
targetptr="b-9780987654323-003">Lucien Gallois</olink>, a disciple and colleague of Vidal’s, also
joined the board in 1894 and was an obvious choice (<link role="bib" linkend="bl2">Claval 1998</link>,
80) (on Gallois, see <emphasis role="italic">Geographers</emphasis> Vol. <olink type="otherBook"
targetdoc="b-9780987654321" targetptr="b-9780987654323-003">24</olink>).</para>
Note that some explicit cross references may include multiple items, so their preceding instances may
be earlier in the paragraph than expected:
<para xml:id="p9">Over the years, de Margerie contributed numerous book reviews to the <emphasis
role="italic">Annales de Géographie</emphasis>, including commentaries on the doctoral monographs
of some of Vidal’s immediate disciples such as <olink type="otherBook" targetdoc="b-9780987654321"
targetptr="b-9780933654321-001">Emmanuel de Martonne</olink> (1873–1955), who researched the
physiography of the Transylvanian Carpathians, and <olink type="otherBook" targetdoc="b-9780987654321"
targetptr="b-9780923654321-005">Antoine Vacher</olink> (1873–1919), who analysed the physical geography
of the province of Berry in central France (De Margerie <link role="bib" linkend="v10">1908a</
link>, <link role="bib" linkend="v15">1909</link>) (on de Martonne and Vacher, see <emphasis
role="italic">Geographers</emphasis> Vols <olink type="otherBook" targetdoc="b-9780987654321"
targetptr="b-9780933654321-001">12</olink> and <olink type="otherBook" targetdoc="b-9780987654321"
targetptr="b-9780923654321-005">31</olink>, respectively).</para>
In addition, books in the series MAY include implicit cross references to named individuals who are
included in subsequent volumes in the series. These will obviously not have any explicit reference,
so as much as possible the first occurrence in any chunk of any name matching one of the list in the
accompanying spreadsheet MUST also be made into a olink.
Implementation note: olink is not supported in DocBook XSL and will need specific handling;
it may have loader implications, since a book in the series could link to any other book in the
series.
223
Worked examples
This REQUIRES the use of a variablelist, with each biblio item to be within the listitem, and
include an implied pubdate as well as author:
See also the sub-section ‘Section 16.7.10, “Implied authors (books)”’ in Section 16.7, “Books”.
Note
Bloomsbury will advise where this is the case.
6
Tested in Schematron: lawstatedate-missing
224
Worked examples
If a date for this field has not been supplied, please contact Bloomsbury.
The main issue with these is that they are structurally more complex than may at first appear,
especially tables of statutes which have sophisticated layout requirements, with implied content, as in
the following example. Note how the ‘s’ of the section numbers align, but if the ‘s’ is omitted, then the
number aligns, and if that is omitted then the subsection aligns:
<variablelist xml:id="djdu7">
<varlistentry>
<term xml:id="jfu7">Access to Justice Act 1999</term>
<listitem xml:id="kfi8s">
<variablelist xml:id="dod93">
<varlistentry>
<term xml:id="fe66d">s 6(8)</term>
<listitem xml:id="dlod93">
<para xml:id="dkd63">
<link linkend="fp1-01" role="xref">1.01</link>
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term xml:id="fkfi8">Alcoholic Liquor Duties Act 1979</term>
<listitem xml:id="kfi8ss">
<para xml:id="d973">
<link linkend="fp1-01" role="xref">1.01</link>
</para>
<variablelist xml:id="dsy36n">
<varlistentry>
<term xml:id="ssk3">s 8</term>
<listitem xml:id="d9d9d">
<para xml:id="dkdd9s">
<link linkend="fp1-01" role="xref">1.01</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
225
Worked examples
</para>
</listitem>
</varlistentry>
<varlistentry>
<term xml:id="dkdid84s"><phrase condition="hidden">s 10</phrase>(4)</term>
<listitem xml:id="ddkd9ssa">
<para xml:id="s9slq">
<link linkend="fp1-01" role="xref">1.01</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term xml:id="ddkddj53"><phrase condition="hidden">s</phrase> 11</term>
<listitem xml:id="ddd8756l">
<para xml:id="dld0987">
<link linkend="fp1-02" role="xref">1.02</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term xml:id="shs73p"><phrase condition="hidden">s 11</phrase>(3)</term>
<listitem xml:id="ploki48">
<para xml:id="dodd9">
<link linkend="fp1-01" role="xref">1.01</link>
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
Implementation note: The fine rendering of this is not supported in DocBook XSL.
<formalpara xml:id="bp-9781234567890-fp1.01">
<info xml:id="djdid">
<title xml:id="lk98">1.01</title>
</info>
<para xml:id="dj87"><emphasis role="bold">Subject matter of the book.</emphasis> The subject matter of this
book is the rules governing the voluntary inter vivos assignment of contractual rights. Such transactions
involve the transfer of a contractual right from the owner (assignor) to the transferee (assignee).
The person bound to perform the correlative obligation is either (in the case of a debt) the debtor or
(in the case of some other contractual performance obligation) the obligor. Assignments of contractual
rights form an important area of commercial practice. Despite this, in terms of legal publications, the
assignment of contractual rights is an area that has received little attention. Recently it was described
as “undeveloped”.</para>
</formalpara>
Implementation note: DocBook XSL renders the title inline; if a marginal position is required a
front end change will be required.
226
Worked examples
See Section 14.1.3, “Formal paragraphs”, and Section 18.2.3, “End of paragraph notes”.
In addition, the formatting of the numbering is often very important since it may need to exactly
follow the style of published legislation, ie surrounded by brackets in the example above.
<variablelist>
<varlistentry>
<term>(5)</term>
<listitem>
<para>References in sections 404 to 404B to a relevant firm include—</para>
<variablelist>
<varlistentry>
<term>(a)</term>
<listitem>
<para>a person who was at any time a relevant firm but has subsequently ceased to be one; and</para>
</listitem>
</varlistentry>
<varlistentry>
<term>(b)</term>
<listitem>
<para>a person who has assumed a liability (including a contingent one) incurred by a relevant firm in
respect of a failure by the firm to comply with a requirement applicable to the carrying on by it of any
activity.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
7
Tested in Schematron: legal-lists
227
Worked examples
<term>(6)</term>
<listitem>
<para>References in those sections to the carrying on of an activity by a relevant firm are, accordingly,
to be read in that case with the appropriate modifications.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>(6A)</term>
<listitem>
<para>References in sections 404 and 404E to an “electronic money issuer” are references to a
person mentioned in paragraph (a), (b), (c), (d), (h) or (i) of the definition of “electronic money
issuer” in regulation 2(1) of the Electronic Money Regulations 2011.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>(7)</term>
<listitem>
<para>If the Authority varies a permission or authorisation of a person so as to impose requirements on
the person to establish and operate a scheme which corresponds to, or is similar to, a consumer redress
scheme, the provision that may be included in the permission or authorisation as varied includes—</para>
<variablelist>
<varlistentry>
<term>(a)</term>
<listitem>
<para>provision imposing requirements on the person corresponding to those that could be included in rules
made under section 404; and</para>
</listitem>
</varlistentry>
<varlistentry>
<term>(b)</term>
<listitem>
<para xml:id="b-9781474201124-0021468">provision corresponding to section 404B.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<chapter xml:id="b-9781849664554-001">
<info xml:id="b-9781849664554-0000097">
228
Worked examples
</para>
<note xml:id="b-9781849664554-0000103a" role="facts"><para xml:id="b-9781849664554-0000103">In order
to address an anticipated increase in the number of cases involving authorisations of deprivation of
liberty (‘DoL’) under the Mental Capacity Act 2005 following the Supreme Court’s decision
in <emphasis role="italic">P v Cheshire West and Chester Council, P v Surrey CC</emphasis> [2014] 2 FCR
71, and the practical and procedural implications of that decision,... guaranteed by art 5<footnote
xml:id="b-9781849664554-0000103b" label="a"><para xml:id="b-9781849664554-0000103c">Article 5, so far as
material, is set out at <link linkend="b-9781849664554-0000114g" role="xref">[31]</link>, below.</para></
footnote> of the European Convention for the Protection of Human Rights and Fundamental Freedoms 1950...</
para></note>
<note xml:id="b-9781849664554-0000104a" role="holding">
<para xml:id="b-9781849664554-0000104"><emphasis role="bold">Held</emphasis> – Upon a proper construction
of the 2005 Act and the 2007 Rules, and considering the general context of applications under the Act,
those responsible for drafting s 53(1) had not intended the word ‘decision’ to have the
special, wider meaning for which the parties contended...</para></note>
<bridgehead renderas="sect1" xml:id="b-9781849664554-0000108c">Cases referred to</bridgehead>
<bibliolist xml:id="b-9781849664554-0000108d">
<bibliomixed role="case" xml:id="b-9781849664554-0000108e"><emphasis role="italic">A (A Patient) (Court of
Protection: Appeal), Re</emphasis> [2013] EWCA Civ 1661, [2014] 1 WLR 3773.</bibliomixed>
<bibliomixed role="case" xml:id="b-9781849664554-0000108f"><emphasis role="italic">A-G v Lord Hotham</
emphasis> (1827) 3 Russ 415.</bibliomixed>
</bibliolist>
<note xml:id="b-9781849664554-0000109" role="history">
<bridgehead renderas="sect1" xml:id="b-9781849664554-0000109b">Appeals</bridgehead>
<para xml:id="b-9781849664554-0000109c">AC, GS and the Law Society of England and Wales appealed from
two judgments of the President of the Court of Protection, Sir James Munby, of 7 August 2014 (<emphasis
role="italic">Re X (deprivation of liberty) (no 1)</emphasis> [2014] EWCOP 25, [2015] 2 FCR 15, [2015] 2
All ER 1154) and 16 October 2014 <emphasis role="italic">Re X (deprivation of liberty) (no 2)</emphasis>
[2014] EWCOP 37, [2015] 2 FCR 28, [2015] 2 All ER 1165). The Secretary of State for Health and the
Secretary of State for Justice also appeared and the Official Solicitor intervened. The facts are set out
in the judgment of Black LJ.</para>
</note>
<para xml:id="b-9781849664554-0000110" role="legalRepresentation"><emphasis role="italic">Nathalie
Lieven QC</emphasis> and <emphasis role="italic">Katie Scott</emphasis> (instructed by <emphasis
role="italic">Irwin Mitchell LLP</emphasis>) for AC and GS.</para>
<para xml:id="b-9781849664554-0000110d" role="judgmentDate">16 June 2015. The following judgments were
delivered.</para>
<note xml:id="b-9781849664554-0000110e" role="judgment">
<para xml:id="b-9781849664554-0000110f" role="judgmentBy">Black LJ.</para>
<formalpara xml:id="b-9781849664554-0000110g"><info xml:id="b-9781849664554-0000110h">
<title xml:id="b-9781849664554-0000110i">[1]</title>
</info><para xml:id="b-9781849664554-0000110j">This appeal concerns the practice and procedure to be
adopted in applications to the Court of Protection in deprivation of liberty cases...</para></formalpara>
<bridgehead xml:id="b-9781849664554-0000110k" renderas="sect1">The process leading to the President’s
judgments</bridgehead>
<formalpara xml:id="b-9781849664554-0000111g"><info xml:id="b-9781849664554-0000111h">
<title xml:id="b-9781849664554-0000111i">[4]</title>
</info><para xml:id="b-9781849664554-0000111j">In view of the unusual path that matters took in front of
the President, I need to look in a little detail at what occurred before him.</para></formalpara>
<bridgehead xml:id="b-9781849664554-0000112k" renderas="sect2">(a) The President’s description of the
process</bridgehead>
<formalpara xml:id="b-9781849664554-0000112g"><info xml:id="b-9781849664554-0000112h">
<title xml:id="b-9781849664554-0000112i">[5]</title>
</info><para xml:id="b-9781849664554-0000112j">A good starting point is the President’s own description of
the exercise upon which he was engaged....’</para>
</blockquote>
</formalpara>
<bridgehead xml:id="b-9781849664554-0000114k" renderas="sect2">(c) Section 53 Mental Capacity Act 2005</
bridgehead>
<formalpara xml:id="b-9781849664554-0000114g"><info xml:id="b-9781849664554-0000114h">
<title xml:id="b-9781849664554-0000114i">[31]</title>
</info><para xml:id="b-9781849664554-0000114j">I start with the parties’ proposed answer to the
jurisdiction question, namely s 53 of the MCA 2005. This sets out the rights of appeal in cases under the
Act...</para></formalpara>
<note xml:id="b-9781849664554-0000112l" role="disposition"><para
xml:id="b-9781849664554-0000112m"><emphasis role="italic">Order accordingly</emphasis></para></note>
</note>
</chapter>
Commentary:
1. A Case Report MUST be within a chapter, but MUST NOT use @label
2. The case name is within the chapter/info/title, and the case name MUST be in a
phrase[@role='caseName']
3. Various metadata components MAY be identified in the chapter/info. Note that the
decisionDate MUST be in ISO date format
229
Worked examples
4. The first few paragraphs of content MAY also be identified with a semantic @role. The
catchwords (keywords) are typically italicised before the main body of the content
5. The first main section of the text comprises the Facts of the Case, and should be identifiable from
the source; it is contained within a note[@role='facts']
6. Likewise the holding section typically starts with the word 'Held' in bold, and should also be
within a semantic note[@role='holding']
7. Note that if note elements are included within a Case Report the section element MUST NOT
be used to model the headings and their content (since it is not permitted in the content model).
Consequently, if there are any headings in the content (either as a direct child of the chapter, or
within a note, they MUST be marked up using bridgehead and the correct @renderas value
12.Numbered paragraphs within a Case Report MUST use the formalpara element
Implementation note: DocBook XSL does not handle any chapter/info/biblioid content,
so if this is required to be displayed or handled in any way it will need additional support.
Furthermore, the default DocBook XSL handling of note will need to be amended, and the
para elements with these case-specific @role values MAY require special styling (eg full-out
and bold)
See also: Section 5.2.7, “IDs for annotated legislation”, Section 14.13, “Notes”
230
Worked examples
</listitem></varlistentry>
</variablelist>
<section xml:id="PCTA1927s1" label="1">
<info xml:id="b-9781782257004-d1e970">
<title xml:id="b-9781782257004-d1e975">Definitions</title>
<biblioid class="other" otherclass="legalDivType">section</biblioid>
</info>
<para xml:id="b-9781782257004-d1e979">In this Act—</para>
<para xml:id="b-9781782257004-d1e982">the expression <emphasis role="bold">“Committee on
Finance”</emphasis> means the Committee on Finance of Dáil Éireann when and so long as such
Committee is a committee of the whole House;</para>
<para xml:id="b-9781782257004-d1e988">[the expression <emphasis role="bold">“new tax”</
emphasis> when used in relation to a resolution under this Act means a tax which was not in force
immediately before the date on which the resolution is expressed to take effect or, where no such date is
expressed, the passing of the resolution by Dáil Éireann;]<superscript>1</superscript></para>
<para xml:id="b-9781782257004-d1e996">the expression <emphasis role="bold">“permanent tax”</
emphasis> means a tax which was last imposed without any limit of time being fixed for its duration;</para>
<para xml:id="b-9781782257004-d1e1003">the expression <emphasis role="bold">“temporary tax”</
emphasis> means a tax which was last imposed or renewed for a limited period only;</para>
<para xml:id="b-9781782257004-d1e1009">the expression <emphasis role="bold">“normal
expiration”</emphasis> when used in relation to a temporary tax means the end of the limited period
for which the tax was last imposed or renewed;</para>
<para xml:id="b-9781782257004-d1e1015">[the word <emphasis role="bold">“tax”</emphasis>
means any customs duty, excise duty, income tax, value-added tax, capital gains tax, corporation
tax, gift tax, inheritance tax, residential property tax, stamp duty, parking levy[, local property
tax]<superscript>2</superscript> or any other levy or charge for the purposes of this Act, for the benefit
of the Exchequer.]<superscript>3</superscript></para>
<note role="annotations" xml:id="b-9781782257004-d1e1028bh1a">
<bridgehead renderas="sect3" xml:id=""b-9781782257004-d1e1028bh1">Amendments</bridgehead>
<para xml:id="b-9781782257004-d1e1034"><superscript>1</superscript> Definition of “new tax”
substituted by FA 2002, s 139(<emphasis role="italic">a</emphasis>) with effect from 25 March 2002.</para>
<para xml:id="b-9781782257004-d1e1042"><superscript>2</superscript> Inserted by Finance (Local Property
Tax) Act 2012, s 159(1) with effect from 1 January 2013 (by virtue of the Finance (Local Property Tax) Act
2012).</para>
<para xml:id="b-9781782257004-d1e1047"><superscript>3</superscript> Definition of “tax”
substituted by FA 2010, s 160 with effect from 3 April 2010.</para></note>
</section>
</chapter>
</book>
Commentary:
3. Each statute or other legal instrument (Statutory Instrument, Regulation, Order, Directive etc)
MUST be within a chapter. This means that all layers in the book hierarchy above it MUST be
in parts.10 Note that the @xml:id does not follow the usual standard format, but instead adopts
a unique abbreviation for the item. These values will be supplied by Bloomsbury and should be
enforced in the schematron
5. Typically, a statute starts with a table of content listing all the sections in the Act. This MUST
reflect accurately the structure and content of the Act, and each heading MUST be a link to the
corresponding section
8
Tested in Schematron: legislation-required
9
Tested in Schematron: jurisdiction-required, jurisdiction-values, jurisdiction-location
10
Tested in Schematron: legislation-chapter
231
Worked examples
6. The internal structure of an Act or other legal instrument MUST be modelled using sections,
with a predictable @xml:id starting with the chapter/@xml:id, and ending with the section/
@label. In between there will be a text string determined by the value of the legalDivType (in
this case 's', since it is a legalDivType=section)
7. The legalDivType=section indicates that this section is a Section in the Act. Other possible
values include chapter or part, which also informs the ID structure, eg 'TCA1997pt8ch4'11
Implementation note: The default DocBook XSL handling of note will need to be amended
In practice, there may be up to thirteen nested layers of content within the taxonomic tree within the
content:
1. Class: Mammalia
2. Supercohort: Afrotheria
3. Cohort: Paenungulata
4. Order: Hyracoidea
5. Family Procaviidae
6. Genus: Dendrohyrax
Each such layer in the tree is called a taxon (pl: taxa). Some other taxonomic layers may also be
present in some cases, eg Super-order etc. Each such layer type (Class, Order, Genus, Species, etc) is
called the Taxon Rank.
[If other Taxon Ranks are required (eg Divisions for plants), please contact Bloomsbury to ensure the
necessary changes are made to the schematron]
It is proposed that the species content is encoded as a DocBook chapter, and all the parent content
as part[partintro].
232
Worked examples
1. A title comprising:
c. English name
2. A reference giving the taxonomic authority, ie an abbreviated form of the bibliographic details of
when the taxon was first described
4. It then contains regular paragraphs, sections, bibliographic short form references (to be linked to
their full forms in the bibliography), images etc
233
Worked examples
3. It usually includes a subtitle containing French and German names for the animal
2. The implicit hierarchy of the content MUST be explicitly represented in the structure of the parts.
This is best assessed by looking at the book’s table of contents, and remembering that sibling
nodes should have the same Taxon Rank
3. A species-level chunk MUST be captured as a chapter, and each parent chunk as a part
4. The corresponding pdf of the chunk MUST only include the text and images for that chunk, ie it
MUST blank out the content from any preceding or following chunk on the page
<chapter xml:id="b-9781234567897-0001">
<info xml:id="akya8">
234
Worked examples
1. The content of title and subtitle has granular content to encode the taxon name and other
language variants. For chunks other than species, the taxon rank MUST also be marked up (see
accompanying sample data)
2. The taxonName must ONLY include the taxon name; it MUST NOT include terminal
punctuation or other names. For species, typically this will be ONLY the portion in italics, and
MUST NOT include the authority name which often follows the taxon name. If this is not clear,
please request further examples
3. The authors of the chunk are listed in the chunk info, not at the end of the chunk
4. The pagenums will generate overlapping page ranges [the schematron may need to be improved to
avoid false positives in this context]
5. There is a new biblioid that is REQUIRED, which records the taxon rank, even in those cases
where (like here) it is not explicitly recorded in the title
235
Worked examples
6. If there is an image that appear above the title, it MUST be placed as the first element after the
taxon authority
7. The first para of most chunks takes a new @role to indicate that it is a bibliographical reference
for the authority who first described the taxon.
Implementation note: Special formatting may be required for taxon name, taxon rank, taxon
authority etc, and linking to external biological databases could be supported
236
Chapter 33. Series names
The following list is the definitive list of all Bloomsbury series names. This list will be added to
as new series are created. If a book has a series name that is not included herein, please contact
Bloomsbury immediately.
237
Series names
238
Series names
239
Series names
240
Series names
241
Series names
242
Series names
Contributions to the Study of Education Contributions to the Study of Mass Media and
Communications
Contributions to the Study of Music and Dance Contributions to the Study of Popular Culture
Contributions to the Study of Religion Contributions to the Study of Religion:
Christianity and the HolocaustÑCore Issues
Contributions to the Study of Science Fiction and Contributions to the Study of World History
Fantasy
Contributions to the Study of World Literature Controversies in Science
Controversies in the Study of Religion Convergence Series
Conway Classics Conway Compass
Conway Maritime Modeller's Series Conway Plan Portfolios
Conway's History of Sail Conway's History of the Ship
Conway's Merchant Marine & Maritime History Conway's Naval History After 1850
Conway's Plan Portfolio Conway's Ship Modelling
Conway's Ship Types Cookbooks for Students
Copenhagen International Seminar Copy and Cut
Copyright Series Core Tax Annuals
Cornerstone on... Corporations That Changed the World
Corpus and Discourse Course Companions in the History of Medicine
Crackers Craft Workshop
Crash Course Create Your Own
Creating Corporate Cultures Creative Careers
Creative Core Creative Painting
Crime in Popular Culture Crime, Media, and Popular Culture
Criminal Justice History Criminal Justice, Delinquency, and Corrections
Criminal Law Library Criminal Practice
Critical Adventures in New Media Critical and Primary Sources
Critical Companions Critical Companions to Popular Contemporary
Writers
Critical Companions to Popular Contemporary Critical Pedagogy Today
Writers--ON LINE
Critical Performances Critical Perspectives in Social Theory
Critical Perspectives on Culture and Society Critical Perspectives on Language, Mobility and
International Education
Critical Political Studies Critical Powers
Critical Research in Material Culture Critical Responses in Arts and Letters
Critical Scripts Critical Stages
Critical Studies in Education and Culture Series Critical Studies in Russian Literature
Critical Theory and Contemporary Society Critiquing Religion: Discourse, Culture, Power
Cross-Cultural Perspectives on Women Cross-Cultural Statistical Encyclopedia of the
World
Crossing Ebenezer Creek Crossroads in World History
Crucible Plays Crunchbone Castle Chronicles
Cultural and Social History Cultural Context of Infancy
Cultural Histories of Cinema Cultural Histories of Design
Cultural Histories of Theatre and Performance Cultural Memory and History in Antiquity
Cultural Politics Cultural Studies in Practice
Culture and Customs of Africa Culture and Customs of Asia
Culture and Customs of Europe Culture and Customs of Latin America and the
Carib
Culture and Customs of Native Peoples in Culture and Customs of North America
America
Culture and Customs of the Middle East Culture Machine
Cultures in the American West Cultures of Consumption Series
Cultures of Early Modern Europe Cultures of the American Mosaic
Current Research in Film Curriculum Charts
Curtain Up Cut 'n Clip Series
D & T Workshop Daily Life Encyclopedias
243
Series names
244
Series names
245
Series names
246
Series names
247
Series names
248
Series names
249
Series names
250
Series names
251
Series names
252
Series names
253
Series names
254
Series names
255
Series names
256
Series names
257
Chapter 34. Accessibility
Note
This section contains new instructions as of Schematron version 7.
• table
• informaltable
• imageobject1
• inlinemediaobject
• equation
• informalequation
• videoobject
• audioobject
<table>
<title>Table title</title>
<alt>Alt text for a table with a title</alt>
<tgroup cols="2">
<tbody>
<row>
<entry>...</entry>
<entry>...</entry>
</row>
</tbody>
</tgroup>
</table>
<informaltable>
<alt>Alt text for a table without a title</alt>
<tgroup cols="2">
<tbody>
<row>
<entry>...</entry>
<entry>...</entry>
</row>
</tbody>
</tgroup>
1
only where used to represent a display image, i.e. as part of a figure or informalfigure
258
Accessibility
</informaltable>
<mediaobject>
<alt>Alt text for a display image</alt>
<imageobject>
<imagedata fileref="image.jpeg"/>
</imageobject>
</mediaobject>
<equation>
<title>Equation title</title>
<alt>Alt text for an equation with a title</alt>
<mathphrase>e=mc<superscript>2</superscript></mathphrase>
</equation>
<informalequation>
<alt>Alt text for an equation without a title</alt>
<mathphrase>e=mc<superscript>2</superscript></mathphrase>
</informalequation>
<mediaobject>
<alt>Alt text for a video</alt>
<videoobject>
<videodata fileref="video.mp4"/>
</videoobject>
</mediaobject>
<mediaobject>
<alt>Alt text for audio</alt>
<audioobject>
<audiodata fileref="audio.mp4"/>
</audioobject>
</mediaobject>
259
Part I. Back matter
Table of Contents
Index ....................................................................................................................................... 262
261
Index
dates, 113
document reference numbers, 125
DOIs, 49, 122
Examples in bold are the primary examples. DVDs, 129
email messages, 125
et al, 118
Symbols EU Directives, 127
<para> style, 80 films, 128
@condition, 93 groups of authors, 116
@label, 74 ibids, 119
@outputformat, 19, 45, 93, 96, 221 implied authors, 118, 118, 123
@relation, 111 in <footnote>s, 138
@role, 86 inconsistent style warning, 197
@role=ancillary, 76 inline, 129
international agreements, treaties, 127
A interviews, 124
A-Z encyclopedias and dictionaries, 52 ISO 690, 112
A-Z container, 59 journal articles, 122
article DOI, 54 journal articles with URL, 122
article pagenums, 54 legal sources, 126
articles, 54 magazine articles, 123
articles that are only cross references, 55 monographs, 115
dummy entries, 55 multiple editions, 117
dummy headings, 57 newspaper articles, 123
high-level structure, 59 non-English language items, 112
inline cross references, 59 numbered volumes, 117
letter divisions, 53 online text, 120
placement of article authors, 53 op cits, 119
Abbreviations, 70, 71 orders, 127
Abstract author, 191 organisation names, 128
Acknowledgements, 69 other editions, 121
Alignment address and name blocks, 72 personal communications, 124
Anchors, 98 personal names, 113
Ancillary (back of book) content, 76 play performances, 129
Appendices in chapters, 192 publisher address, 118
Article groups, 62 radio broadcasts, 129
Article type, 61 recordings, 128
Asterisks, daggers etc, 96 regulations, 127
authorgroups, multiple, 23 reports, 128
reprinted works, 120
B series names, 120
Back matter, 76 theses, 123
Biblio author ID, 24 translators, 118
Bibliographies, 106 unpublished items, 124
<bibliomixed>, 110 untagged content, 114
<bibliomixed>/@role, 112 web sites, 125
abbreviated references, 131 Biological taxa, 232
access date, 125 Blockquotes, 162
Acts of Parliament, 126 different from epigraphs, 162
annotated bibliographies, 131 incorrect markup, 169
anonymous authors, 118 Blurbs, 37
archival content, 214 Bold text, 84
authors with single name, 120 Book reviews, 123
book reviews, 123
cases, 126 C
chapter in edited book, 116 Case regularisation, 40
classical authors, 120 Changes to the data, 35
conference papers, 124 Chapter Outline, 191
262
Index
263
Index
264
Index
265
Index
266
Index
267
Index
268
Index
269
Index
270
Index
271
Index
272