Show / Hide Table of Contents

Escaping

A few characters can not by included inside text intended for printing, due to a conflict with the markup command syntax and word wrapping features. Therefore, these can be escaped with a backslash \ character.

Escapes for character printing

Escapable print characters are:

  • Open square bracket [, to print this character please use \[
  • Closing square bracket ], to print this character please use \]
  • Backslash \, to print a backslash character please use \\
  • Space , to ensure that a space character is printed please use \ followed by a single space character.

Example:

This will print a markup command, instead of acting on it.
\[cut\]

Escaping a newline

If the \ character is used at the end of a line (i.e. immediately before a carriage return and/or line feed), then it will prevent any line break being output. This can be used to insert line breaks into your markup data without breaking word wrapping flow. This method can also be useful for placing markup commands on a single line without causing a line feed.

Example:

[align: middle]\
[barcode: type code39;
          data 123456789012;
		  height 15mm;
		  module 0;
		  hri]
[align]\
Thank you for trying the new Star Document Markup Language\
we hope you will find it useful. Please let us know!
[cut: feed; partial]
Back to top Generated by DocFX