Consistency in editorial style

Ms2ger commented 9 years ago

(From the spec:)

[ ] need to become consistent about whether or not to quote keyword ("<code data-x="">foo</code>" vs <code>foo</code>)
[ ] make the spec consistent about whether the word "algorithm" is part of an algorithm's name or not ("</dfn> algorithm", "</span> algorithm")
[ ] make the spec more consistent about the detail to which the spec explains how to interpret a string as a hexadecimal number.
[ ] become more consistent about what markup we use to mark up productions (nothing? <i>? <code>?)
[ ] use <code>Document</code> consistently instead of 'document'.
[ ] be clearer about arrays/lists/collections being zero-based despite using the term "/index/th".
[ ] use the sample widgets:

         <li><img alt="A text field with editable sections for each
         value, with a button to pop up a dialog showing a calendar or
         clock." src="sample-datetime-ui-2"></li>
         <li><img alt="A calendar grid with a clock in the upper right
         hand corner." src="sample-datetime-ui-3"></li>

yuyokk commented 8 years ago

Throughout the doc I see some text with color and some with colour. Should it be fixed to be consistent in the spec? I can give it a try if it makes sense :smile:

domenic commented 8 years ago

I did a quick search and it looks like existing usage is correct. In English prose, "colour" is used. For talking about code, where you can't spell things how you like but must instead follow standards, "color" is used. Similarly when referencing other document titles like CSS Color, you use the original document title.

yuyokk commented 8 years ago

@domenic oh, now I see how it works. Thanks for clarification.

marti1125 commented 8 years ago

@domenic could I work in this?

annevk commented 8 years ago

@marti1125 you sure can.

zcorpan commented 8 years ago

Note that we switched to en-US recently; make sure to branch off the latest commit on master. :)

domenic commented 8 years ago

@marti1125 FYI this one seems a bit tricky to me; personally I'd think https://github.com/whatwg/html/issues/1582 or https://github.com/whatwg/html/issues/1490 might be easier. But feel free to work on this too!

whatwg / html

Consistency in editorial style #17