Constructing an EPUB

File Naming Conventions

Name the EPUB project files and folders according to the following conventions.

File/FolderNaming Convention
Root project folder_13-digit ISBN_
EPUB package and container filesUse the conventions shown in the Directory Structure section below.
FontsInclude all default style sheet fonts.
ImagesInclude one cover image _(1333x2000 minimum), named cover.jpg_, along with all book images and video poster SVGs.
StylesInclude only mywsb-dev.css
VideosInclude one XHTML document with video markup **for each each non-inline video** (more common with glossaries and notes).
TextEach XHTML file should be named with:
  1. Short name
  2. One of three numbers + type, expressing order:
    • 01_front = frontmatter
    • 02_body = bodymatter
    • 03_back = backmatter
  3. Sequence number + section name as shown by example below
Text: Front MatterShortName01_front01_cover.xhtml
ShortName01_front02_titlepage.xhtml
ShortName01_front03_copyright-page.xhtml
ShortName01_front04_xyz.xhtml (etc.)

The section numbers should be sequential, starting with 01, and the name that follows the number should correspond to the `epub:type` in the document or a brief, descriptive name if there is no corresponding type.

Exception: name abbreviation documents "abbr" rather than "glossary."
Text: Main ContentShortName02_body01_part01.xhtml
ShortName02_body02_chapter01.xhtml
ShortName02_body03_chapter02.xhtml (etc.)

Section numbers should be sequential for bodymatter as well, followed by either "part" or "chapter" along with its order (part01, chapter99, etc).
Text: Back MatterShortName03_back01_xyz.xhtml (etc.)

As with frontmatter, backmatter section numbers should be sequential, starting with 01, and the name that follows the number should correspond to the `epub:type` in the document.

Directory Structure

Use the following directory structure for each EPUB:

Screen shot of the correct directory structure.

Package and Container Files

The primary package and container files are referenced here in their expected basic forms, but it is beyond the scope of this documentation to describe the EPUB specification in detail. For a better understanding of EPUB and related specifications, please use the documents available to the team in Alfresco.

mimetype

The mimetype doc is the same for every EPUB we develop:

application/epub+zip

container.xml

The container.xml is also the same for every EPUB.

<?xml version="1.0"?>
<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
  <rootfiles>
    <rootfile full-path="content.opf" media-type="application/oebps-package+xml"/>
  </rootfiles>
</container>

content.opf

The content.opf is available here in its basic form.

Metadata and included files will vary from one publication to the next, but the link above gives a good overview of the form. For information on metadata, see the Content.opf Metadata section.

Every content file in the EPUB package must be referenced in the manifest.

toc.xhtml

The toc.xhtml is the navigation document for the EPUBs we develop. The children of <body> must be <nav> elements.

The linked toc.xhtml shows the basic form. See Navigation Document for necessary specifics.