docTemp

README

Simple Google Go (golang) library for building templates for generic content

func main() {
	funcMap := template.FuncMap{"title": strings.Title}
	docTemp, _ := GetTemplate("docx/fixtures/test.docx")
	docTemp.AddFunctions(funcMap)
	docTemp.Parse()
	docTemp.Execute("test.docx", nil)
}

Documentation

Index

• type DocTemplate
  • func GetTemplate(filePath string) (*DocTemplate, error)
  • func (docTemplate *DocTemplate) AddFunctions(funcMap template.FuncMap)
  • func (docTemplate *DocTemplate) Execute(exportPath string, data interface{}) error
  • func (docTemplate *DocTemplate) Parse()
• type Document

Types

type DocTemplate

type DocTemplate struct {
	Template *template.Template
	Document Document
}

DocTemplate struct combines data and methods from both the Document interface and golang's templating library

func GetTemplate

func GetTemplate(filePath string) (*DocTemplate, error)

GetTemplate uses the file extension to determine the correct document struct to use

func (*DocTemplate) AddFunctions

func (docTemplate *DocTemplate) AddFunctions(funcMap template.FuncMap)

AddFunctions adds functions to the template

func (*DocTemplate) Execute

func (docTemplate *DocTemplate) Execute(exportPath string, data interface{}) error

Execute func runs the template and sends the output to the export path

func (*DocTemplate) Parse

func (docTemplate *DocTemplate) Parse()

Parse parses the template

type Document

type Document interface {
	ReadFile(string) error
	UpdateContent(string)
	GetContent() string
	WriteToFile(string, string) error
	Close() error
}

Document interface is a combintation of methods use for generic data files