Create toc.xml file by: Title A-Z and Chapter number; and display metadata
The BCMS creates a table of contents in xml based on the components in the book manager.
Here is the relevant BITS documentation and a validation tool
Here's a template toc.xml (toc-template-main.xml) that covers the majority of use cases. Note the code comments in the file. Additionally, here's some more content:
- Don't concern yourself with the
<collection-meta>
and<book-meta>
nodes. @John.kopanas has already developed a step where the<book-meta>
(from the UI) is written into the chapter.xml file before it's sent to NCBI for loading a preview. The same process will apply to the toc.xml file you create. - See the expected structure within the
<toc>
node. These correlate to the sections (front/body/back) we have in the book manager.
- Each book component is a
<toc-entry>
and is listed in the order of the book manager. The<toc-entry>
should contain all the book-part-metadata from the related book component, except the empty fields, according to the guidance in the template.
Any settings that's ON for the "Display metadata on TOC" section means that they'll render on Bookshelf. These settings are integrated with the NCBI domain service (docs BCMS settings).
-
The
<?version 2?>
for each<toc-entry>
is the book component version, not the file version. -
There's an additional structure if the book components have an A - Z ordering by chapter title. That's shown in this template: toc-template-special-alpha-index.xml
I'm sure you'll have a bunch of questions ... have a look and let's chat tomorrow. @John.kopanas has done some of this work already so he can provide guidance. Here's a toc that is partially complete for a book with chapters ordered alphabetically -- and NCBI's feedback on this toc in 24#note_46454