web

Documentation

Overview

Package web contains the Documize static web data.

Index

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

Constants

const (
	// SiteModeNormal serves app
	SiteModeNormal = ""
	// SiteModeOffline serves offline.html
	SiteModeOffline = "1"
	// SiteModeSetup tells Ember to serve setup route
	SiteModeSetup = "2"
	// SiteModeBadDB redirects to db-error.html page
	SiteModeBadDB = "3"
)

Variables

var SiteInfo struct {
	DBname, DBhash, Issue string
}

SiteInfo describes set-up information about the site

var SiteMode string

SiteMode defines that the web server should show the system to be in a particular state.

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 EmberHandler

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

EmberHandler provides the webserver for pages developed using the Ember programming environment.

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