Skip to main content

Plain Text Template

PlainTextTemplate

Generates plain text files using Apache Freemarker templates.

Description​

A Reporter that creates plain text files using Apache Freemarker templates. For each template provided in the config, a separate output file is created. If no templates are provided, the "NOTICE_DEFAULT" template is used. The name of the template id or template path (without extension) is used for the generated file, so be careful to not use two different templates with the same name.

Configuration​

Example​

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

ort:
  reporter:
    reporters:
      PlainTextTemplate:
        options:
          templateIds: <OPTIONAL_STRING_LIST>
          templatePaths: <OPTIONAL_STRING_LIST>

Options​

templateIds​

STRING_LIST

Alias: template.id

A comma-separated list of IDs of templates provided by ORT. Currently, only the "NOTICE_DEFAULT" and "NOTICE_SUMMARY" templates are available. If no template id or path is provided, the "NOTICE_DEFAULT" template is used.

templatePaths​

STRING_LIST

Alias: template.path

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