Introduction

In most cases, books and magazines should be formatted for use with Gutenberg if NLS guidelines for 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. 1) 2) 3)

Working with UIDs

In order to enable recognition by Gutenberg and KLAS, formatted UIDs must be added to/appear in component files (.opf, .ppf, etc.) in 10 specific locations.

UID Format

Formatting examples are included in each of the sub-sections below.

Book UIDs

Example of formatted book UID:

us-nls-ll1a-dbc#####
Component Explanation
us- US prefix
nls- NLS prefix
ll1a- library ID 4)
dbc##### DBC number 5)

Magazine UIDs

1) Example of formatted magazine UID (single month) 6):

 us-nls-ll1a-SER_TTT9-YYYY_MM 

2) Example of formatted magazine UID (multiple months) 7):

 us-nls-ll1a-SER_TTT9-YYYY_MM_MM 
Component Explanation
us- US prefix
nls- NLS prefix
ll1a- library ID 8)
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 can be changed manually by opening the files in a text editor (such as Ted Notepad, or Vim) and pasting/entering in the formatted UID. Automation/partially automation of the process is possible, and a program written in C ( libxml) is used for changing UIDs at MBTBL.

File extension Location
.ncx dtb:uid
.opf dc:Identifier
.ao file name
.pncx dtb:uid
.ppf dc:Identifier
.ao file name
.smil dtb:uid
.ao File name (needs to match UID)
Book uid
odrld:uid

Uploading books to Gutenberg

After fixing the UID, simply adding the book or magazine to the Local Books directory on Gutenberg should result in an E-Document being auto-generated. It will be possible to confirm whether an E-Document has been generated in KLAS by checking the E-Document tab in the Catalog or Serials module 24 – 48 hours after uploading the book file to Gutenberg.

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 Generating E-Documents in KLAS below.

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, it may be necessary to create one manually. The procedures for creating E-Documents (and associated E-Packages) are explained in the sections below.

Creating an E-Package

In order to create an E-Document, an E-package must be created.

1. Open KLAS, and click the E-Package tab for the desired book or magazine.

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/The documents are available for use
Usage Unlimited/No limit to how many items are ‘OUT’ at one time
Price 0.0

Creating 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. 9)

1. Click the E-Document tab for the desired book or magazine.

2. In the Package Info section, choose the following values:

Field Data
PackageNLS Audio/Local Copy of NLS Audio
Status Available/The documents are available for use

3. Then, enter the data for the desired resource type (book, or magazine) to complete the E-Document.

Books

Field Data
Short Desc.Local Copy of NLS Audio
DescriptionNLS Audio compressed file
Seq##
File Type Zip/application/zip
Click Meaning Circ/count the click as circulation
Date Added MM/DD/YYYY
Host Gutenberg
Path /
Filename (leave blank)10)
URL (leave blank)11)
File Size (leave blank)12)
Playing Time (leave blank)13)

Magazines

Field Data
Issue NameYYYY-MM
Short Desc.YYYY-MM
DescriptionNLS Audio compressed file
Seq##
File Type Zip/application/zip
Click Meaning Circ/count the click as circulation
Date Added MM/DD/YYYY
Host Gutenberg
Path /
Filename (leave blank)14)
URL (leave blank)15)
File Size (leave blank)16)
Playing Time (leave blank)17)
1)
Information in this guide is primarily based on procedures/suggestions from Colorado Talking Book Library and Keystone Systems.
2)
Procedures below are explained using Gutenberg and KLAS and may differ slightly depending on the software/hardware combination used.
3)
while formatting the UID can often enable a book to be duplicated onto cartridges using Gutenberg, additional checks/changes may be necessary when submitting books for distribution through BARD.
4)
ll’ will be the first two letters of your library ID.
5)
A prefix other than ‘dbc’ could also be used in-house book numbers
6) , 7)
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.
8)
‘ll’ will be the first two letters of your library ID.
9)
Depending on the server method/settings, it may take up to 48 hours for a book file to be recognized after it has been added and an E-Document has been created.
10) , 11) , 12) , 13) , 14) , 15) , 16) , 17)
Will auto-populate after the book/magazine has been recognized by Gutenberg.
preparing_books_and_magazines_for_use_with_gutenberg_and_klas_uids_e-documents.txt · Last modified: 2021/09/07 12:34 by mn1a
Recent changes RSS feed