This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
preparing_books_and_magazines_for_use_with_gutenberg_and_klas_uids_e-documents [2021/09/07 11:27] mn1a [Introduction] |
preparing_books_and_magazines_for_use_with_gutenberg_and_klas_uids_e-documents [2022/08/02 09:14] mn1a [Manually Generating E-Documents in KLAS] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Introduction | + | = Introduction = |
- | In most cases, books and magazines should be formatted correctly for use with Gutenberg if NLS guidelines for book and magazine metadata are followed during resource creation. However, in some cases it may be necessary to reformat older book and/or magazine Unique Identifiers (UIDs) So that they can be used with Gutenberg and KLAS. Locations that require attention and formatting guidelines have been included in the sections below. | ||
- | (( Information in this guide is primarily based on procedures/ | ||
- | ===== Formatting and Fixing UIDs ===== | ||
- | In order to enable recognition by Gutenberg | + | In most cases, books and magazines should be formatted for use with Gutenberg |
- | ==== Formatting UIDs ==== | + | |
- | Formatting examples are included | + | Information on the formatting process is contained |
- | === Book UIDs === | + | |
+ | = UID Locations = | ||
+ | |||
+ | In order to enable recognition by Gutenberg and KLAS, formatted UIDs must be added to/appear in 10 specific locations of component files (.opf, .ppf, etc.). | ||
+ | |||
+ | The ten locations and their associated file extensions have been listed in the table below. Each location can be changed manually by opening the files in a text editor (such as [[ https:// | ||
+ | Automation/ | ||
+ | |||
+ | |||
+ | ^ File extension | ||
+ | | .ncx | ||
+ | | .opf | ||
+ | | ::: | .ao file name | | ||
+ | | .pncx | dtb:uid | | ||
+ | | .ppf | ||
+ | | ::: | .ao file name | | ||
+ | | .smil ((In this case .smil ONLY refers to the .smil file associated with the item itself, NOT pdtb_protected.smil)) | ||
+ | | .ao | File name (needs to match UID) | | ||
+ | | ::: | Book uid | | ||
+ | | ::: | odrld:uid | | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | Formatting examples are included for individual material types in the sub-sections below. | ||
+ | |||
+ | == Book UIDs == | ||
Example of formatted book UID: | Example of formatted book UID: | ||
Line 17: | Line 39: | ||
^Component ^ Explanation ^ | ^Component ^ Explanation ^ | ||
- | | '' | + | | us- | US prefix | |
- | | '' | + | | nls- | NLS prefix | |
- | | '' | + | | ll1a- | library ID ((‘ll’ will be the first two letters of your library ID.))| |
- | | '' | + | | dbc##### |
- | === Magazine UIDs === | + | == Magazine UIDs == |
- | 1) Example of formatted magazine UID (single month) ((According to Keystone, cases where dashes and underscores are not interchangeable exist, and, while combinations other than those appearing below may be possible, it is highly recommended to format based on the examples from this guide.)): | + | ''' |
+ | * For magazines, final formatting will vary depending on issue naming conventions in the KLAS Serials module. | ||
+ | * Examples in the following sections assume that Issue names in the Issues tab of the KLAS Serials module are formatted as < | ||
+ | |||
+ | |||
+ | ''' | ||
< | < | ||
- | 2) Example of formatted magazine UID (multiple months) ((According to Keystone, cases where dashes and underscores are not interchangeable exist, and, while combinations other than those appearing below may be possible, it is highly recommended to format based on the examples from this guide.)): | + | ''' |
< | < | ||
^Component ^ Explanation ^ | ^Component ^ Explanation ^ | ||
- | | '' | + | | us- | US prefix | |
- | | '' | + | | nls- | NLS prefix | |
- | | '' | + | | ll1a- | library ID ((‘ll’ will be the first two letters of your library ID.))| |
- | | '' | + | | SER_ | Serial prefix | |
- | | '' | + | | TTT9- | Serial ID | |
- | | '' | + | | YYYY_ | 4-digit year| |
- | | '' | + | | MM | 2-digit month | |
- | ==== UID Locations ==== | ||
- | The ten locations and their associated file extensions have been listed in the table below. Each location will need to be changed manually by opening the files in a text editor (such as [[ https:// | ||
- | It is also possible to automate/ | ||
+ | = Uploading Books to Gutenberg = | ||
- | ^ File extension | + | After the UID has been properly formatted, simply adding the book or magazine to the < |
- | | '' | + | |
- | | '' | + | |
- | | ::: | '' | + | |
- | | '' | + | |
- | | '' | + | |
- | | ::: | '' | + | |
- | | '' | + | |
- | | '' | + | |
- | | ::: | '' | + | |
- | | ::: | '' | + | |
+ | In some cases, an E-Document may not be generated automatically. While this can be caused by UID formatting errors, it can also occur even if the UID has been formatted correctly. In these cases, it may be necessary to manually create an E-Document and its associated E-Package. For more information on the process, please refer to '' | ||
- | ===== Uploading books to Gutenberg | + | = Synchronize |
- | After fixing the UID, simply adding the book or magazine to the '' | + | New E-Documents are often available in KLAS approximately 24 - 48 hours after .zip files are uploaded |
- | In some cases, an E-Document may not be generated | + | ''' |
+ | * Running the KLAS Batch Manager may require elevated user privileges. | ||
+ | * For Keystone-hosted libraries, it may take approximately 24 hours after new contents have been added to the Gutenberg workstation before | ||
+ | * UID formatting, | ||
+ | == Displaying the KLAS Batch Manager == | ||
- | ===== Generating E-Documents in KLAS ===== | + | After KLAS has been started,the KLAS Desktop Window should be displayed. click: |
+ | \\ | ||
+ | \\ | ||
+ | ''' | ||
- | In the event that an E-Document is not generated after a book file has been uploaded to the '' | + | ''' |
- | The procedures for creating E-Documents (and associated E-Packages) are explained in the sections below. | + | |
- | ==== Creating | + | ''' |
+ | |||
+ | == Preparing and Running the Batch Job == | ||
+ | |||
+ | When the KLAS Batch Manager is opened by a user for the first time, many of the fields may be empty. In this case, please proceed in order through the following steps. Users that have already worked through the steps for ' | ||
+ | \\ | ||
+ | \\ | ||
+ | ''' | ||
+ | |||
+ | ''' | ||
+ | * All of the batch jobs run on your system will appear in the ' | ||
+ | |||
+ | ''' | ||
+ | *After the job has been selected, it should be highlighted in blue. | ||
+ | |||
+ | ''' | ||
+ | * The most recent job run on the system (at the bottom of the list) should now be highlighted. | ||
+ | |||
+ | ''' | ||
+ | |||
+ | ''' | ||
+ | |||
+ | ''' | ||
+ | * The 'Copy Record' | ||
+ | |||
+ | ''' | ||
+ | |||
+ | ''' | ||
+ | * The 'Set Schedule' | ||
+ | |||
+ | ''' | ||
+ | * The job should start immediately, | ||
+ | * It may be necessary to close and reopen the Serials or Catalog module in order to confirm changes. | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | = Manually Generating E-Documents in KLAS = | ||
+ | |||
+ | In the event that an E-Document is not generated after a book file has been uploaded to the Local Books directory on the Gutenberg workstation, | ||
+ | The procedures for creating E-Documents (and associated E-Packages) are explained in the following sections. | ||
+ | |||
+ | ''' | ||
+ | * In some cases, manually created E-Documents may not be recognized, especially in cases where the Issue Title is manually changed prior to creating the E-Document. | ||
+ | * Using the KLAS Batch Manager to Synchronize Gutenberg Edocs prior to attempting to manually create an E-Document is recommended. | ||
+ | |||
+ | == Creating an E-Package | ||
In order to create an E-Document, an E-package must be created. | In order to create an E-Document, an E-package must be created. | ||
- | 1. Open KLAS, and click the '' | + | ''' |
- | 2. Add a new record. | + | ''' |
- | 3. Fill in the values for each item: | + | ''' |
- | |'' | + | ^ Field ^ Data ^ |
- | |'' | + | |Type |NLS Audio / Audio Files from National Library Service | |
- | |'' | + | |Description |Local Copy of NLS Audio | |
- | |'' | + | |Security |Staff only/Only staff persons can view the package documents | |
- | |'' | + | |Source |NLS RSync/RSync from the NLS Catalog to a local storage device | |
- | |'' | + | |Status |Available/ |
- | |'' | + | |Usage |Unlimited/ |
+ | |Price |0.0| | ||
- | ==== Creating an E-Document | + | == Creating an E-Document == |
After an E-Package has been created, it will be possible to create an E-document. | After an E-Package has been created, it will be possible to create an E-document. | ||
For magazines, separate E-Documents will need to be created for each issue. ((Depending on the server method/ | For magazines, separate E-Documents will need to be created for each issue. ((Depending on the server method/ | ||
- | 1. Click the '' | + | ''' |
+ | |||
+ | '' | ||
+ | |||
+ | ^ Field ^ Data ^ | ||
+ | |Package|NLS Audio/Local Copy of NLS Audio | | ||
+ | |Status |Available/ | ||
+ | |||
+ | ''' | ||
- | 2. In the '' | + | === Books === |
- | |'' | + | ^ Field ^ Data ^ |
- | |'' | + | |Short Desc.|Local Copy of NLS Audio| |
+ | |Description|NLS Audio compressed file| | ||
+ | |Seq|##| | ||
+ | |File Type| Zip/ | ||
+ | |Click Meaning| Circ/count the click as circulation| | ||
+ | |Date Added| (Auto-generated)| | ||
+ | |Host| Gutenberg| | ||
+ | |Path| /| | ||
+ | |Filename| .zip filename ((Will auto-update after the book/ | ||
+ | |URL| (leave blank)((Will auto-populate after the book/ | ||
+ | |File Size| (leave blank)((Will auto-populate after the book/ | ||
+ | |Playing Time| (leave blank)((Will auto-populate after the book/magazine has been recognized by Gutenberg.))| | ||
- | 3. Fill in the values as shown below: | + | === Magazines === |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
- | |'' | + | |
+ | ^ Field ^ Data ^ | ||
+ | |Issue Name|YYYY_MM| | ||
+ | |Short Desc.|YYYY_MM| | ||
+ | |Description|NLS Audio compressed file| | ||
+ | |Seq|##| | ||
+ | |File Type| Zip/ | ||
+ | |Click Meaning| Circ/count the click as circulation| | ||
+ | |Date Added| (Auto-generated)| | ||
+ | |Host| Gutenberg| | ||
+ | |Path| /| | ||
+ | |Filename| .zip filename((Will auto-update after the book/ | ||
+ | |URL| (leave blank)((Will auto-populate after the book/ | ||
+ | |File Size| (leave blank)((Will auto-populate after the book/ | ||
+ | |Playing Time| (leave blank)((Will auto-populate after the book/ | ||