Collection and book ID requirements
For all workflows, there is no file for the collection. This ID needs to be created and displayed in the metadata.
<collection-meta> <collection-id>helpcollect</collection-id> <collection-name>NCBI Help Manual</collection-name>
We have two options:
- Use Coko's database id -- this will be a unique, long string. We generate this when the user creates new collection. The field will not be editable. This is the simplest option and doesn't expect anything from the user.
- Allow the to user insert the id -- After the user creates new collection, she insert a unique ID in the metadata modal. The field will not be editable after the book is published for the first time, which allows the user to add the add at any point before the book is published.
Question: Some collections have a
collection-id-type -- is "pmcid" the only type? Or is there a standard list that we can use in a dropdown field?
<collection-meta collection-type="ncbi-books-collection"> <collection-id collection-id-type="pmcid">helpcollect</collection-id> <title-group> <title>NCBI Help Manual</title> </title-group> </collection-meta>
For books published at the book component level there is no file for the book. This applies to all the Word workflow books and some books in the PDF and XML workflow. The same options above apply.
<book-meta> <book-id book-id-type="pmcid">helpbookshelf</book-id> <book-title-group> <book-title>Bookshelf Help</book-title> </book-title-group>
Questions: As with collections some books have a
book-id-type -- is "pmcid" the only type? Or is there a standard list that we can use in a dropdown field?
For books published at the book level (some PDF and XML workflow books), there is a file for the book so we need to ensure the ID is unique across the system, if we are going to use this ID to match incoming books to their exiting book records.
Since PDF and XML books can also originate from an FTP, ideally the ID should be included in the source:
- for PDF, in a manifest file
- for xml, in the xml id field.
Whatever we choose it should be done consistently/ Since a number of our the book settings depend on the workflow and I suggest we apply consistency by workflow type. Especially is some organisations will submit content for all workflows.
Consistent by workflow:
- All Collections in all workflows = Coko creates the collection ID
- XML and PDF workflow = NCBI supplies the book ID in the source
- Word workflow = Coko creates the book ID.
Does this work for you?