Re: Editorial changes to clreq

Richard,

Thanks for your effort and the hard work. Appreciated.

---
Chen Yijun (@ethantw)

> On 14 May 2019, at 21:10, r12a <ishida@w3.org> wrote:
> 
> folks,
> 
> After discussion with Fuqiao this morning i made a number of wide-ranging editorial changes to clreq, to bring it into line with innovations in other lreq docs (jlreq, klreq, tlreq).  I was initially going to only do a couple of things, but decided to do some more in the end to keep things simpler for you all (even though i did interrupt a PR from @huijing (sorry!)).
> 
> I committed the changes directly (see commits for 14 May at https://github.com/w3c/clreq/commits/gh-pages).  The changes include the following:
> 
> 1. Add ids to all link elements and notes
> 
> 2. Change format for figure and section links to [[[...]]]
> This is the new respec syntax for such links (replacing empty a tags), and makes it easier to work with such links in wysiwyg or semi-wysiwyg editing environments, since the link text is visible.
> 
> 3. Replace data-lang with its-locale-filter-list.
> This addresses https://github.com/w3c/clreq/issues/76
> 
> 4. Apply change from data-lang to its-locale-filter-list to local.css and script.js
> 
> 5. Move language switch buttons to right side & colour.
> Avoids the buttons obscuring headings, and matches style for other multilingual lreq docs.
> 
> 6. Add explicit lang attributes everywhere there is its-..
> This makes it possible for respec to do localisations based on language while composing the page.
> The script.js file still tries to apply the language after loading. That code needs to be removed eventually.
> 
> 
> 
> 
> WHAT YOU NEED TO DO DIFFERENTLY FROM NOW ON
> 
> As you make edits and PRs, please bear in mind the following:
> 
> 1. use its-locale-filter-list instead of data-lang attribute
> 
> 2. everywhere its-locale-filter-list is used, also add lang= attribute
> 
> 3. any time you create a new <li> or <.. class="note"> element, put a unique id on it.  (It doesn't matter much what the id is, but rather than continuing with the current sequential numbering (just done for the initial batch), it may be easier to use something like 201905141400 (time stamp)).
> 
> Later we may want to add more ids, where clreq has several paragraphs in a section, but i haven't done that yet.
> 
> 
> 
> THINGS STILL TO DO
> 
> 1. remove translateme, checkme classes where appropriate - fixing anything that needs it.
> 
> 2. Fix some of the translations in the front matter.
> 
> 
> hope that helps,
> ri
> 

Received on Wednesday, 15 May 2019 13:01:58 UTC