FME Transformers: 2026.3

Categories
Cartography and Reports

Cartography and Reports

Categories
Cartography and Reports

Cartography and Reports

DocumentStyler

Prepares features for output to the OpenDocument Text Writer by applying styling with format-specific attributes.

Jump to Configuration

Typical Uses

  • Styling document output

How does it work?

The DocumentStyler styles features for output via the OpenDocument Text Writer.

Styles are available for:

  • Heading
  • Image
  • List
  • Page Break
  • Paragraph
  • Table

Optional Input Port

This transformer has two modes, depending on whether a connector is attached to the Input port or not:

  • Input-driven: When input features are connected, the transformer runs once for each feature it receives in the Input port.
  • Run Once: When no input features are connected, the transformer runs one time.

Usage Notes

Configuration

Input Ports

This transformer accepts any feature.

Output Ports

Features with styling applied as specified in parameters.

Parameters

Content Type

Select the content type to apply:

  • Heading
  • Image
  • List
  • Page Break
  • Paragraph
  • Table

Format attribute set: fme_doc_type

Heading

Text

Provide the heading text.

Format attribute set: fme_doc_heading_text

Heading Level

Select a heading level to apply to the text, between 1 and 10.

Format attribute set: fme_doc_heading_level

Styling

Font

Specify the font name, style, size, and any effects (strikeout, underline) to apply to the text.

Fonts can be selected from the font picker via the ellipsis button, or provided as a string. String syntax is:

<font name>,<font size>,<font style>,<font effects>

All components are comma-separated, as in these examples:

Arial,75

Arial,75,BOLD

Arial,75,BOLD,ITALIC

Arial,75,BOLD,ITALIC,UNDERLINE

Arial,75,UNDERLINE

Available font styles vary by font.

If the specified font cannot be found on the system, it will default to Helvetica.

Format attributes set:

fme_doc_font_name

fme_doc_font_size

fme_doc_font_bold

fme_doc_font_italic

fme_doc_font_underline

fme_doc_font_strikethrough

Font Color

Specify the color of the text foreground.

Specifying Colors

Colors may be entered directly or chosen from the color picker via the ellipsis button.

Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1).

In the case of (1,1,1) which is valid for both 24-bit and decimal, the decimal interpretation (white) is generally used when specifying colors*.

Hex codes are accepted with or without a hash sign (#).

 

24-bit RGB

Decimal RGB

Hex code

0,0,0

0,0,0

#000000

255,0,0

1,0,0

#FF0000

202,173,232

0.79,0.68,0.91

#CAADE8

255,255,255

1,1,1

#FFFFFF

* Color interpretation may vary in other contexts such as raster bands and palettes.

Format attribute set: fme_doc_font_color

Alignment

Select the alignment to apply to the element:

  • Left Justified: Aligns text to the left margin, with a ragged right edge
  • Centered: Aligns text in the middle, with ragged left and right edges
  • Right Justified: Aligns text to the right margin, with a ragged left edge
  • Fully Justified: Aligns text evenly along both left and right margins, adjusting spacing between words.

Format attribute set: fme_doc_justification

Use Markdown

If the Text contains markdown formatting such as bold, italic, underline, strikethrough, or links, select Yes to have it applied.

If a font property is already set (such as bold), the corresponding markdown marker toggles that property off for the marked span.

Markdown syntax is format-specific - see OpenDocument Text Format Attributes.

Format attribute set: fme_doc_use_markdown

Image

Source

Select the image source:

  • From File: Image is provided as an external file.
  • From Feature: Image is provided as raster geometry on the feature.

Format attribute set: fme_doc_image_source

File

When Source is From File, specify the path and filename of the image.

Format attribute set: fme_doc_image_filename

Width

(Optional) Specify a fixed width to apply to the image, in the units selected in Width Unit.

Format attribute set: fme_doc_image_width

Width Units

When Image Width is specified, select the units to apply:

  • Percentages
  • Centimeters
  • Inches
  • Points

Format attribute set: fme_doc_measurement_units

Styling

Alignment

Select the alignment to apply to the element:

  • Left Justified: Aligns image to the left margin.
  • Centered: Aligns image in the middle.
  • Right Justified: Aligns image to the right margin.

Format attribute set: fme_doc_justification

Text

Provide the list item text.

Format attribute set: fme_doc_list_text

Indent Level

Specify the level of indentation to use, as in:

  1. Level 0 (Default)
    1. Level 1
      1. Level 2

If Ordered is Yes and the indent level changes, the list item count restarts at 1.

Format attribute set: fme_doc_list_level

Ordered

Select a list style:

  • Yes: Numbered.
  • No: Bulleted.

Format attribute set: fme_doc_list_ordered

Styling

Font

Specify the font name, style, size, and any effects (strikeout, underline) to apply to the text.

Fonts can be selected from the font picker via the ellipsis button, or provided as a string. String syntax is:

<font name>,<font size>,<font style>,<font effects>

All components are comma-separated, as in these examples:

Arial,75

Arial,75,BOLD

Arial,75,BOLD,ITALIC

Arial,75,BOLD,ITALIC,UNDERLINE

Arial,75,UNDERLINE

Available font styles vary by font.

If the specified font cannot be found on the system, it will default to Helvetica.

Format attributes set:

fme_doc_font_name

fme_doc_font_size

fme_doc_font_bold

fme_doc_font_italic

fme_doc_font_underline

fme_doc_font_strikethrough

Font Color

Specify the color of the text foreground.

Specifying Colors

Colors may be entered directly or chosen from the color picker via the ellipsis button.

Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1).

