Support for contrib-group roles and ability to set a role to each group of Authors or Editors in chapter-processed book metadata
Expected behaviour
For chapter processed books, we must be able to support accurate metadata display for current, actively updated migrated Bookshelf content.
Current behaviour
Cannot support migration of GeneReviews metadata because they need role at the contrib-group level.
Steps to reproduce
Go to chapter-processed book metadata UI, see that you can add contributors under different contrib-types, but there is no way to group contributors or apply a role to that grouping.
See target we need to match, which includes one role displaying for a group of editors:
<book-meta>
<?get-external-navigation-xml related?>
<?pdfbuild-skip-alt-title-as-rhead?>
<book-id book-id-type="pmcid">gene</book-id>
<book-title-group>
<book-title>GeneReviews<sup>®</sup></book-title>
</book-title-group>
<contrib-group>
<contrib contrib-type="editor">
<name>
<surname>Adam</surname>
<given-names>Margaret P</given-names>
</name>
<role>Editor-in-Chief</role>
</contrib>
</contrib-group>
<contrib-group>
<contrib contrib-type="editor">
<name>
<surname>Ardinger</surname>
<given-names>Holly H</given-names>
</name>
</contrib>
<contrib contrib-type="editor">
<name>
<surname>Pagon</surname>
<given-names>Roberta A</given-names>
</name>
</contrib>
<contrib contrib-type="editor">
<name>
<surname>Wallace</surname>
<given-names>Stephanie E</given-names>
</name>
</contrib>
<role>Senior Editors</role>
</contrib-group>
<contrib-group>
<contrib contrib-type="editor">
<name>
<surname>Bean</surname>
<given-names>Lora JH</given-names>
</name>
</contrib>
<contrib contrib-type="editor">
<name>
<surname>Stephens</surname>
<given-names>Karen</given-names>
</name>
</contrib>
<role>Molecular Genetics</role>
</contrib-group>
<contrib-group>
<contrib contrib-type="editor">
<name>
<surname>Amemiya</surname>
<given-names>Anne</given-names>
</name>
<role>Genetic Counseling</role>
</contrib>
</contrib-group>
<pub-date publication-format="electronic" date-type="pubr">
<year>1993</year>
</pub-date>
<pub-date publication-format="electronic" date-type="pubr">
<year>2020</year>
</pub-date>
<issn>2372-0697</issn>
<publisher>
<publisher-name>University of Washington, Seattle</publisher-name>
<publisher-loc>Seattle (WA)</publisher-loc>
</publisher>
<permissions>
<copyright-statement>Copyright © 1993-2020, University of Washington, Seattle. GeneReviews is
a registered trademark of the University of Washington, Seattle. All rights
reserved.</copyright-statement>
<copyright-year>2020</copyright-year>
<license xmlns:xlink="http://www.w3.org/1999/xlink" license-type="open-access"
xlink:href="https://www.ncbi.nlm.nih.gov/books/NBK138602/">
<license-p>GeneReviews® chapters are owned by the University of Washington. Permission is
hereby granted to reproduce, distribute, and translate copies of content materials for
noncommercial research purposes only, provided that (i) credit for source (<ext-link
ext-link-type="uri" xlink:href="http://www.genereviews.org/"
>http://www.genereviews.org/</ext-link>) and copyright (© 1993-2020 University of
Washington) are included with each copy; (ii) a link to the original material is provided
whenever the material is published elsewhere on the Web; and (iii) reproducers,
distributors, and/or translators comply with the <related-object source-id="gene"
document-id="GRcopyright_permiss">GeneReviews® Copyright Notice and Usage
Disclaimer</related-object>. No further modifications are allowed. For clarity, excerpts
of GeneReviews chapters for use in lab reports and clinic notes are a permitted
use.</license-p>
<license-p>For more information, see the <related-object source-id="gene"
document-id="GRcopyright_permiss">GeneReviews® Copyright Notice and Usage
Disclaimer</related-object>.</license-p>
<license-p>For questions regarding permissions or whether a specified use is allowed,
contact: <email>admasst@uw.edu</email>.</license-p>
</license>
</permissions>
<abstract>
<p><italic>GeneReviews</italic>, an international point-of-care resource for busy clinicians,
provides clinically relevant and medically actionable information for inherited conditions
in a standardized journal-style format, covering diagnosis, management, and genetic
counseling for patients and their families. Each chapter in <italic>GeneReviews</italic> is
written by one or more experts on the specific condition or disease and goes through a
rigorous editing and <xref ref-type="book-part" rid="GRrevprocesses.Peer_Review">peer
review</xref> process before being published online.</p>
<p><italic>GeneReviews</italic> currently comprises <?get-chapter-count?> chapters.</p>
<p>The two general formats for <italic>GeneReviews</italic> are: chapters focused on a single
gene or phenotype (~95%) and overviews summarizing genetic causes of common conditions
(e.g., deafness and hearing loss, Alzheimer disease) (~5%).</p>
<p>To ensure continuing relevant and medically actionable content, each
<italic>GeneReviews</italic> chapter is <xref ref-type="book-part"
rid="GRrevprocesses.Updates">updated</xref> every four to five years (or as needed) by the
author(s) in a formal and comprehensive process curated by the <italic>GeneReviews</italic>
<xref ref-type="book-part" rid="GRpersonnel">editors</xref>. Additional <xref
ref-type="book-part" rid="GRrevprocesses.Revisions">revisions</xref> may occur more
frequently as needed to reflect significant changes in clinically relevant information.</p>
<p>Genetic counseling and testing terms used in <italic>GeneReviews</italic> are hyperlinked
to definitions in the <italic>GeneReviews</italic>
<xref ref-type="book-part" rid="glossary">Glossary</xref>. <xref ref-type="book-part"
rid="resource_mats">Resource Materials</xref> include additional information on key
genetics concepts used in <italic>GeneReviews</italic>.</p>
<p><italic>GeneReviews</italic> are indexed in PubMed.</p>
<p>Note: For a variety of reasons, GeneReviews occasionally removes chapters from the active website. Click <xref ref-type="book-part"
rid="archived_chapters">here</xref> for a list of retired chapters.</p>
</abstract>
<custom-meta-group>
<custom-meta>
<meta-name>books-subject</meta-name>
<meta-value>Genetics</meta-value>
</custom-meta>
<custom-meta>
<meta-name>books-subject</meta-name>
<meta-value>Medicine</meta-value>
</custom-meta>
<custom-meta>
<meta-name>books-subject</meta-name>
<meta-value>Diseases</meta-value>
</custom-meta>
<custom-meta>
<meta-name>books-source-type</meta-name>
<meta-value>Database</meta-value>
</custom-meta>
</custom-meta-group>
<notes notes-type="ednotes">
<p content-type="genetic_counseling">
<italic>Genetic counseling is the process of providing individuals and families with
information on the nature, inheritance, and implications of genetic disorders to help them
make informed medical and personal decisions. The following section deals with genetic
risk assessment and the use of family history and genetic testing to clarify genetic
status for family members. This section is not meant to address all personal, cultural, or
ethical issues that individuals may face or to substitute for consultation with a genetics
professional</italic>. —ED.</p>
<p content-type="resources">
<italic>GeneReviews staff has selected the following disease-specific and/or umbrella
support organizations and/or registries for the benefit of individuals with this disorder
and their families. GeneReviews is not responsible for the information provided by other
organizations. For information on selection criteria, click <related-object
source-id="gene" document-id="app4">here</related-object>.</italic></p>
</notes>
</book-meta>
Requirement
- Add multiple contrib-group ability in chapter-processed book metadata UI and book metadata XML (current development is one contrib-group that includes all contributors).
- Allow ability to assign
<role>
at the contrib-group level in the chapter-processed book metadata UI. - Write these
contrib-group
s and their<role>
s into the chapter-processed book metadata.
Solution (for front end work, see mockup below)
- In the chapter-processed-book book metadata UI, within the contributor types a. Collaborative authors, b. Editors and c. Authors, add one default contributor group under each contributor type, and the contributors of the section go into the default section groups by default. The default groups are just named 'Contributor group'
- Then, in the same UI, under a. Editors and b. Authors, allow the ability to optionally add more contributor groups, with a button '+ Add contributor group' (where multiple contributor groups must be supported under each contributor type).
- When the '+ Add contributor group' is clicked by the user, a group heading appears (as 'Contributor group', 'Contributor group' etc.) with the contributor type headings (under a. Editors and b. Authors headings)
- Contributors can be added to each of the contributor groups. Contributors can be reordered within groups, but if contributors need to be reordered between contributor groups within the contributor type, it will increase the estimate.
- Within the contributor groups in a. Editors and b. Authors sections, add a field under each of the contributor groups called 'Contributor group role' which is an optional field that accepts any string and is not required to be filled in.
- Back end: If and when a contributor group role is added in the UI, write the contributor groups' role into the CPB book metadata into
<role>
at the contrib-group level as in the sample XML above and pasted below, where in the example below 'Senior Editors' is the role applied at the UI for that group. - Make sure the XML written is valid and meets Bookshelf Tagging Guidelines.
- If a contrib-group doesn't have any contribs added then no empty contrib-group will be tagged in the XML.
- For wholebooks no changes will be made, and we will not currently parse multiple contributors groups and display them in the UI (which isn't being done presently).
<contrib-group>
<contrib contrib-type="editor">
<name>
<surname>Ardinger</surname>
<given-names>Holly H</given-names>
</name>
</contrib>
<contrib contrib-type="editor">
<name>
<surname>Pagon</surname>
<given-names>Roberta A</given-names>
</name>
</contrib>
<contrib contrib-type="editor">
<name>
<surname>Wallace</surname>
<given-names>Stephanie E</given-names>
</name>
</contrib>
<role>Senior Editors</role>
</contrib-group>
The UI mockup is here
NCBI's priority feedback
Y, must be able to accurately migrate and display this content on migration and MVP deployment
QA Steps
[To be completed by Coko once dev is done]