Catalog Search

1-888-NLS-READ (1-888-657-7323)

Packaging of Electronic Braille Files

Table of Contents

1. Scope

This specification provides requirements for the packaging of braille books and magazines in electronic format. It is to be used for braille book and magazine production for the National Library Service for the Blind and Print Disabled (NLS).

2. Reference Documents

The following documents and publications form a part of this specification. In the event of conflict between the documents and publications referenced herein and the content of this specification, the content of this specification shall be considered a superseding requirement.

2.1 Specifications

Open eBook Forum

Open eBook Publication Structure 1.01

The document cited above is available from:
http://xml.coverpages.org/OEBPS-101-2001-07-02.pdf External

National Library Service for the Blind and Print Disabled

NLS Specification 800
Braille Books and Pamphlets

NLS Specification 801
Braille Magazines or Newspapers

NLS Specification 803
Print/Braille Books

NLS Specification 1207
Delivery of Braille Book and Magazine Files via the Internet

The documents cited above are available from:

National Library Service for the Blind and Print Disabled
Library of Congress
1291 Taylor St. NW
Washington, DC 20542
https://www.loc.gov/nls/about/organization/standards-guidelines/contract-specifications/

Internet Engineering Task Force Network Working Group

The MD5 Message-Digest Algorithm (RFC 1321, April 1992)

The document cited above is available from:
www.ietf.org/rfc/rfc1321.txt External

3. Container Requirements

The files that compose the electronic braille publication shall be packaged in a zip file with an extension of .zip

3.1. Container Content

The zip file shall contain a BOPF, one or more BRF files, and an MD5 checksum file.

The files shall be delivered following all applicable requirements of NLS Specification 1207.

3.2. File Names

Book Naming Convention — The .bopf filename shall be in the following form “nnnnn.bopf,” where “nnnnn” represents the production identifier supplied by NLS

Magazine Naming Convention — The .bopf filename shall be in the following form: xxmddyy.bopf where “xx” is the magazine name (supplied by NLS) using two alpha character, “m” is the month using one alpha character (a-l), “dd” is the day (1–31) using two numeric characters (if single digit, add leading zero), and “yy” is the year using two numeric characters.

3.3. Package File (BOPF)

3.3.1 BOPF Validity

The BOPF file must be a valid XML 1.0 document conforming to the OEBF Publication Structure 1.0.1 package DTD (oebpkg101.dtd).

3.3.2 BOPF Metadata

No metadata element shall be removed from the initial BOPF provided by NLS. The producer shall ensure the accuracy and correctness of all the dc:metadata and x-metadata. Where appropriate, content of BOPF metadata elements shall be obtained from the source material unless an exception is specified in writing by NLS. Errors in the initial BOPF provided by NLS shall be corrected. The contractor shall contact the NLS contract monitor if the BOPF provided is found to be inaccurate.

3.3.2.1 Definition of Dublin Core (dc) Metadata Content

a. dc:Title — Publication title

b. dc:Creator — Name(s) of primary author, editor, etc. of the print text. Names shall be formatted as Last name, First name.

Note: For multiple creators this element shall be repeated as needed.

c. dc:Subject — Topic of the content of the publication. This is the NLS copy allotment subject heading. Additional dc:subjects may be provided, if the publication belongs to additional NLS broad subject categories. This element shall be repeated as needed.

d. dc:Description — This is the full Library of Congress annotation, including taglines and date, contained on the NLS production authorization record (PAR).

e. dc:Publisher — National Library Service for the Blind and Print Disabled, Library of Congress (this shall be rendered exactly).

f. dc:Date — Date of publication of the BRF. The “dc:Date” element shall contain the year and month in the format “yyyy-mm.”.

g. dc:Format — Shall consist of “BRF/” and the Braille translation code (“UEB” or “EBAE”), followed by “contracted” or “uncontracted”

