pdfcpu

https://pkg.go.dev/github.com/pdfcpu/pdfcpu
Admin
pdfcpu is a PDF processing library written in Go that supports encryption and offers both an API and...
Tokens:101,515
Snippets:1,015
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### CreateAnnotationDemoXRef

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Creates a PDF file with examples of annotations and actions.

```go
func CreateAnnotationDemoXRef() (*model.XRefTable, error)
```

--------------------------------

### List Certificates Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to list installed certificates.

```go
func ListCertificatesCommand(json bool, conf *model.Configuration) *Command
```

--------------------------------

### Define Guide structure

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/primitives

Represents layout lines at specific coordinates.

```go
type Guide struct {
	Position [2]float64 `json:"pos"` // x,y
	// contains filtered or unexported fields
}
```

--------------------------------

### Install Fonts Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Installs TrueType fonts for embedding.

```go
func InstallFontsCommand(fontFiles []string, conf *model.Configuration) *Command
```

--------------------------------

### ListCertificates CLI functions

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Functions to list installed certificates.

```go
func ListCertificates(cmd *Command) ([]string, error)
```

```go
func ListCertificatesAll(json bool, conf *model.Configuration) ([]string, error)
```

--------------------------------

### Load Certificates

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Loads installed certificates from pdfcpu/config/certs exactly once.

```go
func LoadCertificates() error
```

--------------------------------

### Optimization Command Pattern

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/api

Example of the command pattern applied to optimization operations.

```go
func OptimizeFile(inFile, outFile string, conf *pdf.Configuration) error
func Optimize(rs io.ReadSeeker, w io.Writer, conf *pdf.Configuration) error
```

--------------------------------

### Import Content

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/api

Functions for parsing import strings, managing bookmarks, and installing certificates.

```go
func Import(s string, u types.DisplayUnit) (*pdfcpu.Import, error)
```

```go
func ImportBookmarks(rs io.ReadSeeker, rd io.Reader, w io.Writer, replace bool, conf *model.Configuration) (err error)
```

```go
func ImportBookmarksFile(inFilePDF, inFileJSON, outFilePDF string, replace bool, conf *model.Configuration) (err error)
```

```go
func ImportCertificates(inFiles []string) (ss []string, err error)
```

--------------------------------

### Draw booklet guides

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Draws guides according to corresponding nup value.

```go
func DrawBookletGuides(nup *NUp, w io.Writer) FontMap
```

--------------------------------

### Get Version String Representation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the string representation of a Version.

```go
func (v Version) String() string
```

--------------------------------

### CreateFormDemoXRef

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Creates an xRefTable with an AcroForm example.

```go
func CreateFormDemoXRef() (*model.XRefTable, error)
```

--------------------------------

### List installed fonts

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/font

Retrieves a list of all installed TrueType fonts.

```go
func UserFontNames() []string
```

--------------------------------

### InstallFonts CLI function

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Installs True Type fonts into the pdfcpu configuration directory.

```go
func InstallFonts(cmd *Command) ([]string, error)
```

--------------------------------

### Get DefaultResourceLimits

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Retrieves the default configuration for resource limits.

```go
func DefaultResourceLimits() ResourceLimits
```

--------------------------------

### Get Version String

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the string representation of the PDF version.

```go
func (xRefTable *XRefTable) VersionString() string
```

--------------------------------

### Retrieve configuration and metadata

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Methods to get recursion depth, missing objects, name references, and the names dictionary.

```go
func (xRefTable *XRefTable) MaxRecursionDepth() int
```

```go
func (xRefTable *XRefTable) MissingObjects() (int, *string)
```

```go
func (xRefTable *XRefTable) NameRef(nameType string) NameMap
```

```go
func (xRefTable *XRefTable) NamesDict() (types.Dict, error)
```

--------------------------------

### Get PDF Version from String

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Functions to parse a version string into a Version type.

```go
func PDFVersion(versionStr string) (Version, error)
```

```go
func PDFVersionRelaxed(versionStr string) (Version, error)
```

--------------------------------

### Manage user fonts

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/font

Functions for loading, installing, and verifying user-provided TrueType fonts.

```go
func EnsureUserFontsLoaded()
```

```go
func InstallFontFromBytes(fontDir, fontName string, bb []byte) error
```

```go
func InstallTrueTypeCollection(fontDir, fn string) error
```

```go
func InstallTrueTypeFont(fontDir, fontName string) error
```

```go
func IsCoreFont(fontName string) bool
```

```go
func IsUserFont(fontName string) bool
```

```go
func LoadUserFonts() error
```

--------------------------------

### Get Display Unit String

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns a string representation for the display unit in effect.

```go
func (c *Configuration) UnitString() string
```

--------------------------------

### Initialize Default Configuration

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the default pdfcpu configuration.

```go
func NewDefaultConfiguration() *Configuration
```

--------------------------------

### Manage Configuration Directory

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/api

Switches to a specific pdfcpu configuration directory, creating it if necessary.

```go
func EnsureDefaultConfigAt(path string) error
```

--------------------------------

### List installed fonts with glyph counts

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/font

Retrieves a list of all installed TrueType fonts including their glyph counts.

```go
func UserFontNamesVerbose() []string
```

--------------------------------

### Import Bookmarks

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Creates or replaces outlines in the context as provided by the reader.

```go
func ImportBookmarks(ctx *model.Context, rd io.Reader, replace bool) (bool, error)
```

--------------------------------

### Define Font Metrics and Character Widths

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/internal/corefont/metrics

