core

Documentation

Index

• Constants
• func PathsFromSections(secs []Section) []string
• type Section
  • func FindSectionMatches(input string, secs []Section, minus int) ([]Section, error)
  • func SectionFromPath(path string) (Section, error)
  • func (s *Section) ChangeIndex(i int) error
  • func (s Section) IsEqual(other Section) bool

Constants

const SectionSep string = "_"

The string separating the index and the name. If changed, make a due notice to users and either ensure backwards compatibility or have Doctor change the format automatically.

Functions

func PathsFromSections

func PathsFromSections(secs []Section) []string

Takes a list of Section structs and returns a list of the corresponding paths.

Types

type Section

type Section struct {
	Path  string
	Title string
	Index int
}

Represents a section in the document.

func FindSectionMatches

func FindSectionMatches(input string, secs []Section, minus int) ([]Section, error)

Finds all sections that match the input. Returns an error if no sections match. 'minus' is subtracted from the index matching statement, used in the case of looping over multiple inputs to match against.

func SectionFromPath

func SectionFromPath(path string) (Section, error)

Creates a new Section struct from the input path.

func (*Section) ChangeIndex

func (s *Section) ChangeIndex(i int) error

Changes the index of this section by renaming the file it represents.

func (Section) IsEqual

func (s Section) IsEqual(other Section) bool

Check whether this section is equal to another. Checks if their paths are equal.