Skip to content

Commit 0dfad3d

Browse files
karolinelienclaude
andcommitted
docs: document text box markdown support (DHIS2-20008)
Text box items render markdown (headings, ordered/unordered lists, line breaks) via the analytics RichTextParser, but only some features have toolbar buttons and none of this was documented. Add a "Text boxes" section to the user guide describing the supported syntax with an example. AI Assisted Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent cac24f2 commit 0dfad3d

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/dashboards.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,37 @@ You can also configure whether newly added items are automatically placed at the
9393

9494
![](resources/images/dashboard-place-items.png)
9595

96+
#### Text boxes
97+
98+
A text box lets you add formatted text to a dashboard. While editing a text box, use the toolbar buttons for **bold**, _italic_, links, user mentions and emoji. In addition, the text box supports a subset of [Markdown](https://commonmark.org/) syntax that does not have toolbar buttons:
99+
100+
| Feature | How to write it |
101+
| ------------- | ------------------------------------------------------------------------------------------------------------- |
102+
| Headings | Start a line with `#` for a heading. Use more `#` characters for smaller headings, for example `##` or `###`. |
103+
| Numbered list | Start each line with a number followed by a period, for example `1.`, `2.`, `3.` |
104+
| Bulleted list | Start each line with `-`, `*` or `+` |
105+
| Bold | Wrap text in single asterisks: `*bold*` |
106+
| Italic | Wrap text in single underscores: `_italic_` |
107+
| Line break | Press **Enter** to start a new line |
108+
109+
For example, the following text:
110+
111+
```
112+
# Monthly report
113+
114+
Key indicators for _this month_:
115+
116+
1. ANC coverage
117+
2. Immunization rate
118+
119+
Remember to:
120+
121+
- Validate the data
122+
- *Complete* the review
123+
```
124+
125+
renders as a level-one heading, an italicised phrase, a numbered list and a bulleted list. Formatting is not shown while you type; click the **Preview** button in the text box toolbar (or save and view the dashboard) to see the rendered result.
126+
96127
#### Spacer items
97128

98129
When adding items to the dashboard using _Freeflow_ layout, they will "rise" upwards until they bump into another item. In order to force empty vertical space between items (like an empty row), you can add spacer items to the dashboard. They are only visible in edit/create mode. In view mode, they are not displayed, but take up the defined space.

0 commit comments

Comments
 (0)