From ca057fcd370fd50df11435f243e3c5a3642b8c79 Mon Sep 17 00:00:00 2001 From: Alexandra Date: Thu, 27 Aug 2026 17:10:50 +0200 Subject: [PATCH 1/4] citing notes --- src/.vitepress/sidebar/en.js | 1 + src/misc/cite/index.md | 48 ++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 src/misc/cite/index.md diff --git a/src/.vitepress/sidebar/en.js b/src/.vitepress/sidebar/en.js index 828a142a..4cbf5224 100644 --- a/src/.vitepress/sidebar/en.js +++ b/src/.vitepress/sidebar/en.js @@ -170,6 +170,7 @@ export default { collapsed: true, items: [ { text: 'Licensing', link: '/misc/licensing/' }, + { text: 'How to Cite', link: '/misc/cite/' }, { text: 'Get Involved', link: '/misc/get-involved/' }, { text: 'Troubleshoot', collapsed:true, diff --git a/src/misc/cite/index.md b/src/misc/cite/index.md new file mode 100644 index 00000000..a826e129 --- /dev/null +++ b/src/misc/cite/index.md @@ -0,0 +1,48 @@ +--- +description: How to cite Mergin Maps. +--- + +# How to Cite + +[[toc]] + +Lutra Consulting Limited. (Year). Product Name [Computer software]. Publisher/Repository. URL or DOI + +For citing QGIS, see the . + +https://zenodo.org/communities/merginmaps/records + +Since Mergin Maps is a suite of related components, the clearest practice is to cite it as one software platform in the main text, while recording the specific components and versions in the methods or software table. + +A suitable general citation would be: + + Lutra Consulting Limited. (2026). Mergin Maps [Mobile application, cloud service, and QGIS plugin]. https://merginmaps.com/ + +In the text, you could write: + + Field data were collected using Mergin Maps, including its mobile application, cloud synchronisation service, and QGIS plugin (Lutra Consulting Limited, 2026). + +For reproducibility, add details such as: + + mobile app version; + QGIS version; + Mergin Maps QGIS plugin version; + date of access for the cloud service; + relevant repository names, release tags, or commit hashes for GitHub integrations; + names and versions of any external integrations used. + +The official documentation treats the mobile app, QGIS plugin, and server/cloud platform as distinct Mergin Maps components, so separating them in a software inventory is reasonable. merginmaps.com + +If the components were central to your research, cite them individually as well: + + Lutra Consulting Limited. (2026). Mergin Maps mobile app (Version x.y.z) [Mobile application]. https://merginmaps.com/ + + Lutra Consulting Limited. (2026). Mergin Maps QGIS plugin (Version x.y.z) [QGIS plugin]. https://github.com/MerginMaps/ + + Lutra Consulting Limited. (2026). Mergin Maps Cloud [Cloud service]. Retrieved August 27, 2026, from https://app.merginmaps.com/ + +For a GitHub integration, cite the specific repository rather than citing “GitHub” generally: + + Lutra Consulting Limited or named repository authors. (2026). Repository or integration name (Version or commit hash) [Source code]. GitHub. https://github.com/… + +Use the actual release year and version numbers from the software you used; 2026 and x.y.z above are placeholders. If Mergin Maps supplies a preferred citation or a DOI for a particular release, use that in preference to these generic forms. From 995033129723ad25fe04b952981beeda324f22ef Mon Sep 17 00:00:00 2001 From: Alexandra Date: Mon, 7 Sep 2026 13:45:54 +0200 Subject: [PATCH 2/4] how to cite mergin maps --- src/misc/cite/index.md | 49 ++++++++++++++---------------------------- 1 file changed, 16 insertions(+), 33 deletions(-) diff --git a/src/misc/cite/index.md b/src/misc/cite/index.md index a826e129..485cc76e 100644 --- a/src/misc/cite/index.md +++ b/src/misc/cite/index.md @@ -6,43 +6,26 @@ description: How to cite Mergin Maps. [[toc]] -Lutra Consulting Limited. (Year). Product Name [Computer software]. Publisher/Repository. URL or DOI +Here are our recommendations on how to cite . -For citing QGIS, see the . - -https://zenodo.org/communities/merginmaps/records - -Since Mergin Maps is a suite of related components, the clearest practice is to cite it as one software platform in the main text, while recording the specific components and versions in the methods or software table. - -A suitable general citation would be: - - Lutra Consulting Limited. (2026). Mergin Maps [Mobile application, cloud service, and QGIS plugin]. https://merginmaps.com/ - -In the text, you could write: +The specific citation form is usually defined in the Author Guidelines of specific academic journals or thesis instructions. However, standard citation styles for software typically include information about the authors, product name, version, URL or DOI reference and the year of usage. - Field data were collected using Mergin Maps, including its mobile application, cloud synchronisation service, and QGIS plugin (Lutra Consulting Limited, 2026). +The author of is **** -For reproducibility, add details such as: +Since is a suite of related components, we recommend citing it as one software platform: ****, . - mobile app version; - QGIS version; - Mergin Maps QGIS plugin version; - date of access for the cloud service; - relevant repository names, release tags, or commit hashes for GitHub integrations; - names and versions of any external integrations used. +If specific components are central to your research, you may prefer to cite them separately. In this case, it is recommended to include the version and provide corresponding URLs. +- **** + - *Version information*: the version can be found in the [app settings](../../field/mobile-app-ui/#general). + - *URL*: the can be downloaded from [Google Play Store](https://play.google.com/store/apps/details?id=uk.co.lutraconsulting) or [Apple App Store](https://apps.apple.com/us/app/mergin-maps-qgis-in-pocket/id1478603559) +- **** + - *Version information*: the version can be found in [plugin details](../../setup/install-mergin-maps-plugin-for-qgis/#plugin-upgrade) in QGIS + - *URL*: use the [link to QGIS plugin repository](https://plugins.qgis.org/plugins/Mergin/#plugin-about) +- **** + - *URL*: refer to -The official documentation treats the mobile app, QGIS plugin, and server/cloud platform as distinct Mergin Maps components, so separating them in a software inventory is reasonable. merginmaps.com +Some components are also published on [Zenodo](https://zenodo.org/communities/merginmaps/). -If the components were central to your research, cite them individually as well: +For GitHub integrations, cite the specific repository from . - Lutra Consulting Limited. (2026). Mergin Maps mobile app (Version x.y.z) [Mobile application]. https://merginmaps.com/ - - Lutra Consulting Limited. (2026). Mergin Maps QGIS plugin (Version x.y.z) [QGIS plugin]. https://github.com/MerginMaps/ - - Lutra Consulting Limited. (2026). Mergin Maps Cloud [Cloud service]. Retrieved August 27, 2026, from https://app.merginmaps.com/ - -For a GitHub integration, cite the specific repository rather than citing “GitHub” generally: - - Lutra Consulting Limited or named repository authors. (2026). Repository or integration name (Version or commit hash) [Source code]. GitHub. https://github.com/… - -Use the actual release year and version numbers from the software you used; 2026 and x.y.z above are placeholders. If Mergin Maps supplies a preferred citation or a DOI for a particular release, use that in preference to these generic forms. +For citing QGIS, see the . From 7f6faa6b1f9f51e18155b6f722cc41eb792d2ecc Mon Sep 17 00:00:00 2001 From: Alexandra Date: Mon, 7 Sep 2026 13:49:41 +0200 Subject: [PATCH 3/4] update wordlist --- scripts/wordlist.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/wordlist.txt b/scripts/wordlist.txt index f4f30465..c24ac41f 100644 --- a/scripts/wordlist.txt +++ b/scripts/wordlist.txt @@ -25,6 +25,7 @@ CSV CharlieColleague DAF DateTime +DOI DOP ECW ECR @@ -179,6 +180,7 @@ WMS WMTS Workspaces XYZ +Zenodo api aws backend From db6dba1d287e39a3502f836d62884a22455ef1a5 Mon Sep 17 00:00:00 2001 From: Alexandra Date: Mon, 7 Sep 2026 13:53:55 +0200 Subject: [PATCH 4/4] update broken link exceptions --- scripts/broken-link-exceptions.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/broken-link-exceptions.txt b/scripts/broken-link-exceptions.txt index bf03e0bd..b7a34f8d 100644 --- a/scripts/broken-link-exceptions.txt +++ b/scripts/broken-link-exceptions.txt @@ -1 +1 @@ ---exclude=https://de.merginmaps.com/* --exclude=https://es.merginmaps.com/* --exclude=https://fr.merginmaps.com/* --exclude=https://it.merginmaps.com/* --exclude=https://pt.merginmaps.com/* --exclude=.*twitter.com/* --exclude=.*x.com/* --exclude=https://www.fauna-flora.org* --exclude=https://download.geofabrik.de* --exclude=https://www.linkedin.com/* --exclude=https://docs.github.com* --exclude=.*openstreetmap.org.* --exclude=.*sqlite.org.* --exclude=.*gnu.org.* --exclude=.*github.com/merginmaps/docs/edit/.* --exclude=.*libtiff.org.* --exclude=https://gis.stackexchange.com/* --exclude=https://www.stackexchange.com/* --exclude=https://www.stackoverflow.com/* --exclude=https://ocw.un-ihe.org/* --exclude=https://merginmaps.com/case-studies/* --exclude=https://merginmaps.com/support/* --exclude=https://merginmaps.com/glossary/* --exclude=https://merginmaps.com/blog/* --exclude=https://apps.apple.com/us/app/input/* --exclude=https://www.maplango.com* --exclude=https://apps.apple.com/* --exclude=https://www.mobilegis.at/* --exclude=https://fonts.googleapis.com* --exclude=https://fonts.gstatic.com* --exclude=https://gispro.com.au/* --exclude=http://www.mobilegis.at* --exclude=http://linkedin.com/* --exclude=https://www.verticalgeo.com/* --exclude=https://mappinggis.com/* --exclude=https://app.termly.io/* --exclude=https://www.apple.com/* --exclude=https://play.google.com/* --exclude=https://www.nginx.com/* --exclude=https://proj.org/* --exclude=https://www.burdgis.com* --exclude=https://www.docker.com* --exclude=https://www.googletagmanager.com* --exclude=https://assets-global.website-files.com --exclude=https://uploads-ssl.webflow.com --exclude=https://www.institut-agro-montpellier.fr/* --exclude=http://bad-elf.com* --exclude=https://bad-elf.com/* --exclude=https://merginmaps.com/hardware-partners --exclude=https://merginmaps.com/partners --exclude=https://merginmaps.com/use-case/* --exclude=https://www.otter.org/ --exclude=https://docs.sqlalchemy.org* --exclude=https://www.facebook.com/* --exclude=.*gdal.org/* --exclude=.*spatialised.net/* --exclude=https://cdn.prod.website-files.com/* --exclude=https://aws.amazon.com/* --exclude=https://support.apple.com/* --exclude=https://www.ordnancesurvey.co.uk/* --exclude=https://www.ardusimple.com/* --exclude=https://exiftool.org/* --exclude=https://pro.arcgis.com/* --exclude=https://www.esri.com/* --exclude=https://api.merginmaps.com/logs --exclude=https://en.wikipedia.org/wiki/* --exclude=https://www.reddit.com/* --exclude=https://github.com/MerginMaps/python-api-client/blob/634237890afd9f28f03953e5a01376b56f5abf5c/mergin/client.py#L572 --exclude=https://github.com/MerginMaps/python-api-client/blob/634237890afd9f28f03953e5a01376b56f5abf5c/mergin/client.py#L641 --exclude=https://merginmaps.com/ngo-form --exclude=https://merginmaps.com/academia-form --exclude=https://merginmaps.com/eudr-geolocation-data-collection --exclude=https://exiftool.sourceforge.net/TagNames/EXIF.html --exclude=https://emlid.com/emlid-flow/ +--exclude=https://de.merginmaps.com/* --exclude=https://es.merginmaps.com/* --exclude=https://fr.merginmaps.com/* --exclude=https://it.merginmaps.com/* --exclude=https://pt.merginmaps.com/* --exclude=.*twitter.com/* --exclude=.*x.com/* --exclude=https://www.fauna-flora.org* --exclude=https://download.geofabrik.de* --exclude=https://www.linkedin.com/* --exclude=https://docs.github.com* --exclude=.*openstreetmap.org.* --exclude=.*sqlite.org.* --exclude=.*gnu.org.* --exclude=.*github.com/merginmaps/docs/edit/.* --exclude=.*libtiff.org.* --exclude=https://gis.stackexchange.com/* --exclude=https://www.stackexchange.com/* --exclude=https://www.stackoverflow.com/* --exclude=https://ocw.un-ihe.org/* --exclude=https://merginmaps.com/case-studies/* --exclude=https://merginmaps.com/support/* --exclude=https://merginmaps.com/glossary/* --exclude=https://merginmaps.com/blog/* --exclude=https://apps.apple.com/us/app/input/* --exclude=https://www.maplango.com* --exclude=https://apps.apple.com/* --exclude=https://www.mobilegis.at/* --exclude=https://fonts.googleapis.com* --exclude=https://fonts.gstatic.com* --exclude=https://gispro.com.au/* --exclude=http://www.mobilegis.at* --exclude=http://linkedin.com/* --exclude=https://www.verticalgeo.com/* --exclude=https://mappinggis.com/* --exclude=https://app.termly.io/* --exclude=https://www.apple.com/* --exclude=https://play.google.com/* --exclude=https://www.nginx.com/* --exclude=https://proj.org/* --exclude=https://www.burdgis.com* --exclude=https://www.docker.com* --exclude=https://www.googletagmanager.com* --exclude=https://assets-global.website-files.com --exclude=https://uploads-ssl.webflow.com --exclude=https://www.institut-agro-montpellier.fr/* --exclude=http://bad-elf.com* --exclude=https://bad-elf.com/* --exclude=https://merginmaps.com/hardware-partners --exclude=https://merginmaps.com/partners --exclude=https://merginmaps.com/use-case/* --exclude=https://www.otter.org/ --exclude=https://docs.sqlalchemy.org* --exclude=https://www.facebook.com/* --exclude=.*gdal.org/* --exclude=.*spatialised.net/* --exclude=https://cdn.prod.website-files.com/* --exclude=https://aws.amazon.com/* --exclude=https://support.apple.com/* --exclude=https://www.ordnancesurvey.co.uk/* --exclude=https://www.ardusimple.com/* --exclude=https://exiftool.org/* --exclude=https://pro.arcgis.com/* --exclude=https://www.esri.com/* --exclude=https://api.merginmaps.com/logs --exclude=https://en.wikipedia.org/wiki/* --exclude=https://www.reddit.com/* --exclude=https://github.com/MerginMaps/python-api-client/blob/634237890afd9f28f03953e5a01376b56f5abf5c/mergin/client.py#L572 --exclude=https://github.com/MerginMaps/python-api-client/blob/634237890afd9f28f03953e5a01376b56f5abf5c/mergin/client.py#L641 --exclude=https://merginmaps.com/ngo-form --exclude=https://merginmaps.com/academia-form --exclude=https://merginmaps.com/eudr-geolocation-data-collection --exclude=https://exiftool.sourceforge.net/TagNames/EXIF.html --exclude=https://emlid.com/emlid-flow/ --exclude=https://zenodo.org/*