booklit

package module

Go to main page

Versions in this module

v0

v0.12.1

Dec 29, 2021

v0.12.0

Feb 7, 2021

Changes in this version

+ func ErrorResponse(w http.ResponseWriter, err error)

type Reference

+ Optional bool

type Section

+ TitleLocation ast.Location

+ func (con *Section) SimilarTags(tagName string) []Tag

+ type TitleTwiceError struct

+ TitleLocation ErrorLocation

+ func (err TitleTwiceError) Error() string

+ func (err TitleTwiceError) PrettyHTML(out io.Writer) error

+ func (err TitleTwiceError) PrettyPrint(out io.Writer)

type UnknownTagError

+ SimilarTags []Tag

v0.11.0

May 8, 2020

Changes in this version

+ func ErrorPage(err error, w http.ResponseWriter)

+ type AmbiguousReferenceError struct

+ DefinedLocations []ErrorLocation

+ TagName string

+ func (err AmbiguousReferenceError) Error() string

+ func (err AmbiguousReferenceError) PrettyHTML(out io.Writer) error

+ func (err AmbiguousReferenceError) PrettyPrint(out io.Writer)

+ type AnnotationData struct

+ Annotated string

+ EOF bool

+ FilePath string

+ Lineno string

+ Prefix string

+ Suffix string

+ type ErrorLocation struct

+ FilePath string

+ Length int

+ NodeLocation ast.Location

+ func (loc ErrorLocation) Annotate(msg string, args ...interface{}) string

+ func (loc ErrorLocation) AnnotateLocation(out io.Writer) error

+ func (loc ErrorLocation) AnnotatedHTML(out io.Writer) error

+ type FailedFunctionError struct

+ Err error

+ Function string

+ func (err FailedFunctionError) Error() string

+ func (err FailedFunctionError) PrettyHTML(out io.Writer) error

+ func (err FailedFunctionError) PrettyPrint(out io.Writer)

+ type ParseError struct

+ Err error

+ func (err ParseError) Error() string

+ func (err ParseError) PrettyHTML(out io.Writer) error

+ func (err ParseError) PrettyPrint(out io.Writer)

+ type PrettyError interface

+ PrettyHTML func(io.Writer) error

+ PrettyPrint func(io.Writer)

type Reference

+ Location ast.Location

type Section

+ InvokeLocation ast.Location

+ Location ast.Location

+ func (con *Section) FilePath() string

type Tag

+ Location ast.Location

type Target

+ Location ast.Location

+ type UndefinedFunctionError struct

+ Function string

+ func (err UndefinedFunctionError) Error() string

+ func (err UndefinedFunctionError) PrettyHTML(out io.Writer) error

+ func (err UndefinedFunctionError) PrettyPrint(out io.Writer)

+ type UnknownTagError struct

+ TagName string

+ func (err UnknownTagError) Error() string

+ func (err UnknownTagError) PrettyHTML(out io.Writer) error

+ func (err UnknownTagError) PrettyPrint(out io.Writer)

v0.10.0

Apr 16, 2019

v0.9.0

Apr 16, 2019

v0.8.0

Mar 12, 2019

Changes in this version

type Section

+ Processor SectionProcessor

+ type SectionProcessor interface

+ EvaluateFile func(*Section, string, []PluginFactory) (*Section, error)

+ EvaluateNode func(*Section, ast.Node, []PluginFactory) (*Section, error)

v0.7.0

Mar 4, 2019

Changes in this version

type Section

+ func (con *Section) Next() *Section

+ func (con *Section) NextSibling() *Section

+ func (con *Section) Prev() *Section

v0.6.0

Nov 9, 2018

Changes in this version

+ var ErrBrokenReference = errors.New("broken reference")

+ type Aux struct

type Content

+ func StripAux(content Content) Content

+ IsFlow func() bool

+ type Definition struct

+ Definition Content

+ Subject Content

+ type Definitions []Definition

+ func (con Definitions) IsFlow() bool

+ func (con Definitions) String() string

+ func (con Definitions) Visit(visitor Visitor) error

+ type Image struct

+ Description string

+ Path string

+ func (con Image) IsFlow() bool

+ func (con Image) String() string

+ func (con Image) Visit(visitor Visitor) error

type List

+ func (con List) IsFlow() bool

type Paragraph

+ func (con Paragraph) IsFlow() bool

+ type Partials map[string]Content

type Preformatted

+ func (con Preformatted) IsFlow() bool

type Reference

+ func (con *Reference) IsFlow() bool

type Section

+ OmitChildrenFromTableOfContents bool

+ Partials Partials

+ PreventSplitSections bool

+ ResetDepth bool

+ Style string

+ func (con *Section) Depth() int

+ func (con *Section) IsFlow() bool

+ func (con *Section) IsOrHasChild(sub *Section) bool

+ func (con *Section) PageDepth() int

+ func (con *Section) Partial(name string) Content

+ func (con *Section) SetPartial(name string, value Content)

+ func (con *Section) SetTag(name string, title Content, optionalAnchor ...string)

+ func (con *Section) SetTagAnchored(name string, title Content, content Content, anchor string)

+ func (con *Section) SplitSectionsPrevented() bool

