Documentation
¶
Index ¶
- type OverlayContext
- type OverlayError
- type Reader
- func (r *Reader) Children(parent asciidoc.ParentElement) asciidoc.Elements
- func (r *Reader) Iterate(parent asciidoc.Parent, elements asciidoc.Elements) asciidoc.ElementIterator
- func (r *Reader) Parent(child asciidoc.ChildElement) asciidoc.Element
- func (r *Reader) StringValue(parent asciidoc.Parent, elements asciidoc.Elements) (string, error)
- type Variables
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type OverlayContext ¶
type OverlayContext interface {
AddDocument(doc *asciidoc.Document)
ResolvePath(root string, path string) (asciidoc.Path, error)
ShouldIncludeFile(path asciidoc.Path) bool
IncludeFile(path asciidoc.Path, parent asciidoc.Parent) (doc *asciidoc.Document, err error)
MakeSectionName(reader asciidoc.Reader, section *asciidoc.Section, variables Variables) (string, error)
SectionName(section *asciidoc.Section) string
SetSectionName(section *asciidoc.Section, name string)
SectionLevel(section *asciidoc.Section) int
SetSectionLevel(section *asciidoc.Section, level int)
SetParent(parent *asciidoc.Document, child *asciidoc.Document)
}
type OverlayError ¶
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
func Build ¶
func Build(cxt OverlayContext, rootDoc *asciidoc.Document, rootPath string, attributes []asciidoc.AttributeName) (reader *Reader, err error)
func (*Reader) Children ¶
func (r *Reader) Children(parent asciidoc.ParentElement) asciidoc.Elements
Click to show internal directories.
Click to hide internal directories.