-
Notifications
You must be signed in to change notification settings - Fork 1
/
generalmetarules.html
135 lines (135 loc) · 9.95 KB
/
generalmetarules.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE HTML>
<meta charset="utf-8">
<html>
<head>
<title>RnD Coding Standards</title>
<link rel="stylesheet" href="assets/css/stylesheet.css">
</head>
<body>
<div>
<img id = "rndimg" src="assets/img/Rnd CS.jpg">
</div>
<div id="lower-body">
<div id="left-portion">
<p id="table">Table of Contents:</p>
<ul id="table-of-contents">
<li id="content"><a href="/rndhtmlcsscodingstandards#note">Notes</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards#disclaimer">Disclaimer</a></li>
<li><a href="/rndhtmlcsscodingstandards#whoshould">Who Should Read This Book?</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/generalstylerules.html#generalstylerules">General Style Rules</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards/generalstylerules.html#protocol">Protocol</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/generalformattingrules.html#generalformattingrules">General Formatting Rules</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards/generalformattingrules.html#indentation">Indentation</a></li>
<li><a href="/rndhtmlcsscodingstandards/generalformattingrules.html#capitalization">Capitalization</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/generalmetarules.html#generalmetarules">General Meta Rules</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards/generalmetarules.html#encoding">Encoding</a></li>
<li><a href="/rndhtmlcsscodingstandards/generalmetarules.html#comments">Comments</a></li>
<li><a href="/rndhtmlcsscodingstandards/generalmetarules.html#items">Action items</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#htmlstylerules">HTML Style Rules</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#documenttype">Document Type</a></li>
<li><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#htmlvalidity">HTML Validity</a></li>
<li><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#semantics">Semantics</a></li>
<li><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#multimediafallback">Multimedia fallback</a></li>
<li><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#separation">Separation of concerns</a></li>
<li><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#entity">Entity references</a></li>
<li><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#optionaltags">Optional Tags</a></li>
<li><a href="/rndhtmlcsscodingstandards/htmlstylerules.html#typeattributes">Type attributes</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/htmlformattingrules.html#htmlformattingrules">HTML Formatting Rules</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards/htmlformattingrules.html#generalformatting">General formatting</a></li>
<li><a href="/rndhtmlcsscodingstandards/htmlformattingrules.html#quotationmarks">HTML quotation marks</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/cssstylerules.html#cssstylerules">CSS Style Rules</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#cssvalidity">CSS validity</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#idandclass">ID and class naming</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#idandclass2">ID and class name style</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#typeselectors">Type selectors</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#shorthandproperties">Shorthand properties</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#0andunits">0 and units</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#leading0s">Leading 0s</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#hexnotation">Hexadecimal notation</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#prefixes">Prefixes</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#idandclass3">ID and class name delimiter</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssstylerules.html#hacks">Hacks</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/cssformattingrules.html#cssformattingrules">CSS Formatting Rules</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards/cssformattingrules.html#declarationorder">Declaration order</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssformattingrules.html#blockcontent">Block content indentation</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssformattingrules.html#declarationstops">Declaration stops</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssformattingrules.html#propertynamestops">Property name stops</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssformattingrules.html#selectoranddeclaration">Selector and declaration separation</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssformattingrules.html#ruleseparation">Rule separation</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssformattingrules.html#cssquotationmarks">CSS quotation marks</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/cssmetarules.html#cssmetarules">CSS Meta Rules</a>
<div>
<ul id="submenu">
<li><a href="/rndhtmlcsscodingstandards/cssmetarules.html#sectioncomments">Section comments</a></li>
<li><a href="/rndhtmlcsscodingstandards/cssmetarules.html#partingwords">Parting words</a></li>
</ul>
</div>
</li>
<li id="content"><a href="/rndhtmlcsscodingstandards/references.html#references">References</a></li>
</ul>
</div>
<div id="right-portion">
<a name="generalmetarules"><h1>GENERAL META RULES</h1></a>
<h2><a id="subtopic" name="encoding">Encoding</a></h2>
<ul><li id="bullet">Use UTF-8 (no BOM).</li></ul>
<p id="information">Make sure your editor uses UTF-8 as character encoding, without a byte order mark.</p>
<p id="information">Specify the encoding in HTML templates and documents via <span><</span><span>meta charset="utf-8"</span><span>></span>. Do not specify the encoding of style sheets as these assume UTF-8.</p>
<h2><a id="subtopic" name="comments">Comments</a></h2>
<ul><li id="bullet">Explain code as needed, where possible.</li></ul>
<p id="information">Use comments to explain code: What does it cover, what purpose does it serve, why is respective solution used or preferred?</p>
<p id="bulleted-information">Examples:</p>
<img src="assets/img/pic9.jpg">
<img src="assets/img/pic10.jpg">
<h2><a id="subtopic" name="items">Action items</a></h2>
<ul><li id="bullet">Mark todos and action items with TODO.</li></ul>
<p id="information">Highlight todos by using the keyword <span>TODO</span> only, not other common formats like <span>@@</span>.</p>
<p id="information">Append a contact (username or mailing list) in parentheses as with the format <span>TODO(contact)</span>.</p>
<p id="information">Append action items after a colon as in TODO: action item.</p>
<p id="bulleted-information">Examples:</p>
<img src="assets/img/pic11.jpg">
<img src="assets/img/pic12.jpg">
<img src="assets/img/pic13.jpg">
</div>
</div>
</body>
</html>