Example of defining a font's bounding box and a map of character widths for specific glyphs.

```go
types.NewRectangle(-180.0, -293.0, 1090.0, 1010.0),
map[string]int{"space": 250, "exclam": 333, "universal": 713, "numbersign": 500, "existential": 549, "percent": 833, "ampersand": 778, "suchthat": 439, "parenleft": 333, "parenright": 333, "asteriskmath": 500, "plus": 549, "comma": 250, "minus": 549, "period": 250, "slash": 278, "zero": 500, "one": 500, "two": 500, "three": 500, "four": 500, "five": 500, "six": 500, "seven": 500, "eight": 500, "nine": 500, "colon": 278, "semicolon": 278, "less": 549, "equal": 549, "greater": 549, "question": 444, "congruent": 549, "Alpha": 722, "Beta": 667, "Chi": 722, "Delta": 612, "Epsilon": 611, "Phi": 763, "Gamma": 603, "Eta": 722, "Iota": 333, "theta1": 631, "Kappa": 722, "Lambda": 686, "Mu": 889, "Nu": 722, "Omicron": 722, "Pi": 768, "Theta": 741, "Rho": 556, "Sigma": 592, "Tau": 611, "Upsilon": 690, "sigma1": 439, "Omega": 768, "Xi": 645, "Psi": 795, "Zeta": 611, "bracketleft": 333, "therefore": 863, "bracketright": 333, "perpendicular": 658, "underscore": 500, "radicalex": 500, "alpha": 631, "beta": 549, "chi": 549, "delta": 494, "epsilon": 439, "phi": 521, "gamma": 411, "eta": 603, "iota": 329, "phi1": 603, "kappa": 549, "lambda": 549, "mu": 576, "nu": 521, "omicron": 549, "pi": 549, "theta": 521, "rho": 549, "sigma": 603, "tau": 439, "upsilon": 576, "omega1": 713, "omega": 686, "xi": 493, "psi": 686, "zeta": 494, "braceleft": 480, "bar": 200, "braceright": 480, "similar": 549, "Euro": 750, "Upsilon1": 620, "minute": 247, "lessequal": 549, "fraction": 167, "infinity": 713, "florin": 500, "club": 753, "diamond": 753, "heart": 753, "spade": 753, "arrowboth": 1042, "arrowleft": 987, "arrowup": 603, "arrowright": 987, "arrowdown": 603, "degree": 400, "plusminus": 549, "second": 411, "greaterequal": 549, "multiply": 549, "proportional": 713, "partialdiff": 494, "bullet": 460, "divide": 549, "notequal": 549, "equivalence": 549, "approxequal": 549, "ellipsis": 1000, "arrowvertex": 603, "arrowhorizex": 1000, "carriagereturn": 658, "aleph": 823, "Ifraktur": 686, "Rfraktur": 795, "weierstrass": 987, "circlemultiply": 768, "circleplus": 768, "emptyset": 823, "intersection": 768, "union": 768, "propersuperset": 713, "reflexsuperset": 713, "notsubset": 713, "propersubset": 713, "reflexsubset": 713, "element": 713, "notelement": 713, "angle": 768, "gradient": 713, "registerserif": 790, "copyrightserif": 790, "trademarkserif": 890, "product": 823, "radical": 549, "dotmath": 250, "logicalnot": 713, "logicaland": 603, "logicalor": 603, "arrowdblboth": 1042, "arrowdblleft": 987, "arrowdblup": 603, "arrowdblright": 987, "arrowdbldown": 603, "lozenge": 494, "angleleft": 329, "registersans": 790, "copyrightsans": 790, "trademarksans": 786, "summation": 713, "parenlefttp": 384, "parenleftex": 384, "parenleftbt": 384, "bracketlefttp": 384, "bracketleftex": 384, "bracketleftbt": 384, "bracelefttp": 494, "braceleftmid": 494, "braceleftbt": 494, "braceex": 494, "angleright": 329, "integral": 274, "integraltp": 686, "integralex": 686, "integralbt": 686, "parenrighttp": 384, "parenrightex": 384, "parenrightbt": 384, "bracketrighttp": 384, "bracketrightex": 384, "bracketrightbt": 384, "bracerighttp": 494, "bracerightmid": 494, "bracerightbt": 494, "apple": 790},
```

```go
"Times-Bold": {
		types.NewRectangle(-168.0, -218.0, 1000.0, 935.0),
```

--------------------------------

### Get FontObject subtype

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the SubType of this font.

```go
func (fo FontObject) SubType() string
```

--------------------------------

### Get FontObject encoding

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the Encoding of this font.

```go
func (fo FontObject) Encoding() string
```

--------------------------------

### Initialize AES Configuration

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Creates a default configuration for AES encryption.

```go
func NewAESConfiguration(userPW, ownerPW string, keyLength int) *Configuration
```

--------------------------------

### Create Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Renders page content based on JSON declarations.

```go
func Create(cmd *Command) ([]string, error)
```

--------------------------------

### CreateDemoXRef

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Creates a minimal single page PDF file for demo purposes.

```go
func CreateDemoXRef() (*model.XRefTable, error)
```

--------------------------------

### Get Encryption Dictionary

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the encryption dictionary from the catalog.

```go
func (xRefTable *XRefTable) EncryptDict() (types.Dict, error)
```

--------------------------------

### Import Bookmarks Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to import bookmarks into a PDF file.

```go
func ImportBookmarksCommand(inFile, inFileJSON, outFile string, replace bool, conf *model.Configuration) *Command
```

