From e200d3e7c7ef20b29a47b67e58b7561f4099e7ae Mon Sep 17 00:00:00 2001 From: Kurt Date: Thu, 1 Nov 2018 11:51:50 -0400 Subject: Explain in documentation why CreateTemplate() is deprecated. --- def.go | 2 ++ template.go | 10 ++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/def.go b/def.go index fdf439b..b4140a9 100644 --- a/def.go +++ b/def.go @@ -268,6 +268,8 @@ type FontLoader interface { Open(name string) (io.Reader, error) } +// Pdf defines the interface used for various methods. It is implemented by the +// main FPDF instance as well as templates. type Pdf interface { AddFont(familyStr, styleStr, fileStr string) AddFontFromBytes(familyStr, styleStr string, jsonFileBytes, zFileBytes []byte) diff --git a/template.go b/template.go index 0c86762..0bb7f75 100644 --- a/template.go +++ b/template.go @@ -31,7 +31,13 @@ func (f *Fpdf) CreateTemplateCustom(corner PointType, size SizeType, fn func(*Tp return newTpl(corner, size, f.defOrientation, f.unitStr, f.fontDirStr, fn, f) } -// CreateTemplate creates a template not attached to any document (deprecated) +// CreateTemplate creates a template that is not attached to any document. +// +// This function is deprecated; it incorrectly assumes that a page with a width +// smaller than its height is oriented in portrait mode, otherwise it assumes +// landscape mode. This causes problems when placing the template in a master +// document where this condition does not apply. CreateTpl() is a similar +// function that lets you specify the orientation to avoid this problem. func CreateTemplate(corner PointType, size SizeType, unitStr, fontDirStr string, fn func(*Tpl)) Template { orientationStr := "p" if size.Wd > size.Ht { @@ -41,7 +47,7 @@ func CreateTemplate(corner PointType, size SizeType, unitStr, fontDirStr string, return CreateTpl(corner, size, orientationStr, unitStr, fontDirStr, fn) } -// CreateTemplate creates a template not attached to any document +// CreateTpl creates a template not attached to any document func CreateTpl(corner PointType, size SizeType, orientationStr, unitStr, fontDirStr string, fn func(*Tpl)) Template { return newTpl(corner, size, orientationStr, unitStr, fontDirStr, fn, nil) } -- cgit v1.2.1-24-ge1ad