Documentation Conventions and Terminology in CrmLeaf
All editions. This article explains the notation used throughout the manual.
Availability: All editions. This article explains the notation used throughout the manual.
Overview
This manual uses a consistent set of conventions. Understanding them takes two minutes and makes every other article faster to follow.
Navigation Paths
A navigation path shows where to go, written as a sequence:
Important: CrmLeaf's sidebar is configurable. A platform Super Admin can lay the menu out differently for each product edition, renaming, regrouping, reordering or hiding entries, and each user can pin their own Quick Access favourites. A menu layout can never grant access to something your plan does not include, but it can certainly move it.
This means your sidebar may not match a path in this manual exactly. If a path does not lead where you expect, use Search, or check your Quick Access items and the "More" fly-out. Where a screen's exact location varies, the manual describes the action rather than inventing a path.
User Interface Labels
Names of buttons, menus, tabs and modules appear in bold: select Save, open Settings, go to Purchase Orders.
The manual uses a deliberately small set of generic action words - Save, Submit, Add, Edit, Delete, Approve, Reject, Cancel, Search, Filter, Export, Import, Download, Upload, Assign - because the precise wording of a control can change between releases and editions. Where the exact label matters and has not been confirmed, the article names the outcome instead.
Internal Values and Status Names
Values stored by the system appear in code formatting, for example an invoice status of unpaid or a purchase order's delivery_status of delivered. These are the underlying values, which is what determines system behaviour. The label you see on screen may be formatted differently, for example "Not started" for not_started. Status behaviour is what the manual documents; presentation may vary.
Role Terminology
| Term | Meaning in this manual |
|---|---|
| Administrator | A user with the admin role in a company - full access, configures the system. Shown by the black Administrator badge on an article. |
| User | A person doing day-to-day work, usually with the employee role and a defined set of module permissions. Shown by the amber User badge. |
| Client | An external customer with the client role, who signs in to the client portal to see their own invoices, estimates, proposals and contracts. |
| Super Admin | A platform-level operator, not a customer role. Manages packages, menu layouts and company accounts across the whole installation. |
Information Blocks
- Availability - the green-bordered block after each title: editions and add-on requirements.
- Expected Result - the green block: how to confirm success.
Language
The manual is written in simple international English for readers in many countries. It uses international spelling, for example "organisation" and "customise". Instructions use direct action verbs. Where currency examples are needed, the currency is stated explicitly, because CrmLeaf supports multiple currencies.
Related Articles
Our support team answers on business days. Reference FM-02 so we can jump straight in.