PdfParams (Fake)

6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See

DocFx.PdfParams Type

Namespace: Fake.Documentation
Assembly: Fake.Documentation.DocFx.dll
Parent Module: DocFx
Base Type: obj
All Interfaces: IEquatable<PdfParams> , IStructuralEquatable , IComparable<PdfParams> , IComparable , IStructuralComparable

Pdf-Command parameters

Record fields

Record Field	Description
`BasePath` Full Usage: `BasePath` Field type: `string`	Specify the base path to generate external link, {host}/{locale}/{basePath}. Field type: `string`
`BuildParams` Full Usage: `BuildParams` Field type: `BuildParams`	Specify build parameters. Field type: `BuildParams`
`CssFilePath` Full Usage: `CssFilePath` Field type: `string`	Specify the path for the css to generate pdf, default value is styles/default.css. Field type: `string`
`ExcludedTocs` Full Usage: `ExcludedTocs` Field type: `string list`	Specify the toc files to be excluded. Field type: `string list`
`GeneratesAppendices` Full Usage: `GeneratesAppendices` Field type: `bool option`	Specify whether or not to generate appendices for not-in-TOC articles. Field type: `bool option`
`GeneratesExternalLink` Full Usage: `GeneratesExternalLink` Field type: `bool option`	generatesExternalLink", HelpText = "Specify whether or not to generate external links for PDF. Field type: `bool option`
`Host` Full Usage: `Host` Field type: `string`	Specify the hostname to link not-in-TOC articles. Field type: `string`
`KeepRawFiles` Full Usage: `KeepRawFiles` Field type: `bool option`	Specify whether or not to keep the intermediate html files that used to generate the PDF file. It it usually used in debug purpose. By default the value is false. Field type: `bool option`
`LoadErrorHandling` Full Usage: `LoadErrorHandling` Field type: `string`	Specify how to handle pdf pages that fail to load: abort, ignore or skip(default abort), it is the same input as wkhtmltopdf --load-error-handling options. Field type: `string`
`Locale` Full Usage: `Locale` Field type: `string`	Specify the locale of the pdf file. Field type: `string`
`Name` Full Usage: `Name` Field type: `string`	Specify the name of the generated pdf. Field type: `string`
`RawOutputFolder` Full Usage: `RawOutputFolder` Field type: `string`	Specify the output folder for the raw files, if not specified, raw files will by default be saved to _raw subfolder under output folder if keepRawFiles is set to true. Field type: `string`

Instance members

Instance member	Description
`this.WithBuildParams` Full Usage: `this.WithBuildParams` Parameters: f : `BuildParams -> BuildParams` Returns: `PdfParams` Modifiers: inline	Changes the "BuildParams" according to the given function f : `BuildParams -> BuildParams` Returns: `PdfParams`
`this.WithCommon` Full Usage: `this.WithCommon` Parameters: f : `CommonParams -> CommonParams` Returns: `PdfParams` Modifiers: inline	Changes the "Common" parameters according to the given function f : `CommonParams -> CommonParams` Returns: `PdfParams`
`this.WithLogParams` Full Usage: `this.WithLogParams` Parameters: f : `LogParams -> LogParams` Returns: `PdfParams` Modifiers: inline	Changes the "LogParams" according to the given function f : `LogParams -> LogParams` Returns: `PdfParams`

Static members

Static member	Description
`PdfParams.Create()` Full Usage: `PdfParams.Create()` Returns: `PdfParams`	Pdf default parameters Returns: `PdfParams`