whatwg/html

Escaped characters in source

Open

#3,683 opened on May 14, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)HTML (7,654 stars) (2,520 forks)batch import
good first issue

Description

The current source file has a large number of encoded entities. This makes it rather hard to edit and read. As UTF-8 is everywhere, is it time to replace these with their Unicode representation?

For example:

  <li value="9"><cite lang="sh">Црна мачка, бели мачор</cite>, 1998</li>

Becomes:

  <li value="9"><cite lang="sh">Црна мачка, бели мачор</cite>, 1998</li>

And

<p w-nodev>In an algorithm, steps in <span data-x="synchronous section">synchronous
  sections</span> are marked with &#x231B;.</p>

Could be changed to:

<p w-nodev>In an algorithm, steps in <span data-x="synchronous section">synchronous
  sections</span> are marked with ⌛.</p>

There is one obvious exception - invisible / non-printing characters.

Would you be interested in a pull request to transform all the &#x... references to decoded equivalent?

This builds upon the HTML5.3 work done in https://github.com/w3c/html/pull/1280

Contributor guide

Tech stack
html
Domain
documentation
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic HTML knowledgetext editor
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Identify all HTML source files containing encoded entities (&#x...). Use the previous PR (https://github.com/w3c/html/pull/1280) as a reference. Ensure invisible/non printing characters are excluded. Create a pull request to replace them with Unicode characters.