Skip to content

GitLab

Open
Created by Dione Mentis@DioneMentisMaintainer

Book metadata proposal and queries

Book metadata proposal and queries

Hi @lathrops1

From our discussion about #142, I am raising separate issues to confirm approach and deal with queries. This covers book metadata for Word and XML workflow

Book metadata (Word workflow)

  • There is no source file for book metadata, so the user must add it via the UI. Therefore book metadata always editable
  • keywords and subject groups types to be developed in the Org template.
  • Fields that require styling use the Wax editor. The styling possibilities are agreed in #223 (closed).
  • An abstract may only be simple (i.e. no structured sections with figures etc) however there is a rare use case when a graphic with no caption is needed. We discussed supporting this by having an 'Upload image' button (similar to what we already have for uploading a cover image). The image would not appear inside the abstract text editor, instead when book metadata node is written into the chapter.xml file, the graphic is always placed before main text as in this example . I think this will be fine, but I need to clarify actual implementation with our team.
<abstract>
   <title></title>
   <graphic></graphic>
   <p>my abstract text</p>
</abstract>

Fields that require stying

metadata field / types formatting
abstract bold, italic, underline, hyperlink, lists (bullet, number, alpha)
contributors author(s): - one or more given names, surname; suffix editor(s): one or more given names, surnames, suffix; organizations as authors: one or more collaborative authors part of organizational author authors writing on behalf of the organization affiliations: bold, italic, superscript, hyperlink
funding information: grant(s)/contract number(s), funder(s), principal awardee(s), statement bold italic hyperlink
notes: author notes, disclaimer, conflict of interest, edition statement, generic bold, italic, hyperlink, lists (bullet, numbered, alpha)
permissions: copyright statement, year; license: open access?, creative commons license type, license paragraph/statement statements: bold, italic, hyperlinks
title and edition information: main title, subtitle(s) - one or more subtitle in text version, alternative title edition italic, subscript, superscript, small cap

Book metadata (XML workflow book-level processed)

  • Custom metadata is always editable in the UI (these are Bookshelf specific that only NCBI knows)
  • All other metadata is in the source file, so:
    • Only display the metadata in the UI ‘as is’ and do not allow editing in UI.
    • If the users want to amend the metadata, they modify the source xml file and resupply via FTP or upload the corrected version in BCMS and ‘reconvert’.

Book metadata (XML workflow chapter-level processed)

  • Chapter content is submitted via FTP. This package does include book domain ID but not the other book metadata fields. NCBI sys admins will add these fields via the UI, therefore book metadata always editable.
  • keywords and subject groups types to be developed in the Org template.
  • Fields that require styling use the Wax editor. The styling possibilities are agreed in #223 (closed). An abstract may only be simple.

Fields that require stying

Same as list above for Word WF

Queries

Please see the attached roughs showing the specific field names required and:

  • confirm all fields are correct
  • answer questions below (numbers correspond to annotations on the PDF)
  • provide a meta.xml file showing correct structure of the required fields

Title and publisher

  1. Is type a dropdown with predefined values? Are these always the same or do they get set on an org template?

IDs

  1. these IDs were provided in #70 (closed).

    • Are all relevant or must Org choose in metadata template?
    • What about ISSN, should that be included here?

contributors

  1. Unclear if Affiliations is one or many fields with sub-fields:

    • address
    • country
    • email
    • label and footnote linked to author/editor
    • institution

  2. Unclear what fields are needed for "Organizations"

permissions

  1. Does this need to be a larger text area? I.e. more than one paragraph?
  2. Assume dropdown options are the same as my query form collection metadata

funding information

  1. Are both these paragraph fields?
  2. There can be more than one. Sometimes has sub-fields. Not clear how to support this variety in UI. Please confrim.

notes

  1. Notes types include: author notes, disclaimer, conflict of interest, edition statement, generic Same as my query for collections: You mention "generic" in #142 -- is this a type or does this mean user needs to create own types that are defined in Org metadata template, or is this a free text field on this page?

custom

Same as my query for collections: 1)Types and values to be defined in Org metadata template or created here? Are there any types that should show for ALL orgs?

Subjects and keywords

  1. Do the values vary or are they predefined? If vary then makes sense to insert per book.

metadata-book-20201125.pdf