Should tyxml percent-encode urls ?
Open
Nobody has claimed this yet.
- Dominant language
- OCaml
- Stars
- 179
- Forks
- 63
- Avg merge
- 5h
- Merged PRs (30d)
- 22
Description
Code like this:
p [ a ~a:[ a_href "#val-(^)" ] [ txt "val (<)" ] ];
p [ a ~a:[ a_href "#val-(<)" ] [ txt "val (<)" ] ];
p [ a ~a:[ a_href "#val-(>)" ] [ txt "val (<)" ] ];
Generates HTML like this:
<p><a href="#val-(^)">val (<)</a></p>
<p><a href="#val-(<)">val (<)</a></p>
<p><a href="#val-(>)">val (<)</a></p>
Of course, web browsers accept this but tidy-html5 generates warnings:
Warning: <a> escaping malformed URI reference
Warning: <a> illegal characters found in URI
Warning: <a> escaping malformed URI reference
Warning: <a> illegal characters found in URI
Should Tyxml percent-encode the value of href attributes ?
Contributor guide
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 reproducing the three OCaml examples in the issue and comparing their generated HTML with tidy-html5's warnings. Determine the expected handling of href values such as #val-(^), #val-(<), and #val-(>); the work is done when Tyxml's behavior for these URI references is defined and validated against the reported warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100