BOM Convert tool
The BOM Convert tool controls whether the output document carries a
Unicode byte-order mark. It operates on layer-start parts: when a layer
begins, the tool sets that layer's HasBOM flag, and the writer honours it
when serializing the document.
Use it to add a BOM where a downstream consumer expects one, or to strip a BOM that would otherwise interfere with parsing. The tool changes only the BOM flag on layers; it does not alter block text.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
addBOM | boolean | false | When true the Unicode BOM is added; when false it is removed |
alsoNonUTF8 | boolean | false | Also remove the BOM from UTF-16 files not just UTF-8 |
Configure these parameters interactively and copy the flow-step YAML on the Tool Reference.
Examples
Remove the BOM
Mark the document to be written without a byte-order mark.
addBOM: false
Add a BOM, including UTF-16
Ensure a BOM is present on both UTF-8 and UTF-16 output.
addBOM: true alsoNonUTF8: true
Processing notes
Operates on layer-start parts; the layer's BOM flag is set and the writer applies it.
Block, data, and media parts pass through unchanged.
← Back to the Tool Reference