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

Book protocol

folletto edited this page Oct 11, 2011 · 12 revisions

The book:// protocol syntax:

book://example.org/whatever/whenever/publication.hpub/filename.html#anchor

Two great advantages:

  • We are able to uniquely identify a book: the path is unique, identifies a uniquely owned domain (i.e. "example.org"), a specific path (i.e. "whatever/whenever"), a specific publication (i.e. "publication"), format (i.e. "hpub")
    • Once identified, we can also refer to items from its content: filename (i.e. "filename.html") and anchor (i.e. "#anchor").
  • We are able to download a book: the protocol used is the standard HTTP, so you can easily convert book:// in http:// and download the book from that specific location.

Notes:

  1. The specific extension can be omitted: in that scenario, the reading software might try to download the extension that is best suited. Baker will download ".hpub" files by default, but the book:// protocol is agnostic so it could point also to a ".epub" version or ".mobi" version or even a pure textual ".html" version.

Usage in Baker

Baker will recognize book:// links from the currently opened book page, and will automatically download and substitute the current book with the downloaded one.

This will allow:

  1. Manual updates of the current book.
  2. The creation of a lightweight version or some kind of shelf that downloads the book you want.

This is the old repository of Baker Framework. It's not in use anymore. Please go to the active repository on BakerFramework.

Clone this wiki locally