Editor
The Zammad editor provides a rich text editing experience for creating articles. It should be self-explanatory and simple to use. Because of the importance of this central element in Zammad, this page covers some features which may not be visible at the first glance.
Special Functions
Zammad's editor includes some smart features. You can find them on the left side of the toolbar in the editor. Because they are already described somewhere else, we only refer to these places here to avoid duplicate content.
Pasting Complex Content
When pasting content from other sources, especially documents containing tables, complex formatting or images, be aware that the appearance in Zammad might differ. The editor attempts to preserve your formatting if possible, but inconsistencies can occur. If you face such a situation, try to copy/paste the content one by one or paste plain text and apply the formatting in the editor (see formatting section below).
Paragraphs
To separate paragraphs in the editor, use the enter key once. This gets rendered as paragraphs either with an empty line or without, depending on the recipient's used software. If you add an additional empty line, this can get rendered as two empty lines on client side.
Cite Text
You may want to quote text of your customer to exactly refer your answer to and your customer doesn't lose track in long conversations. To use this feature, simply select the text you want to cite and click on the reply or forward button next to the article. If you already inserted text, it gets preserved and the selected text gets inserted additionally. This means you can repeat this to cite different sections without losing your written text.
Apply Formatting
You can format text in the editor in different ways:
- Use the integrated toolbar
- Use keyboard shortcuts
- Use Markdown syntax
The editor toolbar includes buttons for common formatting tasks. Hovering over each button will display a tooltip explaining its function. As an alternative you can use keyboard shortcuts (see next two sections). For both variants you can activate a formatting option in advance and then add your text or select existing text and apply the formatting option afterwards.
General Keyboard Shortcuts
The editor also supports keyboard shortcuts to streamline your workflow. These shortcuts are common across many text processing tools. Important shortcuts are:
| Shortcut/command | Formatting |
|---|---|
| ctrl + b | Bold |
| ctrl + i | Italics |
| ctrl + u | Underline |
Have a look at the next section to use even more formatting via keyboard. Regardless if you are used to Markdown or not, some of them might still be helpful in your daily work.
Markdown Usage
For users familiar with Markdown syntax, the editor provides support for formatting content with Markdown. When using Markdown syntax, it gets immediately replaced/executed so you can see the result directly in the editor. To go back to standard text, simply use the same limiter again or use enter, depending on the option.
It is not intended to support all Markdown features, but to help users getting things done more easily. Therefore, the most important things are supported like headings, lists, links, code blocks and more. Have a look at the non-exhaustive formatting examples below.
| Markdown Syntax | Formatting |
|---|---|
** | Limiter for bold |
_ | Limiter for italics |
#, ##, ### | Heading, level depending on number of # |
> | Quoted |
` | Limiter for inline code |
``` | Code block |
--- | Horizontal line as divider |