New settings template for Word One doc
Context
The original documentation is in #215 (closed).
Since this was developed there have been various issues related to the Word one doc settings currently used:
- #1138 (closed): Users Should be able to Upload Display PDFs for Word One Doc Books
- #1142 (closed): Do not display chapter-level affiliation style setting in Word One Doc books
- #1178: "Ignore book order" domain attribute is not set for yes for Word One Doc book
This is documented as user story 18 in the scoping outcomes list. Based on scoping outcomes we need a new distinct template for Word one doc books. Ideally, this case would be met by supporting wholebook conversion for the Word workflow but this functionality does not exist in NCBI systems. The next best option is to create a new settings template for "one doc" Word WF case, and map this template to Conversion Workflow "Word" and submission type "Complete books and documents".
Proposal
Develop a new settings template for "one doc" Word WF case to cater for this unique submission type.
Design
- At the book creation step, users see the following:
Note: Since book versions has since been introduced in the BCMS, all references to "support multiple published versions" should be changed to "support multiple published chapter versions" to avoid confusion.
- In book settings after book creation, users see the following:
Note in the above, in the Landing Page: Downloads section, if users turn 'Display book-level PDF for download' on, they will then be required to choose between two options:
- Create book-level PDF for download
- Upload book-level PDF for download
When option 2 is set in settings, the "Upload" button displays on the "Display PDFs" section in the files tab, enabling users to upload a file.
NCBI to confirm:
- all of the settings in the above screenshots, and whether any relevant settings details for this case are missing.
- whether there is always a choice for Word one doc books to Create or Upload PDFs for display, or whether Word one doc users always upload bookshelf display PDFs when they want to display a PDF, in which case we would hide the 'Create book-level PDF' setting and just show the 'Display book-level PDF' setting.
Implementation (if applicable)
-
NCBI creates another template in their domain tool. In the template, Ignore book order
must be = YES, and any other settings that must be on or off defaults should be set based on NCBI's requirements. Once that is set up, we need the name of the domain from NCBI. -
NCBI confirm the settings which should display in the BCMS for Word one doc books (see design above). -
Coko creates another settings template form, once NCBI confirms the domain name and settings required for the settings template.
Once the settings and approach have been agreed, we will need to add the details to the Settings sheet.
The related issues linked below should be closed once this issue is approved
Alternative approaches (if applicable)
This proposal is in keeping with the current code base and data model and is the most appropriate path to resolve all issues mentioned in the 'Context' above.
An alternative approach is to keep the settings template as it is, and only resolve the bug described in #1178, which should be a matter of a few hours work. This approach depends on whether NCBI is able to remove the feature changes requested in #1138 (closed) and #1142 (closed) from the scope of work.
Scheduling
Schedule this feature to be scoped and designed for Epic: