Skip to content

renaming qgis variables to mm_ #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

renaming qgis variables to mm_ #607

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c0f765f
renaming qgis variables to mm_
alex-cit Apr 25, 2025
49eb208
Update src/layer/plugin-variables/index.md
alex-cit Apr 30, 2025
7efed41
Update src/layer/plugin-variables/index.md
alex-cit May 9, 2025
5c6b5fd
Update src/layer/plugin-variables/index.md
alex-cit May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions src/layer/plugin-variables/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,19 @@
The <QGISPluginName /> adds several variables that can be used in QGIS expressions:

| Variable name | Sample value | Scope | Description |
|-----------------------------|-------------------------------|---------|-------------|
| `@mergin_username` | `martin` | global | Name of the user currently logged in to <MainPlatformNameLink /> |
| `@mergin_user_email` | `martin@example.com` | global | Email of the user currently logged in to <MainPlatformName />|
| `@mergin_url` | `https://app.merginmaps.com` | global | URL of the <MainPlatformName /> service |
| `@mergin_project_name` | `Tree survey` | project | Name of the active <MainPlatformName /> project |
| `@mergin_project_owner` | `martin` | project | Name of the owner of the active project |
| `@mergin_project_full_name` | `martin/Tree survey` | project | Owner and project name joined with a forward slash |
| `@mergin_project_version` | `42` | project | Current version of the active project |

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.
|-----------------------------|-------------------------------|---------|-------------
| `@mm_full_name` | `martin second name` | global | Full name of the currently logged in user, blank if the full name is not set |
| `@mm_username` | `martin` | global | Username of the user currently logged in to <MainPlatformNameLink /> |
| `@mm_user_email` | `martin@example.com` | global | Email of the user currently logged in to <MainPlatformName />|
| `@mm_url` | `https://app.merginmaps.com` | global | URL of the <MainPlatformName /> service |
| `@mm_project_name` | `Tree survey` | project | Name of the active <MainPlatformName /> project |
| `@mm_project_full_name` | `martin/Tree survey` | project | Workspace and project name joined with a forward slash |
| `@mm_project_version` | `42` | project | Current version of the active project |

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.

::: tip `mergin_` variable names still work!
QGIS variables listed here previously used the prefix `mergin_`. Now we use the prefix `mm_` standing for <MainPlatformName />.

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.
:::
Loading