The epubble format packages publications as a ~TiddlyWiki plugin. They can be created from off-the-shelf .epub files by using the epub-slicer plugin, or newly created publications can be authored directly in the new format for enhanced flexibility.
The fields of an epubble publication plugin are as follows:
| Field | Description |
|---|---|
| description | Short description of the publication |
| epub-creator | Identifies the person or entity that produced the publication |
| epub-title | The original title of the publication (see below) |
| list | The shortnames of the tabs to be displayed in control panel for the plugin (generally just "readme") |
| plugin-type | Always set to plugin |
| title | By convention, the title of the plugin is $:/plugins/epubble/ plus the human readable title of the publication |
| type | Always set to application/json |
This filter expression lists all the loaded epubble plugins:
[plugin-type[plugin]has[epub-title]]The spine tiddler contains the overall structure of the publication.
It contains the following fields:
| Field | Description |
|---|---|
| cover-image | The title of the tiddler containing the cover image for the publication |
| dc-creator | The creator responsible for the publication |
| dc-title | The title of the publication |
| list | Lists the titles of the tiddlers describing the sections of the publication |
| role | Always set to epubble-spine |
| table-of-contents | The title of the tiddler containing the table of contents for the publication (see below) |
| title | Matches the epub-title field of the publication plugin |
Each epubble publication plugin contains a $:/DefaultTiddlers tiddler that lists the individual tiddlers making up the default story river for the publication.
Publication section tiddlers split the publication up into logical groups of tiddler (e.g. corresponding to a chapter in a novel; for converted epubs each section corresponds to a separate HTML file). Publication tiddlers are listed in the list field of the spine tiddler, and contain the following fields:
| Field | Description |
|---|---|
| list | Lists the titles of the content tiddlers making up this section |
| role | Always set to epubble-content |
| slicer-output-mode | Specific to epub-slicer (eg "html") |
| slicer-rules | Specific to epub-slicer (eg "html-linear") |
| title | Matches the title specified in the spine tiddler |
| toc-type | Always set to document |
Sequences of content tiddlers are the smallest level of structure within a publication, typically corresponding to a paragraph. Content tiddlers have the following fields:
| Field | Description |
|---|---|
| role | Always set to epubble-content |
| tags | Tagged with the title of the section tiddler to which this content tiddler belongs |
| title | Generated title for the tiddler (the title isn't displayed to users) |
| toc-type | Always set to paragraph |
The table of contents referenced in the spine tiddler is structured as usual for TiddlyWiki, with each child entry being tagged with the title of its parent. The caption field carries the text of the TOC entry.