Skip to content

Latest commit

 

History

History
60 lines (51 loc) · 2.08 KB

bookeye-naming-template.md

File metadata and controls

60 lines (51 loc) · 2.08 KB

bookeye workflow naming template

  • in the bookeye workflow:
    • no special naming conventions are used to differentiate the session target, front matter pages, numbered pages, and back matter pages
    • each digital object MUST have a session target that MUST be named using this template <digi_id>_000001.tif

examples: (template details below)

  • session target and item images
    nyu_aco123456_0000001.tif  # this is the session target!
    nyu_aco123456_0000002.tif  # this is the first image  of the item
    nyu_aco123456_0000003.tif  # this is the second image of the item
    ...
    
  • EOC file:
    • 20160324-IQ260-EOC.csv
    • nyu_aco123456_eoc.csv

template

  • generic template:
    • <digi_id>_<sequence number>.tif
      • digi_id: the digitization id assigned to the digital object
      • sequence number: an integer padded with leading-zeros as needed,
        e.g., 000007, that indicates the order of the corresponding page in the item

specific templates

  • session target:

    • <digi_id>_000001.tif
  • EOC file:

    • the following are valid EOC templates:
      • template: <digitization station name>-EOC.csv
      • template: <digitization station name>_EOC.csv
      • template: <digitization station name>_eoc.csv
      • template: <digi_id>_eoc.csv

requirements:

  • all digital objects created with the bookeye workflow MUST include an EOC file.
    (Without an EOC file, there is no way to differentiate between access-workflow
    digital objects and a bookeye-workflow digital objects.)

  • all filenames must be numbered sequentially

    • i.e.,
      # GOOD
      ...
      nyu_aco001143_000123.tif
      nyu_aco001143_000124.tif
      nyu_aco001143_000125.tif
      ...
      
      # BAD 
      ...
      nyu_aco001143_000723.tif
      nyu_aco001143_000725.tif  # missing file for 000724
      nyu_aco001143_000726.tif
      ...