ebook

README

https://pkg.go.dev/github.com/HalCanary/facility/ebook

Documentation

Overview

Copyright 2022 Hal Canary Use of this program is governed by the file LICENSE.

Index

• Variables
• func ConvertToEbook(src, dst string, arguments ...string) error
• func PopulateInfo(info *EbookInfo, doc *dom.Node)
• func RegisterEbookGenerator(downloadFunction EbookGeneratorFunction)
• type Chapter
• type EbookGeneratorFunction
• type EbookInfo
  • func DownloadEbook(url string, doPopulate bool) (EbookInfo, error)
  • func (info EbookInfo) CalculateLastModified() time.Time
  • func (info *EbookInfo) Cleanup()
  • func (info EbookInfo) Print(dst io.Writer)
  • func (info EbookInfo) Write(dst io.Writer) error
  • func (info EbookInfo) WriteHtml(dst io.Writer) error
• type Node
  • func Cleanup(node *Node) *Node
  • func ResolveLinks(node *Node, ref *url.URL) *Node

Variables

var UnsupportedUrlError = errors.New("unsupported url")

Returned by a EbookGeneratorFunction when the URL can not be handled.

Functions

func ConvertToEbook

func ConvertToEbook(src, dst string, arguments ...string) error

Convert a html file to an epub, using `ebook-convert`.

func PopulateInfo

func PopulateInfo(info *EbookInfo, doc *dom.Node)

Populate `info` based on common patterns.

func RegisterEbookGenerator

func RegisterEbookGenerator(downloadFunction EbookGeneratorFunction)

Register the given function.

Types

type Chapter

type Chapter struct {
	Title    string
	Url      string
	Content  *Node
	Modified time.Time
}

One Chapter of an Ebook.

type EbookGeneratorFunction

type EbookGeneratorFunction func(url string, doPopulate bool) (EbookInfo, error)

A function that generates an ebook from a url. @param url - the URL of the title page of the book. @param doPopulate - if true, download and populate the entire EbookInfo data structure, not just its metadata.

type EbookInfo

type EbookInfo struct {
	Authors  string
	Comments string
	Title    string
	Source   string
	Language string
	Chapters []Chapter
	Modified time.Time
	Cover    []byte
}

Ebook content and metadata.

func DownloadEbook

func DownloadEbook(url string, doPopulate bool) (EbookInfo, error)

Return the result of the first registered download function that does not return UnsupportedUrlError. @param url - the URL of the title page of the book. @param doPopulate - if true, download and populate the entire EbookInfo data structure, not just its metadata.

func (EbookInfo) CalculateLastModified

func (info EbookInfo) CalculateLastModified() time.Time

Return the time of most recently modified chapter.

func (*EbookInfo) Cleanup

func (info *EbookInfo) Cleanup()

func (EbookInfo) Print

func (info EbookInfo) Print(dst io.Writer)

Print information about the book.

func (EbookInfo) Write

func (info EbookInfo) Write(dst io.Writer) error

Write the ebook as an Epub.

func (EbookInfo) WriteHtml

func (info EbookInfo) WriteHtml(dst io.Writer) error

Write the ebook as a single HTML file.

type Node

type Node = dom.Node

func Cleanup

func Cleanup(node *Node) *Node

Clean up a HTML fragment.

func ResolveLinks

func ResolveLinks(node *Node, ref *url.URL) *Node

Resolve all links in the tree, relative to `ref`.