Skip to content

Commit 80d9dcd

Browse files
authored
renaming qgis variables to mm_ (#607)
1 parent 4ed9c1e commit 80d9dcd

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

src/layer/plugin-variables/index.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,19 @@
33
The <QGISPluginName /> adds several variables that can be used in QGIS expressions:
44

55
| Variable name | Sample value | Scope | Description |
6-
|-----------------------------|-------------------------------|---------|-------------|
7-
| `@mergin_username` | `martin` | global | Name of the user currently logged in to <MainPlatformNameLink /> |
8-
| `@mergin_user_email` | `martin@example.com` | global | Email of the user currently logged in to <MainPlatformName />|
9-
| `@mergin_url` | `https://app.merginmaps.com` | global | URL of the <MainPlatformName /> service |
10-
| `@mergin_project_name` | `Tree survey` | project | Name of the active <MainPlatformName /> project |
11-
| `@mergin_project_owner` | `martin` | project | Name of the owner of the active project |
12-
| `@mergin_project_full_name` | `martin/Tree survey` | project | Owner and project name joined with a forward slash |
13-
| `@mergin_project_version` | `42` | project | Current version of the active project |
14-
15-
A common use case is to use `@mergin_username` as the [default value](../form-configuration/#default-values) for one of the fields in a survey layer to automatically track who has added (and/or modified) a particular record.
6+
|-----------------------------|-------------------------------|---------|-------------
7+
| `@mm_full_name` | `martin second name` | global | Full name of the currently logged in user, blank if the full name is not set |
8+
| `@mm_username` | `martin` | global | Username of the user currently logged in to <MainPlatformNameLink /> |
9+
| `@mm_user_email` | `martin@example.com` | global | Email of the user currently logged in to <MainPlatformName />|
10+
| `@mm_url` | `https://app.merginmaps.com` | global | URL of the <MainPlatformName /> service |
11+
| `@mm_project_name` | `Tree survey` | project | Name of the active <MainPlatformName /> project |
12+
| `@mm_project_full_name` | `martin/Tree survey` | project | Workspace and project name joined with a forward slash |
13+
| `@mm_project_version` | `42` | project | Current version of the active project |
14+
15+
A common use case is to use `@mm_username` or `@mm_user_email` as the [default value](../form-configuration/#default-values) for one of the fields in a survey layer to automatically track who has added (and/or modified) a particular record.
16+
17+
::: tip `mergin_` variable names still work!
18+
QGIS variables listed here previously used the prefix `mergin_`. Now we use the prefix `mm_` standing for <MainPlatformName />.
19+
20+
Both naming options are functional and will continue to work in the future: `@mergin_user_email` and `@mm_user_email` provide the same value when used in QGIS expressions.
21+
:::

0 commit comments

Comments
 (0)