diff --git a/htmlcssguide.xml b/htmlcssguide.xml index 738c050..6308ee2 100644 --- a/htmlcssguide.xml +++ b/htmlcssguide.xml @@ -1,9 +1,8 @@ -

- Revision 2.1 + Revision 2.2

@@ -13,12 +12,12 @@ This style guide contains many details that are initially hidden from view. They are marked by the triangle icon, which you see here on your left. Click it now. - You should see “Hooray” appear below. + You should see “Hooray” appear below.

Hooray! Now you know you can expand points to get more - details. Alternatively, there’s a “toggle all” at the + details. Alternatively, there’s a “toggle all” at the top of this document.

@@ -52,8 +51,8 @@ files are not available over both protocols.

- Omitting the protocol—which makes the URL - relative—prevents mixed content issues and results in + Omitting the protocol—which makes the URL + relative—prevents mixed content issues and results in minor file size savings.

@@ -88,7 +87,7 @@

- Don’t use tabs or mix tabs and spaces for indentation. + Don’t use tabs or mix tabs and spaces for indentation.

<ul> @@ -109,7 +108,7 @@

- All code has to be lowercase: this applies to element names, + All code has to be lowercase: This applies to element names, attributes, attribute values (unless text/CDATA), selectors, properties, and property values (with the exception of strings). @@ -173,7 +172,7 @@

- Use comments to explain code: what does it cover, what + Use comments to explain code: What does it cover, what purpose does it serve, why is respective solution used or preferred?

@@ -181,7 +180,7 @@ (This item is optional as it is not deemed a realistic expectation to always demand fully documented code. Mileage may vary heavily for HTML and CSS code and depends on the - project’s complexity.) + project’s complexity.)

@@ -230,11 +229,15 @@ <!DOCTYPE html>.

