Processing instructions in Word and PDF chapter processed book metadata
Feature proposal: Processing instructions in Word and PDF chapter processed metadata UI, and written into related components
Context
There are certain processing instructions that NCBI needs written into book metadata if they are applied in the metadata UI. These were originally discussed in points 4-7 of #1378 (closed).
Proposal
UI for Word for System admins
In the metadata UI of Word workflow books, add a new section below the Funding section, editable by System admins only (related permissions have been documented in row 8 of the chapter processed book manager permissions sheet) with the heading 'Processing instructions'. Under that heading make the following processing instructions available as checkboxes (the numbers shown in the list below are not necessary to show in the UI, they are for reference purposes in the issue only, rather use a checkbox in the UI):
<?create-gtr-links?>
<?pdfbuild-skip-alt-title-as-rhead?>
<?get-external-navigation-xml related?>
-
<?external-xml-source-base /pmcdata/bookshelf/gene/external-xml/ready/?>
and<?external-xml-source-name .molgene.db.xml?>
(these are two separate processing instructions but since they always occur together, they will be selectable via one checkbox).
UI for PDF chapter-processed books for System admins
In the metadata UI of PDF chapter-processed books, add a new section below the Funding section, editable by System admins only (related permissions have been documented in row 8 of the chapter processed book manager permissions sheet) with the heading 'Processing instructions'. Under that heading make the following processing instructions available as checkboxes:
<?pdfbuild-skip-alt-title-as-rhead?>
Back end writing of these Processing instructions:
-
<?create-gtr-links?>
: when this PI is selected in the metadata UI for Word books, write the PI into all the chapters/components of that book, when loading to PMC (at preview and publish), into the<book-meta>
.
Example tagging:
<book dtd-version="2.0">
<book-meta>
<?create-gtr-links?>
<book-id book-id-type="pmcid">gtrbook</book-id>
<book-title-group>
<book-title>Medical Genetics Summaries</book-title>
</book-title-group>
-
<?pdfbuild-skip-alt-title-as-rhead?>
: when this PI is selected in the UI for Word books, or for PDF chapter processed books, write the PI into all the chapters/components of that book, when loading to PMC (at preview and publish), into the<book-meta>
:
Example tagging:
<book-meta>
<?get-external-navigation-xml related?>
<?pdfbuild-skip-alt-title-as-rhead?>
<book-id book-id-type="pmcid">gene</book-id>
-
<?get-external-navigation-xml related?>
: when this PI is selected in the metadata UI for Word books, write the PI into all the chapters/components of that book, when loading to PMC (at preview and publish), into the<book-meta>
:
Example tagging:
<book-meta>
<?get-external-navigation-xml related?>
<?pdfbuild-skip-alt-title-as-rhead?>
<book-id book-id-type="pmcid">gene</book-id>
-
<?external-xml-source-base /pmcdata/bookshelf/gene/external-xml/ready/?>
&<?external-xml-source-name .molgene.db.xml?>
: when this PI combination is selected in the metadata UI for Word books, add them both to the book-part-wrapper for every component in the book when loading to PMC (at preview and publish). We should maintain the order of the tagging example below when the PIs are selected in the single checkbox:
<book-part-wrapper content-type="chapter" id="mdel17q12"><?external-xml-source-base /pmcdata/bookshelf/gene/external-xml/ready/?><?external-xml-source-name .molgene.db.xml?>
Implementation (if applicable)
[A description of the steps to implement the feature.]
Alternative approaches (if applicable)
[Include any alternatives to meet this use case.]
QA Steps / Acceptance Criteria
- Create a Word complete doc or a PDF/Word chapter-processed book
- Fill in the required metadata for the book, and notice that below Funding in the Metadata, there is a new section: Processing instructions.
For books of word workflow, as below: For PDF chapter-processed books, as below:
- Check the PIs you need and save the metadata
- Upload the necessary files and submit book for conversion or upload converted file and click reload preview.
- After you get the converted file or the book is in Previewing, check the xml file for Processing instructions. They go inside the book-meta, which is within book-part-wrapper.
Example below is from a word complete book, where all the PIs were checked:
<book-part-wrapper content-type="toc" id="toc">
<book-meta>
<?create-gtr-links ?>
<?pdfbuild-skip-alt-title-as-rhead ?>
<?get-external-navigation-xml related?>
<?external-xml-source-base /pmcdata/bookshelf/gene/external-xml/ready/?>
<?external-xml-source-name .molgene.db.xml?>
<book-id book-id-type="pmcid">aaevqbhcfq</book-id>
- You can also login as an Org Admin or Editor, and notice that the Processing Instructions are disabled for these users to make changes.
- When you open up the PDF and Word book created for testing the PIs should still be selected and when send for reload written still into the converted XML.