How styled metadata in the UI translates to xml
Styling
Users can add style, to the fields defined below, in collection metadata and chapter-processed book metadata UIs. The BCMS needs to translate the html tags to xml tags. The BCMS stying possibilities are limited to:
- bold and italics
- superscript and subscript
- an ordered list (numbered) of one level
- an unordered list (bulleted) of one level
- an external hyperlink
These styles can be applied to following metadata fields
Styling requirements
Metadata filed name in UI | Styling required | Context | relevant xml tag where style can be applied |
---|---|---|---|
NCBI collection title | bold, italic, superscript, subscript | collection-meta node |
<collection-name>NCBI collection title</collection-name> ; <title>NCBI collection title</title>
|
Book series title | bold, italic, superscript, subscript | collection-meta node | <title>Book series title</title> |
title | bold, italic, superscript, subscript | book-meta node | <book-title>Book title</book-title> |
subtitle | bold, italic, superscript, subscript | book-meta node | <subtitle>Book subtitle</subtitle> |
alternative title | bold, italic, superscript, subscript | book-meta node | <alt-title>Book alternative title</alt-title> |
abstract | bold, italic, hyperlink, lists | collection-meta node; book-meta node | <abstract><p>This is an abstract</p></abstract> |
notes: disclaimer; generic; author notes; Funder Courtesy Note; Manuscript Final Version Note; Editorial notes (with content types genetic_counseling and resources ) |
bold, italic, hyperlinks, lists | collection-meta node; book-meta node |
<notes><p>This is a note without a type defined</p></notes> ; <author-notes><fn><p>This is an author note</p></fn></author-notes> ; <notes notes-type="ednotes"><p content-type="genetic_counseling"><italic>Genetic counseling is the process of p....</p><p content-type="resources"><italic>GeneReviews staff has selected ....</italic></p></notes>
|
permissions: copyright statement; license statement | bold, italic, hyperlinks | collection-meta node; book-meta node |
<license xmlns:xlink="http://www.w3.org/1999/xlink" license-type="open-access" xlink:href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><license-p>This work is also available in an Open Access edition, which is licensed under a Creative Commons Attribution–NonCommercial–NoDerivatives 4.0 International License: <ext-link xmlns:xlink="http://www.w3.org/1999/xlink" ext-link-type="uri" xlink:href="http://creativecommons.org/licenses/by-nc-nd/4.0/">http://creativecommons.org/licenses/by-nc-nd/4.0/</ext-link>.</license-p></license> ; <copyright-statement>This is a copyright statement</copyright-statement>
|
The xml tags are:
<bold>bold</bold>
<italic>italic</italic>
<sub>subscript</sub> (same as html)
<sup>superscript</sup> (same as html)
Ordered list
<list list-type="order">
<list-item><p>item one</p></list-item>
<list-item><p>item two</p></list-item>
</list>
Unordered list
<list list-type="bullet">
<list-item><p>item one</p></list-item>
<list-item><p>item two</p></list-item>
</list>
Link
<ext-link xmlns:xlink="http://www.w3.org/1999/xlink" ext-link-type="uri" xlink:href="https://example.com">text to link</ext-link>
Acceptance criteria
-
HTML2XML translation will generate valid BITS 2.0 XML that meets Bookshelf tagging guidelines (so pass style checker rules) -
BCMS Coded XML will render on the Bookshelf site accurately