Libraries for the Blind and Print Disabled

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
preparing_books_and_magazines_for_use_with_gutenberg_and_klas_uids_e-documents [2022/04/07 11:22]
mn1a [UID Format] 		preparing_books_and_magazines_for_use_with_gutenberg_and_klas_uids_e-documents [2022/09/13 10:43] (current)
mn1a [UID Locations]
Line 4: Line 4:
 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) to enable use with Gutenberg and KLAS.  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) to enable use with Gutenberg and KLAS. 
  
-Additionally, extra procedures and/or troubleshooting may be required to ensure that records within KLAS (E-Packages and E-Documents) can be successfully generated and linked with items in Gutenberg.+Information on the formatting process is contained in the following sections.(( Information in this guide is primarily based on procedures/suggestions from [[ https://myctbl.cde.state.co.us/ | Colorado Talking Book Library]] and [[ https://www.klas.com/ | Keystone Systems]].)) ((Procedures below are explained using Gutenberg and KLAS and may differ slightly depending on the software/hardware combination used.)) ((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.))
  
-Information on the above topics is contained within the sections below.(( Information in this guide is primarily based on procedures/suggestions from [[ https://myctbl.cde.state.co.us/ | Colorado Talking Book Library]] and [[ https://www.klas.com/ | Keystone Systems]].)) ((Procedures below are explained using Gutenberg and KLAS and may differ slightly depending on the software/hardware combination used.)) ((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.)) 
  
-= Issue Name Formatting (KLAS) = 
 = UID Locations = = UID Locations =
  
-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. +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://en.wikipedia.org/wiki/TED_Notepad | Ted Notepad]], or [[ https://www.vim.org/ | Vim]]) and pasting/entering in the formatted UID.  +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://en.wikipedia.org/wiki/TED_Notepad | Ted Notepad]], or [[ https://www.vim.org/ | Vim]]) and pasting/entering the formatted UID.  
-Automation/partially automation of the process is possible, and a program written in C ([[ http://xmlsoft.org/ | libxml]]) is used for changing UIDs at MBTBL.+Automation/partial automation of the process is possible, and a program written in C ([[ http://xmlsoft.org/ | libxml]]) is used for changing UIDs at the Minnesota Braille and Talking Book Library (MBTBL/MN1A).
  
  
Line 32: Line 30:
  
  
-Formatting examples are included in each of the sub-sections below.+Formatting examples are included for individual material types in the sub-sections below.
  
 == Book UIDs == == Book UIDs ==
Line 51: Line 49:
  
 '''PLEASE NOTE:'''  '''PLEASE NOTE:''' 
-* For magazines, formatting of the title section of the UID will ultimately depend on how the issues names have been saved to KLAS. +* 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 are formatted as <tt>YYYY-MM </tt>(monthly) or <tt>YYYY_MM_MM</tt> (bi-monthly)+* Examples in the following sections assume that Issue names in the Issues tab of the KLAS Serials module are formatted as <tt>YYYY-MM </tt>(monthly) or <tt>YYYY_MM_MM</tt> (bi-monthly)
  
  
Line 76: Line 74:
 = Uploading Books to Gutenberg = = 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. The KLAS Batch Manager can be used to Synchronize Gutenberg Edocs, resulting in near-instantaneous updates. However, if use of the Batch Manger is not desirable/possible, E-Document generation can also be confirmed by viewing the E-Document tab in the Catalog or Serials module 24 – 48 hours after uploading the book file to Gutenberg.+After the UID has been properly formatted, simply adding the book or magazine to the <tt>Local Books</tt> directory on Gutenberg should result in auto-generation of an E-Document. The KLAS Batch Manager can be used to Synchronize Gutenberg Edocs, resulting in near-instantaneous updates. However, if use of the Batch Manger is not desirable/possible, E-Document generation can also be confirmed by viewing 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 ''Manually Generating E-Documents in KLAS'' below. 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 ''Manually Generating E-Documents in KLAS'' below.
  
-= Synchronize Gutenberg Edocs with KLAS Batch Manager =+= Synchronize Gutenberg E-Documents with KLAS Batch Manager =
  
-New E-Documents are often available in KLAS approximately 24 - 48 hours after .zip files are uploaded to Gutenberg. However, in some cases, quickly confirming that E-Documents have been successfully generated may be desirable, and the KLAS Batch Manager enables users to run the process on demand.+New E-Documents are often available in KLAS approximately 24 - 48 hours after .zip files are uploaded to Gutenberg. However, in some cases, quickly confirming that E-Documents have been successfully generated may be desirable. The KLAS Batch Manager enables users to run the process on demand.
  
 '''PLEASE NOTE:''' '''PLEASE NOTE:'''
 * Running the KLAS Batch Manager may require elevated user privileges. * 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 eDocs can be generated with KLAS Batch Manager +* For Keystone-hosted libraries, it may take approximately 24 hours after new contents have been added to the Gutenberg workstation before E-Documents can be generated with KLAS Batch Manager 
-* UID formatting, correspondence (within tolerance) between file names in KLAS and UIDs, and other system-level considerations may also be necessary to enable E-Documents to be generated.+* UID formatting, correspondence (within tolerance) between file names in KLAS and UIDs, and other system-level considerations may also be necessary to enable auto-generation of E-Documents.
  
 == Displaying the KLAS Batch Manager == == Displaying the KLAS Batch Manager ==
Line 102: Line 100:
 == Preparing and Running the Batch Job == == 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 steps below. Users that have already worked through the steps for 'Synchronize Gutenberg Edocs', or a similar batch job in the past will be able to skip to step 6.+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 'Synchronize Gutenberg Edocs', or a similar batch job in the past will be able to skip to step 6.
 \\ \\
 \\ \\
Line 141: Line 139:
  
 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. 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.+The procedures for creating E-Documents (and associated E-Packages) are explained in the following sections.
  
 '''PLEASE NOTE:''' '''PLEASE NOTE:'''
-* In some cases, manually created E-Documents may not be recognized, especially in cases where the Issue title is changed manually directly prior to creating the E-Document.+* 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.  * Using the KLAS Batch Manager to Synchronize Gutenberg Edocs prior to attempting to manually create an E-Document is recommended. 
  
preparing_books_and_magazines_for_use_with_gutenberg_and_klas_uids_e-documents.1649344932.txt.gz · Last modified: 2022/04/07 11:22 by mn1a

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: Public Domain