njn

package
v0.5.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 18, 2024 License: Apache-2.0 Imports: 59 Imported by: 0

Documentation

Index

Constants

View Source 
const Tag feature.Tag = "pages-formats-njn"

Variables

View Source 
var (
	DefaultStringTags = []string{
		"b", "del", "em", "i", "ins", "kbd", "mark",
		"q", "s", "small", "strong", "sub", "sup", "u",
		"var", "code",
	}
)

Functions

This section is empty.

Types

type CDocument 

type CDocument struct {
	search.CDocument

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

func NewEnjinDocument 

func NewEnjinDocument(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 (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) AddBlock 

func (f *CFeature) AddBlock(block feature.EnjinBlock) MakeFeature

func (*CFeature) AddField 

func (f *CFeature) AddField(field feature.EnjinField) MakeFeature

func (*CFeature) AddSearchDocumentMapping 

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

func (*CFeature) AddStringTags 

func (f *CFeature) AddStringTags(names ...string) MakeFeature

func (*CFeature) ContainerBlocks 

func (f *CFeature) ContainerBlocks() (blocks map[string]feature.EnjinBlock)

func (*CFeature) ContainerFields 

func (f *CFeature) ContainerFields() (fields map[string]feature.EnjinField)

func (*CFeature) Defaults 

func (f *CFeature) Defaults() MakeFeature

func (*CFeature) Extensions 

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

func (*CFeature) FindBlock 

func (f *CFeature) FindBlock(tagClass feature.NjnClass, blockType string) (block feature.EnjinBlock, ok bool)

func (*CFeature) FindField 

func (f *CFeature) FindField(tagClass feature.NjnClass, fieldType string) (field feature.EnjinField, ok bool)

func (*CFeature) IndexDocument 

func (f *CFeature) IndexDocument(pg feature.Page) (out interface{}, err error)

func (*CFeature) Init 

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

func (*CFeature) InlineBlocks 

func (f *CFeature) InlineBlocks() (blocks map[string]feature.EnjinBlock)

func (*CFeature) InlineFields 

func (f *CFeature) InlineFields() (fields map[string]feature.EnjinField)

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) PostStartup added in v0.5.11 

func (f *CFeature) PostStartup(ctx *cli.Context) (err error)

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, content string) (html template.HTML, redirect string, err error)

func (*CFeature) SearchDocumentMapping 

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

func (*CFeature) Setup 

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

func (*CFeature) StringTags 

func (f *CFeature) StringTags() (names []string)

type Document 

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

type Feature 

type Feature interface {
	feature.Feature
	feature.PageFormat
	feature.EnjinSystem
}

type MakeFeature 

type MakeFeature interface {
	AddField(field feature.EnjinField) MakeFeature
	AddBlock(block feature.EnjinBlock) MakeFeature
	AddStringTags(names ...string) MakeFeature

	Defaults() MakeFeature

	Make() Feature
}

func New 

func New() MakeFeature

func NewTagged added in v0.4.0 

func NewTagged(tag feature.Tag) MakeFeature

type RenderEnjin 

type RenderEnjin struct {
	Njn   feature.EnjinSystem
	Theme feature.Theme
	Enjin feature.Internals

	sync.RWMutex
	// contains filtered or unexported fields
}

func (*RenderEnjin) AddFootnote 

func (re *RenderEnjin) AddFootnote(blockIndex int, field map[string]interface{}) (index int)

func (*RenderEnjin) CheckInlineFieldText 

func (re *RenderEnjin) CheckInlineFieldText(parent feature.EnjinField, parentName string, child interface{}) (njn feature.EnjinField, field map[string]interface{}, name string, err error)

func (*RenderEnjin) DecCurrentDepth 

func (re *RenderEnjin) DecCurrentDepth() (depth int)

func (*RenderEnjin) DecHeadingLevel 

func (re *RenderEnjin) DecHeadingLevel()

func (*RenderEnjin) FinalizeFieldAttributes 

func (re *RenderEnjin) FinalizeFieldAttributes(attrs map[string]interface{}) (attributes []template.HTMLAttr)

func (*RenderEnjin) FinalizeFieldData 

func (re *RenderEnjin) FinalizeFieldData(data map[string]interface{}, field map[string]interface{}, skip ...string)

func (*RenderEnjin) GetBlockIndex 