type Sequence

+ func (con Sequence) IsFlow() bool

type String

+ func (str String) IsFlow() bool

type Style

+ const StyleAside

+ const StyleInset

+ const StyleLarger

+ const StyleSmaller

+ const StyleStrike

+ const StyleSubscript

+ const StyleSuperscript

type Styled

+ Block bool

+ Content Content

+ Partials Partials

+ func (con Styled) IsFlow() bool

+ func (con Styled) Partial(name string) Content

+ func (con Styled) String() string

+ type Table struct

+ Rows [][]Content

+ func (con Table) IsFlow() bool

+ func (con Table) String() string

+ func (con Table) Visit(visitor Visitor) error

type TableOfContents

+ func (con TableOfContents) IsFlow() bool

type Tag

+ Content Content

+ Title Content

type Target

+ Content Content

+ Title Content

+ func (con Target) IsFlow() bool

type Visitor

+ VisitDefinitions func(Definitions) error

+ VisitImage func(Image) error

+ VisitTable func(Table) error

v0.0.1

Jul 12, 2017

Changes in this version

+ var Version = "0.0.0-dev"

+ func RegisterPlugin(name string, factory PluginFactory)

+ type Block struct

+ Class string

+ Content Content

+ func (con Block) IsSentence() bool

+ func (con Block) String() string

+ func (con Block) Visit(visitor Visitor) error

+ type Content interface

+ IsSentence func() bool

+ String func() string

+ Visit func(Visitor) error

+ func Append(first Content, rest ...Content) Content

+ type Link struct

+ Target string

+ func (con Link) Visit(visitor Visitor) error

+ type List struct

+ Items []Content

+ Ordered bool

+ func (con List) IsSentence() bool

+ func (con List) String() string

+ func (con List) Visit(visitor Visitor) error

+ type Paragraph []Content

+ func (con Paragraph) IsSentence() bool

+ func (con Paragraph) String() string

+ func (con Paragraph) Visit(visitor Visitor) error

+ type Plugin interface

+ type PluginFactory interface

+ NewPlugin func(*Section) Plugin

+ func LookupPlugin(name string) (PluginFactory, bool)

+ type PluginFactoryFunc func(*Section) Plugin

+ func (f PluginFactoryFunc) NewPlugin(s *Section) Plugin

+ type Preformatted []Content

+ func (con Preformatted) IsSentence() bool

+ func (con Preformatted) String() string

+ func (con Preformatted) Visit(visitor Visitor) error

+ type Reference struct

+ Content Content

+ Tag *Tag

+ TagName string

+ func (con *Reference) Display() Content

+ func (con *Reference) IsSentence() bool

+ func (con *Reference) String() string

+ func (con *Reference) Visit(visitor Visitor) error

+ type Section struct

+ Body Content

+ Children []*Section

+ Parent *Section

+ Path string

+ PluginFactories []PluginFactory

+ Plugins []Plugin

+ PrimaryTag Tag

+ SplitSections bool

+ Tags []Tag

+ Title Content

+ func (con *Section) AnchorTags() []Tag

+ func (con *Section) Contains(sub *Section) bool

+ func (con *Section) FindTag(tagName string) (Tag, bool)

+ func (con *Section) HasAnchors() bool

+ func (con *Section) IsSentence() bool

+ func (con *Section) Number() string

+ func (con *Section) SetTitle(title Content, tags ...string)

+ func (con *Section) String() string

+ func (con *Section) Top() *Section

+ func (con *Section) UsePlugin(pf PluginFactory)

+ func (con *Section) Visit(visitor Visitor) error

+ type Sequence []Content

+ func (con Sequence) Contents() []Content

+ func (con Sequence) IsSentence() bool

+ func (con Sequence) String() string

+ func (con Sequence) Visit(visitor Visitor) error

+ type String string

+ var Empty String

+ func (str String) IsSentence() bool

+ func (str String) String() string

+ func (str String) Visit(visitor Visitor) error

+ type Style string

+ const StyleBold

+ const StyleItalic

+ const StyleVerbatim

+ type Styled struct

+ Style Style

+ func (con Styled) Visit(visitor Visitor) error

+ type TableOfContents struct

+ Section *Section

+ func (con TableOfContents) IsSentence() bool

+ func (con TableOfContents) String() string

+ func (con TableOfContents) Visit(visitor Visitor) error

+ type Tag struct

+ Anchor string

+ Display Content

+ Name string

+ Section *Section

+ type Target struct

+ Display Content

+ TagName string

+ func (con Target) IsSentence() bool

+ func (con Target) String() string

+ func (con Target) Visit(visitor Visitor) error

+ type Visitor interface

+ VisitBlock func(Block) error

+ VisitLink func(Link) error

+ VisitList func(List) error

+ VisitParagraph func(Paragraph) error

+ VisitPreformatted func(Preformatted) error

+ VisitReference func(*Reference) error

+ VisitSection func(*Section) error

+ VisitSequence func(Sequence) error

+ VisitString func(String) error

+ VisitStyled func(Styled) error

+ VisitTableOfContents func(TableOfContents) error

+ VisitTarget func(Target) error

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