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

manual: fix more broken HTML tags #4781

Merged
merged 2 commits into from
Nov 28, 2024

Conversation

neteler
Copy link
Member

@neteler neteler commented Nov 28, 2024

In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used (continuation of #4765).

This PR fixes numerous broken HTML tags identified during a test run of adding HTML validation with super-linter.

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12067630007/job/33651008404?pr=303

Fixes include:

  • complete selected ncomplete tag pairs (esp. <li>)
  • tabs replaced with white space
  • <, >, & replaced with their HTML representations
  • avoid caps in HTML tags
  • quote HTML tag values
  • URL fix: www.ohloh.net -> openhub.net

In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used (continuation of OSGeo#4765).

This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303).

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12067630007/job/33651008404?pr=303

Fixes include:
- complete selected ncomplete tag pairs (esp. `<li>`)
- tabs replaced with white space
- `<`, `>`, `&` replaced with their HTML representations
@neteler neteler added manual Documentation related issues HTML Related code is in HTML docs labels Nov 28, 2024
@neteler neteler added this to the 8.5.0 milestone Nov 28, 2024
@neteler neteler self-assigned this Nov 28, 2024
@github-actions github-actions bot added windows Microsoft Windows specific GUI wxGUI related vector Related to vector data processing raster Related to raster data processing temporal Related to temporal data processing database Related to database management libraries module general imagery raster3d labels Nov 28, 2024
raster/r.geomorphon/r.geomorphon.html Outdated Show resolved Hide resolved
python/grass/docs/_templates/oholosidebar.html Outdated Show resolved Hide resolved
python/grass/docs/_templates/oholosidebar.html Outdated Show resolved Hide resolved
python/grass/docs/_templates/oholosidebar.html Outdated Show resolved Hide resolved
@echoix echoix enabled auto-merge (squash) November 28, 2024 22:01
@echoix echoix merged commit b8fc5a2 into OSGeo:main Nov 28, 2024
23 checks passed
@neteler neteler deleted the manual_fix_broken_HTML_tags branch November 30, 2024 11:56
neteler added a commit that referenced this pull request Nov 30, 2024
* manual: fix more broken HTML tags

In order to obtain a good result when converting the HTML manual pages files to markdown, ideally clean HTML code is used (continuation of #4765).

This PR fixes numerous broken HTML tags identified during a test run of [adding HTML validation with super-linter](echoix#303).

For reference, see logs showing the errors at
https://github.com/echoix/grass/actions/runs/12067630007/job/33651008404?pr=303

Fixes include:
- complete selected ncomplete tag pairs (esp. `<li>`)
- tabs replaced with white space
- `<`, `>`, `&` replaced with their HTML representations

* Apply suggestions from code review

---------

Co-authored-by: Edouard Choinière <[email protected]>
@neteler neteler modified the milestones: 8.5.0, 8.4.1 Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
database Related to database management docs general GUI wxGUI related HTML Related code is in HTML imagery libraries manual Documentation related issues module raster Related to raster data processing raster3d temporal Related to temporal data processing vector Related to vector data processing windows Microsoft Windows specific
Projects
Development

Successfully merging this pull request may close these issues.

2 participants