Formatting

The Formatting panel in the Advanced WYSIWYG editor provides inline and block-level formatting controls to help you style and structure your content. It is organized into two sections:

• Formatting & Lists - controls for inline text emphasis (bold, italic, underline, strikethrough), text alignment, and list indentation.
• Controls - controls for indentation, subscript, superscript, letter spacing, line height, line break, and page break.

To access the Formatting panel, click the Format icon on the right side of the editor panel.

When to use formatting elements

• Use bold to highlight key terms, warnings, or action items within a step
• Use italic to indicate UI labels, variable names, or titles referenced within prose
• Use strikethrough to mark deprecated steps or outdated values without deleting them — useful for changelog-style content
• Use subscript and superscript when documenting chemical formulas (H₂O), mathematical expressions (x²), or footnote references
• Use line break inside a list item to add a second line of explanation without creating a new bullet point
• Use page break before a major section in long articles to control PDF layout for print-ready documentation

Formatting & Lists

Bold, Italic, Underline, Strikethrough

These are inline text emphasis options applied to selected text.

To apply:

1. Select the text you want to format.
2. Click the corresponding icon in the Formatting & Lists section, or use the keyboard shortcut.

Alignment

Text alignment controls how content is positioned horizontally within a block.

To apply:

1. Click anywhere in the paragraph or select the text.
2. Click the desired alignment icon in the Formatting & Lists section.

Indentation

Indentation increases or decreases the indent level of a paragraph or list item.

To apply:

1. Click in the paragraph or list item you want to indent.
2. Click Increase indent or Decrease indent from the Formatting & Lists section, or use the keyboard shortcuts.

Controls

Subscript and Superscript

Subscript and superscript display text slightly below or above the baseline, respectively.

To apply:

1. Select the text.
2. Click Subscript or Superscript from the Controls section.

Letter spacing

Letter spacing adjusts the horizontal space between characters in selected text.

To apply:

1. Select the text.
2. Click the Letter space icon in the Controls section.
3. Choose your desired spacing value.

Line height

Line height controls the vertical spacing between lines within a paragraph.

To apply:

1. Click in the paragraph you want to adjust.
2. Click the Line height icon in the Controls section.
3. Select your desired line height value.

Line break

A line break moves the cursor to the next line within the same block, without starting a new paragraph or block.

To insert a line break:

• Click the Line break icon in the Controls section, or press Shift + Enter.

Page break

A page break specifies where the current page ends and the next page begins when exporting an article as a PDF.

To insert a page break:

1. Place your cursor at the point where you want the page to break.
2. Click the Page break icon in the Controls section.

Best practices

• Use bold and italic sparingly — overuse reduces their impact and makes content harder to scan.
• Use strikethrough instead of deleting content when you want readers to see what changed, such as in release notes or versioned procedures.
• Avoid using alignment other than left for body text — centered or justified body text is harder to read in documentation.
• Use line breaks instead of empty paragraphs to add spacing within a block, to keep the document structure clean.
• Insert page breaks intentionally in long articles before exporting as PDF, to ensure section breaks land in logical places.

FAQ