Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/skoji/gepub

a generic EPUB library for Ruby : supports EPUB 3
https://github.com/skoji/gepub

Last synced: about 1 month ago
JSON representation

a generic EPUB library for Ruby : supports EPUB 3

Host: GitHub
URL: https://github.com/skoji/gepub
Owner: skoji
License: other
Created: 2010-05-05T01:21:18.000Z (about 14 years ago)
Default Branch: main
Last Pushed: 2024-04-27T10:21:10.000Z (about 1 month ago)
Last Synced: 2024-04-28T08:56:32.544Z (about 1 month ago)
Language: Ruby
Homepage:
Size: 27.7 MB
Stars: 208
Watchers: 14
Forks: 41
Open Issues: 13
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Lists

awesome-ruby - Gepub - A generic EPUB library for Ruby : supports EPUB 3. (Ebook)
awesome-ruby - Gepub - A generic EPUB library for Ruby : supports EPUB 3. (Ebook)
awesome-ruby - Gepub - A generic EPUB library for Ruby : supports EPUB 3. (Ebook)

README

        # gepub  

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/skoji/gepub?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![GitHub Actions Status](https://github.com/skoji/gepub/workflows/Test/badge.svg)](https://github.com/skoji/gepub/actions?query=workflow%3ATest)

[![Test Coverage](https://api.codeclimate.com/v1/badges/acd6df07e071a4bbb399/test_coverage)](https://codeclimate.com/github/skoji/gepub/test_coverage)

[![Gem Version](https://badge.fury.io/rb/gepub.svg)](http://badge.fury.io/rb/gepub)

* https://rubydoc.info/github/skoji/gepub

## DESCRIPTION:

a generic EPUB parser/generator library.

## FEATURES/PROBLEMS:

* GEPUB::Book provides functionality to create EPUB files and parse EPUB files

* Handle every metadata in EPUB2/EPUB3.

* See [issues](https://github.com/skoji/gepub/issues/) for known problems.

If you are using GEPUB::Builder and do not like its behavior (e.g., GEPUB::Builder evaluates the block as inside the Builder instance),  consider using GEPUB::Book directly.

## SYNOPSIS:

### Example

```ruby

require 'rubygems'

require 'gepub'

book = GEPUB::Book.new

book.primary_identifier('http://example.jp/bookid_in_url', 'BookID', 'URL')

book.language = 'ja'

book.add_title 'GEPUBサンプル文書', 

               title_type: GEPUB::TITLE_TYPE::MAIN,

               lang: 'ja',

               file_as: 'GEPUB Sample Book',

               display_seq: 1,

               alternates: {

                       'en' => 'GEPUB Sample Book (Japanese)',

                       'el' => 'GEPUB δείγμα (Ιαπωνικά)',

                       'th' => 'GEPUB ตัวอย่าง (ญี่ปุ่น)' }

               

# you can do the same thing using method chain

book.add_title('これはあくまでサンプルです', title_type: GEPUB::TITLE_TYPE::SUBTITLE).display_seq(1).add_alternates('en' => 'this book is just a sample.')

# use arguments

book.add_creator '小嶋智', 

                 display_seq:1, 

                 alternates: { 'en' => 'KOJIMA Satoshi' } 

book.add_contributor '電書部',

                     display_seq: 1,

                     alternates: {'en' => 'Denshobu'}

book.add_contributor 'アサガヤデンショ',

                     display_seq: 2, 

                     alternates: {'en' => 'Asagaya Densho'}

# you can also use method chain

book.add_contributor('湘南電書鼎談').display_seq(3).add_alternates('en' => 'Shonan Densho Teidan')

book.add_contributor('電子雑誌トルタル').display_seq(4).add_alternates('en' => 'eMagazine Torutaru')

imgfile = File.join(File.dirname(__FILE__),  'image1.jpg')

File.open(imgfile) do

  |io|

  book.add_item('img/image1.jpg',content: io).cover_image

end

# within ordered block, add_item will be added to spine.

book.ordered {

  book.add_item('text/cover.xhtml',

                content: StringIO.new(<<-COVER)).landmark(type: 'cover', title: 'cover page')

                

                

                  cover page

                

                

                
The Book

                

                

  COVER

  book.add_item('text/chap1.xhtml').add_content(StringIO.new(<<-CHAP_ONE)).toc_text('Chapter 1').landmark(type: 'bodymatter', title: '本文')

  

  c1

  the first page

  CHAP_ONE

  book.add_item('text/chap1-1.xhtml').add_content(StringIO.new(<<-SEC_ONE_ONE)) # do not appear on table of contents

  

  c2

  the second page

  SEC_ONE_ONE

  book.add_item('text/chap2.xhtml').add_content(StringIO.new(<<-CHAP_TWO)).toc_text('Chapter 2')

  

  c3

  the third page

  CHAP_TWO

  # to add nav file:

  # book.add_item('path/to/nav').add_content(nav_html_content).add_property('nav')

}

epubname = File.join(File.dirname(__FILE__), 'example_test.epub')

# if you do not specify a nav document with add_item, 

# generate_epub will generate simple navigation text.

# auto-generated nav file will not appear on the spine.

book.generate_epub(epubname)

```

 * [examples in this repository](https://github.com/skoji/gepub/tree/main/examples/) 

## INSTALL:

* gem install gepub

## DONATE:

* Bitcoin Address: `1M69AwoxpgPZsp5KStLUEjP7so5dHVfDTH`