--------------------------------

### Create a new TextAnnotation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Initializes a new text annotation instance.

```go
func NewTextAnnotation(
	rect types.Rectangle,
	apObjNr int,
	contents, id string,
	modDate string,
	f AnnotationFlags,
	col *color.SimpleColor,
	title string,
	popupIndRef *types.IndirectRef,
	ca *float64,
	rc, subject string,
	borderRadX float64,
	borderRadY float64,
	borderWidth float64,

	displayOpen bool,
	name string) TextAnnotation
```

--------------------------------

### Get StringLiteral Value

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/types

Returns the string value of the literal.

```go
func (stringliteral StringLiteral) String() string
```

```go
func (stringliteral StringLiteral) Value() string
```

--------------------------------

### Initialize New Context

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Initializes a new processing context.

```go
func NewContext(rs io.ReadSeeker, conf *Configuration) (*Context, error)
```

--------------------------------

### Page Layout and Optimization Commands

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Commands for N-up rendering, poster cutting, and file optimization.

```go
func NDownCommand(inFile, outDir, outFile string, pageSelection []string, n int, cut *model.Cut, conf *model.Configuration) *Command
```

```go
func NUpCommand(inFiles []string, outFile string, pageSelection []string, nUp *model.NUp, conf *model.Configuration) *Command
```

```go
func OptimizeCommand(inFile, outFile string, conf *model.Configuration) *Command
```

```go
func PosterCommand(inFile, outDir, outFile string, pageSelection []string, cut *model.Cut, conf *model.Configuration) *Command
```

--------------------------------

### Get Destination Name

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the destination name associated with an object.

```go
func (xRefTable *XRefTable) DestName(obj types.Object) (string, error)
```

--------------------------------

### Initialize RC4 Configuration

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Creates a default configuration for RC4 encryption.

```go
func NewRC4Configuration(userPW, ownerPW string, keyLength int) *Configuration
```

--------------------------------

### Create a new TextMarkupAnnotation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Initializes a new text markup annotation instance.

```go
func NewTextMarkupAnnotation(
	subType AnnotationType,
	rect types.Rectangle,
	apObjNr int,
	contents, id string,
	modDate string,
	f AnnotationFlags,
	col *color.SimpleColor,
	borderRadX float64,
	borderRadY float64,
	borderWidth float64,
	title string,
	popupIndRef *types.IndirectRef,
	ca *float64,
	rc, subject string,
```

--------------------------------

### CreateCommand

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to create a PDF file.

```go
func CreateCommand(inFilePDF, inFileJSON, outFilePDF string, conf *model.Configuration) *Command
```

--------------------------------

### Get TrustDetails String Representation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the string representation of TrustDetails.

```go
func (td TrustDetails) String() string
```

--------------------------------

### Get FontObject string representation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the string value of fo.

```go
func (fo FontObject) String() string
```

--------------------------------

### Get StreamDict Image

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/types

Retrieves the image stream dictionary data.

```go
func (sd StreamDict) Image() bool
```

--------------------------------

### Load Certificates from File

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Loads certificates from a specified filename.

```go
func LoadCertificatesFile(filename string) ([]*x509.Certificate, error)
```

--------------------------------

### ListBox Creation and Configuration

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/primitives

Initializes a new listbox and sets its font ID.

```go
func NewListBox(
	ctx *model.Context,
	d types.Dict,
	opts []string,
	ind types.Array,
	da *string,
	fonts map[string]types.IndirectRef) (*ListBox, *types.IndirectRef, error)
```

```go
func (lb *ListBox) SetFontID(s string)
```

--------------------------------

### Get font widths

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/font

Returns the value for Widths in a TrueType FontDict.

```go
func Widths(xRefTable *model.XRefTable, ttf font.TTFLight, first, last int) (*types.IndirectRef, error)
```

--------------------------------

### Get script for encoding

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/font

Returns the script associated with a specific encoding.

```go
func ScriptForEncoding(enc string) string
```

--------------------------------

### Bind viewer preferences

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Writes viewer preferences into the root catalog.

```go
func (xRefTable *XRefTable) BindViewerPreferences()
```

--------------------------------

### InspectCertificates CLI function

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Prints detailed information about certificates.

```go
func InspectCertificates(cmd *Command) ([]string, error)
```

--------------------------------

### Get PDF Version

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the PDF version of the writer that created the file.

```go
func (xRefTable *XRefTable) Version() Version
```

--------------------------------

### Initialize WriteContext

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Creates a new WriteContext instance for managing PDF file writing.

```go
func NewWriteContext(eol string) *WriteContext
```

--------------------------------

### Get EOL String

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns a string representation for the end-of-line character in effect.

```go
func (c *Configuration) EolString() string
```

--------------------------------

### Import Certificates Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to import certificates.

```go
func ImportCertificatesCommand(inFiles []string, conf *model.Configuration) *Command
```

--------------------------------

### Get Permissions

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Retrieves lists of set permissions from a context or integer value.

```go
func Permissions(ctx *model.Context) (list []string)
```

```go
func PermissionsList(p int) (list []string)
```

--------------------------------

### Get CLI Command Help

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu

Access help documentation for specific commands.

```bash
pdfcpu [command] --help
```

--------------------------------

### Configure Image N-Up

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Returns an NUp configuration for Nup-ing image files.

```go
func ImageNUpConfig(val int, desc string, conf *model.Configuration) (*model.NUp, error)
```

--------------------------------

