web

Documentation

Overview

Package web contains the Documize static web data.

Package web contains the Documize static web data.

Index

• Variables
• func Asset(location string) ([]byte, error)
• func AssetDir(dir string) ([]string, error)
• func ReadFile(filename string) ([]byte, error)
• func StaticAssetsFileSystem() http.FileSystem
• type EmbedHandler
• type Handler
  • func (h *Handler) EmberHandler(w http.ResponseWriter, r *http.Request)

Variables

var SiteInfo struct {
	DBname, DBhash, Issue, Edition string
}

SiteInfo describes set-up information about the site

Functions

func Asset

func Asset(location string) ([]byte, error)

Asset fetch.

func AssetDir

func AssetDir(dir string) ([]string, error)

AssetDir returns web app "assets" folder.

func ReadFile

func ReadFile(filename string) ([]byte, error)

ReadFile is intended to substitute for ioutil.ReadFile().

func StaticAssetsFileSystem

func StaticAssetsFileSystem() http.FileSystem

StaticAssetsFileSystem data encoded in the go:generate above.

Types

type EmbedHandler

type EmbedHandler interface {
	Asset(string) ([]byte, error)
	AssetDir(string) ([]string, error)
	StaticAssetsFileSystem() http.FileSystem
}

EmbedHandler is defined in each embed directory

var Embed EmbedHandler

Embed allows access to the embedded data

type Handler

type Handler struct {
	Runtime *env.Runtime
	Store   *store.Store
}

Handler contains the runtime information such as logging and database.

func (*Handler) EmberHandler

func (h *Handler) EmberHandler(w http.ResponseWriter, r *http.Request)

EmberHandler serves HTML web pages