Skip to content
This repository has been archived by the owner on Mar 26, 2018. It is now read-only.

hpub specification

therabidbanana edited this page Jun 4, 2011 · 24 revisions

Current HPub Draft 0.9 [2010-11-21]

1. Abstract

The HPub (HTML Publication) standard is a file format designed to release rich content books in a simple and manageable package.

2. The principles

We want a digital publishing format that:

Allows great designs Allows both pixel-perfect and flexible reflowable publications Is simple for authors Is simple for parsers

3. The Spec

  • An HPub publication is a normal .zip file with ".hpub" extension. Unpacked books are allowed.
  • The content format must be HTML5.
  • It must contain at least one HTML file with extension "html".
  • If more than one HTML file are included, the pagination order must be alphabetical.
  • Any HTML file contained in subfolders must be excluded from the pagination order.
  • All the assets (CSS, images, JS, ...) must be included in the package and referenced relatively from the HTML5 files.

Open parts

  • Required: Unique referencing protocol (book://)
  • Evaluating: manifest + toc files
  • Optional: Title (take first page title tag?)
  • Optional: Author (take first page meta author tag?)
  • Optional: Page size for default CSS selection by the reader
  • Optional: cover
  • Optional: thumbnails (same name as html files)
  • Optional: reading system properties?