### Import Configuration Functions

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Functions for retrieving default import settings, parsing command strings, and string representation of the Import struct.

```go
func DefaultImportConfig() *Import
```

```go
func ParseImportDetails(s string, u types.DisplayUnit) (*Import, error)
```

```go
func (imp Import) String() string
```

--------------------------------

### Get string representation of TTFLight

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/font

Returns the string representation of the TTFLight object.

```go
func (fd TTFLight) String() string
```

--------------------------------

### AddPropertiesCommand

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to add document properties.

```go
func AddPropertiesCommand(inFile, outFile string, properties map[string]string, conf *model.Configuration) *Command
```

--------------------------------

### Create Empty Page

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Creates a new empty page with the specified parent reference and media box.

```go
func (xRefTable *XRefTable) EmptyPage(parentIndRef *types.IndirectRef, mediaBox *types.Rectangle, objNr int) (*types.IndirectRef, error)
```

--------------------------------

### Check font support

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/font

Verifies if a font is a core font or an installed user font.

```go
func SupportedFont(fontName string) bool
```

--------------------------------

### Command Creation Functions

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Helper functions to instantiate specific commands for attachment management.

```go
func AddAttachmentsCommand(inFile, outFile string, fileNames []string, conf *model.Configuration) *Command
```

```go
func AddAttachmentsPortfolioCommand(inFile, outFile string, fileNames []string, conf *model.Configuration) *Command
```

--------------------------------

### EnsureDefaultConfigAt

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Loads or creates the default configuration file at the specified path.

```go
func EnsureDefaultConfigAt(path string, override bool) error
```

--------------------------------

### Manage configuration and metadata

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Utility functions to remove metadata keywords, reset certificates, or reset the default configuration.

```go
func RemoveKeywords(metadata *[]byte) error
```

```go
func ResetCertificates() error
```

```go
func ResetConfig() error
```

--------------------------------

### Get Default ViewerPreferences

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns the default viewer preferences for a given PDF version.

```go
func DefaultViewerPreferences(version Version) *ViewerPreferences
```

--------------------------------

### EncryptCommand

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to encrypt a file.

```go
func EncryptCommand(inFile, outFile string, conf *model.Configuration) *Command
```

--------------------------------

### Create new FreeTextAnnotation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Initializes a new FreeTextAnnotation.

```go
func NewFreeTextAnnotation(
	rect types.Rectangle,
	apObjNr int,
	contents, id string,
	modDate string,
	f AnnotationFlags,
	col *color.SimpleColor,
	title string,
	popupIndRef *types.IndirectRef,
	ca *float64,
	rc, subject string,
```

--------------------------------

### Get FontObject resource names

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns a string representation of all the resource names of this font.

```go
func (fo FontObject) ResourceNamesString() string
```

--------------------------------

### Get Validation Mode String

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns a string representation for the validation mode in effect.

```go
func (c *Configuration) ValidationModeString() string
```

--------------------------------

### Configure Image Grid

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Returns a grid configuration for Nup-ing image files.

```go
func ImageGridConfig(rows, cols int, desc string, conf *model.Configuration) (*model.NUp, error)
```

--------------------------------

### List Document Info

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Returns formatted information about the context.

```go
func ListInfo(info *PDFInfo, selectedPages types.IntSet, fonts bool) ([]string, error)
```

--------------------------------

### Get PDF String Representation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/types

Returns the string representation as it appears in a PDF file.

```go
func (stringliteral StringLiteral) PDFString() string
```

--------------------------------

### Set Viewer Preferences Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to set the viewer preferences using a JSON configuration.

```go
func SetViewerPreferencesCommand(inFilePDF, inFileJSON, outFilePDF, stringJSON string, conf *model.Configuration) *Command
```

--------------------------------

### Apply N-Up Tiling

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Applies N-Up tiles from a PDF.

```go
func (ctx *Context) NUpTilePDFBytesForPDF(
	pageNr int,
	formsResDict types.Dict,
	buf *bytes.Buffer,
	rDest *types.Rectangle,
	nup *NUp,
	rotate bool) error
```

--------------------------------

### Get font resources

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/font

Returns a font resource dictionary for a given font map.

```go
func FontResources(xRefTable *model.XRefTable, fm model.FontMap) (types.Dict, error)
```

--------------------------------

### PDF Creation Functions

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/api

Functions for rendering PDF structures and managing font demo files.

```go
func Create(rs io.ReadSeeker, rd io.Reader, w io.Writer, conf *model.Configuration) (err error)
```

```go
func CreateCheatSheetsUserFonts(fontNames []string) error
```

```go
func CreateFile(inFilePDF, inFileJSON, outFilePDF string, conf *model.Configuration) (err error)
```

```go
func CreatePDFFile(xRefTable *model.XRefTable, outFile string, conf *model.Configuration) error
```

```go
func CreateUserFontDemoFiles(dir, fn string) error
```

--------------------------------

### Get glyph IDs

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/font

Returns the glyph IDs for a string using the specified font.

```go
func (fd TTFLight) Gids() []int
```

--------------------------------

### Retrieve PDF Page Mode

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/api

Functions to get the page mode from a ReadSeeker or a file path.

```go
func PageMode(rs io.ReadSeeker, conf *model.Configuration) (pm *model.PageMode, err error)
```

```go
func PageModeFile(inFile string, conf *model.Configuration) (*model.PageMode, error)
```

--------------------------------

### List Page Layout Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to list the document page layout.

