wiki

Documentation

Index

• Variables
• type Field
• type Item
• type SyntaxError
  • func (p *SyntaxError) Error() string
  • func (p *SyntaxError) Unwrap() error
• type Wiki
  • func Parse(s string) (Wiki, error)
  • func ParseOmitError(s string) Wiki
  • func (w Wiki) NonZero() Wiki

Variables

var (
	ErrWikiSyntax         = errors.New("invalid wiki syntax")
	ErrGlobalPrefix       = errgo.Wrap(ErrWikiSyntax, "missing prefix '{{Infobox' at the start")
	ErrGlobalSuffix       = errgo.Wrap(ErrWikiSyntax, "missing '}}' at the end")
	ErrArrayNoClose       = errgo.Wrap(ErrWikiSyntax, "array should be closed by '}'")
	ErrArrayItemWrapped   = errgo.Wrap(ErrWikiSyntax, "array item should be wrapped by '[]'")
	ErrExpectingNewField  = errgo.Wrap(ErrWikiSyntax, "missing '|' to start a new field")
	ErrExpectingSignEqual = errgo.Wrap(ErrWikiSyntax, "missing '=' to separate field name and value")
)

Types

type Field

type Field struct {
	Key    string `json:"key"`
	Value  string `json:"value"`
	Values []Item `json:"values"`
	Array  bool   `json:"array"`
	Null   bool   `json:"null,omitempty"`
}

type Item

type Item struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type SyntaxError

type SyntaxError struct {
	// contains filtered or unexported fields
}

func (*SyntaxError) Error

func (p *SyntaxError) Error() string

func (*SyntaxError) Unwrap

func (p *SyntaxError) Unwrap() error

type Wiki

type Wiki struct {
	Type   string  `json:"type"`
	Fields []Field `json:"fields"`
}

func Parse

func Parse(s string) (Wiki, error)

func ParseOmitError

func ParseOmitError(s string) Wiki

ParseOmitError try to parse a string as wiki, omitting error.

func (Wiki) NonZero

func (w Wiki) NonZero() Wiki

NonZero return a wiki without empty fields and items.