Iss 132 how to cite Mergin Maps

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/*

scripts/wordlist.txt

@@ -26,6 +26,7 @@ CSV
 CharlieColleague
 DAF
 DateTime
+DOI
 DOP
 ECW
 ECR
@@ -185,6 +186,7 @@ WMS
 WMTS
 Workspaces
 XYZ
+Zenodo
 api
 aws
 backend
@@ -347,4 +349,6 @@ JavaScript
 EOS
 Skadi
 TCP
+APA
+BibTeX
 geolocation

src/.vitepress/sidebar/en.js

@@ -171,6 +171,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,

src/misc/cite/index.md

@@ -0,0 +1,33 @@
+---
+description: How to cite Mergin Maps. 
+---
+
+# How to Cite
+
+[[toc]]
+
+Here are our recommendations on how to cite <MainPlatformName />. 
+
+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.
+
+The author of <MainPlatformName /> is **<LutraConsultingName />**
+
+Since <MainPlatformName /> is a suite of related components, we recommend citing it as one software platform: **<MainPlatformName />**, <MainDomainNameLink />.
+
+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.
+- **<MobileAppName />**
+   - *Version information*: the <MobileAppNameShort /> version can be found in the [app settings](../../field/mobile-app-ui/#general).
+   - *URL*: the <MobileAppNameShort /> 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)
+- **<QGISPluginName />**
+   - *Version information*: the <QGISPluginNameShort /> 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)
+- **<ServerCloudName />**
+   - *URL*: refer to <AppDomainNameLink />
+
+For **GitHub integrations**, cite the specific repository from <GitHubRepo id="MerginMaps/" desc="Mergin Maps repositories" />. 
+
+:::tip Citing GitHub repository
+Each of our GitHub repositories includes a `CITATION.cff` file. Click the **Cite this repository** button on the repository page (in the right sidebar under **About**) to get a ready-to-use citation with the correct version (available in both APA and BibTeX formats).
+:::
+
+For citing QGIS, see the <QGIS link="resources/support/faq/#how-to-cite-qgis" text="QGIS Citation information" />.