```go
func ListPageLayoutCommand(inFile string, conf *model.Configuration) *Command
```

--------------------------------

### Dispatch Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Executes a generic pdfcpu command.

```go
func Dispatch(cmd *Command) (out []string, err error)
```

--------------------------------

### Get Page Number from Destination

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Retrieves the page number associated with a specific destination object.

```go
func PageNrFromDestination(ctx *model.Context, dest types.Object) (int, error)
```

--------------------------------

### Get Form Fields and Metadata

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/form

Returns all form fields present in the context along with their metadata.

```go
func FormFields(ctx *model.Context) ([]Field, *FieldMeta, error)
```

--------------------------------

### Get PDF document encoding

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/font

Returns an indirect reference to a new PDF document encoding dictionary.

```go
func PDFDocEncoding(xRefTable *model.XRefTable) (*types.IndirectRef, error)
```

--------------------------------

### Manage free object list and PDF version

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Methods to navigate the free object list and check PDF version compatibility.

```go
func (xRefTable *XRefTable) NextForFree(objNr int) (int, error)
```

```go
func (xRefTable *XRefTable) PDF20() bool
```

--------------------------------

### Create stream and file specification dictionaries

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Methods for creating embedded files, sound streams, and general stream dictionaries.

```go
func (xRefTable *XRefTable) NewEmbeddedFileStreamDict(filename string) (*types.IndirectRef, error)
```

```go
func (xRefTable *XRefTable) NewEmbeddedStreamDict(r io.Reader, modDate time.Time) (*types.IndirectRef, error)
```

```go
func (xRefTable *XRefTable) NewFileSpecDict(f, uf, desc string, indRefStreamDict types.IndirectRef) (types.Dict, error)
```

```go
func (xRefTable *XRefTable) NewFileSpecDictForAttachment(a Attachment) (types.Dict, error)
```

```go
func (xRefTable *XRefTable) NewSoundStreamDict(filename string, samplingRate int, fileSpecDict types.Dict) (*types.IndirectRef, error)
```

```go
func (xRefTable *XRefTable) NewStreamDictForBuf(buf []byte) (*types.StreamDict, error)
```

```go
func (xRefTable *XRefTable) NewStreamDictForFile(filename string) (*types.StreamDict, error)
```

--------------------------------

### Retrieve font information

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/font

Functions to get bounding boxes, character widths, and lists of available fonts.

```go
func BoundingBox(fontName string) *types.Rectangle
```

```go
func CharWidth(fontName string, r rune) int
```

```go
func CoreFontNames() []string
```

--------------------------------

### Panic.Unwrap method signature

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/fault

Allows standard library errors.Is/As to work.

```go
func (p Panic) Unwrap() error
```

--------------------------------

### Get font bounding box

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/font

Returns the bounding box for a font at a specific size in user space coordinates.

```go
func UserSpaceFontBBox(fontName string, fontSize int) *types.Rectangle
```

--------------------------------

### NUp Configuration and Methods

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Configuration structure and helper methods for N-Up page layout commands.

```go
type NUp struct {
	PageDim         *types.Dim         // Page dimensions in display unit.
	PageSize        string             // Paper size eg. A4L, A4P, A4(=default=A4P), see paperSize.go
	UserDim         bool               // true if one of dimensions or paperSize provided overriding the default.
	Orient          orientation        // One of rd(=default),dr,ld,dl - grid orientation
	Enforce         bool               // enforce best-fit orientation of individual content on grid.
	Grid            *types.Dim         // Intra page grid dimensions eg (2,2)
	PageGrid        bool               // Create a m x n grid of pages for PDF inputfiles only (think "extra page n-Up").
	ImgInputFile    bool               // Process image or PDF input files.
	Margin          float64            // Cropbox for n-Up content.
	Border          bool               // Draw bounding box.
	BorderOnCropbox *BorderStyling     // Draw bounding box around crop box.
	BookletGuides   bool               // Draw folding and cutting lines.
	MultiFolio      bool               // Render booklet as sequence of folios.
	FolioSize       int                // Booklet multifolio folio size: default: 8
	BookletType     BookletType        // Is this a booklet or booklet cover layout
	BookletBinding  BookletBinding     // Does the booklet have short or long-edge binding
	InpUnit         types.DisplayUnit  // input display unit.
	BgColor         *color.SimpleColor // background color
}
```

```go
func DefaultNUpConfig() *NUp
```

```go
func (nup NUp) IsBooklet() bool
```

```go
func (nup NUp) IsTopFoldBinding() bool
```

```go
func (nup NUp) N() int
```

```go
func (nup NUp) RectsForGrid() []*types.Rectangle
```

--------------------------------

### Define N-Up Configuration Variables

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Configuration slices for N-Up layout operations.

```go
var (
	NUpValues = []int{2, 3, 4, 6, 8, 9, 12, 16}
)
```

```go
var NUpValuesForBooklets = []int{2, 4, 6, 8}
```

--------------------------------

### Get Preferred Certificate Revocation Checker String

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns a string representation for the preferred certificate revocation checker in effect.

```go
func (c *Configuration) PreferredCertRevocationCheckerString() string
```

--------------------------------

### Bookmarks

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Returns all ctx bookmark information recursively.

```go
func Bookmarks(ctx *model.Context) ([]Bookmark, error)
```

--------------------------------

### Append pages to the page tree

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Appends pages from a context to the page tree root starting at a specific page number.

```go
func (xRefTable *XRefTable) AppendPages(rootPageIndRef *types.IndirectRef, fromPageNr int, ctx *Context) (int, error)
```