h. dc:Identifier — Unique identifier (UID). The element shall have an id attribute set to “uid” and a scheme attribute set to “dtb”. For books the content shall consist of the lowercase character string “us-nls-ppnnnnn,” where “p” represents the prefix (two or three characters) and where “nnnnn” represents the production identifier supplied by NLS. For magazines the content shall consist of the lowercase character string “us-nls-br_xx_yyyy_mm_dd, where “xx” represents the two-character magazine code provided by NLS and ”yyyy_mm_dd” represents the year, month, and day of the issue date.

i. dc:Source — ISBN of the print book or ISSN of the print magazine.

j. dc:Language — Language of the BRF. (English is represented as “en.” Spanish is represented as “es.”) (See RFC 1766 and ISO 639-1)

Note: Language code shall be rendered in lower case. For multiple languages this element shall be repeated as needed.

k. dc:Rights — Further reproduction or distribution in other than an accessible format is prohibited.

Note: The quoted text above shall be rendered, on a single line, exactly as shown.

3.3.2.2 Definition of Extended (x) Metadata Content

a. brl:sourceDate – The date of the publication of the source material, as supplied by NLS, in the format “yyyy[-mm[-dd]].”

b. brl:sourcePublisher — Publisher of the source material. If the magazine is a composite of several print magazines, brl:sourcePublisher may be repeated.

c. brl:sourceRights — Copyright year and holder of the copyright for the source material from which the braille book or magazine is derived. If the magazine is a composite of several print magazines, brl:sourceRights may be repeated.

d. brl:transcribingAgency – Shall contain the full name of the organization that made the original braille transcription.

e. brl:producer — Full name of the organization that produced the braille publication.

f. brl:producedDate – Shall contain the date of the first submission of the braille publication to NLS in the format “yyyy-mm-dd” and shall not be changed.

g. brl:revision — Shall contain an integer. For the first submission to NLS, the revision shall be “0,” and the revision shall be incremented for each subsequent submission.

h. brl:revisionDate — Shall contain the date of the most recent revision of the braille publication in the format “yyyy-mm-dd”. When brl:revision equals “0” brl:revisionDate shall equal the content of the brl:producedDate.

i. brl:revisionDescription — Shall contain a text string describing the reason for each revision, listed in order; “brl:revisionDescription” shall be present and valued for all revisions greater than “0”.

j. brl:volumes — Shall contain the total number of volumes or parts for the publication.

k. brl:code — Shall contain the abbreviation of the translation code used for the publication, ueb or ebae.

l. brl:pages — Shall contain the total number of pages in the publication equal to the number of form feed characters.

m. brl:lineLength —Shall equal the number of characters in the longest line of the publication.

n. brl:pageLength — Shall equal the number of lines on the page with the greatest number of lines.

o. brl:contractionLevel — Shall contain an integer representing the contraction level: 1 for uncontracted and 2 for contracted.

p. brl:containsMusic — Shall be “true” if braille music is present, “false” if not.

q. brl:containsMath — Shall be “true” if braille math is present, “false” if not.

Note:
— Shall be set to “true” only if the publication includes displayed math or contains mathematical expressions that go beyond “basic arithmetic.”

r. brl:mathCode — If brl:containsMath is true, brl:mathCode shall contain the type of math code used. Shall be Nemeth or UEB.

s. brl:tactileGraphics — Shall be “true” if the hard-copy version of this publication includes one or more tactile graphics that have been omitted from the eBraille package and “false” if not.

t. brl:nonfiction — Shall be “true” if the book is nonfiction and “false” if fiction.

u. brl:dewey — Shall contain the Dewey decimal number.

v. brl:series — If the book is part of a series the element shall contain the name of the series. The element can be repeated if the book belongs to more than one series.

w. brl:seriesSequence — Shall contain the number of the book in its series at the time of publication of the braille edition.

Notes:
Non-ASCII characters in all element content shall be represented as numeric character references or as UTF-8 multi-byte sequences.

3.3.3 BOPF Manifest

The manifest shall list the files that make up the publication. Each item element in the manifest must have a href attribute that shall contain the name of a unique file that is part of the publication. Each item element must have a media-type attribute containing the MIME media type of the file and an id attribute. For BRF files the MIME media type shall be “text/brf”.

3.3.4 BOPF Spine

