Descriptions with the text editor
For objects, sectors, and text modules, you can maintain descriptions with the built-in Markdown text editor. The text is rendered in the protocol — with headings, lists, and emphasis.
Where the text editor is available
| Area | Where | Field |
|---|---|---|
| Object | Object details → Add description | Object description |
| Sector | Open a sector on the object → Notes and descriptions | Sector notes |
| Text module | Text modules → Description | Reusable protocol text |
In all cases you use the same editor with a formatting toolbar, preview (eye icon), and optional speech-to-text.
Markdown rules (quick reference)
The app supports simple Markdown syntax:
| Syntax | Effect | Example |
|---|---|---|
# Heading | Heading level 1–6 (# through ######) | # Living room |
**text** | Bold | **Important:** |
*text* | Italic | *optional* |
- item or * item | Bullet list | - Heating checked |
1. item | Numbered list | 1. Keys handed over |
`code` | Inline code | `Serial no.` |
[text](url) | Link | [House rules](https://…) |
Line breaks create new paragraphs — a blank line separates paragraphs more clearly.
The editor toolbar inserts syntax at the cursor (bold, italic, link, H1–H3, lists). Use preview to see the result before saving.
What to use it for — examples
Object description
- General notes about the object — e.g. access, parking, property specifics
- Legal or organisational explanations that should appear in every protocol for this object
- Handover or takeback guidance for all parties (e.g. process, responsibilities)
Sector — notes and descriptions
- Extended explanations for ratings and checklists — what “OK”, “defect”, or a check item means in practice
- Inspection or maintenance procedures — on-site steps, e.g. 1. Visual check, 2. Function test, 3. Documentation
- Technical notes — meter location, shut-off valves, fuses, maintenance intervals
- Room-specific details — renovated areas, excluded zones, notes from the previous tenant
Text modules
- Standard texts on liability, privacy, or house rules — with formatted paragraphs and lists
- Occasion-specific explanations — e.g. handover or takeback only (via filters)
- Checklist supplements — detailed rating guidance beyond the short checklist line
- Links to external documents —
[Operating manual](https://…)directly in the protocol
Tips
- Short headings and lists improve readability in PDF and the web viewer
- For text modules, text applies only when filters match (occasion, object type, …) — see Text modules
- Sector notes appear in the protocol under the relevant sector — ideal for recurring inspection instructions