--------------------------------

### List Annotations Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to list annotations for selected pages.

```go
func ListAnnotationsCommand(inFile string, pageSelection []string, conf *model.Configuration) *Command
```

--------------------------------

### Resize Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to scale selected pages.

```go
func ResizeCommand(inFile, outFile string, pageSelection []string, resize *model.Resize, conf *model.Configuration) *Command
```

--------------------------------

### Dump Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Outputs object information to standard output.

```go
func Dump(cmd *Command) ([]string, error)
```

--------------------------------

### List Keywords Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to list keywords in a PDF.

```go
func ListKeywordsCommand(inFile string, conf *model.Configuration) *Command
```

--------------------------------

### Create New N-Up Page for Image

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Creates a new page dictionary in the xRefTable for a given image filename and n-up configuration.

```go
func NewNUpPageForImage(xRefTable *model.XRefTable, fileName string, parentIndRef *types.IndirectRef, nup *model.NUp) (*types.IndirectRef, error)
```

--------------------------------

### Create New UnderlineAnnotation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Initializes a new underline annotation with specified parameters.

```go
func NewUnderlineAnnotation(
	rect types.Rectangle,
	apObjNr int,
	contents, id string,
	modDate string,
	f AnnotationFlags,
	col *color.SimpleColor,
	borderRadX float64,
	borderRadY float64,
	borderWidth float64,
	title string,
	popupIndRef *types.IndirectRef,
	ca *float64,
	rc, subject string,

	quad types.QuadPoints) UnderlineAnnotation
```

--------------------------------

### Inspect Certificates Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to inspect certificates.

```go
func InspectCertificatesCommand(inFiles []string, conf *model.Configuration) *Command
```

--------------------------------

### Info Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to output information about a PDF file.

```go
func InfoCommand(inFiles []string, pageSelection []string, fonts, json bool, conf *model.Configuration) *Command
```

--------------------------------

### Global Configuration Variables

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Variables defining trusted certificate locations, user certificate pools, and the current library version.

```go
var TrustedCertDir string
```

```go
var UserCertPool *x509.CertPool
```

```go
var VersionStr = "v0.13.0 dev"
```

--------------------------------

### CropCommand

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to apply a cropBox to selected pages.

```go
func CropCommand(inFile, outFile string, pageSelection []string, box *model.Box, conf *model.Configuration) *Command
```

--------------------------------

### Configure Image Booklet

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Returns an NUp configuration for booklet-ing image files.

```go
func ImageBookletConfig(val int, desc string, conf *model.Configuration) (*model.NUp, error)
```

--------------------------------

### Parse page configuration string

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Converts a configuration string and display unit into a PageConfiguration structure.

```go
func ParsePageConfiguration(s string, u types.DisplayUnit) (*PageConfiguration, error)
```

--------------------------------

### List Fonts Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Returns a list of supported fonts.

```go
func ListFontsCommand(conf *model.Configuration) *Command
```

--------------------------------

### List Images Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to list images for selected pages.

```go
func ListImagesCommand(inFiles []string, pageSelection []string, conf *model.Configuration) *Command
```

--------------------------------

### Define ConfigPath variable

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Sets the configuration directory path, with 'default' and 'disable' as special values.

```go
var ConfigPath string = "default"
```

--------------------------------

### ExportBookmarksCommand

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to export bookmarks of a file.

```go
func ExportBookmarksCommand(inFile, outFileJSON string, conf *model.Configuration) *Command
```

--------------------------------

### Retrieve catalog

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Returns a pointer to the root object or catalog.

```go
func (xRefTable *XRefTable) Catalog() (types.Dict, error)
```

--------------------------------

### CreateContext

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Creates a Context for a given cross reference table and configuration.

```go
func CreateContext(xRefTable *model.XRefTable, conf *model.Configuration) *model.Context
```

--------------------------------

### Import Images Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to import images into a PDF.

```go
func ImportImagesCommand(imageFiles []string, outFile string, imp *pdfcpu.Import, conf *model.Configuration) *Command
```

--------------------------------

### Set Permissions Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to add permissions to a document.

```go
func SetPermissionsCommand(inFile, outFile string, conf *model.Configuration) *Command
```

--------------------------------

### Generic Command Pattern

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/api

The standard pattern for executing pdfcpu commands, showing the relationship between file-based and stream-based functions.

```go
func CommandFile(inFile, outFile string, conf *pdf.Configuration) error
func Command(rs io.ReadSeeker, w io.Writer, conf *pdf.Configuration) error
```

--------------------------------

### Styling and Utility Functions

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/draw

Functions for configuring drawing state and rendering text separators.

```go
func HorSepLine(ii []int) string
```

```go
func SetFillColor(w io.Writer, c color.SimpleColor)
```

```go
func SetLineJoinStyle(w io.Writer, s types.LineJoinStyle)
```

```go
func SetLineWidth(w io.Writer, width float64)
```

```go
func SetStrokeColor(w io.Writer, c color.SimpleColor)
```

--------------------------------

### List Annotations

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Returns a formatted list of annotations.

```go
func ListAnnotations(annots map[int]model.PgAnnots) (int, []string, error)
```

--------------------------------

### List Bookmarks Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to list bookmarks of a PDF file.

```go
func ListBookmarksCommand(inFile string, conf *model.Configuration) *Command
```

--------------------------------

### Initialize NewLineAnnotation

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Constructor for creating a new line annotation instance.

