epub

Documentation

Index

• type Author
• type Book
  • func Open(fn string) (*Book, error)
  • func (p *Book) Close()
  • func (p *Book) Files() []string
  • func (p *Book) Open(n string) (io.ReadCloser, error)
  • func (p *Book) ReadAll() (string, error)
  • func (p *Book) ReadChapter(n string) (string, error)
• type Container
• type Content
• type Date
• type Identifier
• type Manifest
• type Metadata
• type Metafield
• type NavPoint
• type Ncx
• type Opf
• type Rootfile
• type Spine
• type SpineItem

Types

type Author

type Author struct {
	Data   string `xml:",chardata" json:"author"`     // 作者的名称。
	FileAs string `xml:"file-as,attr" json:"file_as"` // 作者的文件名。
	Role   string `xml:"role,attr" json:"role"`       // 作者的角色。
}

Author 表示电子书的作者。

type Book

type Book struct {
	Ncx       Ncx       `json:"ncx"` // 电子书的目录文件。
	Opf       Opf       `json:"opf"` // 电子书的 OPF 文件。
	Container Container `json:"-"`   // 电子书的容器文件。
	Mimetype  string    `json:"-"`   // 电子书的 MIME 类型。
	// contains filtered or unexported fields
}

Book 表示一个 EPUB 电子书。

func Open

func Open(fn string) (*Book, error)

Open 打开指定路径的 EPUB 电子书文件，并返回一个 Book 结构体指针。

func (*Book) Close

func (p *Book) Close()

Close 关闭电子书的 ZIP 文件读取器。

func (*Book) Files

func (p *Book) Files() []string

Files 返回电子书中所有文件的文件名列表。

func (*Book) Open

func (p *Book) Open(n string) (io.ReadCloser, error)

Open 打开电子书中的指定文件，并返回一个 io.ReadCloser 接口。

func (*Book) ReadAll

func (p *Book) ReadAll() (string, error)

返回所有章节的内容

func (*Book) ReadChapter

func (p *Book) ReadChapter(n string) (string, error)

返回一个章节的内容

type Container

type Container struct {
	Rootfile Rootfile `xml:"rootfiles>rootfile" json:"rootfile"` // 电子书的根文件。
}

Container 表示 EPUB 电子书的 META-INF/container.xml 文件。

type Content

type Content struct {
	Src string `xml:"src,attr" json:"src"` // 内容的路径。
}

Content 表示导航点的内容。

type Date

type Date struct {
	Data  string `xml:",chardata" json:"data"`   // 日期的值。
	Event string `xml:"event,attr" json:"event"` // 日期的事件。
}

Date 表示电子书的日期。

type Identifier

type Identifier struct {
	Data   string `xml:",chardata" json:"data"`     // 标识符的值。
	ID     string `xml:"id,attr" json:"id"`         // 标识符的 ID。
	Scheme string `xml:"scheme,attr" json:"scheme"` // 标识符的方案。
}

Identifier 表示电子书的标识符。

type Manifest

type Manifest struct {
	ID           string `xml:"id,attr" json:"id"`                   // 文件的 ID。
	Href         string `xml:"href,attr" json:"href"`               // 文件的路径。
	MediaType    string `xml:"media-type,attr" json:"type"`         // 文件的 MIME 类型。
	Fallback     string `xml:"media-fallback,attr" json:"fallback"` // 文件的备用路径。
	Properties   string `xml:"properties,attr" json:"properties"`   // 文件的属性。
	MediaOverlay string `xml:"media-overlay,attr" json:"overlay"`   // 文件的媒体叠加。
}

Manifest 表示电子书的文件清单。

type Metadata

type Metadata struct {
	Title       []string     `xml:"title" json:"title"`             // 电子书的标题。
	Language    []string     `xml:"language" json:"language"`       // 电子书的语言。
	Identifier  []Identifier `xml:"identifier" json:"identifier"`   // 电子书的标识符。
	Creator     []Author     `xml:"creator" json:"creator"`         // 电子书的作者。
	Subject     []string     `xml:"subject" json:"subject"`         // 电子书的主题。
	Description []string     `xml:"description" json:"description"` // 电子书的描述。
	Publisher   []string     `xml:"publisher" json:"publisher"`     // 电子书的出版社。
	Contributor []Author     `xml:"contributor" json:"contributor"` // 电子书的贡献者。
	Date        []Date       `xml:"date" json:"date"`               // 电子书的日期。
	Type        []string     `xml:"type" json:"type"`               // 电子书的类型。
	Format      []string     `xml:"format" json:"format"`           // 电子书的格式。
	Source      []string     `xml:"source" json:"source"`           // 电子书的来源。
	Relation    []string     `xml:"relation" json:"relation"`       // 电子书的关系。
	Coverage    []string     `xml:"coverage" json:"coverage"`       // 电子书的覆盖范围。
	Rights      []string     `xml:"rights" json:"rights"`           // 电子书的版权信息。
	Meta        []Metafield  `xml:"meta" json:"meta"`               // 电子书的元数据字段。
}

Metadata 表示 EPUB 电子书的元数据。

type Metafield

type Metafield struct {
	Name    string `xml:"name,attr" json:"name"`       // 字段的名称。
	Content string `xml:"content,attr" json:"content"` // 字段的内容。
}

Metafield 表示电子书的元数据字段。

type NavPoint

type NavPoint struct {
	Text    string     `xml:"navLabel>text" json:"text"` // 导航点的文本内容。
	Content Content    `xml:"content" json:"content"`    // 导航点的内容。
	Points  []NavPoint `xml:"navPoint" json:"points"`    // 导航点的子导航点。
}

NavPoint 表示电子书目录中的一个导航点。

type Ncx

type Ncx struct {
	Points []NavPoint `xml:"navMap>navPoint" json:"points"` // 电子书的目录结构。
}

Ncx 表示 EPUB 电子书的 OPS/toc.ncx 文件。

type Opf

type Opf struct {
	Metadata Metadata   `xml:"metadata" json:"metadata"`      // 电子书的元数据。
	Manifest []Manifest `xml:"manifest>item" json:"manifest"` // 电子书的文件清单。
	Spine    Spine      `xml:"spine" json:"spine"`            // 电子书的阅读顺序。
}

Opf 表示 EPUB 电子书的 content.opf 文件。

type Rootfile

type Rootfile struct {
	Path string `xml:"full-path,attr" json:"path"`  // 根文件的路径。
	Type string `xml:"media-type,attr" json:"type"` // 根文件的 MIME 类型。
}

Rootfile 表示 EPUB 电子书的根文件。

type Spine

type Spine struct {
	ID              string      `xml:"id,attr" json:"id"`                                  // 阅读顺序的 ID。
	Toc             string      `xml:"toc,attr" json:"toc"`                                // 目录文件的路径。
	PageProgression string      `xml:"page-progression-direction,attr" json:"progression"` // 页面进度方向。
	Items           []SpineItem `xml:"itemref" json:"items"`                               // 阅读顺序的项目。
}

Spine 表示电子书的阅读顺序。

type SpineItem

type SpineItem struct {
	IDref      string `xml:"idref,attr" json:"id_ref"`          // 项目的 ID。
	Linear     string `xml:"linear,attr" json:"linear"`         // 项目的线性属性。
	ID         string `xml:"id,attr" json:"id"`                 // 项目的 ID。
	Properties string `xml:"properties,attr" json:"properties"` // 项目的属性。
}

SpineItem 表示电子书阅读顺序中的一个项目。