summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKurt Jung <kurt.w.jung@code.google.com>2013-08-02 15:52:30 -0400
committerKurt Jung <kurt.w.jung@code.google.com>2013-08-02 15:52:30 -0400
commitc405973d69ae4029da5df8a0d1facee6677c0f1a (patch)
tree1d5e370369e3a9e9343673d948022e2385f094cd
parenta1431b754603495409df52a9f8e2e11a928f413d (diff)
Updated documentation: go get, makefont.
-rw-r--r--doc.go33
1 files changed, 29 insertions, 4 deletions
diff --git a/doc.go b/doc.go
index a95a7e0..b2d514e 100644
--- a/doc.go
+++ b/doc.go
@@ -45,11 +45,19 @@ gofpdf has no dependencies other than the Go standard library. All tests pass
on Linux, Mac and Windows platforms. Like FPDF version 1.7, from which gofpdf
is derived, this package does not yet support UTF-8 source text.
+Run
+
+ go get code.google.com/p/gofpdf
+
+to install the package on your system. To receive updates, run
+
+ go get -u code.google.com/p/gofpdf
+
Quick Start
The following Go code generates a simple PDF.
- pdf := fpdf.New("P", "mm", "A4", "../font")
+ pdf := gofpdf.New("P", "mm", "A4", "../font")
pdf.AddPage()
pdf.SetFont("Arial", "B", 16)
pdf.Cell(40, 10, "Hello, world")
@@ -92,9 +100,26 @@ PHP.
Tutorials
-A side effect of running "go test" in the fpdf directory is the production of
-the tutorial PDFs. These can be found in the gofpdf/pdf directory after the
-tests complete.
+A side effect of running "go test" is the production of the tutorial PDFs.
+These can be found in the gofpdf/pdf directory after the tests complete.
+
+Nonstandard Fonts
+
+Nothing special is required to use the standard PDF fonts (courier, helvetica,
+times, zapfdingbats) in your documents other than calling SetFont().
+
+In order to use a different TrueType or Type1 font, you will need to generate a
+font definition file and, if the font will be embeded into PDFs, a compressed
+version of the font file. This is done by calling the MakeFont function or
+using the included makefont command line utility. To create the utility, cd
+into the makefont subdirectory and run "go build". This will produce a
+standalone executable named makefont. Select the appropriate encoding file from
+the font subdirectory and run the command as in the following example.
+
+ ./makefont --embed --enc=../font/cp1252.map --dst=../font ../font/calligra.ttf
+
+In your PDF generation code, call AddFont() to load the font and, as with the
+standard fonts, SetFont() to begin using it. See tutorial 7 for an example.
Roadmap