```go
func NewLineAnnotation(
	rect types.Rectangle,
	apObjNr int,
	contents, id string,
	modDate string,
	f AnnotationFlags,
	col *color.SimpleColor,
	title string,
	popupIndRef *types.IndirectRef,
	ca *float64,
	rc, subject string,

	p1, p2 types.Point,
	beginLineEndingStyle *LineEndingStyle,
	endLineEndingStyle *LineEndingStyle,
	leaderLineLength float64,
	leaderLineOffset float64,
	leaderLineExtensionLength float64,
	intent *LineIntent,
	measure types.Dict,
	caption bool,
	captionPosTop bool,
	captionOffsetX float64,
	captionOffsetY float64,
	fillCol *color.SimpleColor,
	borderWidth float64,
	borderStyle BorderStyle) LineAnnotation
```

--------------------------------

### ListFonts CLI function

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Gathers information about supported fonts.

```go
func ListFonts(cmd *Command) ([]string, error)
```

--------------------------------

### Convert PageConfiguration to string

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Returns the string representation of the PageConfiguration instance.

```go
func (p PageConfiguration) String() string
```

--------------------------------

### Bookmark

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Represents an outline item tree.

```go
type Bookmark struct {
	Title    string             `json:"title"`
	PageFrom int                `json:"page"`
	PageThru int                `json:"-"` // for extraction only; >= pageFrom and reaches until before pageFrom of the next bookmark.
	Bold     bool               `json:"bold,omitempty"`
	Italic   bool               `json:"italic,omitempty"`
	Color    *color.SimpleColor `json:"color,omitempty"`
	Kids     []Bookmark         `json:"kids,omitempty"`
	Parent   *Bookmark          `json:"-"`
}
```

--------------------------------

### Statistics and Utility Functions

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Functions for logging statistics and caching resources.

```go
func AppendStatsFile(ctx *model.Context) error
```

```go
func CacheFormFonts(ctx *model.Context) error
```

--------------------------------

### Import Certificate

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Imports certificates from a specified file.

```go
func ImportCertificate(inFile string, overwrite bool) (int, bool, error)
```

--------------------------------

### Resize Configuration

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Configuration for resizing PDF pages.

```go
type Resize struct {
	Scale         float64            // scale factor x > 0, x > 1 enlarges, x < 1 shrinks down
	Unit          types.DisplayUnit  // display unit
	PageDim       *types.Dim         // page dimensions in display unit
	PageSize      string             // paper size eg. A2,A3,A4,Legal,Ledger,...
	EnforceOrient bool               // enforce orientation of PageDim
	UserDim       bool               // true if dimensions set by dim rather than formsize
	Border        bool               // true to render original crop box
	BgColor       *color.SimpleColor // background color
}
```

```go
func (r Resize) EnforceOrientation() bool
```

--------------------------------

### BookmarkTree

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Structure for bookmark tree.

```go
type BookmarkTree struct {
	Header    Header     `json:"header"`
	Bookmarks []Bookmark `json:"bookmarks"`
}
```

--------------------------------

### Metadata and Configuration Types

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Structs representing document metadata, layout cuts, and PDF destinations.

```go
type Creator struct {
	//XMLName xml.Name `xml:"http://purl.org/dc/elements/1.1/ creator"`
	Seq Seq `xml:"http://www.w3.org/1999/02/22-rdf-syntax-ns# Seq"`
}
```

```go
type Cut struct {
	Hor      []float64          // Horizontal cut points
	Vert     []float64          // Vertical cut points
	Scale    float64            // scale factor x > 1 (poster)
	PageSize string             // paper/form size eg. A2,A3,A4,Legal,Ledger,...
	PageDim  *types.Dim         // page dimensions in display unit
	Unit     types.DisplayUnit  // display unit
	UserDim  bool               // true if dimensions set by dim rather than formsize
	Border   bool               // true to render crop box
	Margin   float64            // glue area in display unit
	BgColor  *color.SimpleColor // background color
	Origin   types.Corner       // one of 4 page corners, default = UpperLeft
}
```

```go
type Desc struct {
	//XMLName xml.Name `xml:"http://purl.org/dc/elements/1.1/ description"`
	Alt Alt `xml:"http://www.w3.org/1999/02/22-rdf-syntax-ns# Alt"`
}
```

```go
type Description struct {
	//XMLName      xml.Name `xml:"http://www.w3.org/1999/02/22-rdf-syntax-ns# Description"`
	Title        Title    `xml:"http://purl.org/dc/elements/1.1/ title"`
	Author       Creator  `xml:"http://purl.org/dc/elements/1.1/ creator"`
	Subject      Desc     `xml:"http://purl.org/dc/elements/1.1/ description"`
	Creator      string   `xml:"http://ns.adobe.com/xap/1.0/ CreatorTool"`
	CreationDate UserDate `xml:"http://ns.adobe.com/xap/1.0/ CreateDate"`
	ModDate      UserDate `xml:"http://ns.adobe.com/xap/1.0/ ModifyDate"`
	Producer     string   `xml:"http://ns.adobe.com/pdf/1.3/ Producer"`
	Trapped      bool     `xml:"http://ns.adobe.com/pdf/1.3/ Trapped"`
	Keywords     string   `xml:"http://ns.adobe.com/pdf/1.3/ Keywords"`
}
```

```go
type Destination struct {
	Typ                      DestinationType
	PageNr                   int
	Left, Bottom, Right, Top int
	Zoom                     float32
}
```

--------------------------------

### BookletCommand

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to render PDFs or image files in booklet fashion.

