options

Documentation

Overview

Package options provides a configuration data structure to pass when invoking the Mycomarkup parser.

Index

• type InterwikiError
  • func (i InterwikiError) Error() string
• type Options
  • func (opts Options) FillTheRest() Options

Types

type InterwikiError

type InterwikiError int

const (
	Ok InterwikiError = iota
	UnknownPrefix
	NotSetUp
)

func (InterwikiError) Error

func (i InterwikiError) Error() string

type Options

type Options struct {
	// Canonical hypha name that is being parsed now.
	HyphaName string

	// Canonical URL (including the protocol) of your website. Used for OpenGraph. Example: https://mycorrhiza.wiki.
	WebSiteURL string

	TransclusionSupported bool
	RedLinksSupported     bool
	InterwikiSupported    bool

	HyphaExists           func(string) bool
	IterateHyphaNamesWith func(func(string))
	HyphaHTMLData         func(string) (rawText, binaryHtml string, err error)

	LocalTargetCanonicalName         func(string) string
	LocalLinkHref                    func(string) string
	LocalImgSrc                      func(string) string
	LinkHrefFormatForInterwikiPrefix func(string) (string, InterwikiError)
	ImgSrcFormatForInterwikiPrefix   func(string) (string, InterwikiError)
}

Options is what you pass when invoking the parser.

func (Options) FillTheRest

func (opts Options) FillTheRest() Options