Sha256: aedb2b527f9d1e433ed76c031822eb4021872cfd89bf3fbfe4276a8ea82ab3a1

Contents?: true

Size: 1.67 KB

Versions: 10

Compression:

Stored size: 1.67 KB

Contents

EeePub
======

EeePub is a Ruby ePub generator.

Usage
-------

    epub = EeePub.make do
      title       'sample'
      creator     'jugyo'
      publisher   'jugyo.org'
      date        '2010-05-06'
      identifier  'http://example.com/book/foo', :scheme => 'URL'
      uid         'http://example.com/book/foo'

      files ['/path/to/foo.html', '/path/to/bar.html'] # or files [{'/path/to/foo.html' => 'dest/dir'}, {'/path/to/bar.html' => 'dest/dir'}]
      nav [
        {:label => '1. foo', :content => 'foo.html', :nav => [
          {:label => '1.1 foo-1', :content => 'foo.html#foo-1'}
        ]},
        {:label => '1. bar', :content => 'bar.html'}
      ]
    end
    epub.save('sample.epub')

### Low Level API

Create NCX:

    EeePub::NCX.new(
      :uid => 'xxxx',
      :title => 'sample',
      :nav => [
        {:label => '1. foo', :content => 'foo.html'},
        {:label => '2. bar', :content => 'bar.html'}
      ]
    ).save(File.join('sample', 'toc.ncx'))

Create OPF:

    EeePub::OPF.new(
      :title => 'sample',
      :identifier => {:value => '0-0000000-0-0', :scheme => 'ISBN'},
      :manifest => ['foo.html', 'bar.html'],
      :ncx => 'toc.ncx'
    ).save(File.join('sample', 'content.opf'))

Create OCF and ePub file:

    EeePub::OCF.new(
      :dir => 'sample',
      :container => 'content.opf'
    ).save('sample.epub')

Install
-------

    gem install eeepub

Requirements
-------

* builder
* eBook Reader :)

Links
-------

* Documentation: [http://yardoc.org/docs/jugyo-eeepub](http://yardoc.org/docs/jugyo-eeepub)
* Source code: [http://github.com/jugyo/eeepub](http://github.com/jugyo/eeepub)

Copyright
-------

Copyright (c) 2010 jugyo. See LICENSE for details.

Version data entries

10 entries across 10 versions & 4 rubygems

Version Path
eeepub-with-cover-support-0.8.8 README.md
eeepub-0.8.1 README.md
eeepub-with-cover-support-0.8.7 README.md
eeepub-with-cover-support-0.8.6 README.md
eeepub-0.8.0 README.md
eeepub-0.7.1 README.md
eeepub-0.7.0 README.md
walterdavis-eeepub-0.6.3 README.md
walterdavis-eeepub-0.6.2 README.md
sudothinker-eeepub-0.6.1 README.md