This is an old revision of the document!
In most cases, books and magazines should be formatted correctly for use with Gutenberg if NLS guidelines for book and magazine metadata are followed. 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. Locations that require attention and formatting guidelines have been included in the sections below. 1) 2) 3)
In order to ensure successful recognition by Gutenberg and KLAS, Correctly formatted UIDs must appear in 10 specific locations in the component files of books/magazines.
Formatting guidelines and examples are included in each of the sub-sections below.
Example of formatted book UID:
us-nls-ll1a-dbc#####
1) Example of formatted magazine UID (single month):
us-nls-ll1a-SER_TTT9-YYYY_MM
2) Example of formatted magazine UID (multiple months):
us-nls-ll1a-SER_TTT9-YYYY_MM_MM
| Component | Explanation |
|---|---|
| us- | US prefix |
| nls- | NLS prefix |
| ll1a- | library ID 6) |
| SER_ | Serial prefix |
| TTT9- | Serial ID |
| YYYY_ | 4-digit year |
| MM | 2-digit month |
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 Ted Notepad, or Vim) and pasting/entering in the correctly formatted UID. It is also possible to automate/partially automate the process, and a C program ( 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” |
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.
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.
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:
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.
1. Click the E-Document tab for the desired book or magazine. 2. In the Package Info section, choose the following values:
3. Fill in the values as shown below:
the Filename and File Size fields should be left blank, and will be auto-populated after the book/magazine has been recognized by Gutenberg.
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.