alreq
alreq copied to clipboard
Document styling fixes
Tracking various document markup/styling issues, which are not urgent, but better be addressed before first public draft.
- [ ] Decide on
idsyntax and fix all tags.- [X] Decided to keep the
h_prefix. - [ ] Use either underscore or hyphen-minus.
- [X] Decided to keep the
- [ ] Fix style of all Unicode codepoint literals.
- [ ] Add character name to fix reference to a codepoint literal.
(Please add new ones at the end, and update with PR number when marking as done.)
[Copying part of this comment from https://github.com/w3c/alreq/pull/152#issuecomment-340725395]
I don't understand why there's a need to change the ids from h_xxx to xxx. As a consequence, all the links to the document from issues and from the text layout index (eg. http://w3c.github.io/typography/#glyphs_diacritics), etc., will now break and need to be fixed. I don't think that's a good thing, and i don't really want to take the time needed to edit the layout index doc just for that unless there's a good reason.
For the figure ids (and ids in general), i recommend that we don't use hyphen-minus. figure_id can be copied to the clipboard with a single doubleclick, but for figure-id you need to select and extend the range (which has to be done any time you want to link to that figure). It's a small thing, but it mounts up.
I recommend the following syntax for referring to Unicode code points, based on having tried lots of alternatives (I think we already agreed on this, but i could be mistaken).
<span class="codepoint"><span dir="rtl" lang="ar">ع</span> [<span class="uname">U+0639 ARABIC LETTER AIN</span>]</span>
Btw, this can be automatically generated really quickly by going to https://r12a.github.io/pickers/arabic/?text=%20%D8%B9 and clicking on Make Example.
Thanks, @r12a, for the feedback.
why there's a need to change the ids from h_xxx to xxx
Let's discuss this one on the meeting.
For the figure ids (and ids in general), i recommend that we don't use hyphen-minus. [...] It's a small thing, but it mounts up.
I don't have a hard preference here, either. The reason I thought maybe we want to change is 1) the fact that most (or all) examples from ReSpec docs is with hyphen, and 2) being able to jump in the middle of the id to edit it easily while authoring. (Related to double-click, but it's a good thing for me.)
Again, let's discuss in the meeting.
I recommend the following syntax for referring to Unicode code points, based on having tried lots of alternatives (I think we already agreed on this, but i could be mistaken).
You're right. We did. We should use that syntax. I'll submit PR to fix them.
One question, though: What is the expected different between codepoint and uname classes?