func (re *RenderEnjin) GetBlockIndex() (index int)

func (*RenderEnjin) GetCurrentDepth 

func (re *RenderEnjin) GetCurrentDepth() (depth int)

func (*RenderEnjin) GetData 

func (re *RenderEnjin) GetData() (data interface{})

func (*RenderEnjin) GetHeadingCount 

func (re *RenderEnjin) GetHeadingCount() (count int)

func (*RenderEnjin) GetHeadingLevel 

func (re *RenderEnjin) GetHeadingLevel() (level int)

func (*RenderEnjin) GetNjnTemplateContent 

func (re *RenderEnjin) GetNjnTemplateContent(name string) (contents string, err error)

func (*RenderEnjin) GetWithinAside 

func (re *RenderEnjin) GetWithinAside() (within bool)

func (*RenderEnjin) IncCurrentDepth 

func (re *RenderEnjin) IncCurrentDepth() (depth int)

func (*RenderEnjin) IncHeadingCount 

func (re *RenderEnjin) IncHeadingCount()

func (*RenderEnjin) IncHeadingLevel 

func (re *RenderEnjin) IncHeadingLevel()

func (*RenderEnjin) ParseBlockHeadingLevel 

func (re *RenderEnjin) ParseBlockHeadingLevel(count, current int, blockData map[string]interface{}) (level, headingReset, headingLevel int)

func (*RenderEnjin) ParseFieldAndTypeName 

func (re *RenderEnjin) ParseFieldAndTypeName(data interface{}) (field map[string]interface{}, name string, ok bool)

func (*RenderEnjin) ParseFieldAttributes 

func (re *RenderEnjin) ParseFieldAttributes(field map[string]interface{}) (attributes map[string]interface{}, classes []string, styles map[string]string, ok bool)

func (*RenderEnjin) ParseTypeName 

func (re *RenderEnjin) ParseTypeName(data map[string]interface{}) (name string, ok bool)

func (*RenderEnjin) PrepareBlock 

func (re *RenderEnjin) PrepareBlock(data map[string]interface{}) (block map[string]interface{}, redirect string, err error)

func (*RenderEnjin) PrepareBlockFooter 

func (re *RenderEnjin) PrepareBlockFooter(content map[string]interface{}) (combined []interface{}, ok bool)

func (*RenderEnjin) PrepareBlockHeader 

func (re *RenderEnjin) PrepareBlockHeader(content map[string]interface{}) (combined []interface{}, ok bool)

func (*RenderEnjin) PrepareContainerField 

func (re *RenderEnjin) PrepareContainerField(field map[string]interface{}) (prepared map[string]interface{}, err error)

func (*RenderEnjin) PrepareContainerFieldList 

func (re *RenderEnjin) PrepareContainerFieldList(list []interface{}) (fields []interface{}, err error)

func (*RenderEnjin) PrepareContainerFieldText 

func (re *RenderEnjin) PrepareContainerFieldText(field map[string]interface{}) (fields []interface{}, err error)

func (*RenderEnjin) PrepareContainerFields 

func (re *RenderEnjin) PrepareContainerFields(fields []interface{}) (combined []map[string]interface{}, err error)

func (*RenderEnjin) PrepareErrorBlock 

func (re *RenderEnjin) PrepareErrorBlock(summary string, data ...interface{}) (block map[string]interface{}, err error)

func (*RenderEnjin) PrepareFootnotes 

func (re *RenderEnjin) PrepareFootnotes(blockIndex int) (footnotes []map[string]interface{}, err error)

func (*RenderEnjin) PrepareGenericBlock 

func (re *RenderEnjin) PrepareGenericBlock(typeName string, data map[string]interface{}) (preparedData map[string]interface{})

func (*RenderEnjin) PrepareGenericBlockData 

func (re *RenderEnjin) PrepareGenericBlockData(contentData interface{}) (blockDataContent map[string]interface{}, err error)

func (*RenderEnjin) PrepareInlineField 

func (re *RenderEnjin) PrepareInlineField(field map[string]interface{}) (prepared map[string]interface{}, err error)

func (*RenderEnjin) PrepareInlineFieldList 

func (re *RenderEnjin) PrepareInlineFieldList(list []interface{}) (combined []interface{}, err error)

func (*RenderEnjin) PrepareInlineFieldText 

