Skip to content

Fulcrum Edition 1.0 Specification

Jonathan McGlone edited this page Nov 16, 2017 · 5 revisions

This document defines a specification for EPUBs ingested, stored, and presented in Fulcrum, referred to as the Fulcrum Edition of an EPUB. The spec builds upon the EPUB 3.1 specification, adding detailed examples, best practices, and notes to ensure optimum presentation, accessibility, and rendering of an EPUB in Fulcrum's EPUB Reader.

Markup

EPUBs should use semantic HTML5 elements whenever possible.

Headings

For example, each section or chapter should have a heading that reflects its level in the document hierarchy.

<section epub:type="chapter">
  <header>
    <h1><span epub:type="title">Chapter 1</h1>
  </header>
  ...
</section>

Folder Structure

To ensure chapters (links and titles) are accessible to multiple EPUB Reader widgets, it is recommended that chapter .xhtml files are placed within the root of the OEBPS folder. Other sub-folders, such as fonts, images, or styles can be nested within the OEBPS folder and referenced from the root level .xhtml files. For example:

.
├── META-INF
│   ├── com.apple.ibooks.display-options.xml
│   └── container.xml
├── OEBPS
│   ├── 00_Nav.xhtml                        ## Chapter files are at the root
│   ├── 01_Cover.xhtml                      ## of the OEBPS folder, not
│   ├── 02_Halftitle.xhtml                  ## nested into sub-folders.
│   ├── 03_Title01.xhtml
│   ├── 04_Copyright01.xhtml
│   ├── 05_Dedication.xhtml
│   ├── 06_Contents.xhtml
│   ├── 07_Acknowledgement.xhtml
│   ├── 08_Introduction.xhtml
│   ├── 09_Chapter01.xhtml
│   ├── 10_Chapter02.xhtml
│   ├── 11_Chapter03.xhtml
│   ├── 12_Chapter04.xhtml
│   ├── 13_Chapter05.xhtml
│   ├── 14_Chapter06.xhtml
│   ├── 15_Conclusion.xhtml
│   ├── 16_Notes.xhtml
│   ├── 17_Index01.xhtml
│   ├── 18_Author.xhtml
│   ├── content.opf
│   ├── fonts                
│   │   ├── MinionPro-It.ttf
│   │   └── MinionPro-Regular.ttf
│   ├── images
│   │   ├── cover.jpg
│   │   ├── fig1_1.png
│   │   ├── fig1_2.png
│   │   ├── fig2_1.png
│   │   ├── fig2_2.png
│   │   ├── fig2_3.jpg
│   │   ├── fig2_4.png
│   │   ├── fig3_1.png
│   │   ├── fig3_2.png
│   │   ├── fig3_3.png
│   │   ├── fig3_4.jpg
│   │   ├── fig4_1.jpg
│   │   ├── fig5_1.jpg
│   │   ├── fig5_2.png
│   │   ├── fig5_3.jpg
│   │   ├── fig6_1.png
│   │   ├── fig6_2.jpg
│   │   ├── fig6_3.png
│   │   ├── figC_1.png
│   │   ├── figC_2.png
│   │   └── pub.jpg
│   ├── styles
│   │   ├── page-template.xpgt
│   │   └── stylesheet.css
│   └── toc.ncx
└── mimetype