The Text Editor and Its Formatting Options

The text editor in awork helps you structure content cleanly and format it quickly – directly in description fields, comments, and docs.

---

Main Benefits and Use Cases

• Cleanly structured content through headings, lists, dividers, and formatting options

• Write faster with slash commands (/) straight from your keyboard

• Collaborate in real-time through live editing in project and task descriptions

---

How to Use the Text Editor

You can use formatting in the following areas in awork:

• Docs (pages & comments) – full feature set

• Project descriptions

• Task descriptions

• Project comments

• Task comments

Depending on where you are, not all slash commands are available.

---

Real-Time Collaborative Editing in Descriptions

Multiple team members can edit project and task descriptions at the same time. Here's how you can see what's happening:

• Live cursor shows you who's currently working in the description

• Color coding per person for the live cursor (can't be changed)

• Highlights in user color when someone selects text

• Status indicator in the top right showing "Updated" or "Syncing"

• Only available in details (project and task details), not through the Edit button

---

Available Text Formatting Options

You can use a range of formatting options, including:

• Text sizes (header, title, subtitle, text)

• Text styles (bold, italic, strikethrough, underline)

• Lists (numbered and bulleted)

• Section divider

• Emojis

• Line and paragraph breaks

• Attach files

• Add links

• Display code with the appropriate font

When your cursor is in an empty line, you can quickly insert elements using the + button.

Insert Elements in Empty Lines

1. Place your cursor in an empty line

2. Click the + icon on the left side of the line

3. Choose a formatting option for the start of the line (for example, title or list)

Format Selected Text

1. Select a word or passage

2. Use the formatting options above your selection

---

Slash Commands

With slash commands, you create content faster: Type /, choose a command, and add formatting, elements, or actions straight from your keyboard.

With slash commands, you can while writing:

• Convert text formats (for example, heading, list, quote)

• Insert content (for example, images, emojis, files, tables)

• Execute actions from your keyboard

How Slash Commands Work

1. Type / in a supported text field

2. A popup with available commands opens

3. Keep typing to filter the list

4. The first entry is always pre-selected

5. Navigate through the list with the arrow keys (↑/↓)

6. Press Enter to execute the command you want

Slash commands work at the beginning of a new line and also in the middle of text. You can also convert existing lines to other formats.

Supported Commands and Formatting

Overview of available slash commands (🇬🇧 and 🇩🇪 are equally supported):

---

Tips, Shortcuts, and Best Practices

Keyboard Shortcuts in the Text Editor

These shortcuts apply formatting to selected text. If nothing is selected, you'll continue writing in the corresponding format:

• Bold with ⌘ + B (macOS) or Ctrl + B (Windows)

• Italic with ⌘ + I (macOS) or Ctrl + I (Windows)

More shortcuts for fast text creation and formatting:

• Undo with Cmd/Ctrl + Z

• Redo with Cmd/Ctrl + Shift + Z

• Activate H1 with # then space

• Activate H2 with ## then space

• Activate H3 with ### then space

• Write italic with *example*

• Write bold with **example**

• Write strikethrough with ~~example~~

• Write code with `example`

• Insert divider with ---

Automatic Detection at the Beginning of a Line

At the start of a line, you can type character combinations to automatically format the line:

• Bullet list with - + space

• Numbered list with 1. + space

• Title with # + space

• Section divider with -- + space

Line and Paragraph Breaks

You can create in your text:

• Paragraph breaks with Enter

• Line breaks with Shift + Enter

Paragraph breaks create more space between lines and add a new element in lists.

Line breaks maintain normal line spacing. In lists, you can use them to write multi-line elements.

Attach Files

In the text editor, you can attach files by:

• Uploading new files through slash commands (see the Slash Commands section)

• Linking existing files by typing @ and entering the file name

Select the file in the popup. It will then appear in the text field.

Save and Reset Input

In task and project details, you can edit descriptions "inline":

• Auto-save when you click outside the text field

• Save and close with ⌃ + Enter (macOS) or Ctrl + Enter (Windows)

• Close without saving with Esc (shows the status before editing again)

---

FAQ

In which areas can I use formatting?

You can format in docs (pages & comments) (full feature set), project descriptions, task descriptions, project comments, and task comments.

Why don't I see all slash commands?

Depending on where you are, not all slash commands are available. Also, slash commands don't work when text is actively selected and are disabled in code blocks.

Why can't I use attachments or @ mentions in dashboard notes?

All formatting options are available in dashboard notes. However, you can't upload attachments, make mentions (@), or use slash commands there.

Why can't I undo changes anymore?

Undo and redo only work while you're actively in the corresponding text field. Once you click outside the text field, this is no longer possible.

How do I save changes or discard them?

When you click outside the text field, your changes are saved immediately. With ⌃ + Enter (macOS) or Ctrl + Enter (Windows), you save and close edit mode. With Esc, you close without saving and see the status before editing again.