epub

package module

Go to main page

Versions in this module

v1

v1.1.0

Jun 12, 2022

v1.0.0

Jun 11, 2022

Changes in this version

+ var Debug = false

+ var ImageMediaTypes = map[string]string

+ func CompileTemplate(filename string) (*template.Template, error)

+ func OverrideTemplate(filename string, content []byte)

+ func RegisterShortcode(name string, handler ShortcodeHandler)

+ func RetrieveTemplate(filename string) ([]byte, error)

+ type Book struct

+ func NewBook(title string) *Book

+ func (e *Book) AddAsset(source, filename, mediaType string) error

+ func (e *Book) AddChapterHTML(title string, body []string) error

+ func (e *Book) AddChapterMD(title, body string) error

+ func (e *Book) AddImage(source, filename string) error

+ func (e *Book) AddImageFolder(source string) error

+ func (e *Book) AddIntroductionHTML(title string, body []string) error

+ func (e *Book) AddIntroductionMD(title string, body string) error

+ func (e *Book) AddMDExtension(ext goldmark.Extender)

+ func (e *Book) AddPostscriptHTML(title string, body []string) error

+ func (e *Book) AddPostscriptMD(title, body string) error

+ func (e *Book) Author() string

+ func (e *Book) Description() string

+ func (e *Book) Identifier() string

+ func (e *Book) LookupAsset(assetFilename string) (string, bool)

+ func (e *Book) LookupImage(imageFilename string) (string, bool)

+ func (e *Book) Publisher() string

+ func (e *Book) ReleaseDate() string

+ func (e *Book) SetAuthor(author string)

+ func (e *Book) SetCSS(source string) error

+ func (e *Book) SetCover(source string) error

+ func (e *Book) SetDescription(d string)

+ func (e *Book) SetIdentifier(id string)

+ func (e *Book) SetPublisher(pub string)

+ func (e *Book) SetReleaseDate(t string)

+ func (e *Book) SetTitle(t string)

+ func (e *Book) Title() string

+ func (e *Book) Write(filename string) error

+ type ShortcodeHandler func(*Book, string, map[string]any, string) (string, error)

v0

v0.4.0

Oct 1, 2018

Changes in this version

+ type FileRetrievalError struct

+ Err error

+ Source string

+ func (e *FileRetrievalError) Error() string

+ type FilenameAlreadyUsedError struct

+ Filename string

+ func (e *FilenameAlreadyUsedError) Error() string

+ type UnableToCreateEpubError struct

+ Err error

+ Path string

+ func (e *UnableToCreateEpubError) Error() string

v0.3.0

Aug 24, 2018

v0.2.2

Jan 10, 2018

v0.2.1

Dec 15, 2016

Changes in this version

type Epub

+ func (e *Epub) Ppd() string

+ func (e *Epub) SetPpd(direction string)

v0.2.0

Aug 25, 2016

Changes in this version

type Epub

+ func (e *Epub) Identifier() string

+ func (e *Epub) SetIdentifier(identifier string)

v0.1.0

Jun 29, 2016

Changes in this version

+ const CSSFolderName

+ const FontFolderName

+ const ImageFolderName

+ var ErrFilenameAlreadyUsed = errors.New("Filename already used")

+ var ErrRetrievingFile = errors.New("Error retrieving file from source")

+ var ErrUnableToCreateEpub = errors.New("Unable to create EPUB file")

+ type Epub struct

+ func NewEpub(title string) *Epub

+ func (e *Epub) AddCSS(source string, internalFilename string) (string, error)

+ func (e *Epub) AddFont(source string, internalFilename string) (string, error)

+ func (e *Epub) AddImage(source string, imageFilename string) (string, error)

+ func (e *Epub) AddSection(body string, sectionTitle string, internalFilename string, ...) (string, error)

+ func (e *Epub) Author() string

+ func (e *Epub) Lang() string

+ func (e *Epub) SetAuthor(author string)

+ func (e *Epub) SetCover(internalImagePath string, internalCSSPath string)

+ func (e *Epub) SetLang(lang string)

+ func (e *Epub) SetTitle(title string)

+ func (e *Epub) SetUUID(uuid string)

+ func (e *Epub) Title() string

+ func (e *Epub) UUID() string

+ func (e *Epub) Write(destFilePath string) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL