EeePub 使用与技术文档

一、安装指南

首先，确保您的开发环境中已经安装了Ruby。然后，通过以下命令安装EeePub：

gem install eeepub

确保已经安装了所有必要的依赖，如builder和eBook Reader。

二、项目使用说明

EeePub是一个使用Ruby编写的工具，用于生成ePub格式的电子书。以下是一个简单的使用例子：

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']
  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')

这段代码创建了一个新的ePub文档，设定了标题、创建者、出版者等信息，并添加了文件和目录结构。最后，将生成的ePub文件保存为sample.epub。

三、项目API使用文档

以下是EeePub中一些核心类和方法的简要描述：

EeePub

EeePub.make 是创建ePub文件的主要方法。在这个块中，您可以设置以下属性：

• title：电子书的标题。
• creator：电子书的创建者。
• publisher：电子书的出版者。
• date：电子书的出版日期。
• identifier：电子书的唯一标识符。
• uid：电子书的UUID。

files 方法用于添加要包含在电子书中的文件，可以是单个文件路径或带有目标路径的哈希。

nav 方法用于定义电子书的目录结构。

完成设置后，调用 save 方法保存生成的ePub文件。

EeePub::NCX

EeePub::NCX 类用于生成NCX（Navigation Control file for XML）文件，它定义了电子书的目录结构。

EeePub::OPF

EeePub::OPF 类用于生成OPF（Open Packaging Format）文件，它描述了ePub包的结构和内容。

EeePub::OCF

EeePub::OCF 类用于生成OCF（Open Container Format）文件，它包含了ePub文件的实际内容。

四、项目安装方式

请参考上述的安装指南部分，使用Ruby的包管理工具gem来安装EeePub。

以上就是EeePub的使用和技术文档。希望本文档能够帮助您更好地了解和使用EeePub生成ePub文件。