Follow

HTML Manifest Document Type

Overview

Provides a simple format for specifying an ordered list of pages in a document, with no additional metadata. This format can be used in all Pugpig versions, and it is currently the only way to order pages in Pugpig Free. If you create a manifest called “index.manifest” in your Data directory, Pugpig can be configured to use it like this:

[pageControl setDataSource:[[[KGHTMLManifestDataSource alloc] initWithPath:@"Data/index.manifest"] autorelease]];

Fields

This is a simple text file based on the HTML offline manifest format. Only HTML files should be included, one on each line. The HTML files are relative paths.

Testing and Validation

  • No standard validator exists for this.

Example

CACHE MANIFEST
# you can include comments. Just start a line with the 'hash' character
cover.html
contents.html
chapter1/page01.html
chapter1/page02.html
end.html

Pugpig Live

When this document type is used with Pugpig Live, the manifest file usually comes from a server. Keep the following in mind:

  • The manifest should be served with the mime-type text/cache-manifest
  • The manifest will be requested every time a client downloads the edition, so it should be cached
  • The manifest should be protected if the document is not freely available
  • You can use absolute URLs in a live manifest, but usually the URLs will be relative the manifest's URL
  • Each HTML file in the manifest needs to include a link to its own HTML manifest (see Asset Downloading)

Example

Request

GET /editions/1/index.manifest HTTP/1.1
Host: sample.kaldorgroup.com

Response

HTTP/1.1 200 OK
Content-Type: text/cache-manifest
Date: Tue, 06 Dec 2011 14:26:15 GMT
Content-Length: 77
CACHE MANIFEST
cover.html
contents.html
page01.html
page02.html
end.html
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk