README
¶
DoGen
DoGen is allows you to generate documents on the fly through an API through a predefined template.
Goal
The goal of DoGen is to simplify document generation. We want to make it easy for DoGen consumers to generate a document through a uniform interface, which can then be outputted in a number of formats.
The generation of these documents should all go through a predefined template, which will be passed to the renderer. The renderer parses these templates and outputs them in a desired output format.
Note: for now, we will focus on PDF generation
Future
Templates
At the moment, templates are tightly coupled with document output. This should be decoupled in the near future.
Documents
For now, the only available document is the PDF type. This reflects in the document interface, which is heavily focused on the underlying PDF library. This should be abstracted and have a more general interface.
This reflects back on the templates which currently depend on a lot of the document internals. We'll start tearing this out and make a template less aware of what happens underneath the document methods.
CLI
At the moment, there is only a web interface to generate documents. There should be a CLI instance as well.
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/gorilla/context
Package context stores values shared during a request lifetime.
|
Package context stores values shared during a request lifetime. |
|
_workspace/src/github.com/gorilla/mux
Package gorilla/mux implements a request router and dispatcher.
|
Package gorilla/mux implements a request router and dispatcher. |
|
_workspace/src/github.com/jung-kurt/gofpdf
Package gofpdf implements a PDF document generator with high level support for text, drawing and images.
|
Package gofpdf implements a PDF document generator with high level support for text, drawing and images. |
|
_workspace/src/github.com/jung-kurt/gofpdf/contrib/barcode
Package barcode provides helper methods for adding barcodes of different types to your pdf document.
|
Package barcode provides helper methods for adding barcodes of different types to your pdf document. |
|
_workspace/src/github.com/jung-kurt/gofpdf/internal/example
Package example provides some helper routines for the test packages of gofpdf and its various contributed packages located beneath the contrib directory.
|
Package example provides some helper routines for the test packages of gofpdf and its various contributed packages located beneath the contrib directory. |
|
_workspace/src/github.com/jung-kurt/gofpdf/makefont
Command makefont generates a font definition file.
|
Command makefont generates a font definition file. |
|
_workspace/src/github.com/mitchellh/mapstructure
The mapstructure package exposes functionality to convert an abitrary map[string]interface{} into a native Go structure.
|
The mapstructure package exposes functionality to convert an abitrary map[string]interface{} into a native Go structure. |
|
_workspace/src/github.com/stretchr/objx
objx - Go package for dealing with maps, slices, JSON and other data.
|
objx - Go package for dealing with maps, slices, JSON and other data. |
|
_workspace/src/github.com/stretchr/testify
Package testify is a set of packages that provide many tools for testifying that your code will behave as you intend.
|
Package testify is a set of packages that provide many tools for testifying that your code will behave as you intend. |
|
_workspace/src/github.com/stretchr/testify/assert
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
|
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. |
|
_workspace/src/github.com/stretchr/testify/http
A set of tools to make testing http activity using the Go testing system easier.
|
A set of tools to make testing http activity using the Go testing system easier. |
|
_workspace/src/github.com/stretchr/testify/mock
Provides a system by which it is possible to mock your objects and verify calls are happening as expected.
|
Provides a system by which it is possible to mock your objects and verify calls are happening as expected. |
|
_workspace/src/github.com/stretchr/testify/require
Alternative testing tools which stop test execution if test failed.
|
Alternative testing tools which stop test execution if test failed. |
|
_workspace/src/github.com/stretchr/testify/suite
The suite package contains logic for creating testing suite structs and running the methods on those structs as tests.
|
The suite package contains logic for creating testing suite structs and running the methods on those structs as tests. |
|
Package renderer exists out of multiple parts which, combined, will transform data into a specified ouptput format.
|
Package renderer exists out of multiple parts which, combined, will transform data into a specified ouptput format. |
|
documents
Package documents represents the available documents in our system.
|
Package documents represents the available documents in our system. |
|
documents/pdf
Package PDF contains functionality to draw data onto a PDF and render said PDF to a file or string buffer.
|
Package PDF contains functionality to draw data onto a PDF and render said PDF to a file or string buffer. |
|
layouts
Package layouts represents the layout of an item to be rendered.
|
Package layouts represents the layout of an item to be rendered. |
|
templates
Package templates provides a templating system to draw items on your documents.
|
Package templates provides a templating system to draw items on your documents. |