Skip to content
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.

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

docs: Add cite me button to each tool #5228

Open
cwhite911 opened this issue Feb 27, 2025 · 2 comments
Open

docs: Add cite me button to each tool #5228

cwhite911 opened this issue Feb 27, 2025 · 2 comments

Comments

@cwhite911
Copy link
Contributor

Add output from g.citation to each tool. Ideally, this would allow a user to copy or download bib, text, etc. from the docs.

@wenzeslaus
Copy link
Member

Is there some potential for a minimal implementation which would involve just a button which would read info from citation in YAML metadata which would be provided by the author in the Markdown header?

If we need to do this totally from scratch, esp. automated with g.citation involved, then let's focus now on other things. We have more pressing issues like basic intro and nav. g.citation itself is not perfect, didn't received only limited attention since I originally wrote it, and still didn't make it to the core. Some other changes we discussed, specifically the machine-readable authors, would be beneficial here, but they are issues for future, too. While somehow linked g.citation code could spit out some bib during the build, the complexity of citing basically turns this quickly into a project on its own.

@cwhite911
Copy link
Contributor Author

Yes, we can implement a minimal feature by writing a script to add additional metadata to the md docs from the full module export from g.citation. Then they can be managed by contributors after that.

chicago-footnote

citation: Charles Ehlschlaeger, Markus Metz <markus.metz.giswork at gmail.com>, and Andreas Gericke (IGB Berlin), GRASSS GIS module r.watershed (8.5.0dev), computer software (2025).

json output

{
  "access": "2025-02-20T11:18:37",
  "authors": [
    {
      "feature": "Original version",
      "institute": "U.S. Army Construction Engineering Research Laboratory",
      "name": "Charles Ehlschlaeger"
    },
    {
      "feature": "Faster sorting algorithm and MFD support",
      "name": "Markus Metz <markus.metz.giswork at gmail.com>"
    },
    {
      "feature": "Retention for flow distribution",
      "name": "Andreas Gericke (IGB Berlin)"
    }
  ],
  "code-url": "https://github.com/OSGeo/grass/tree/main/raster/r.watershed/front",
  "grass-build-date": "2025-02-23",
  "grass-version": "8.5.0dev",
  "module": "r.watershed",
  "references": [
    {
      "authors": [
        {
          "name": "The GRASS Development Team",
          "website": "https://grass.osgeo.org/"
        }
      ],
      "date-released": "2025-02-23",
      "keywords": [
        "GIS",
        "geospatial analysis",
        "remote sensing",
        "image processing"
      ],
      "license": "GPL-2.0-or-later",
      "scope": "Use the following to cite the whole GRASS GIS",
      "title": "GRASS GIS 8.5.0dev",
      "type": "software",
      "version": "8.5.0dev",
      "year": "2025"
    }
  ],
  "url-code-history": "https://github.com/OSGeo/grass/commits/main/raster/r.watershed/front",
  "year": 2025
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants