org

Documentation

Index

• Variables
• type CDocument
  • func NewOrgModeDocument(language, url, title string) (doc *CDocument)
  • func (d *CDocument) AddFootnote(text string)
  • func (d *CDocument) AddHeading(text string)
  • func (d *CDocument) AddLink(text string)
  • func (d *CDocument) Self() interface{}
• type CFeature
  • func (f *CFeature) AddSearchDocumentMapping(tag language.Tag, indexMapping *mapping.IndexMappingImpl)
  • func (f *CFeature) Extensions() (extensions []string)
  • func (f *CFeature) IndexDocument(p interface{}) (out interface{}, err error)
  • func (f *CFeature) Init(this interface{})
  • func (f *CFeature) Label() (label string)
  • func (f *CFeature) Make() Feature
  • func (f *CFeature) Name() (name string)
  • func (f *CFeature) NewDocumentMapping(tag language.Tag) (doctype, analyzer string, dm *mapping.DocumentMapping)
  • func (f *CFeature) Prepare(ctx context.Context, content string) (out context.Context, err error)
  • func (f *CFeature) Process(ctx context.Context, t types.Theme, content string) (html template.HTML, redirect string, err *types.EnjinError)
  • func (f *CFeature) RenderOrgMode(content string) (rendered string, err error)
  • func (f *CFeature) SearchDocumentMapping(tag language.Tag) (doctype string, dm *mapping.DocumentMapping)
  • func (f *CFeature) SetDefault(key, value string) MakeFeature
  • func (f *CFeature) SetDefaults(settings map[string]string) MakeFeature
  • func (f *CFeature) Setup(enjin feature.Internals)
• type Document
• type Feature
• type MakeFeature
  • func New() MakeFeature

Variables

var Tag feature.Tag = "pages-formats-org"

Types

type CDocument

type CDocument struct {
	search.CDocument

	Links     []string `json:"links"`
	Headings  []string `json:"headings"`
	Footnotes []string `json:"footnotes"`
}

func NewOrgModeDocument

func NewOrgModeDocument(language, url, title string) (doc *CDocument)

func (*CDocument) AddFootnote

func (d *CDocument) AddFootnote(text string)

func (*CDocument) AddHeading

func (d *CDocument) AddHeading(text string)

func (*CDocument) AddLink

func (d *CDocument) AddLink(text string)

func (*CDocument) Self

func (d *CDocument) Self() interface{}

type CFeature

type CFeature struct {
	feature.CFeature
	// contains filtered or unexported fields
}

func (*CFeature) AddSearchDocumentMapping

func (f *CFeature) AddSearchDocumentMapping(tag language.Tag, indexMapping *mapping.IndexMappingImpl)

func (*CFeature) Extensions

func (f *CFeature) Extensions() (extensions []string)

func (*CFeature) IndexDocument

func (f *CFeature) IndexDocument(p interface{}) (out interface{}, err error)

func (*CFeature) Init

func (f *CFeature) Init(this interface{})

func (*CFeature) Label

func (f *CFeature) Label() (label string)

func (*CFeature) Make

func (f *CFeature) Make() Feature

func (*CFeature) Name

func (f *CFeature) Name() (name string)

func (*CFeature) NewDocumentMapping

func (f *CFeature) NewDocumentMapping(tag language.Tag) (doctype, analyzer string, dm *mapping.DocumentMapping)

func (*CFeature) Prepare

func (f *CFeature) Prepare(ctx context.Context, content string) (out context.Context, err error)

func (*CFeature) Process

func (f *CFeature) Process(ctx context.Context, t types.Theme, content string) (html template.HTML, redirect string, err *types.EnjinError)

func (*CFeature) RenderOrgMode

func (f *CFeature) RenderOrgMode(content string) (rendered string, err error)

func (*CFeature) SearchDocumentMapping

func (f *CFeature) SearchDocumentMapping(tag language.Tag) (doctype string, dm *mapping.DocumentMapping)

func (*CFeature) SetDefault

func (f *CFeature) SetDefault(key, value string) MakeFeature

func (*CFeature) SetDefaults

func (f *CFeature) SetDefaults(settings map[string]string) MakeFeature

func (*CFeature) Setup

func (f *CFeature) Setup(enjin feature.Internals)

type Document

type Document interface {
	search.Document
	AddLink(text string)
	AddHeading(text string)
	AddFootnote(text string)
}

type Feature

type Feature interface {
	feature.Feature
	types.Format
}

type MakeFeature

type MakeFeature interface {
	// SetDefault updates org.Configuration.DefaultSettings
	SetDefault(key, value string) MakeFeature

	// SetDefaults replaces org.Configuration.DefaultSettings
	SetDefaults(defaults map[string]string) MakeFeature

	Make() Feature
}

func New

func New() MakeFeature