All Collections
awork explained in detail
General
The text editor and its formatting
The text editor and its formatting

The formatting options of the text editor allow you to write clear project and task briefings.

Merle Hecht avatar
Written by Merle Hecht
Updated over a week ago

Good descriptions and briefings will be very helpful for sharing work and passing on work orders. awork's text editors in both the description and comment fields allow you to write clearly formatted texts.

Which text fields can I format?

You will be able to format the text for the description of the projects and the tasks, as well as the comments and the notes on the dashboard.

☝️Hint: All formatting options are also available for the notes on the dashboard. However, no attachments can be uploaded there, no mentions ("@") can be made and no slash commands can be used.

Live editing collaboration

Several people can now edit the project and task descriptions at the same time. These functions are included in live editing:

  • A "live cursor" shows you who is currently working on the description.

  • Each user receives a color for the "live cursor", which cannot be changed.

  • If someone marks a text in the description, this text appears in the color of the user.

  • At the top right of the description, you will see an "Updated" or "Syncing" indicator, which tells you whether the description displayed to you is the current one or not.

  • Live editing is only available in the project and task details, but not when you click on the "Edit" button in the project or task.

Options for formatting the text

Overall, you will be able to format the text as listed below.

  • Text size: Header, title, subtitle and text

  • Bold, italic, strike-through and underlined

  • Numbered and unnumbered enumeration

  • Section separator

  • Emojis

  • Line and paragraph breaks

  • Attach files

  • Add links

  • Display code as such, with corresponding font

To format text quickly and easily, just click on the + button in an empty line.

How to use the formatting

Insert elements into empty lines

If your cursor is placed over a blank line of text, the small plus icon will appear to the left of the line. If you click on it, you will be able to choose different formatting options for the beginning of the line, e.g. a title or a listing.

Marked text

Mark the text, and a box with formatting options will appear above the mark. Now you will be able to format single words or whole passages and, for example, make them bold.

Key commands and Shortcuts

The following key commands are available in the text editor. The formatting is applied to the marked text passage, or if nothing is marked, you continue writing in the formatting as follows.

  • + B (MacOS) or Ctrl + B (Windows): Bold formatting

  • + I (MacOS) or Ctrl + I (Windows): Format italics

Of course, we haven't forgotten about our power users. We added some new shortcuts to help you speed through the tool even faster and more safely. Especially when creating and designing texts:

  • Undo changes: "CMD/CTRL + z"

  • Restore changes: "CMD/CTRL + SHIFT + z"

  • Activate H1 format (header): "#", then "blank line"

  • Activate H2 format (title): "##", then "blank line"

  • Activate H3 format (subtitle): "###", then "blank line"

  • Display text in italics: "*Example*"

  • Display text in bold: "**Example**"

  • Display text in strikethrough: "~~example~~"

  • Display text in code: "`Example`"

  • Insert hyphen: "---"

☝️Important: The functions for undoing or redoing changes are only possible as long as you are actively in the corresponding text field. If you click out of the text field, changes can no longer be undone or restored.

Automatic recognition at the beginning of a line

You will be able to type certain character combinations at the beginning of a line to have the line format itself automatically. Once you have them, you can format your text at high speed while simultaneously writing.

  • Hyphen + Space: Start an unnumbered enumeration

  • 1. + Space: Start a numbered enumeration

  • # + Space: Set a title

  • -- + Space: A section separator line is inserted

Slash commands

The slash commands open as soon as you write a slash "/" in the text. There are different objects or formats to choose from to insert, e.g. adding a file.

Line and paragraph breaks

You will be able to create paragraph breaks (with Enter) and line breaks (with Shift + Enter) within your text.

Paragraph breaks create a slightly larger space between the text lines and ensure that a new count element is created in enumerations.

Line breaks, on the other hand, have a normal line spacing. If you use them in bulleted lists, you will be able to write multi-line bulleted items.

Attach files

Within the Text Editor, you will be able to attach files. Either upload a new file using the slash commands or link a file already uploaded in the project or task by typing an @ symbol and starting to type the file name. Select the file in the pop-up, and it will appear in the text field afterward.

Saving and resetting the editor input

In the task and project details you will be able to change easily the description inline. If you click with the mouse anywhere outside the text field, your changess will be saved immediately.

If you tap ⌃ + Enter (MacOS) or Ctrl + Enter (Windows) while editing the text, the text will also be saved, and the edit mode will close.

Tap ESC to close the edit mode, and the text changes will not be saved. The text before the start of editing will be displayed again.

Did this answer your question?