templates

Documentation

Overview

Package templates generates and stores HTML templates

Index

• Variables
• func Board(b string, data *types.Board) ([]byte, error)
• func Compile() error
• func ParseTemplates() error
• func Set(name string, s Store)
• func Thread(t *types.Thread) ([]byte, error)
• type Store
  • func Get(name string) Store

Variables

var (
	// TemplateRoot stores the root directory of all HTML templates. Overridden
	// in tests.
	TemplateRoot = "templates"
)

Functions

func Board

func Board(b string, data *types.Board) ([]byte, error)

Board renders board page HTML for noscript browsers

func Compile

func Compile() error

Compile reads template HTML from disk, injects dynamic variables, hashes and stores them

func ParseTemplates

func ParseTemplates() error

ParseTemplates reads all HTML templates from disk, strips whitespace and parses them into the global template map

func Set

func Set(name string, s Store)

Set sets a template to the specified value. Only use in tests.

func Thread

func Thread(t *types.Thread) ([]byte, error)

Thread renders thread page HTML for noscript browsers

Types

type Store

type Store struct {
	HTML []byte
	Hash string
}

Store stores the compiled HTML template and the corresponding truncated MD5 hash of said template

func Get

func Get(name string) Store

Get retrieves a compiled template by its name