- (It is recommended to use HTML, as text/html. Do not use + (It’s recommended to use HTML, as text/html. Do not use XHTML. XHTML, as application/xhtml+xml, lacks both browser and infrastructure support and offers less room for optimization than HTML.)

+

+ Although fine with HTML, do not close void elements, i.e. write + <br>, not <br />. +

@@ -276,7 +279,7 @@

- Use elements (sometimes incorrectly called “tags”) for what + Use elements (sometimes incorrectly called “tags”) for what they have been created for. For example, use heading elements for headings, p elements for paragraphs, a elements for anchors, etc. @@ -310,7 +313,7 @@

Providing alternative contents is important for - accessibility reasons: a blind user has few cues to tell + accessibility reasons: A blind user has few cues to tell what an image is about without @alt, and other users may have no way of understanding what video or audio contents are about either. @@ -369,9 +372,9 @@ <link rel="stylesheet" href="grid.css" media="screen"> <link rel="stylesheet" href="print.css" media="print"> <h1 style="font-size: 1em;">HTML sucks</h1> - <p>I’ve read about this on a few sites but now I’m sure: + <p>I’ve read about this on a few sites but now I’m sure: <u>HTML is stupid!!1</u> - <center>I can’t believe there’s no way to control the styling of + <center>I can’t believe there’s no way to control the styling of my website without doing everything all over again!</center> @@ -380,10 +383,10 @@ <title>My first CSS-only redesign</title> <link rel="stylesheet" href="default.css"> <h1>My first CSS-only redesign</h1> - <p>I’ve read about this on a few sites but today I’m actually + <p>I’ve read about this on a few sites but today I’m actually doing it: separating concerns and avoiding anything in the HTML of my website that is presentational. - <p>It’s awesome! + <p>It’s awesome! @@ -402,7 +405,7 @@

The only exceptions apply to characters with special meaning in HTML (like < and &) as - well as control or “invisible” characters (like no-break + well as control or “invisible” characters (like no-break spaces).

@@ -411,7 +414,7 @@ <!-- Recommended --> - The currency symbol for the Euro is “€”. + The currency symbol for the Euro is “€”.
@@ -428,9 +431,9 @@

(This approach may require a grace period to be established - as a wider guideline as it is significantly different + as a wider guideline as it’s significantly different from what web developers are typically taught. For - consistency and simplicity reasons it is best served + consistency and simplicity reasons it’s best served omitting all optional tags, not just a selection.)

@@ -512,7 +515,7 @@

(If you run into issues around whitespace between list items - it is acceptable to put all li elements in one + it’s acceptable to put all li elements in one line. A linter is encouraged to throw a warning instead of an error.)

@@ -542,6 +545,25 @@
+ + + Use double quotation marks for attribute values where necessary. + + +

+ When quoting attribute values, use double ("") rather + than single quotation marks (''). +

+ + <!-- Not recommended --> + <a class='maia-button maia-button-secondary'>Sign in</a> + + + <!-- Recommended --> + <a class="maia-button maia-button-secondary">Sign in</a> + + +
@@ -585,7 +607,7 @@

Generic names are simply a fallback for elements that have no particular or no meaning different from their siblings. They are - typically needed as “helpers.” + typically needed as “helpers.”

Using functional or generic names reduces the probability of @@ -700,7 +722,7 @@

- Omit unit specification after “0” values. + Omit unit specification after “0” values.

@@ -715,7 +737,7 @@

- Omit leading “0”s in values. + Omit leading “0”s in values.

@@ -727,20 +749,6 @@ - -

- Omit quotation marks in URI values. - - -

- Do not use quotation marks ("", - '') with url(). -

- - @import url(//www.google.com/css/go.css); - - - Use 3 character hexadecimal notation where possible. @@ -795,7 +803,7 @@ in order to improve understanding and scannability.

- /* Not recommended: does not separate the words “demo” and “image” */ + /* Not recommended: does not separate the words “demo” and “image” */ .demoimage {} /* Not recommended: uses underscore instead of hyphen */ @@ -810,12 +818,12 @@ - Avoid user agent detection as well as CSS “hacks”—try a different + Avoid user agent detection as well as CSS “hacks”—try a different approach first.

- It is tempting to address styling differences over user + It’s tempting to address styling differences over user agent detection or special CSS filters, workarounds, and hacks. Both approaches should be considered last resort in order to achieve and maintain an efficient and manageable @@ -823,7 +831,7 @@ free pass will hurt projects in the long run as projects tend to take the way of least resistance. That is, allowing and making it easy to use detection and hacks means using - detection and hacks more frequently—and more frequently + detection and hacks more frequently—and more frequently is too frequently.

@@ -909,7 +917,7 @@
- Use a space after a property name’s colon. + Use a space after a property name’s colon.

@@ -975,6 +983,35 @@ + +

+ Use single quotation marks for attribute selectors and property values + where necessary. + + +

+ When quoting attribute selectors and property values, use single + ('') rather than double ("") quotation + marks. Do not use quotation marks in URI values (url()). +

+ + /* Not recommended */ + @import url("//www.google.com/css/maia.css"); + + html { + font-family: "open sans", arial, sans-serif; + } + + + /* Recommended */ + @import url(//www.google.com/css/maia.css); + + html { + font-family: 'open sans', arial, sans-serif; + } + + +
@@ -985,7 +1022,7 @@

- If possible, group style sheets sections together by using + If possible, group style sheet sections together by using comments. Separate sections with new lines.

@@ -1010,7 +1047,7 @@ Be consistent.

- If you’re editing code, take a few minutes to look at the code + If you’re editing code, take a few minutes to look at the code around you and determine its style. If they use spaces around all their arithmetic operators, you should too. If their comments have little boxes of hash marks around them, make your @@ -1018,8 +1055,8 @@

The point of having style guidelines is to have a common vocabulary - of coding so people can concentrate on what you’re saying rather - than on how you’re saying it. We present global style rules here so + of coding so people can concentrate on what you’re saying rather + than on how you’re saying it. We present global style rules here so people know the vocabulary, but local style is also important. If code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they go to @@ -1028,7 +1065,7 @@

- Revision 2.1 + Revision 2.2