Knowledge Base
Admin

Use callouts and tables

Edit

Callouts and tables are the two block-level formatting tools in The Editor that most beginners get stuck on. This guide explains when to reach for each, how to escape them when you're done, and a few practical conventions for keeping articles readable inside the chat-widget.

Callouts at a glance

Four variants, each with its own colour, icon, and use case.

VariantToolbarUse it forAvoid it for
Note๐Ÿ“Background context that's useful but not strictly required to follow the article.Anything time-sensitive or risky โ€” use Warning or Danger.
Tip๐Ÿ’กBest practices, productivity shortcuts, optional improvements.Mandatory steps. If it must be done, put it in the main flow.
Warningโš ๏ธOutcomes that surprise the reader (state-locking actions, asynchronous side effects, common foot-guns).Hard data-loss / irreversible operations โ€” use Danger instead.
Dangerโ—Anything that can lose data, break production, or cost money. Few articles need more than one.Decoration. If everything is Danger, nothing is.

Insert a callout

  1. Place the cursor on a paragraph (or select multiple paragraphs).
  2. Click the variant icon in the toolbar โ€” ๐Ÿ“, ๐Ÿ’ก, โš ๏ธ, or โ—.
  3. The selected content wraps in a callout block with the matching colour and icon.

To change a callout's variant, click inside it and click a different variant icon.

Escape a callout

This is the most common reason authors get stuck. Once your cursor is inside a callout, Enter keeps adding paragraphs inside the block. To break out:

  • Press Ctrl+Enter (or click the โ†ต Exit block button in the toolbar).
  • A fresh paragraph is inserted immediately after the callout, and the cursor lands in it.
  • The same shortcut works for blockquotes and code blocks.

Memorise this one. There is no other ergonomic way out.

Insert a table

  1. Place the cursor where you want the table.
  2. Click +Table in the toolbar.
  3. A 3ร—3 table inserts at the cursor with empty cells.

Fixed 3ร—3 is the default; resize via the cell menu.

Edit a table

Every action below is available via the cell menu โ€” a small floating button that appears to the right of the active cell when your cursor is inside a table.

ActionShortcut / control
Move to next cellTab
Move to previous cellShift+Tab
Insert row aboveCell menu โ†’ row above
Insert row belowCell menu โ†’ row below
Insert column leftCell menu โ†’ column left
Insert column rightCell menu โ†’ column right
Delete rowCell menu โ†’ delete row
Delete columnCell menu โ†’ delete column
Resize column widthDrag the right border of any cell

Conventions for readable tables

Every article you write is also displayed inside the chat-widget Help tab โ€” a 380 px-wide column on most screens. Tables that look fine on the public reader can horizontal-scroll painfully there.

  • Keep cells short. One sentence per cell, ideally a single phrase. Move long prose into the body around the table.
  • Maximum 4 columns. Five columns wrap into the second line; six columns are unreadable in the widget.
  • Headers should be a single word or two. "Status", "Where visible", "Set by" โ€” not "What sets this row's value in the database".
  • Wrap acronyms / IDs in code. <code>kb_article</code> keeps them on one line and visually separates them.

Don't put callouts inside callouts

The sanitiser allows it, but the result looks confusing โ€” overlapping coloured stripes, unclear hierarchy. If you find yourself nesting callouts, refactor the article: split a deep callout off into its own section, or convert the inner block to a paragraph + bold lead-in.

When not to use a callout

  • A single sentence of prose is rarely worth a callout. A bold lead-in ("Note: โ€ฆ") inside a regular paragraph reads better.
  • Lists of items. Use a bullet list, not a callout-of-bullets.
  • Reference data. Use a table, or split the data into a separate โ€ฆfield definitions article and link to it.

Related articles