[GRASS-git] [OSGeo/grass] 7d39c5: docs: Use meta page info from HTML in Markdown (#5...

[Vaclav Petras]

  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: 7d39c54cf77475a76f697b9520b0ac6dd4741b88
      https://github.com/OSGeo/grass/commit/7d39c54cf77475a76f697b9520b0ac6dd4741b88
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2025-02-21 (Fri, 21 Feb 2025)

  Changed paths:
    M db/databaseintro.md
    M db/drivers/dbf/grass-dbf.md
    M db/drivers/mysql/grass-mesql.md
    M db/drivers/mysql/grass-mysql.md
    M db/drivers/odbc/grass-odbc.md
    M db/drivers/ogr/grass-ogr.md
    M db/drivers/postgres/grass-pg.md
    M db/drivers/sqlite/grass-sqlite.md
    M display/displaydrivers.md
    M doc/examples/gui/wxpython/g.gui.example.md
    M doc/grass_database.md
    M doc/gui/wxpython/example/g.gui.example.md
    M doc/projectionintro.md
    M general/g.parser/g.parser.md
    M gui/wxguiintro.md
    M gui/wxpython/animation/g.gui.animation.md
    M gui/wxpython/datacatalog/g.gui.datacatalog.md
    M gui/wxpython/dbmgr/g.gui.dbmgr.md
    M gui/wxpython/docs/wxGUI.components.md
    M gui/wxpython/docs/wxGUI.iscatt.md
    M gui/wxpython/docs/wxGUI.md
    M gui/wxpython/docs/wxGUI.modules.md
    M gui/wxpython/docs/wxGUI.nviz.md
    M gui/wxpython/docs/wxGUI.toolboxes.md
    M gui/wxpython/docs/wxGUI.vnet.md
    M gui/wxpython/gcp/g.gui.gcp.md
    M gui/wxpython/gmodeler/g.gui.gmodeler.md
    M gui/wxpython/iclass/g.gui.iclass.md
    M gui/wxpython/image2target/g.gui.image2target.md
    M gui/wxpython/mapswipe/g.gui.mapswipe.md
    M gui/wxpython/photo2image/g.gui.photo2image.md
    M gui/wxpython/psmap/g.gui.psmap.md
    M gui/wxpython/rdigit/g.gui.rdigit.md
    M gui/wxpython/rlisetup/g.gui.rlisetup.md
    M gui/wxpython/timeline/g.gui.timeline.md
    M gui/wxpython/tplot/g.gui.tplot.md
    M gui/wxpython/vdigit/g.gui.vdigit.md
    M imagery/imageryintro.md
    M lib/cairodriver/cairodriver.md
    M lib/db/sqlp/sql.md
    M lib/htmldriver/htmldriver.md
    M lib/init/grass.md
    M lib/init/helptext.md
    M lib/init/variables.md
    M lib/pngdriver/pngdriver.md
    M lib/psdriver/psdriver.md
    M lib/vector/vectorascii.md
    M raster/r.li/r.li.daemon/r.li.daemon.md
    M raster/r.li/r.li.md
    M raster/rasterintro.md
    M raster3d/raster3dintro.md
    M temporal/temporalintro.md
    M utils/mkmarkdown.py
    M vector/v.lrs/lrs.md
    M vector/vectorintro.md

  Log Message:
  -----------
  docs: Use meta page info from HTML in Markdown (#5169)

Special pages like raster intro or r.li in the orginal HTML doc contain one or more of meta page such as name or description.

The conversion to Markdown ignored them. This brings the info over to Markdown in YAML headers. There is no use for it at this point. They are transferred as is except `name description` which is changed to just `description`.

Additionally, `description` if present is used as a level 1 heading. This makes pages to behave like the intro pages (e.g., raster intro). This is a slight change from HTML doc where r.li would try to behave like a tool, but that's more complex and I don't see why that would be better. 

Specifically this:

- Transfers meta page from HTML to Markdown as YAML header.
- Transfers meta page description to a Markdown heading if description is present.
- Moves heading level up in several files because using heading level 1 on the source code level requires further changes in the files to avoid skipping one heading level. (That's a linting issue.)
- Modifies one database (as in project parent directory) heading text to avoid having a duplicate heading. (That's also a linting issue.)
- Modifies the build procedure to combine YAML headers in files with generated YAML headers by parser. (For all files.)



To unsubscribe from these emails, change your notification settings at https://github.com/OSGeo/grass/settings/notifications