OpenReport yaml structure

This page provides an overview on general structure of OpenReport yaml file, including examples and details on required and optional properties.

Back to homepage

Document

Overview

To initiate a document a "document" instance is required:

document:
  name: document.docx
  structure:
    # - document component 1 
    # - document component 2

To initiate a set of similar documents please see Document iterations.

Required properties

Properties "name" and "structure" are required.

document:
  name: document.docx
  structure:
    # - document component 1 
    # - document component 2

Property "name" is the name to be used when saving the file. A file name should contain .docx extension. A file name can't contain any of the following characters \ / : * ? \" < > | "

Optional properties

- document: 
    document_params: 
    document_styles:
    parameters:
    sources:

Back to homepage

---

Structure

Overview

The "structure" instance lists all components of the "document". The order components appear in the list reflects the order in the document.

Required properties

The "structure" instance does not have any required components.

Optional components

structure:
  - text:
  - heading:
  - table:
  - figure:
  - math_expression:
  - word_file:
  - loop:
  - bullet_list:
  - table_of_contents:
  - list_of_tables: 
  - list_of_figures:
  - page_break:

Continue to components

Back to top

Back to homepage

---