The spine shall consist of a list of one or more itemref elements whose order defines the default linear reading order of the braille publication. Each itemref must contain an idref that points to the id of a BRF file listed in the manifest.

3.4. Checksum File

An XML file shall be created containing a checksum for each file in the publication as specified in section 3.1 except for the MD5 file itself. All the files listed in the checksum file shall be present in the single zip container file used for transmission of the publication as described in NLS Specification 1207. The checksum shall be calculated using the MD5 algorithm as described in the reference cited in Section ‎2.1 and shall be in the form of 32 hexadecimal digits. The checksums shall be generated from the source files prior to their packaging and transmission. This checksum file does not form part of the publication and thus shall not be listed in the BOPF manifest. The checksums contained in the checksum file must be identical to the checksums calculated from the source files and to those calculated from the corresponding files extracted from the zip container file. The format of the XML file is described by the following DTD, which shall be placed at the beginning of each checksum file.


<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE diskcheck [
  <!ELEMENT diskcheck (book, file+)>
  <!ATTLIST diskcheck version CDATA #FIXED "1.0" >
	  <!ELEMENT book (#PCDATA)>
  <!ELEMENT file (filename, checksum)>
  <!ATTLIST file type CDATA #IMPLIED content CDATA #IMPLIED >
  <!ELEMENT filename (#PCDATA)>
  <!ELEMENT checksum (#PCDATA)>
  <!ATTLIST checksum type CDATA #REQUIRED>
]>

The contents of element shall match the UID as found in the content of the BOPF dc:Identifier.

The element shall contain the name of the file for which the checksum is calculated. The “type” attribute on the element shall contain the value “MD5.”

4. Quality Assurance

4.1 Responsibility for Inspections

The contractor is responsible for the inspection of all files for compliance with the requirements of this specification. NLS reserves the right to perform inspections when deemed necessary to ensure that products conform to the prescribed requirements.

4.2 Quality Assurance Procedures (QAP)

The contractor shall prepare written documentation that describes the quality-assurance procedures used to ensure that the requirements of the specification are addressed during production and inspection. The contractor shall submit this documentation to the NLS Quality Assurance Section prior to the commencement of work at the beginning of each new contract, when changed, or when requested by NLS. NLS reserves the right to require the contractors failing to provide conforming products to improve or enhance inspection and quality-assurance procedures at no additional cost to NLS.

4.3 Responsibility for Compliance

The requirements set forth in this specification shall become a part of the contractor’s overall inspection system or quality program. The absence of any inspection requirements in the specification shall not relieve the contractor of the responsibility of assuring that all products submitted to NLS comply with all requirements of the contract. Sampling in quality conformance does not authorize the submission of known defective material, either indicated or actual, nor does it commit NLS to the acceptance of defective material. Should NLS determine that a significant fault or faults are found in production materials within the warranty period, correction of the fault or faults and inspections or controls for prevention shall be instituted without additional charge to the Government.

4.4 Incoming Inspection

Incoming inspection shall be performed by the contractor on all source materials provided by NLS.

4.5 Warranty

The contractor shall unconditionally warrant that the publication conforms to the requirements set forth in this specification for a period of two years from the date the publication is approved by the NLS Quality Assurance Section.

4.6 Correction

Should NLS determine that a noncompliance with the specifications exists on a publication during the warranty period, the non-compliant product shall be corrected within ten business days of notification at no cost to NLS.

4.7 NLS Testing

NLS reserves the right to inspect any process or tests being performed. The library representative shall have the authority, without advance notice, to select at random a sample at any time during the course of the contract for testing to the specified requirements.

4.8 Facility Inspection

NLS reserves the right to inspect plant facilities or processes at any reasonable time. An NLS representative shall have the authority, without advance notice, to select at random a sample of the publications at any time during the course of the contract for testing to the specified requirements.

4.9 NLS-Supplied Tools, Information, and Materials

NLS may in some cases provide tools, information, and materials to assist in the production of braille publications. Use or non-use of these items does not release the contractor from their obligation to produce publications that meet the specifications. NLS provides such tools “as-is” and may update or discontinue providing the items at any time without notice.

Skip to main content