func (re *RenderEnjin) PrepareInlineFieldText(field map[string]interface{}) (combined []interface{}, err error)

func (*RenderEnjin) PrepareInlineFields 

func (re *RenderEnjin) PrepareInlineFields(fields []interface{}) (combined []interface{}, err error)

func (*RenderEnjin) PreparePageData 

func (re *RenderEnjin) PreparePageData(data interface{}) (blocks []interface{}, redirect string, err *errors.EnjinError)

func (*RenderEnjin) PrepareStringTags 

func (re *RenderEnjin) PrepareStringTags(text string) (data []interface{}, err error)

func (*RenderEnjin) ProcessBlock 

func (re *RenderEnjin) ProcessBlock(block map[string]interface{}) (html template.HTML, redirect string, err error)

func (*RenderEnjin) Render 

func (re *RenderEnjin) Render(data interface{}) (html template.HTML, redirect string, err error)

func (*RenderEnjin) RenderBlockFooter 

func (re *RenderEnjin) RenderBlockFooter(content map[string]interface{}) (html template.HTML, ok bool)

func (*RenderEnjin) RenderBlockHeader 

func (re *RenderEnjin) RenderBlockHeader(content map[string]interface{}) (html template.HTML, ok bool)

func (*RenderEnjin) RenderContainerField 

func (re *RenderEnjin) RenderContainerField(field map[string]interface{}) (combined []template.HTML, err error)

func (*RenderEnjin) RenderContainerFieldList 

func (re *RenderEnjin) RenderContainerFieldList(list []interface{}) (text template.HTML, err error)

func (*RenderEnjin) RenderContainerFieldText 

func (re *RenderEnjin) RenderContainerFieldText(field map[string]interface{}) (text template.HTML, err error)

func (*RenderEnjin) RenderContainerFields 

func (re *RenderEnjin) RenderContainerFields(fields []interface{}) (combined []template.HTML, err error)

func (*RenderEnjin) RenderErrorBlock 

func (re *RenderEnjin) RenderErrorBlock(summary string, data ...interface{}) (html template.HTML, err error)

func (*RenderEnjin) RenderInlineField 

func (re *RenderEnjin) RenderInlineField(field map[string]interface{}) (combined []template.HTML, err error)

func (*RenderEnjin) RenderInlineFieldList 

func (re *RenderEnjin) RenderInlineFieldList(list []interface{}) (html template.HTML, err error)

func (*RenderEnjin) RenderInlineFieldText 

func (re *RenderEnjin) RenderInlineFieldText(field map[string]interface{}) (html template.HTML, err error)

func (*RenderEnjin) RenderInlineFields 

func (re *RenderEnjin) RenderInlineFields(fields []interface{}) (combined []template.HTML, err error)

func (*RenderEnjin) RenderNjnTemplate 

func (re *RenderEnjin) RenderNjnTemplate(tag string, data map[string]interface{}) (html template.HTML, err error)

func (*RenderEnjin) RenderNjnTemplateList 

func (re *RenderEnjin) RenderNjnTemplateList(tag string, data []interface{}) (html template.HTML, err error)

func (*RenderEnjin) RenderPreparedBlock 

func (re *RenderEnjin) RenderPreparedBlock(block map[string]interface{}) (html template.HTML, err error)

func (*RenderEnjin) RequestArgv 

func (re *RenderEnjin) RequestArgv() (reqArgv *argv.Argv)

func (*RenderEnjin) RequestContext 

func (re *RenderEnjin) RequestContext() (ctx context.Context)

func (*RenderEnjin) SetHeadingCount 

func (re *RenderEnjin) SetHeadingCount(count int)

func (*RenderEnjin) SetHeadingLevel 

func (re *RenderEnjin) SetHeadingLevel(level int)

func (*RenderEnjin) SetWithinAside 

func (re *RenderEnjin) SetWithinAside(within bool)

func (*RenderEnjin) WalkStringTags 

func (re *RenderEnjin) WalkStringTags(doc *html.Node) (prepared []interface{})

Source Files

View all Source files

Directories

Path Synopsis
blocks
card
carousel
content
header
icon
image
index
linkList
notice
pair
sidebar
toc
fields
anchor
code
container
details
fa
fieldset
figure
footnote
img
inline
input
list
literal
optgroup
option
p
picture
pre
select
table

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.