In the case of (1,1,1) which is valid for both 24-bit and decimal, the decimal interpretation (white) is generally used when specifying colors*.

Hex codes are accepted with or without a hash sign (#).

 

24-bit RGB

Decimal RGB

Hex code

0,0,0

0,0,0

#000000

255,0,0

1,0,0

#FF0000

202,173,232

0.79,0.68,0.91

#CAADE8

255,255,255

1,1,1

#FFFFFF

* Color interpretation may vary in other contexts such as raster bands and palettes.

Format attribute set: fme_doc_font_color

Alignment

Select the alignment to apply to the element:

  • Left Justified: Aligns text to the left margin, with a ragged right edge
  • Centered: Aligns text in the middle, with ragged left and right edges
  • Right Justified: Aligns text to the right margin, with a ragged left edge
  • Fully Justified: Aligns text evenly along both left and right margins, adjusting spacing between words.

Format attribute set: fme_doc_justification

Use Markdown

If the Text contains markdown formatting such as bold, italic, underline, strikethrough, or links, select Yes to have it applied.

If a font property is already set (such as bold), the corresponding markdown marker toggles that property off for the marked span.

Markdown syntax is format-specific - see OpenDocument Text Format Attributes.

Format attribute set: fme_doc_use_markdown

Page Break

Number of Breaks

Specify the number of page breaks to add to the document.

Format attribute set: fme_doc_break_count

Paragraph

Text

Provide the paragraph text.

Format attribute set: fme_doc_paragraph_text

Style Name

(Optional) Provide the name of a paragraph style defined in the target document’s template, such as Title or Body Text.

Format attribute set: fme_doc_paragraph_style

Styling

Font

Specify the font name, style, size, and any effects (strikeout, underline) to apply to the text.

Fonts can be selected from the font picker via the ellipsis button, or provided as a string. String syntax is:

<font name>,<font size>,<font style>,<font effects>

All components are comma-separated, as in these examples:

Arial,75

Arial,75,BOLD

Arial,75,BOLD,ITALIC

Arial,75,BOLD,ITALIC,UNDERLINE

Arial,75,UNDERLINE

Available font styles vary by font.

If the specified font cannot be found on the system, it will default to Helvetica.

Format attributes set:

fme_doc_font_name

fme_doc_font_size

fme_doc_font_bold

fme_doc_font_italic

fme_doc_font_underline

fme_doc_font_strikethrough

Font Color

Specify the color of the text foreground.

Specifying Colors

Colors may be entered directly or chosen from the color picker via the ellipsis button.

Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1).

In the case of (1,1,1) which is valid for both 24-bit and decimal, the decimal interpretation (white) is generally used when specifying colors*.

