ocsigen / ocsigen/tyxml

`~indent:true` generates broken HTML

Open
#332 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
OCaml
Stars
179
Forks
63
Avg merge
5h
Merged PRs (30d)
22

Description

Hi,

This is quite similar to #287 and #288 but more annoying...

When using br () and ~indent:true, sometimes there will be a line break in the middle of the generated <br />, for instance:

... <
... br />

Thus the produced HTML is invalid (< is not escaped...) and <br/> will even be displayed in the rendered page, which is of course problematic.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with br () and ~indent:true, then locate the HTML formatting code that inserts line breaks within the generated
element. Add a regression test for the shown invalid output and verify that indentation never splits the tag.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, ocaml
Domain
web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.