```go
func BookletCommand(inFiles []string, outFile string, pageSelection []string, nup *model.NUp, conf *model.Configuration) *Command
```

--------------------------------

### ImportCertificates CLI function

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Imports certificates into the configuration.

```go
func ImportCertificates(cmd *Command) ([]string, error)
```

--------------------------------

### Set Page Layout Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to set the document page layout.

```go
func SetPageLayoutCommand(inFile, outFile, value string, conf *model.Configuration) *Command
```

--------------------------------

### CreateXRefTableWithRootDict

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Creates an x ref table with a root dictionary.

```go
func CreateXRefTableWithRootDict() (*model.XRefTable, error)
```

--------------------------------

### ListInfo CLI function

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Gathers general information about a PDF file.

```go
func ListInfo(cmd *Command) ([]string, error)
```

--------------------------------

### Create a PDF page dictionary

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/create

Generates a page dictionary for a given page model.

```go
func CreatePage(
	xRefTable *model.XRefTable,
	parentPageIndRef types.IndirectRef,
	p *model.Page,
	fonts model.FontMap) (*types.IndirectRef, types.Dict, error)
```

--------------------------------

### AddKeywordsCommand

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a command to add keywords to a PDF.

```go
func AddKeywordsCommand(inFile, outFile string, keywords []string, conf *model.Configuration) *Command
```

--------------------------------

### CreateResourceDictInheritanceDemoXRef

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Creates a page tree for testing resource dict inheritance.

```go
func CreateResourceDictInheritanceDemoXRef() (*model.XRefTable, error)
```

--------------------------------

### Collect Command

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/cli

Creates a custom page sequence from selected pages.

```go
func Collect(cmd *Command) ([]string, error)
```

--------------------------------

### ViewerPreferences Setter Methods

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Methods to configure specific viewer preference settings.

```go
func (*ViewerPreferences) SetCenterWindow(val bool)
```

```go
func (*ViewerPreferences) SetDisplayDocTitle(val bool)
```

```go
func (*ViewerPreferences) SetFitWindow(val bool)
```

```go
func (*ViewerPreferences) SetHideMenuBar(val bool)
```

```go
func (*ViewerPreferences) SetHideToolBar(val bool)
```

```go
func (*ViewerPreferences) SetHideWindowUI(val bool)
```

```go
func (*ViewerPreferences) SetNumCopies(i int)
```

```go
func (*ViewerPreferences) SetPickTrayByPDFSize(val bool)
```

--------------------------------

### CreateTestPageContent

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu

Draws a test grid on the provided page.

```go
func CreateTestPageContent(p model.Page)
```

--------------------------------

### Configuration Structure

Source: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model

Defines the global configuration settings for PDF processing.

```go
type Configuration struct {
	// Location of corresponding config.yml
	Path string

	CreationDate string

	Version string

	// Ensure .pdf input file extension.
	CheckFileNameExt bool

	// Enable PDF V1.5 compatible processing of object streams, xref streams, hybrid PDF files.
	Reader15 bool

	// Enable decoding of all streams (fontfiles, images..) for logging purposes.
	DecodeAllStreams bool

	// Validate against ISO-32000: strict or relaxed.
	ValidationMode int

	// Enable validation right before writing.
	PostProcessValidate bool

	// Check for broken links in LinkedAnnotations/URIActions.
	ValidateLinks bool

	// End of line char sequence for writing.
	Eol string

	// Turn on object stream generation.
	// A signal for compressing any new non-stream-object into an object stream.
	// true enforces WriteXRefStream to true.
	// false does not prevent xRefStream generation.
	WriteObjectStream bool

	// Switch between xRefSection (<=V1.4) and objectStream/xRefStream (>=V1.5) writing.
	WriteXRefStream bool

	// CSV filename holding input file statistics.
	StatsFileName string

	// Supplied user password.
	UserPW    string
	UserPWNew *string

	// Supplied owner password.
	OwnerPW    string
	OwnerPWNew *string

	// Supplied private key password.
	PrivateKeyPW string

	// EncryptUsingAES ensures AES encryption.
	// true: AES encryption
	// false: RC4 encryption.
	EncryptUsingAES bool

	// AES:40,128,256 RC4:40,128
	EncryptKeyLength int

	// Supplied user access permissions, see Table 22.
	Permissions PermissionFlags // int16

	// Command being executed.
	Cmd CommandMode

	// Display unit in effect.
	Unit types.DisplayUnit

	// Timestamp format.
	TimestampFormat string

	// Date format.
	DateFormat string

	// Optimize after reading and validating the xreftable but before processing.
	Optimize bool

	// Optimize after processing but before writing.
	// TODO add to config.yml
	OptimizeBeforeWriting bool

	// Optimize page resources via content stream analysis. (assuming Optimize == true || OptimizeBeforeWriting == true)
	OptimizeResourceDicts bool

	// Optimize duplicate content streams across pages. (assuming Optimize == true || OptimizeBeforeWriting == true)
	OptimizeDuplicateContentStreams bool

	// Merge creates bookmarks.
	CreateBookmarks bool

	// MergeBookmarkMode controls how merge creates or preserves bookmarks.
	// This is a runtime option and is not read from config.yml.
	MergeBookmarkMode MergeBookmarkMode

	// PDF Viewer is expected to supply appearance streams for form fields.
	NeedAppearances bool

	// Internet availability.
	Offline bool

	// HTTP timeout in seconds.
	Timeout int
}
```
Tokens:
Raw