https://github.com/9beach/pubgen
Pubgen is a command-line based epub generator. Make an epub with YAML.
https://github.com/9beach/pubgen
Last synced: 4 months ago
JSON representation
Pubgen is a command-line based epub generator. Make an epub with YAML.
- Host: GitHub
- URL: https://github.com/9beach/pubgen
- Owner: 9beach
- License: mit
- Created: 2012-02-26T12:37:35.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2013-11-04T11:48:21.000Z (over 12 years ago)
- Last Synced: 2025-01-22T03:38:20.141Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 152 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pubgen
Pubgen is a command-line based epub generator. Make an epub with YAML.
## Installation
```bash
$ # First, install Ruby and then
$ gem install pubgen
```
## Usage
```bash
$ pubgen -h
pubgen 0.2.0, an epub generator. (http://github.com/9beach/pubgen)
Usage:
pubgen [-o ] [-v]
pubgen -m
pubgen -t
-o, --output EPUB_FILE Specify output epub file path
-m, --meta-file-only Generate .opf, .ncx, mimetype, ...
-t, --toc TOC_FILE EPUB_ROOT Print YAML using TOC file
-v, --verbose Verbose output
```
## Quick Start
### Create an epub
Prepare files (documents, images, style sheets, etc.) that make up the
publication. Apple's iBooks requires strict xhtml. [`tidy -asxhtml`]
(http://tidy.sourceforge.net/) will be helpful to you.
```bash
$ find .
.
./contents
./contents/x.html
./contents/y.html
./images
./images/1.jpg
./images/2.jpg
./images/3.jpg
./images/cover.jpg
./style.css
```
Make your files XHTML compatible.
```
$ cd contents
$ tidy -asxhtml x.html > a.html
$ tidy -asxhtml y.html > b.html
```
Create the utf-8 encoded YAML file describing the publication. As an example,
`will_oldham.yml`.
```yaml
# METADATA: Publication metadata (title, author, publisher, etc.).
#
# See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2
metadata:
title: "Will Oldham: Wikipedia, the free encyclopedia"
creator: Wikipedia
date: 2012
language: en
subject: American alternative country singers
publisher:
contributor:
description:
source: "http://en.wikipedia.org/wiki/Will_Oldham"
rights:
relation:
# GUIDE: A set of references to fundamental structural features of the
# publication, such as table of contents, foreword, bibliography, etc.
#
# See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6
#
# If you provide cover-image without cover-page, pubgen automatically
# generates cover-page xhtml, and add it to manifest and spine.
guide:
toc-page:
title-page:
cover-page:
cover-image: images/cover.jpg
# MANIFEST: A list of files (documents, images, style sheets, etc.) that make
# up the publication.
#
# See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.3
#
# All the file paths in manifest ought to be relative to yaml's path and in the
# same or sub-directory of yaml file. Say yaml's path is /book/a.yaml.
# - a/b/c.html # good. in the sub-directory
# - d.jpg # good. in the same directory
# - ./e.jpg # good. in the same directory
# - /a/b/c.html # bad. in the different directory
# - ../d.png # bad. in the parent directory
# - /book/e.html # bad. although in the same directory
# - ../book/f.png # bad. although in the same directory
manifest:
- contents/a.html
- contents/b.html
- images/cover.jpg
- images/1.jpg
- images/2.jpg
- images/3.jpg
- style.css
# SPINE: An arrangement of documents providing a linear reading order.
#
# See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4
spine:
- contents/a.html
- contents/b.html
# TOC: Table of contents
#
# See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1
toc:
# Add a colon suffix to indent
- 1 Music -- contents/a.html:
- 1.1 Discography -- contents/a.html#discography:
- 1.1.1 Studio albums -- contents/a.html#studio_albums
- 1.2 Response -- contents/a.html#response
- 2 Film -- contents/b.html:
- 2.1 Filmography -- contents/b.html#filmography
- 3 Photography -- contents/b.html#photography
- 4 References -- contents/b.html#references
- 5 External links -- contents/b.html#external_links
```
Run pubgen.
```bash
$ pubgen /will_oldham.yml -o out.epub
zip > out.epub
```
Done!
### Create meta files
If you understand [Open Packaging Format 2.0.1]
(http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm) spec, and want to edit some
properties of the epub before packaging, you can try pubgen with
`--meta-file-only` option.
```bash
$ cd
$ pubgen will_oldham.yml -m
cat > META-INF/container.xml
cat > mimetype
cat > cover-pubgen.xhtml
cat > content.opf
cat > toc.ncx
# Edit content.opf/toc.ncx, and archive epub with zip command
$ zip -r ../will_oldham.epub .
```
### Generate YAML using TOC file
Pubgen generates a YAML using TOC file. Pubgen-generated YAML is not complete,
but is probably quite useful.
```bash
$ pubgen -t /contents/toc.html > out.yml
$ vi out.yml # Open and complete YAML
$ cp out.yml
$ pubgen /out.yml -o out.epub
zip > out.epub
```