tagcloud

Documentation

Overview

Package tagcloud provides tag cloud enjin features

From Wikipedia: (see: https://en.wikipedia.org/wiki/Tag_cloud)

A tag cloud is a visual representation of text data which is often used
to depict keyword metadata on websites, or to visualize free form text.
Tags are usually single words, and the importance of each tag is shown
with font size or color. When used as website navigation aids, the terms
are hyperlinked to items associated with the tag.

- indexing support to cache and maintain a mapping of tag weights - njn block to render a variable-sized widget - shortcode to wrap the njn block

Index

• Constants
• Variables
• type CFeature
  • func (f *CFeature) Build(b feature.Buildable) (err error)
  • func (f *CFeature) GetPageTagCloud(shasum string) (tags feature.TagCloud)
  • func (f *CFeature) GetTagCloud() (tags feature.TagCloud)
  • func (f *CFeature) IgnorePageTypes(types ...string) MakeFeature
  • func (f *CFeature) Init(this interface{})
  • func (f *CFeature) ListPageContextFields() (kebabs []string)
  • func (f *CFeature) Make() (feat Feature)
  • func (f *CFeature) MakePageContextFields(r *http.Request) (list page_fields.Fields)
  • func (f *CFeature) OnlyArchetypes(types ...string) MakeFeature
  • func (f *CFeature) PageTypeNames() (names []string)
  • func (f *CFeature) ProcessRequestPageType(r *http.Request, p feature.Page) (pg feature.Page, redirect string, processed bool, err error)
  • func (f *CFeature) SetIndexKey(name string) MakeFeature
  • func (f *CFeature) SetPageUrl(path string) MakeFeature
  • func (f *CFeature) Setup(enjin feature.Internals)
  • func (f *CFeature) Startup(ctx *cli.Context) (err error)
• type Feature
• type MakeFeature
  • func New() MakeFeature
  • func NewTagged(tag feature.Tag) MakeFeature

Constants

const Tag feature.Tag = "tagcloud"

Variables

var (
	DefaultPageUrl  = "/tags"
	DefaultIndexKey = "tags"
)

Types

type CFeature

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

func (*CFeature) Build

func (f *CFeature) Build(b feature.Buildable) (err error)

func (*CFeature) GetPageTagCloud

func (f *CFeature) GetPageTagCloud(shasum string) (tags feature.TagCloud)

func (*CFeature) GetTagCloud

func (f *CFeature) GetTagCloud() (tags feature.TagCloud)

func (*CFeature) IgnorePageTypes

func (f *CFeature) IgnorePageTypes(types ...string) MakeFeature

func (*CFeature) Init

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

func (*CFeature) ListPageContextFields

func (f *CFeature) ListPageContextFields() (kebabs []string)

func (*CFeature) Make

func (f *CFeature) Make() (feat Feature)

func (*CFeature) MakePageContextFields

func (f *CFeature) MakePageContextFields(r *http.Request) (list page_fields.Fields)

func (*CFeature) OnlyArchetypes

func (f *CFeature) OnlyArchetypes(types ...string) MakeFeature

func (*CFeature) PageTypeNames

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

func (*CFeature) ProcessRequestPageType

func (f *CFeature) ProcessRequestPageType(r *http.Request, p feature.Page) (pg feature.Page, redirect string, processed bool, err error)

func (*CFeature) SetIndexKey

func (f *CFeature) SetIndexKey(name string) MakeFeature

func (*CFeature) SetPageUrl

func (f *CFeature) SetPageUrl(path string) MakeFeature

func (*CFeature) Setup

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

func (*CFeature) Startup

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

type Feature

type Feature interface {
	feature.Feature
}

type MakeFeature

type MakeFeature interface {
	SetPageUrl(path string) MakeFeature
	SetIndexKey(name string) MakeFeature

	Make() Feature
}

func New

func New() MakeFeature

func NewTagged

func NewTagged(tag feature.Tag) MakeFeature