gdal icon indicating copy to clipboard operation
gdal copied to clipboard

Add a glossary and example link

Open geographika opened this issue 7 months ago • 5 comments

The GDAL docs contain a lot of abbreviations and technical terms. A glossary defining these terms and abbreviations could be of use to a reader.

This PR adds a glossary page to the GDAL docs, with an example link, as a starting point for discussions to see if this would be a good idea to include and expand upon.

The glossary uses the standard Sphinx glossary approach, similar to MapServer https://mapserver.org/glossary.html

image

Terms can link to the glossary using the following syntax. An example is included in this PR.

:term:`EPSG`

image

There is an OSGeo Lexicon mailing list that was looking to "Coordinate definitions for terminology used within the OSGeo context" - https://lists.osgeo.org/mailman/listinfo/lexicon. I've emailed the list to see if there are any definition datasets that could be used as a starting point.

geographika avatar May 08 '25 10:05 geographika

Note docs builds were failing due to https://github.com/sphinx-doc/sphinx/issues/13533 which seems to now be resolved: https://github.com/sphinx-doc/sphinx/issues/13533#issuecomment-2862775896

geographika avatar May 08 '25 12:05 geographika

@dbaston @rouault any opinions on if adding a glossary should be pursued? The entries in this PR were just to show the structure - obviously a base set of terms would be added before merging, and then built upon as I go through the drivers and tutorials. There were also a couple of replies on the lexicon list with links to previous datasets that could be used to help populate an inital glossary: https://lists.osgeo.org/pipermail/lexicon/2025-May/thread.html

geographika avatar May 15 '25 20:05 geographika

@geographika Yes definitely a good idea! There is so much jargon that can be explained

rouault avatar May 15 '25 20:05 rouault

any opinions on if adding a glossary should be pursued?

I like it!

dbaston avatar May 15 '25 22:05 dbaston

Coverage Status

coverage: 71.014% (-0.004%) from 71.018% when pulling 6870841c4fa69eb51d84ba5df18d6f0e8e665d4c on geographika:glossary into 9f4bc2d28f853d9e39a59656cb8f3318b51f9be2 on OSGeo:master.

coveralls avatar May 31 '25 09:05 coveralls

@dbaston @rouault - although only a few entries, it would be good to merge this so I can start linking to terms in other places in the docs in follow-up PR.

geographika avatar Jun 19 '25 07:06 geographika