Hex codes are accepted with or without a hash sign (#).

 

24-bit RGB

Decimal RGB

Hex code

0,0,0

0,0,0

#000000

255,0,0

1,0,0

#FF0000

202,173,232

0.79,0.68,0.91

#CAADE8

255,255,255

1,1,1

#FFFFFF

* Color interpretation may vary in other contexts such as raster bands and palettes.

Format attribute set: fme_doc_font_color

Alignment

Select the alignment to apply to the element:

  • Left Justified: Aligns text to the left margin, with a ragged right edge
  • Centered: Aligns text in the middle, with ragged left and right edges
  • Right Justified: Aligns text to the right margin, with a ragged left edge
  • Fully Justified: Aligns text evenly along both left and right margins, adjusting spacing between words.

Format attribute set: fme_doc_justification

Use Markdown

If the Text contains markdown formatting such as bold, italic, underline, strikethrough, or links, select Yes to have it applied.

If a font property is already set (such as bold), the corresponding markdown marker toggles that property off for the marked span.

Markdown syntax is format-specific - see OpenDocument Text Format Attributes.

Format attribute set: fme_doc_use_markdown

Table

Table Style

(Optional) Provide the name of a table style defined in the target document’s template.

Format attribute set: fme_doc_table_style

Width Units

Select the units to use for Column Width:

  • Inches
  • Centimeters
  • Points
  • Percentages

Format attribute set: fme_doc_measurement_units

Table Data

This table specifies the columns to include in the table.

Column Header

Specify the column name to appear in the heading row.

Format attribute set: fme_doc_table_col_header

Column Value

Specify the column value or text, to be placed under the Column Header.

Format attribute set: fme_doc_table_col_value

Column Width

Specify the column width, either:

  • A positive number used in conjunction with Width Units to set this column's width, or
  • Stretch

Stretch columns all share the remaining space after columns with numeric widths are allocated.

Format attribute set: fme_doc_table_col_width

Styling

Use Markdown

If the Text contains markdown formatting such as bold, italic, underline, strikethrough, or links, select Yes to have it applied.

If a font property is already set (such as bold), the corresponding markdown marker toggles that property off for the marked span.

Markdown syntax is format-specific - see OpenDocument Text Format Attributes.

Format attribute set: fme_doc_use_markdown

Header

Font

Specify the font name, style, and any effects (strikeout, underline) to apply to the text.

Fonts can be selected from the font picker via the ellipsis button, or provided as a string.

Format attributes set:

fme_doc_font_name_header

fme_doc_font_size_header

fme_doc_font_bold_header

fme_doc_font_italic_header

fme_doc_font_underline_header

fme_doc_font_strikethrough_header

Font Color

Specify the color of the text foreground.

Specifying Colors

Colors may be entered directly or chosen from the color picker via the ellipsis button.

Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1).

In the case of (1,1,1) which is valid for both 24-bit and decimal, the decimal interpretation (white) is generally used when specifying colors*.

Hex codes are accepted with or without a hash sign (#).

 

24-bit RGB

Decimal RGB

Hex code

0,0,0

0,0,0

#000000

255,0,0

1,0,0

#FF0000

202,173,232

0.79,0.68,0.91

#CAADE8

255,255,255

1,1,1

#FFFFFF

* Color interpretation may vary in other contexts such as raster bands and palettes.

Format attribute set: fme_doc_font_color_header

Alignment

Select the alignment to apply to the element:

  • Left Justified: Aligns text to the left margin, with a ragged right edge
  • Centered: Aligns text in the middle, with ragged left and right edges
  • Right Justified: Aligns text to the right margin, with a ragged left edge
  • Fully Justified: Aligns text evenly along both left and right margins, adjusting spacing between words.

Format attribute set: fme_doc_justification

Row

Font

Specify the font name, style, and any effects (strikeout, underline) to apply to the text.

Fonts can be selected from the font picker via the ellipsis button, or provided as a string.

Format attributes set:

fme_doc_font_name_header

fme_doc_font_size_header

fme_doc_font_bold_header

fme_doc_font_italic_header

fme_doc_font_underline_header

fme_doc_font_strikethrough_header

Font Color

Specify the color of the text foreground.

Specifying Colors

Colors may be entered directly or chosen from the color picker via the ellipsis button.

Colors can be specified by RGB values or hex codes. RGB values may be either 24-bit or decimal (0 - 1).

In the case of (1,1,1) which is valid for both 24-bit and decimal, the decimal interpretation (white) is generally used when specifying colors*.

Hex codes are accepted with or without a hash sign (#).

 

24-bit RGB

Decimal RGB

Hex code

0,0,0

0,0,0

#000000

255,0,0

1,0,0

#FF0000

202,173,232

0.79,0.68,0.91

#CAADE8

255,255,255

1,1,1

#FFFFFF

* Color interpretation may vary in other contexts such as raster bands and palettes.

Format attribute set: fme_doc_font_color_header

Alignment

Select the alignment to apply to the element:

  • Left Justified: Aligns text to the left margin, with a ragged right edge
  • Centered: Aligns text in the middle, with ragged left and right edges
  • Right Justified: Aligns text to the right margin, with a ragged left edge
  • Fully Justified: Aligns text evenly along both left and right margins, adjusting spacing between words.

Format attribute set: fme_doc_justification

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters Create your own editable parameters.

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

Reference

Processing Behavior

Feature-Based

Feature Holding

No
Dependencies None
Aliases  
History  

FME Online Resources

The FME Community and Support Center Knowledge Base have a wealth of information, including active forums with 35,000+ members and thousands of articles.

Search for all results about the DocumentStyler on the FME Community.

 

Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.