Notes and friends generate semantic HTML garbage
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 91
- Forks
- 59
- PR merge metrics
- No merged PRs in 30d
Description
I've just noticed that <note> (and likely <caution>, <warning>, and <tip>) especially when having a <title> generate semantic HTML garbage HTML. See e.g. https://www.php.net/manual/en/openssl.installation.php.
<note> yields a <blockquote> which is doubtful per se, but the <title> is just a <strong> element. Instead, we should probably generate a <section> (a div might be a first step in the right direction) ideally with a proper heading for the title. Regarding the latter it might be hard to keep a proper heading structure, but even a gap in the headers appears to be better than misusing a <blockquote>, and a title should be a title.
Also, <simpara>s inside the <note> are apparently ignored/collapsed.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the generated HTML for the cited openssl.installation.php page, focusing on note, caution, warning, tip, title, and simpara handling. Compare the current structure with the issue's semantic-HTML concerns; done means titles have heading semantics and nested simparas are preserved rather than ignored or collapsed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100