epub

README

epub

A pure go implementation of epub file format.

Documents

• http://idpf.org/epub
• http://www.cnblogs.com/Alex80/p/5127104.html
• http://www.cnblogs.com/diligenceday/p/4999315.html

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)
• 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 author

type Book

type Book struct {
	Ncx       Ncx       `json:"ncx"`
	Opf       Opf       `json:"opf"`
	Container Container `json:"-"`
	Mimetype  string    `json:"-"`
	// contains filtered or unexported fields
}

Book epub book

func Open

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

Open open a epub file

func (*Book) Close

func (p *Book) Close()

Close close file reader

func (*Book) Files

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

Files list resource files

func (*Book) Open

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

Open open resource file

type Container

type Container struct {
	Rootfile Rootfile `xml:"rootfiles>rootfile" json:"rootfile"`
}

Container META-INF/container.xml file

type Content

type Content struct {
	Src string `xml:"src,attr" json:"src"`
}

Content nav-point content

type Date

type Date struct {
	Data  string `xml:",chardata" json:"data"`
	Event string `xml:"event,attr" json:"event"`
}

Date date

type Identifier

type Identifier struct {
	Data   string `xml:",chardata" json:"data"`
	ID     string `xml:"id,attr" json:"id"`
	Scheme string `xml:"scheme,attr" json:"scheme"`
}

Identifier identifier

type Manifest

type Manifest struct {
	ID           string `xml:"id,attr" json:"id"`
	Href         string `xml:"href,attr" json:"href"`
	MediaType    string `xml:"media-type,attr" json:"type"`
	Fallback     string `xml:"media-fallback,attr" json:"fallback"`
	Properties   string `xml:"properties,attr" json:"properties"`
	MediaOverlay string `xml:"media-overlay,attr" json:"overlay"`
}

Manifest 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 metadata

type Metafield

type Metafield struct {
	Name    string `xml:"name,attr" json:"name"`
	Content string `xml:"content,attr" json:"content"`
}

Metafield 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 nav point

type Ncx

type Ncx struct {
	Points []NavPoint `xml:"navMap>navPoint" json:"points"`
}

Ncx 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 content.opf

type Rootfile

type Rootfile struct {
	Path string `xml:"full-path,attr" json:"path"`
	Type string `xml:"media-type,attr" json:"type"`
}

Rootfile root file

type Spine

type Spine struct {
	ID              string      `xml:"id,attr" json:"id"`
	Toc             string      `xml:"toc,attr" json:"toc"`
	PageProgression string      `xml:"page-progression-direction,attr" json:"progression"`
	Items           []SpineItem `xml:"itemref" json:"items"`
}

Spine spine

type SpineItem

type SpineItem struct {
	IDref      string `xml:"idref,attr" json:"id_ref"`
	Linear     string `xml:"linear,attr" json:"linear"`
	ID         string `xml:"id,attr" json:"id"`
	Properties string `xml:"properties,attr" json:"properties"`
}

SpineItem spine item