gepub

Gitter Build Status Coverage Status Gem Version

DESCRIPTION:

a generic EPUB parser/generator library.

FEATURES/PROBLEMS:

  • GEPUB::Book provides functionality to create EPUB file, and parsing EPUB files

  • Handle every metadata in EPUB2/EPUB3.

  • See issues for known problems.

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

SYNOPSIS:

Example

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("                <html xmlns=\"http://www.w3.org/1999/xhtml\">\n                <head>\n                  <title>cover page</title>\n                </head>\n                <body>\n                <h1>The Book</h1>\n                <img src=\"../img/image1.jpg\" />\n                </body></html>\n  COVER\n  book.add_item('text/chap1.xhtml').add_content(StringIO.new(<<-CHAP_ONE)).toc_text('Chapter 1').landmark(type: 'bodymatter', title: '\u672C\u6587')\n  <html xmlns=\"http://www.w3.org/1999/xhtml\">\n  <head><title>c1</title></head>\n  <body><p>the first page</p></body></html>\n  CHAP_ONE\n  book.add_item('text/chap1-1.xhtml').add_content(StringIO.new(<<-SEC_ONE_ONE)) # do not appear on table of contents\n  <html xmlns=\"http://www.w3.org/1999/xhtml\">\n  <head><title>c2</title></head>\n  <body><p>the second page</p></body></html>\n  SEC_ONE_ONE\n  book.add_item('text/chap2.xhtml').add_content(StringIO.new(<<-CHAP_TWO)).toc_text('Chapter 2')\n  <html xmlns=\"http://www.w3.org/1999/xhtml\">\n  <head><title>c3</title></head>\n  <body><p>the third page</p></body></html>\n  CHAP_TWO\n  # to add nav file:\n  # book.add_item('path/to/nav').add_content(nav_html_content).add_property('nav')\n}\nepubname = File.join(File.dirname(__FILE__), 'example_test.epub')\n\n# if you do not specify your own nav document with add_item, \n# simple navigation text will be generated in generate_epub.\n# auto-generated nav file will not appear on spine.\nbook.generate_epub(epubname)\n")).landmark(type: 'cover', title: 'cover page')

INSTALL:

  • gem install gepub