Skip to main content

PDF Template

PdfTemplate

Generates PDF from AsciiDoc files from Apache Freemarker templates.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  reporter:
    reporters:
      PdfTemplate:
        options:
          templateIds: <OPTIONAL_STRING_LIST>
          templatePaths: <OPTIONAL_STRING_LIST>
          pdfThemeFile: "uri:classloader:/pdf-theme/pdf-theme.yml"
          pdfFontsDir: "uri:classloader:/fonts"

Options​

templateIds​

STRING_LIST

Alias: template.id

A comma-separated list of IDs of templates provided by ORT. If no template id or path is provided, the "disclosure_document" template is used, and if the ORT result contains an advisor run, the "vulnerability_report" and "defect_report" templates are used as well.

templatePaths​

STRING_LIST

Alias: template.path

A comma-separated list of paths to template files provided by the user.

pdfThemeFile​

STRING Default

Alias: pdf.theme.file

The path to an AsciiDoc PDF theme file.

pdfFontsDir​

STRING Default

Alias: pdf.fonts.dir

The path to a directory containing custom fonts.