templates

Documentation

Index

• Constants
• type Provider
  • func NewProvider(templateFolder string) Provider
  • func (provider *Provider) GetAliasIndexTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetConversionTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetErrorTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetItemTemplate(itemType, hostname string) (*template.Template, error)
  • func (provider *Provider) GetOpenSearchDescriptionTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetRSSTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetRobotsTxtTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetSearchTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetSimpleTemplate(templateName, hostname string) (*template.Template, error)
  • func (provider *Provider) GetSitemapEntryTemplate(hostname string) (template *template.Template, childPlaceholder string, err error)
  • func (provider *Provider) GetSitemapTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetSnippetTemplate(snippetName, hostname string) (*template.Template, error)
  • func (provider *Provider) GetTagMapTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) GetXMLSitemapTemplate(hostname string) (*template.Template, error)
  • func (provider *Provider) StoreTemplatesOnDisc() (success bool, err error)

Constants

const (
	TemplateFileExtension = ".gohtml"
)

Types

type Provider

type Provider struct {
	Modified chan bool
	// contains filtered or unexported fields
}

A Provider gives access to all required templates.

func NewProvider

func NewProvider(templateFolder string) Provider

NewProvider creates a new template provider with the given folder as the base.

func (*Provider) GetAliasIndexTemplate

func (provider *Provider) GetAliasIndexTemplate(hostname string) (*template.Template, error)

GetAliasIndexTemplate returns the alias-index template.

func (*Provider) GetConversionTemplate

func (provider *Provider) GetConversionTemplate(hostname string) (*template.Template, error)

GetConversionTemplate returns the template for conversion.

func (*Provider) GetErrorTemplate

func (provider *Provider) GetErrorTemplate(hostname string) (*template.Template, error)

GetErrorTemplate returns the template for error pages.

func (*Provider) GetItemTemplate

func (provider *Provider) GetItemTemplate(itemType, hostname string) (*template.Template, error)

GetItemTemplate returns the item template for the given item type (e.g. document, presentation).

func (*Provider) GetOpenSearchDescriptionTemplate

func (provider *Provider) GetOpenSearchDescriptionTemplate(hostname string) (*template.Template, error)

GetOpenSearchDescriptionTemplate returns the template for conversion.

func (*Provider) GetRSSTemplate

func (provider *Provider) GetRSSTemplate(hostname string) (*template.Template, error)

GetRSSTemplate returns the template for RSS feeds.

func (*Provider) GetRobotsTxtTemplate

func (provider *Provider) GetRobotsTxtTemplate(hostname string) (*template.Template, error)

GetRobotsTxtTemplate returns the template for robots.txt.

func (*Provider) GetSearchTemplate

func (provider *Provider) GetSearchTemplate(hostname string) (*template.Template, error)

GetSearchTemplate returns the search template.

func (*Provider) GetSimpleTemplate

func (provider *Provider) GetSimpleTemplate(templateName, hostname string) (*template.Template, error)

GetSimpleTemplate returns a simple template without wrapping or combination with other templates.

func (*Provider) GetSitemapEntryTemplate

func (provider *Provider) GetSitemapEntryTemplate(hostname string) (template *template.Template, childPlaceholder string, err error)

GetSitemapEntryTemplate returns the sitemap-entry template.

func (*Provider) GetSitemapTemplate

func (provider *Provider) GetSitemapTemplate(hostname string) (*template.Template, error)

GetSitemapTemplate returns the sitemap template.

func (*Provider) GetSnippetTemplate

func (provider *Provider) GetSnippetTemplate(snippetName, hostname string) (*template.Template, error)

GetSnippetTemplate returns a snippet template without wrapping or combination with other templates.

func (*Provider) GetTagMapTemplate

func (provider *Provider) GetTagMapTemplate(hostname string) (*template.Template, error)

GetTagMapTemplate returns the template for tags.

func (*Provider) GetXMLSitemapTemplate

func (provider *Provider) GetXMLSitemapTemplate(hostname string) (*template.Template, error)

GetXMLSitemapTemplate returns the template for XML sitemaps.

func (*Provider) StoreTemplatesOnDisc

func (provider *Provider) StoreTemplatesOnDisc() (success bool, err error)

StoreTemplatesOnDisc saves all templates to disc.