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/* 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 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..485cc76e --- /dev/null +++ b/src/misc/cite/index.md @@ -0,0 +1,31 @@ +--- +description: How to cite Mergin Maps. +--- + +# How to Cite + +[[toc]] + +Here are our recommendations on how to cite . + +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 is **** + +Since is a suite of related components, we recommend citing it as one software platform: ****, . + +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 + +Some components are also published on [Zenodo](https://zenodo.org/communities/merginmaps/). + +For GitHub integrations, cite the specific repository from . + +For citing QGIS, see the .