index.html
69.3 KB
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang=
"en-US">
<head>
<title>W3C Manual of Style</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="/StyleSheets/generic-base-1.css" type="text/css"/>
<link rel="stylesheet" type="text/css" href="/Guide/guide2006.css" />
<link rel="shortcut icon" href="/Icons/WWW/Literature.gif" />
<style type="text/css">
#maintoc li {
font-weight: bold;
}
#maintoc ol, #maintoc ul {
padding-left: 0;
}
#maintoc li li {
font-weight: normal;
list-style: none;
}
</style>
</head>
<body>
<div id="header">
<span class="logo"><a href="/"><img src="/Icons/WWW/w3c_home_nb"
alt="W3C" height="48" width="72"/></a></span>
<div class="breadcrumb">
<a href="/Member/">Member</a> → <a href="/Guide/">The Art of
Consensus</a> →
<h1>Manual of Style</h1>
</div>
<p class="baseline">This <strong>Guidebook</strong> is the collected
wisdom of the W3C Group Chairs and other collaborators.</p>
</div>
<div class="toc">
<h4>Also On This Page →</h4>
<ul>
<li style="display: none"><a href="#SOTD">Status</a> •</li>
<li><a href="#toc">Contents</a></li>
</ul>
</div>
<div class="toolbox box" style="margin-bottom: 1em">
<h4>Publication Policies</h4>
<ul>
<li><a href="/Guide/pubrules">Technical Report Publication Policy</a></li>
<li><a href="/Guide/pubrules-about">About pubrules</a></li>
<li><a href="/2005/05/tr-versions">Version Management in W3C Technical Reports</a></li>
<li><a href="/2005/07/13-pubrules-disclosure">Guidelines for linking to
disclosure pages</a></li>
<li><a href="/2005/07/13-nsuri">URIs for W3C Namespaces</a></li>
<li><a href="/2002/06/registering-mediatype">How to Register a Media Type for a W3C Specification</a></li>
<li><a href="/2005/04/xpointer-policy">XPointer Scheme Name Registry Policy</a></li>
</ul>
<h4>Resources</h4>
<ul>
<li><a href="/Guide/transitions">Organize Recommendation Track
Transition</a></li>
<li><a href="/Guide/transitions-about" shape="rect">Details of Rec
Track transitions</a></li>
<li><a
href="http://www.w3.org/2005/10/Process-20051014/tr.html#Reports">Recommendation
Track Process</a></li>
<li><a href="/2003/Editors/">W3C Editors' Home Page</a></li>
<li>Manual of Style</li>
<li><a href="/2005/03/28-editor-style.html">Style Guidelines for Group-Internal Drafts</a></li>
</ul>
<h4>Tools</h4>
<ul>
<li><a href="http://validator.w3.org/checklink">Link checker</a></li>
<li><a href="http://validator.w3.org/">HTML Validator</a></li>
<li><a href="http://jigsaw.w3.org/css-validator/">CSS Validator</a></li>
</ul>
</div>
<p><img style="float:none;" height="28" width="316" alt=
"editor's red and blue pencil" src="pencil" /></p>
<h2><a id="SOTD" name="SOTD">Status of This Document</a></h2>
<p>This is the <cite>W3C Manual of Style</cite> based on <cite><a href=
"/Guide/Reports">How to Write a W3C Technical Report</a></cite> (W3C
Member-only link). This manual is a guide containing best current
practice. No requirements for W3C publications are in this document.
All requirements for W3C publications are in <cite>W3C Publication
Rules</cite> [<cite><a href="#ref-PUBRULES">PUBRULES</a></cite>].</p>
<p>Helpful resources for editors and authors are kept on the
<cite><a href="http://www.w3.org/2003/Editors/">W3C Editors Home
Page</a></cite> [<cite><a href="#ref-EDITORS">EDITORS</a></cite>].
Notes on document management are available [<cite><a href=
"#ref-MANAGE">MANAGE</a></cite>]. When in doubt, ask for help on the
public mailing list <cite>spec-prod@w3.org</cite> [<cite><a href=
"#ref-SPEC-PROD">SPEC-PROD</a></cite>].</p>
<p>Please send
your comments to the public mailing list <a href=
"mailto:spec-prod@w3.org">spec-prod@w3.org</a> (<a href=
"http://lists.w3.org/Archives/Public/spec-prod/">archive</a>).
If for any reason you do not
wish your contributions to be credited in <a href=
"#ACK">Acknowledgments</a>, please indicate this in your email.</p>
<h2><a accesskey="c" id="toc">Table of Contents</a></h2>
<ol id="maintoc">
<li><a href="#Introduction">Introduction</a></li>
<li><a href="#Validation">Validation</a></li>
<li><a href="#Accessibility">Accessibility</a></li>
<li>
<a href="#I18n">Internationalization</a>
<ul>
<li><a href="#Unicode">4.1 Unicode</a></li>
<li><a href="#Translations">4.2 Translations</a></li>
<li><a href="#Dates">4.3 Style for Dates</a></li>
</ul>
</li>
<li>
<a href="#Parts">The Parts of a Technical Report</a>
<ul>
<li><a href="#Title">5.1 Document Title</a></li>
<li><a href="#Editors">5.2 Editors and
Authors</a></li>
<li><a href="#Abstract">5.3 Abstract</a></li>
<li>
<a href="#Status">5.4 Status Section</a>
</li>
</ul>
</li>
<li><a href="#Errata">Errata</a></li>
<li>
<a href="#References">References</a>
<ul>
<li><a href="#extractor">7.1 Bibliography
Extractor</a></li>
<li><a href="#citation">7.2 Citation</a></li>
<li><a href="#linking-within">7.3 Citing a Reference
From Within a Document</a></li>
<li><a href="#ref-section">7.4 References
Section</a></li>
<li><a href="#normative">7.5 Normative and Informative
References</a></li>
</ul>
</li>
<li><a href="#Revisions">Revisions</a></li>
<li><a href="#Production"><abbr title=
"Extensible Markup Language">XML</abbr>, <acronym title=
"XML Specification DTD">XMLspec</acronym>, <abbr title=
"XSL Transformations">XSLT</abbr> and Production</a></li>
<li><a href="#RFC"><abbr title=
"Request for Comments">RFC</abbr> 2119 Key Words</a></li>
<li>
<a href="#Editorial">Editorial Guidelines</a>
<ul>
<li><a href="#Grammar">11.1 Grammar</a></li>
<li><a href="#Spelling">11.2 Spelling</a></li>
<li><a href="#Punctuation">11.3 Punctuation</a></li>
<li><a href="#Case">11.4 Case, Combining Words, and
Hyphenation</a></li>
<li><a href="#Misc">11.5 Miscellaneous</a></li>
<li><a href="#Linking">11.6 Linking</a></li>
<li><a href="#Examples">11.7 Using Examples</a></li>
<li><a href="#Images">11.8 Images</a></li>
<li><a href="#Markup">11.9 Markup</a></li>
<li><a href="#Large">11.10 Large Documents</a></li>
</ul>
</li>
<li><a href="#MediaTypes">Internet Media Types</a></li>
<li><a href="#Terms">Commonly Misspelled
Terms</a></li>
<li><a href="#ACK">Acknowledgments</a></li>
<li><a href="#REF">References</a></li>
<li><a href="#Changes">Change History</a></li>
<li><a href="#ToDo">To Do List</a></li>
</ol>
<h2><a id="Introduction" name="Introduction">1. Introduction</a></h2>
<p>Written for editors and authors of W3C technical reports, this
document assumes that the reader has mastered publishing on the W3C Web
site, and is familiar with the <cite>Style Guide for Online
Hypertext</cite> [<cite><a href=
"#ref-STYLE-GUIDE">STYLE-GUIDE</a></cite>]. It is a companion to the
<em class="RFC2119">REQUIRED</em> <cite>Technical Report Publication
Policy</cite> [<cite><a href="#ref-PUBRULES">PUBRULES</a></cite>],
called "pubrules" for short. Following the advice in this manual has
benefits:</p>
<ul>
<li>Non-native English readers, native English readers, and translators
will find your text easy to read and implement.</li>
<li>All audiences can concentrate on ideas rather than the mechanics of
reading.</li>
<li>Polished at early public maturity levels, clean copy eliminates
multiple "typo" reports.</li>
</ul>
<p>Chapter 2 covers <a href="#Validation">validation</a>. Chapters 3
and 4 cover <a href="#Accessibility">accessibility</a> and <a href=
"#I18n">internationalization</a>. Chapter 5 describes <a href=
"#Parts">parts</a> of a W3C technical report. Chapters 6, 7, and 8
cover <a href="#Errata">errata</a>, <a href=
"#References">references</a> and <a href="#Revisions">revisions</a>.
Chapter 9 introduces <a href="#Production"><acronym title=
"XML Specification DTD">XMLspec</acronym> and <abbr title=
"XSL Transformations">XSLT</abbr></a>. Chapter 10 addresses <a href=
"#RFC"><abbr title="Request for Comments">RFC</abbr> 2119 key
words</a>. Chapter 11 presents <a href="#Editorial">editorial
guidelines</a>, and, finally, chapter 12 documents commonly <a href=
"#Terms">misspelled terms</a>.</p>
<p>Bear in mind that our reports are used as world-class primary
reference material. Readability across a wide variety of browsers and
platforms is far more important than using jazzy features. At some
point, what we write becomes history and is preserved on the Web
through the W3C <cite><a href=
"http://www.w3.org/Consortium/Persistence">Persistence
Policy</a></cite> [<cite><a href=
"#ref-PERSISTENCE">PERSISTENCE</a></cite>].</p>
<h2><a id="Validation" name="Validation">2. Validation</a></h2>
<ul>
<li>Make sure there are no broken links in your documents at the time
of publication. Some services on the Web may help you with this,
including the <cite>W3C Link Checker</cite> [<cite><a href=
"#ref-CHECKLINK">CHECKLINK</a></cite>]. Append ",checklink" to a W3C
<abbr title="Uniform Resource Identifier">URI</abbr> to invoke the link
checker.</li>
<li>Make sure your technical report validates in the <cite>W3C Markup
Validation Service</cite> [<cite><a href=
"#ref-VALIDATE">VALIDATE</a></cite>]. Append ",validate" to a W3C
<abbr title="Uniform Resource Identifier">URI</abbr> to invoke the
validator.</li>
<li>Make sure your technical report validates in the <cite>W3C
<abbr title="Cascading Style Sheets">CSS</abbr> Validation
Service</cite> [<cite><a href=
"#ref-CSSVALIDATE">CSSVALIDATE</a></cite>]. Append ",cssvalidate" to a
W3C <abbr title="Uniform Resource Identifier">URI</abbr> to invoke the
<abbr title="Cascading Style Sheets">CSS</abbr> validator.</li>
<li>Make sure any examples in your document validate as well.</li>
</ul>
<p><strong>Note.</strong> It is the editor's responsibility to ensure
that documents are valid before requesting publication.</p>
<h2><a id="Accessibility" name="Accessibility">3.
Accessibility</a></h2>
<ul>
<li>Follow the <cite>Web Content Accessibility Guidelines 1.0</cite>
(<abbr>WCAG</abbr>) [<cite><a href="#ref-WCAG">WCAG</a></cite>]. Can
simpler words express your ideas? Is your text marked up with
structural elements? Are alternatives provided for auditory and visual
content?</li>
<li>Use two or more accessibility evaluation tools such as
<cite>Bobby</cite>, <cite>The Wave</cite>, or <cite>A-Prompt</cite>
[<cite><a href="#ref-EVALUATE">EVALUATE</a></cite>].</li>
</ul>
<h2><a id="I18n" name="I18n">4. Internationalization</a></h2>
<p>Follow the <cite>Character Model for the World Wide Web 1.0:
Fundamentals</cite> W3C work in progress [<cite><a href=
"#ref-CHARMOD">CHARMOD</a></cite>]. Does your specification define
protocols or format elements? If it does, define when conversion to
legal <abbr title="Uniform Resource Identifier">URI</abbr> reference
characters takes place, and do so as late as possible.</p>
<h3><a id="Unicode" name="Unicode">4.1 Unicode</a></h3>
<p>When specifying characters, refer to <cite>The Unicode
Standard</cite>; see <a href=
"http://www.w3.org/TR/charmod/#sec-RefUnicode" title=
"Section 8 of the Character Model">section 8</a> of the <cite>Character
Model for the World Wide Web 1.0: Fundamentals</cite> [<cite><a href=
"#ref-CHARMOD">CHARMOD</a></cite>]. The Unicode Consortium gives
guidelines for how to cite their standards; see [<cite><a href=
"#ref-UNICODE">UNICODE</a></cite>]. Refer to individual characters in
any of three ways; see the email thread <cite>"Unicode character
names"</cite> [<cite><a href=
"#ref-CHARNAMES">CHARNAMES</a></cite>]:</p>
<ol>
<li>by codepoint (<span class="not-en">e.g.</span>,
<code>U+002E</code>)</li>
<li>by formal Unicode name (<span class="not-en">e.g.</span>,
<span class="UnicodeName">full stop</span>); see [<cite><a href=
"#ref-CHARTS">CHARTS</a></cite>]</li>
<li>by Unicode alias (<span class="not-en">e.g.</span>, <span class=
"UnicodeAlias">dot</span>, or <span class="UnicodeAlias">decimal
point</span>, or <span class="UnicodeAlias">period</span>); see
[<cite><a href="#ref-CHARTS">CHARTS</a></cite>]</li>
</ol>
<h3><a id="Translations" name="Translations">4.2 Translations</a></h3>
<p>W3C has no official translations of its technical reports. W3C does
encourage people to translate the technical reports and helps to track
translators and translations.</p>
<ul>
<li>A central translation page includes links to pages that document
translations of particular specifications [<cite><a href=
"#ref-TRANSLATE">TRANSLATE</a></cite>].</li>
<li>Read the <cite>W3C Intellectual Property <acronym title=
"Frequently Asked Questions list">FAQ</acronym></cite>, <cite><a href=
"http://www.w3.org/Consortium/Legal/IPR-FAQ-20000620#translate">Can I
translate one of your specifications into another language?</a></cite>
and <cite><a href=
"http://www.w3.org/Consortium/Legal/IPR-FAQ-20000620#official">Can I
create the "official" translation?</a></cite> ([<cite><a href=
"#ref-IPRFAQ">IPRFAQ</a></cite>] sections 5.6 and 5.7).</li>
</ul>
<p>Although technical reports are written in U.S. English, examples and
wording should not rely on conventions and idioms used only in the
United States (<span class="not-en">e.g.</span>, "<acronym title=
"U.S. Postal Service acronym for Zone Improvement Plan">ZIP</acronym>
code"). Use international examples (<span class="not-en">e.g.</span>,
"postal code") wherever possible.</p>
<p>Make your specification more readable by adding markup to
distinguish common words from keywords in your language. Mark up every
occurrence. For example:</p>
<pre>
The title attribute of these elements
may be used to provide the full
or expanded form of the expression.
</pre>
<p>becomes:</p>
<pre>
The <code>title</code> attribute of these elements
may be used to provide the full
or expanded form of the expression.
</pre>
<p>A French translator would then know not to translate <em>title</em>
to <em xml:lang="fr" lang="fr">titre</em>.</p>
<p>First person pronouns ("I," "we") which are hard to translate should
not be used in the text of examples. See the email message
<cite>"Personal pronouns in specifications"</cite> [<cite><a href=
"#ref-PRONOUNS">PRONOUNS</a></cite>]. Avoid "my" and "me" in examples
(<span class="not-en">e.g.</span>, use "userResource" and not
"myResource").</p>
<p>Specifications should not directly address the reader as well.
Translating second person singular pronouns is a hard task if the
language distinguishes between various forms like formal and informal
of "you," hence avoid "you."</p>
<p>Do not invent elements to replace natural language. For example, do
not use <code><must/></code> and a stylesheet to render MUST.
Other languages may need grammatical agreement with the sentence's
subject, <span class="not-en">e.g.</span>, in French, MUST will become
<em xml:lang="fr" lang="fr">DOIT</em> if the subject is singular, or
<em xml:lang="fr" lang="fr">DOIVENT</em> if it is plural. Use standard
markup instead.</p>
<h3><a id="Dates" name="Dates">4.3 Style for Dates</a></h3>
<p>5/6/03 to denote a date is ambiguous in the international context
(the example could mean 6 May or 5 June). Either spell out the month (6
May 2003) or use an ISO-8601-derived form (2003-05-06). <cite><a href=
"http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#date" title=
"Section 3.2.9 of the XML Schema Datatypes">XML Schema Part 2:
Datatypes</a></cite> ([<cite><a href=
"#ref-SCHEMA-DATATYPES">SCHEMA-DATATYPES</a></cite>], sections 3.2.9
through 3.2.14.1) formally explains how to write dates in XML
documents.</p>
<h2><a id="Parts" name="Parts">5. The Parts of a Technical
Report</a></h2>
<p id="Template">As of November 2005, <a href=
"/Guide/pubrules">pubrules</a> [<cite><a href=
"#ref-PUBRULES">PUBRULES</a></cite>] includes a technical report
template.</p>
<h3><a id="Title" name="Title">5.1 Document Title</a></h3>
<p>The title of your document in the document head and on the technical
reports index [<cite><a href="#ref-TR">TR</a></cite>] will read as
follows. Optional elements are in square brackets.</p>
<p>Title [(ACRONYM)] ["Specification"] ["Part" Part_Number] [:
Subtitle] ["Module"] [(nth "Edition")] ["Version" Version_Number]</p>
<p>See pubrules [<cite><a href="#ref-PUBRULES">PUBRULES</a></cite>] for
information about the use of "version" and "edition". "Level" and
"revised" are deprecated. Try not to invent a new titling
convention.</p>
<p>Capitalize title words following U.S. usage.</p>
<h3><a id="Editors" name="Editors">5.2 Editors and Authors</a></h3>
<h3 id="affs">5.2.1 Managing Changing Affiliations</h3>
<p>Editor/Author affiliations change over time. Here are examples that
illustrate the suggested approach for managing them.</p>
<dl>
<dt>Still editor</dt>
<dd>Richard Ishida, W3C (and before at Xerox)</dd>
<dd>François Yergeau, Invited Expert (and before at Alis
Technologies)</dd>
<dd>Jane Doe, MyCompany (and before at ThierCompany, and at HisCompany,
and at HerCompany)</dd>
<dt>No longer editor</dt>
<dd>Martin J. Dürst (until Dec 2004 while at W3C)</dd>
<dd>Misha Wolf (until Dec 2002 while at Reuters Ltd.)</dd>
<dd>Tex Texin (until Dec 2004 while an Invited Expert, and before at
Progress Software)</dd>
<dd>FitzChivalry Farseer (until Oct 2005 while at AnyCompany, and
before at ThisCompany, and at ThatCompany)</dd>
</dl>
<h3><a id="Abstract" name="Abstract">5.3 Abstract</a></h3>
<p><a id="must-abstract" name="must-abstract">Give each document an
Abstract</a> (a few paragraphs at most) that summarizes what the
document is about. The Communications Team may use the Abstract as a
whole or in part to publicize your work. Write it for a non-technical
audience.</p>
<h3><a id="Status" name="Status">5.4 Status Section</a></h3>
<p>The "Status of This Document" section describes the document status
and publication context on the publication date. Pubrules
[<cite><a href="#ref-PUBRULES">PUBRULES</a></cite>] states the
requirements for the status section of each type of technical report
(e.g., use of customized and boilerplate text).</p>
<p>Since the status section does not change over time, express it in
terms that will be valid over time (<span class="not-en">e.g.</span>,
avoid the word "new"). Indicate the anticipated stability of the
document while recognizing that the future is unknown. Readers are
responsible for discovering the latest status information (<span class=
"not-en">e.g.</span>, by following the latest version link, or visiting
the W3C technical reports index [<cite><a href=
"#ref-TR">TR</a></cite>].</p>
<p>The custom paragraph is very important as it actually contains
information! In it, you should explain where a part of the energy of
the group has been invested. The custom paragraph should help a reader
decide "I really should read this draft." This implies that you
shouldn't paste it in from somewhere else. It should be very specific
to this document.</p>
<p>TimBL expressed the goal of the custom paragraph this way, "Don't be
afraid of being honest about the relevant techno-political situation."
In the custom paragraph, make th case for why someone should read this
draft.</p>
<p>In the custom paragraph, include what you would reply to a Member or
colleague who asked you such things as:</p>
<ul>
<li>Are we requesting that people implement this specification? If so,
where should experience reports be sent?</li>
<li>Are we requesting people do <em>not</em> implement the
specification until a later date? What sort of damage do we expect to
inflict on those who do by future changes to the document?</li>
<li>Does it reflect the consensus of a W3C Working Group? (Pay
attention to the authors and acknowledgments.)</li>
<li>Are there any changes expected?</li>
<li>Do we maintain a page of background information (<span class=
"not-en">e.g.</span>, the <abbr title=
"Platform for Privacy Preferences Project">P3P</abbr> <abbr title=
"Frequently Asked Questions list">FAQ</abbr> [<cite><a href=
"#ref-P3PFAQ">P3PFAQ</a></cite>])?</li>
<li>For pre-release drafts, state in the status section any limits on
redistribution, such as "Member confidential."</li>
</ul>
<h2><a id="Errata" name="Errata">6. Errata</a></h2>
<p>All Recommendations have errors in them. They link to an errata page
that evolves over time. Since the errata page changes over time but a
specific version of a Recommendation does not, place the errata page
<strong>outside</strong> of the <kbd>/TR</kbd> hierarchy. There is an
expectation that documents in the "<abbr title=
"technical report">TR</abbr> zone" will not evolve over time
[<cite><a href="#ref-PERSISTENCE">PERSISTENCE</a></cite>]. For example,
locate errata pages in the portion of the Web space dedicated to the
relevant Working Group or Activity.</p>
<p>Clearly indicate on the errata page:</p>
<ul>
<li>The last modified date for the errata page.</li>
<li>The <abbr title="Uniform Resource Identifier">URI</abbr> of the
source document (<span class="not-en">i.e.</span>, the one with the
errata).</li>
<li>Where to find the latest version of the source document.</li>
</ul>
<p>For example (shown here without links):</p>
<dl style="margin-left: 10%">
<dt>This document:</dt>
<dd>http://www.w3.org/Style/css2-updates/REC-CSS2-19980512-errata</dd>
<dt>Last revised:</dt>
<dd>$Date: 2009/06/15 22:02:17 $</dd>
<dt>This document records known errors in the document:</dt>
<dd>http://www.w3.org/TR/1998/REC-CSS2-19980512</dd>
<dt>The latest version of the CSS 2 Recommendation:</dt>
<dd>http://www.w3.org/TR/REC-CSS2</dd>
</dl>
<p>On the errata page, list the newest entries nearer to the top.</p>
<h3><a name="errata-entry" id="errata-entry">Entries on an errata
page</a></h3>
<p>For each entry on the errata page, provide:</p>
<ol>
<li>A unique identifier</li>
<li>The date it was added to the errata page</li>
<li>A classification of the error (e.g., editorial, clarification, bug,
known problem with the document itself)</li>
<li>A short description of the problem and what part of the
Recommendation is affected.</li>
<li>Any proposed corrections and whether those corrections would affect
conformance of documents or software</li>
<li>Any normative corrections; see the section on <a href=
"http://www.w3.org/2003/06/Process-20030618/tr.html#errata">Errata
Management</a> in the <cite>W3C Process Document</cite>
([<cite><a href="#ref-PROCESS">PROCESS</a></cite>] section 7.6.1) for
more information about normative corrections</li>
</ol>
<p>Do no remove entries from the errata page; if a correction turns out
to be incorrect, just add another entry (with a cross reference).</p>
<h2><a id="References" name="References">7. References</a></h2>
<h3><a id="extractor" name="extractor">7.1 Bibliography
Extractor</a></h3>
<p>The <cite><a href=
"http://www.w3.org/2002/01/tr-automation/tr-biblio-ui">W3C Bibliography
Extractor</a></cite> [<cite><a href=
"#ref-BIB-EXTRACT">BIB-EXTRACT</a></cite>] will automatically generate
a list of references in W3C style.</p>
<h3><a id="citation" name="citation">7.2 Citation</a></h3>
<p>Reference links (<span class="not-en">e.g.</span>, "[<abbr title=
"Extensible Markup Language">XML</abbr>]") link at least the first mention of a source to the References
section and take the form:</p>
<pre>
<cite><a href="http://www.example.org/example">Full Name</a></cite> [<cite><a href="#ref-REFNAME">REFNAME</a></cite>]
</pre>
<p>Parentheses around square brackets can be omitted unless the
parentheses would contain a section number.</p>
<p>References links occur at minimum at the first mention of the
source. Spell out what the reference link refers to at least in the
first occurrence, <span class="not-en">e.g.</span>:</p>
<pre>
This is discussed in <cite>Namespaces in XML</cite> [XMLName].
</pre>
<p>or</p>
<pre>
This is discussed in the XML namespaces specification [XMLName].
</pre>
<p>and not</p>
<pre>
This is discussed in [XMLName].
</pre>
<h3><a id="linking-within" name="linking-within">7.3 Citing a Reference
From Within a Document</a></h3>
<p>When linking from the middle of the document to an external
resource:</p>
<ol>
<li>Ensure that the link text, title, and context indicate you are
leaving the document, and</li>
<li>After the link, link to the reference in the references section,
and indicate section, page, or whatever is useful for those when the
link is unavailable (e.g., when printed).</li>
</ol>
<p>Thus, for example:</p>
<pre>
...as is done for the <a href=
"http://www.w3.org/TR/1998/REC-CSS2-19980512/page.html#named-pages"
title=
"Section 13.3.2 of CSS 2">'page' property of CSS2</a> ([<cite><a href=
"#ref-CSS2">CSS2</a></cite>], section 13.3.2).
</pre>
<h3><a id="ref-section" name="ref-section">7.4 References
Section</a></h3>
<ul>
<li>All entries in a references section should be referred to in the
prose. If an entry is not referred to from the body of the document,
make it clear why it is in the References section.</li>
<li>If a reference is a W3C Recommendation track technical report that
has not reached Recommendation, state in the References section that it
is "work in progress."</li>
<li>It is helpful to include references to both persistent resources
and their latest version. Use titles for links. If there is an
institutionalized identifier (<abbr title=
"Uniform Resource Identifier">URI</abbr>) for a document, cite the most
specific identifier. For example, usually you would link the title to
<kbd>http://www.w3.org/TR/1999/REC-html401-19991224</kbd> rather than
to <kbd>http://www.w3.org/TR/html4/</kbd>. For more information on
using versioned and unversioned identifiers, refer to the
<cite><a href="http://www.w3.org/TR/charmod/#sec-RefUnicode">Character
Model for the World Wide Web 1.0: Fundamentals</a></cite>
([<cite><a href="#ref-CHARMOD">CHARMOD</a></cite>] section 8).</li>
<li>An entry in a references section takes this form:
<ul>
<li>Title, inside <code>a</code> (if available), inside
<code>cite</code></li>
<li>Comma-delimited list of authors' names</li>
<li>If there are no authors, use editors instead if available.
Following the last family name, say "eds." or "Editors."</li>
<li>Publisher, followed by the date of publication in the form DD Month
YYYY</li>
<li>A sentence containing a text-only <abbr title=
"Uniform Resource Identifier">URI</abbr>.</li>
<li>When available, a sentence ending in the latest version
<abbr title="Uniform Resource Identifier">URI</abbr></li>
</ul>
<p>Example:</p>
<dl>
<dt>[XML1]</dt>
<dd><cite><a href="http://www.w3.org/TR/2006/REC-xml-20060816/">Extensible Markup Language (XML) 1.0 (Fourth Edition)</a></cite>, T. Bray, J. Paoli, E. Maler, C. M. Sperberg-McQueen, F. Yergeau, Editors. World Wide Web Consortium, 16 August 2006, edited in place 29 September 2006. This edition of the XML 1.0 Recommendation is http://www.w3.org/TR/2006/REC-xml-20060816/. The <a href="http://www.w3.org/TR/xml/">latest edition of XML 1.0</a> is available at http://www.w3.org/TR/xml/.</dd>
</dl>
<p>Markup for the example above:</p>
<pre>
<dl>
<dt><a id="ref-XML1" name="ref-XML1">[XML1]</a></dt>
<dd><cite><a href="http://www.w3.org/TR/2006/REC-xml-20060816/">Extensible
Markup Language (XML) 1.0 (Fourth Edition)</a></cite>,
T. Bray, J. Paoli, E. Maler, C. M. Sperberg-McQueen, F. Yergeau,
Editors. World Wide Web Consortium, 16 August 2006, edited in place
29 September 2006. This edition of the XML 1.0 Recommendation is
http://www.w3.org/TR/2006/REC-xml-20060816/. The <a
href="http://www.w3.org/TR/xml/">latest edition of XML 1.0</a>
is available at http://www.w3.org/TR/xml/.</dd>
</pre>
</li>
<li>Reference titles are recommended, not the "<abbr title=
"Uniform Resource Identifier">URI</abbr>-in-your-face" idiom, as link
text; see [<cite><a href="#ref-REF-TITLES">REF-TITLES</a></cite>]. For
example, <strong>Do use</strong>: <kbd><cite><a
href="http://www.w3.org/TR/1999/REC-html401-19991224/">HTML 4.01
Specification</a></cite></kbd>. Do not use:
<kbd><cite><a
href="http://www.w3.org/TR/1999/REC-html401-19991224/">http://www.w3.org/TR/1999/REC-html401-19991224</a></cite></kbd>.</li>
</ul>
<h3><a id="normative" name="normative">7.5 Normative and Informative
References</a></h3>
<p>Normative references should be to stable and mature resources
(<span class="not-en">e.g.</span>, only Recommendations).</p>
<h2><a id="Revisions" name="Revisions">8. Revisions</a></h2>
<p>See the <cite><a href=
"/2003/06/Process-20030618/tr.html#rec-modify">W3C Process
Document</a></cite> ([<cite><a href="#ref-PROCESS">PROCESS</a></cite>]
section 7.6) for instructions on how to revise a technical report.</p>
<p><strong>Note.</strong> When a document is revised, the original
publication date remains the same (and on the technical reports index
[<cite><a href="#ref-TR">TR</a></cite>] as well); see pubrules
[<cite><a href="#ref-PUBRULES">PUBRULES</a></cite>] for more
detail.</p>
<p>Be careful not to break links in revisions. If your document uses
latest version <abbr title="Uniform Resource Identifier">URI</abbr>s
with a fragment identifier, unless those anchors are maintained across
versions, links will break.</p>
<h2><a id="Production" name="Production">9. <abbr title=
"Extensible Markup Language">XML</abbr>, <acronym title=
"XML Specification DTD">XMLspec</acronym>, <abbr title=
"XSL Transformations">XSLT</abbr> and Production</a></h2>
<p>Though the <abbr title="HyperText Markup Language">HTML</abbr> or
<abbr title="Extensible HyperText Markup Language">XHTML</abbr> version
of your specification is always the definitive one, many editors find
an <abbr title="Extensible Markup Language">XML</abbr> original easier
to work with, and sometimes an <abbr title=
"Extensible Markup Language">XML</abbr> version is provided as an
alternative format. The <cite>W3C XML Specification DTD</cite>
(XMLspec) used to produce many of W3C's <abbr title=
"Extensible Markup Language">XML</abbr>-related Recommendations can
facilitate this work. <acronym title=
"XML Specification DTD">XMLspec</acronym> is fully documented
[<cite><a href="#ref-XMLSPEC">XMLSPEC</a></cite>]. Various <abbr title=
"XSL Transformations">XSLT</abbr> style sheets are in use and continual
development to output the final technical report [<cite><a href=
"#ref-XSLT">XSLT</a></cite>]. For help with this process, you can ask
the experts on the public mailing list spec-prod@w3.org [<cite><a href=
"#ref-SPEC-PROD">SPEC-PROD</a></cite>].</p>
<h2><a id="RFC" name="RFC">10. <abbr title=
"Request for Comments">RFC</abbr> 2119 Key Words</a></h2>
<p>Adhere to and credit <cite><abbr title=
"Request for Comments">RFC</abbr> 2119 Key words for use in
<abbr title="Request for Comments">RFC</abbr>s to Indicate Requirement
Levels</cite> [<cite><a href="#ref-KEYWORDS">KEYWORDS</a></cite>]
(<span class="not-en">e.g.</span>, "MUST", "MUST NOT", "REQUIRED").</p>
<p>When these key words are used in the <abbr title=
"Request for Comments">RFC</abbr> sense, make them UPPERCASE, enclose
them in the <code>em</code> element, and style them with <abbr title=
"Cascading Style Sheets">CSS</abbr> to make the <em class=
"RFC2119">UPPERCASE</em> readable.</p>
<pre>
<em title="MUST in RFC 2119 context"
class="RFC2119">MUST</em>
.RFC2119 {
text-transform: lowercase;
font-style: italic;
}
</pre>
<p>The author may explain why if these key words are not used in the
<abbr title="Request for Comments">RFC</abbr> sense.</p>
<p>Where they are not <em><q cite=
"ftp://ftp.rfc-editor.org/in-notes/rfc2119.txt">required for
interoperation or to limit behavior which has potential for causing
harm</q></em> these key words <em><q cite=
"ftp://ftp.rfc-editor.org/in-notes/rfc2119.txt">must not be used to try
to impose a particular method on implementors where the method is not
required for interoperability.</q></em></p>
<h2><a id="Editorial" name="Editorial">11. Editorial
Guidelines</a></h2>
<p>This section refers to editorial practice at W3C. It touches on
grammar, spelling, punctuation, case, linking, appearance and
markup.</p>
<h3><a id="Grammar" name="Grammar">11.1 Grammar</a></h3>
<ul>
<li>Delete repeated words.</li>
<li>Check subject-verb agreement.</li>
<li>Break long sentences.</li>
<li>Eliminate contractions (<span class="not-en">e.g.</span>, "don't"
should read "do not")?</li>
</ul>
<h3><a id="Spelling" name="Spelling">11.2 Spelling</a></h3>
<ul>
<li>Spell-check using a U.S. English dictionary. Append ",spell" to a
W3C <abbr title="Uniform Resource Identifier">URI</abbr> to invoke
W3C's spell checker.</li>
<li>Free dictionaries are also available on the <a title=
"Ispell home page at UCLA" href=
"http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html">Ispell home
page</a> [<cite><a href="#ref-ISPELL">ISPELL</a></cite>] for UNIX and
the <a title="Excalibur home page at Bucknell" href=
"http://www.eg.bucknell.edu/~excalibr/excalibur.html">Excalibur home
page</a> [<cite><a href="#ref-EXCAL">EXCAL</a></cite>] for Mac OS.</li>
<li>W3C uses <cite>Merriam-Webster's
Collegiate<sup><small>®</small></sup> Dictionary</cite>, 10th Edition
[<cite><a href="#ref-M-W">M-W</a></cite>], on the Web as the spelling
arbiter because it is free, on-line, and available to every technical
report author and editor. If a word does not appear there, use the
<cite>American Heritage<sup><small>®</small></sup> Dictionary</cite>,
4th Edition [<cite><a href="#ref-AH">AH</a></cite>]. Other dictionaries
are used as needed (for example, Random House and Webster's unabridged,
Oxford and Oxford Concise).</li>
<li>W3C uses U.S. English (<span class="not-en">e.g.</span>,
"standardise" should read "standardize" and "behaviour" should read
"behavior").</li>
<li>Form the plural of abbreviations, initialisms and acronyms without
an apostrophe (<span class="not-en">e.g.</span>, the plural of
<abbr title="Uniform Resource Identifier">URI</abbr> is <abbr title=
"Uniform Resource Identifiers">URIs</abbr> not <abbr title=
"Uniform Resource Identifiers">URI's</abbr>). See the FAQ
<cite>"Infrequently Asked Questions Concerning the Proper Spelling of
'DTD' in its Plural Form"</cite> [<cite><a href=
"#ref-PLURAL">PLURAL</a></cite>].</li>
</ul>
<h3><a id="Punctuation" name="Punctuation">11.3 Punctuation</a></h3>
<ul>
<li>Use correct punctuation. A hard copy of <cite>The Chicago Manual of
Style</cite> or <cite>The Gregg Reference Manual</cite> may be of some
help.</li>
<li>Remember you are typing <abbr title=
"HyperText Markup Language">HTML</abbr> or <abbr title=
"Extensible Markup Language">XML</abbr> not TeX. Use quotation marks
rather than grave accents and apostrophes to quote text (<span class=
"not-en">e.g.</span>, ``value'' should read "value").</li>
</ul>
<h3><a id="Case" name="Case">11.4 Case, Combining Words, and
Hyphenation</a></h3>
<ul>
<li>Capitalize W3C entities to match the <cite>W3C Process
Document</cite> [<cite><a href="#ref-PROCESS">PROCESS</a></cite>]
(<span class="not-en">e.g.</span>, Working Group, Recommendation).</li>
<li>Make the case, number of words, and hyphenation in terms match
<a href="#Terms">chapter 12</a>.</li>
</ul>
<h3><a id="Misc" name="Misc">11.5 Miscellaneous</a></h3>
<ul>
<li>Spell out acronyms and initialisms in their first occurrence in
prose, for example, "Internet Engineering Task Force
(<abbr>IETF</abbr>)" or "Internationalization (<abbr>I18N</abbr>)." In
subsequent occurrences when they are not spelled out, use
<code>abbr</code> and <code>acronym</code> elements, and give them
<code>title</code> attributes. For the purposes of <abbr title=
"HyperText Markup Language">HTML</abbr> and <abbr title=
"Extensible HyperText Markup Language">XHTML</abbr> 1.0, mark up as an
<code>acronym</code> anything that can be pronounced as a word, and
mark up initialisms and abbreviations as <code>abbr</code>.</li>
<li>Check references (most commonly, for no full stop after the
<span class="not-en" xml:lang="la" lang="la">et</span> in et al.). Do
the entries match?</li>
</ul>
<h3><a id="Linking" name="Linking">11.6 Linking</a></h3>
<ul>
<li>Unless intentionally referring to the latest document in a series,
always refer to specific W3C documents by using the "this version"
<abbr title="Uniform Resource Identifier">URI</abbr>.</li>
<li>If you are referring to a W3C document using either its this
version or latest version <abbr title=
"Uniform Resource Identifier">URI</abbr>, note whether the <abbr title=
"Uniform Resource Identifier">URI</abbr> ends in a slash or not. These
identifiers do not end in an extension such as "<kbd>.html</kbd>".
Include the extension when intentionally referring to a specific
version (e.g., a <acronym title=
"Graphics Interchange Format">GIF</acronym> image where <acronym title=
"Graphics Interchange Format">GIF</acronym> and <acronym title=
"Portable Network Graphics">PNG</acronym> are both available through
content negotiation).</li>
<li>Visible <abbr title="Uniform Resource Identifier">URI</abbr>s and
<code>href</code> attributes should have the same value.</li>
</ul>
<h3><a id="Examples" name="Examples">11.7 Using Examples</a></h3>
<ul>
<li>Domains in examples adhere to section 3, "Reserved Example Second
Level Domain Names," in <cite><abbr title=
"Request for Comments">RFC</abbr> 2606</cite> [<cite><a href=
"#ref-DOMAINS">DOMAINS</a></cite>]. Use the domains
<kbd>example.com</kbd>, <kbd>example.org</kbd>, and
<kbd>example.net</kbd> for all examples. The Internet Assigned Numbers
Authority (IANA) reserves them for this purpose. If you need an
evocative name or the name of a business, use a machine name (<span
class="not-en">e.g.</span>, <kbd>http://cats.example.org</kbd>).</li>
<li>When not addressed by second level example domains, top level
domains (<abbr title="top level domain">TLD</abbr>s) adhere to section
2, "TLDs for Testing, & Documentation Examples," in
<cite><abbr title="Request for Comments">RFC</abbr> 2606</cite>
[<cite><a href="#ref-DOMAINS">DOMAINS</a></cite>]. Use
<kbd>.test</kbd>, <kbd>.example</kbd>, <kbd>.invalid</kbd> or
<kbd>.localhost</kbd>.</li>
<li>Remember to validate markup in examples. Escaped characters pass
through routine validation.</li>
<li>W3C publications are copyrighted by W3C, and W3C liability,
trademark and document use rules apply. Note that in general, one
should not use material (text, photo, audio) in examples when the
copyright is not held by W3C. If the group wishes to publish
copyrighted materials, it should contact the Team legal staff.</li>
<li>
<p>Use <abbr title="Cascading Style Sheets">CSS</abbr> with
<code>div</code> elements to mark up examples, as is done in the
<a href="http://www.w3.org/TR/2001/REC-xmlschema-0-20010502/#DerivExt"
title="Section 4.2 of the XML Schema Primer">XML Schema primer</a>
([<cite><a href="#ref-SCHEMA-PRIMER">SCHEMA-PRIMER</a></cite>], section
4.2):</p>
<div class="exampleOuter">
<div class="exampleHeader">
Example
</div>
<div class="exampleInner">
<pre>
background-color: #d5dee3
</pre>
</div>
</div>
<p>Some <abbr title="Extensible Markup Language">XML</abbr>-related
specifications such as <a href=
"http://www.w3.org/TR/2006/REC-xml-20060816/#sec-comments" title=
"Section 2.5 of XML 1.0">XML 1.0</a> ([<cite><a href=
"#ref-XML">XML1</a></cite>], section 2.5) use <code>table</code>
elements to achieve this visual effect. This is less desirable than
using CSS.</p>
<table class="eg" width="100%" border="1" cellpadding="5" bgcolor=
"#99FFFF" summary="one cell illustrating an aqua blue">
<tr>
<td>
<pre>
bgcolor="#99ffff"
</pre>
</td>
</tr>
</table>
</li>
</ul>
<h3><a id="Images" name="Images">11.8 Images</a></h3>
<ul>
<li>We recommend that each image be available as PNG, even if you use
content negotiation to serve alternative formats.</li>
<li>Give images a background color (<span class="not-en">e.g.</span>,
white) so your technical report can be read with any style sheet
(<span class="not-en">e.g.</span>, with W3C's dark on light style
sheets, or a user style sheet that specifies a dark background).</li>
<li>Match image size to markup <code>width</code> and
<code>height</code> (or images will be distorted).</li>
<li>See the <a href="/TR/WCAG20-GENERAL/">Web Content Accessibility
Guidelines Techniques</a> for information about providing alternative
text (<code>alt</code>) and long descriptions (<code>longdesc</code>)
for images. Also, don't forget to spell-check your alternative
text.</li>
</ul>
<h3><a id="Markup" name="Markup">11.9 Markup</a></h3>
<ul>
<li>Use markup as it is intended. The <code>blockquote</code> and
<code>ul</code> and <code>li</code> elements were designed for
quotations and lists and not for indentation. Use <abbr title=
"Cascading Style Sheets">CSS</abbr> instead.</li>
<li>Remove extraneous non-breaking spaces.</li>
<li>Mark up attributes and elements consistently.</li>
<li>Make sure there are no <code>font</code> or <code>basefont</code>
elements in your document.</li>
<li>Make sure all <code>table</code> elements in your document are real
data tables, not tables used for layout.</li>
<li>Make sure there are no <code>bgcolor</code>,
<code>background</code>, <code>color</code>, <code>face</code>,
<code>marginheight</code>, <code>marginwidth</code> or
<code>size</code> attributes.</li>
<li>Give each page <code>lang="en-US"</code> on the <code>html</code>
element for <abbr title="HyperText Markup Language">HTML</abbr>, or
<code>xml:lang="en-US" lang="en-US"</code> on the <code>html</code>
element for <abbr title=
"Extensible HyperText Markup Language">XHTML</abbr> 1.0.</li>
<li>Use the <code>span</code> element and <code>lang</code> and
<code>xml:lang</code> attributes for language changes within a
page.</li>
<li>Make semantic distinctions using more than only color, for example,
a font-style change, so that color-blind individuals can see a
difference.</li>
<li>Links with the anchor text "Click here" provide no context. The
visitor may become lost not knowing where "here" is. See also
<cite><a href="http://www.w3.org/QA/Tips/noClickHere">Don't use "click
here" as link text</a></cite> [<cite><a href=
"#ref-CLICK-HERE">CLICK-HERE</a></cite>].</li>
<li>Mark up data <code>table</code> headers with <code>th</code> not by
bolding a <code>td</code>.</li>
</ul>
<h3><a id="Large" name="Large">11.10 Large Documents</a></h3>
<p>Large single files that may be easy to print and search may not be
easy to download. For large documents:</p>
<ul>
<li>Divide the document logically, storing chapters in separate
files.</li>
<li>Offer a single-page, printable, searchable version of the
specification. This format may be compressed if large.</li>
<li>You can offer an archived version (zip, tar, tgz) of the separate
files. Provide all necessary file in archived versions including the
relevant style sheets. Don't link to images or style sheets not
included in the archive.</li>
</ul>
<h2><a id="MediaTypes" name="MediaTypes">12. Internet Media Types</a></h2>
<ul>
<li>For information about defining a new Internet media type (formerly known as <acronym title="Multipurpose Internet Mail Extensions">MIME</acronym> type) in your specification, see <cite><a href=
"http://www.w3.org/2002/06/registering-mediatype">How to Register an Internet Media Type for a W3C Specification</a></cite> [<cite><a href="#ref-REGISTER-1">REGISTER-1</a></cite>].</li>
<li>For information about referring to existing Internet media types (registered or not), see the email message <cite><a href=
"http://lists.w3.org/Archives/Public/www-tag/2006Aug/0012">TAG Position on Use of Unregistered Media Types in W3C Recommendations</a></cite> [<cite><a href="#ref-REGISTER-2">REGISTER-2</a></cite>].</li>
</ul>
<h2><a id="Terms" name="Terms">13. Commonly Misspelled Terms</a></h2>
<p>W3C has reviewed its technical reports one by one since November
1999, for typographical errors. The following words appear often in
those reviews and are easy to misspell.</p>
<dl class="terms">
<dt>anti-alias</dt>
<dd>hyphenate</dd>
<dt><acronym title=
"American Standard Code for Information Interchange">ASCII</acronym></dt>
<dd>all caps</dd>
<dt>base64</dt>
<dd>lowercase, one word</dd>
<dt>Bézier</dt>
<dd>always capitalize, and accent the first e</dd>
<dt>braille</dt>
<dd>capitalize only when talking about Louis Braille</dd>
<dt>built-in</dt>
<dd>hyphenate when used as an adjective or noun, not when built is a
verb</dd>
<dt><abbr title="document type definition">DTDs</abbr></dt>
<dd>no apostrophe (see [<cite><a href=
"#ref-PLURAL">PLURAL</a></cite>])</dd>
<dt>dingbat</dt>
<dd>one word</dd>
<dt>ECMAScript</dt>
<dd>one word, cap S</dd>
<dt><span xml:lang="la" lang="la">et al.</span></dt>
<dd>no <span class="UnicodeName">full stop</span> after "et"</dd>
<dt><span class="UnicodeName">full stop</span> (.)</dt>
<dd><span class="UnicodeName">Full stop</span> is the formal name.
<span class="UnicodeAlias">Dot</span> and <span class=
"UnicodeAlias">period</span> are good aliases.</dd>
<dt><span class="UnicodeName">hash</span> (#)</dt>
<dd>also <span class="UnicodeAlias">number sign</span>, usually not <span class="UnicodeAlias">pound sign</span>, <span class="UnicodeAlias">crosshatch</span> or <span class="UnicodeAlias">octothorpe</span></dd>
<dt>heading</dt>
<dd>Term for <code>h1</code>-<code>h6</code>. Tables and HTTP have
headers.</dd>
<dt>HTTP/1.0</dt>
<dd>needs slash when referred to as a protocol, none in free text</dd>
<dt>HTTP/1.1</dt>
<dd>needs slash when referred to as a protocol, none in free text</dd>
<dt>home page</dt>
<dd>two words</dd>
<dt>Java</dt>
<dd>cap J</dd>
<dt>JavaScript</dt>
<dd>cap S</dd>
<dt>Level 1, 2, 3</dt>
<dd>cap L when referring to a W3C technical report</dd>
<dt>line feed</dt>
<dd>two words</dd>
<dt>lowercase</dt>
<dd>one word</dd>
<dt>markup</dt>
<dd>one word</dd>
<dt><acronym title="Multipurpose Internet Mail Extensions">MIME</acronym> type</dt>
<dd>now Internet media type (MIME type is two words. MIME is all caps.)</dd>
<dt>namespace</dt>
<dd>lowercase unless referring to the <cite>Namespaces in XML</cite>
specification by name</dd>
<dt><span class="UnicodeName">number sign</span> (#)</dt>
<dd>also <span class="UnicodeAlias">hash</span>, usually not <span class="UnicodeAlias">pound sign</span>, <span class="UnicodeAlias">crosshatch</span> or <span class="UnicodeAlias">octothorpe</span></dd>
<dt>on-line</dt>
<dd>hyphenate</dd>
<dt>PDF</dt>
<dd>all caps</dd>
<dt>PostScript</dt>
<dd>cap S</dd>
<dt>read-only</dt>
<dd>hyphenate</dd>
<dt>ruby</dt>
<dd>lowercase</dd>
<dt>schema</dt>
<dd>lowercase</dd>
<dt>schemas</dt>
<dd>preferred to schemata</dd>
<dt>semicolon</dt>
<dd>one word</dd>
<dt>stand-alone</dt>
<dd>hyphenate</dd>
<dt>style sheet</dt>
<dd>two words</dd>
<dt>subset</dt>
<dd>no hyphen</dd>
<dt>superset</dt>
<dd>no hyphen</dd>
<dt>uppercase</dt>
<dd>one word</dd>
<dt><abbr title="Uniform Resource Identifier">URI</abbr> reference</dt>
<dd>usually not <abbr title="Uniform Resource Identifier">URI</abbr>
Reference or <abbr title=
"Uniform Resource Identifier">URI</abbr>-Reference</dd>
<dt><abbr title="Uniform Resource Identifiers">URIs</abbr></dt>
<dd>no apostrophe (see [<cite><a href=
"#ref-PLURAL">PLURAL</a></cite>])</dd>
<dt>user agent</dt>
<dd>lowercase</dd>
<dt>user interface</dt>
<dd>lowercase</dd>
<dt>Web (on its own)</dt>
<dd>always capitalize</dd>
<dt>Web (as part of a phrase)
<dd>Either capitalize or lower case "Web" (e.g., Web developer or web developer, Web project or web project, Web page or web page, Web application or web application</dd>
<dt>Webmaster, webmaster</dt>
<dd>one word, either capitalize or lower case</dd>
<dt>Web page, web page</dt>
<dd>two words, either capitalize or lower case "Web"</dd>
<dt>Web site, web site, website</dt>
<dd>two words (capitalize or lower case "Web") or one (lower case)</dd>
<dt>well-formed</dt>
<dd>hyphenate</dd>
<dt>white space</dt>
<dd>two words</dd>
<dt>worldwide</dt>
<dd>one word</dd>
<dt>World Wide Web</dt>
<dd>three words, no hyphen</dd>
<dt>W3C Note</dt>
<dd>not W3C NOTE</dd>
</dl>
<h2><a id="ACK" name="ACK">14. Acknowledgments</a></h2>
<p>Thank you to Karl Dubost (W3C). Thank you to Philip Gallo for the
pencil image and to Paul Harmon and to E.K. for artwork used in earlier
versions. The following people contributed to this compilation:</p>
<ul>
<li>All affiliated with W3C at the time, Dan Connolly, Ian Jacobs,
Joseph Reagle, Tim Berners-Lee, Karen MacArthur, and Håkon Wium Lie
wrote the majority of this guide in various incarnations since it
started in 1995.</li>
<li>Charles McCathieNevile (W3C), Bob Hopgood (Oxford Brookes
University), Björn Höhrmann, Paul Grosso (Arbortext), Daniel Dardailler
(W3C), Steven Pemberton (W3C), Richard Ishida (Xerox), Martin Dürst
(W3C), Mark Davis, Hugo Haas (W3C), Dominique Hazaël-Massieux (W3C),
Max Froumentin (W3C), Judy Brewer (W3C), Stuart Williams
(Hewlett-Packard), François Yergeau (Alis Technologies), and David
Carlisle contributed valuable comments.</li>
</ul>
<h2><a id="REF" name="REF">15. References</a></h2>
<dl class="ref">
<dt><a id="ref-AH" name="ref-AH">[AH]</a></dt>
<dd><cite><a href="http://www.bartleby.com/61/">American
Heritage<sup><small>®</small></sup> Dictionary</a></cite>, 4th Edition.
Houghton Mifflin Company, 2000. This book is on-line at
http://www.bartleby.com/61.</dd>
<dt><a id="ref-BIB-EXTRACT" name=
"ref-BIB-EXTRACT">[BIB-EXTRACT]</a></dt>
<dd><a href="http://www.w3.org/2002/01/tr-automation/tr-biblio-ui">W3C
Bibliography Extractor</a>, Dominique Hazaël-Massieux, 2003. This tool
is on-line at
http://www.w3.org/2002/01/tr-automation/tr-biblio-ui.</dd>
<dt><a id="ref-CHARMOD" name="ref-CHARMOD">[CHARMOD]</a></dt>
<dd><cite><a href=
"http://www.w3.org/TR/2004/WD-charmod-20040225/">Character Model for
the World Wide Web 1.0: Fundamentals</a></cite>, M. Dürst, F. Yergeau,
R. Ishida, M. Wolf, and T. Texin, Editors. W3C work in progress, 2004.
This version of the Character Model Fundamentals is
http://www.w3.org/TR/2004/WD-charmod-20040225/. The <a href=
"http://www.w3.org/TR/charmod/">latest version of the Character Model
Fundamentals</a> is available at http://www.w3.org/TR/charmod.</dd>
<dt><a id="ref-CHARNAMES" name="ref-CHARNAMES">[CHARNAMES]</a></dt>
<dd><a href=
"http://lists.w3.org/Archives/Public/www-international/2001JulSep/0133.html">
Unicode character names</a>, M. Davis, M. Dürst, et al., 25-27 August
2001. This email thread is on-line at
http://lists.w3.org/Archives/Public/www-international/2001JulSep/thread.html#133.</dd>
<dt><a id="ref-CHARTS" name="ref-CHARTS">[CHARTS]</a></dt>
<dd><a href="http://www.unicode.org/charts/About.html">About the Online
Code Charts</a>, <cite>The Unicode Standard</cite>, Version 1.1 or
later. The Unicode Consortium, 2001. Unicode code charts are on-line at
http://www.unicode.org/charts/About.html.</dd>
<dt><a id="ref-CHECKLINK" name="ref-CHECKLINK">[CHECKLINK]</a></dt>
<dd><a href="http://www.w3.org/2000/07/checklink">W3C Link Checker</a>,
W3C QA Activity, 2000-2004. This service is on-line at
http://www.w3.org/2000/07/checklink.</dd>
<dt><a id="ref-CLICK-HERE" name="ref-CLICK-HERE">[CLICK-HERE]</a></dt>
<dd><a href="http://www.w3.org/QA/Tips/noClickHere">Don't use "click
here" as link text</a>, Aaron Swartz. W3C QA Team, 2001. This QA tip is
on-line at http://www.w3.org/QA/Tips/noClickHere.</dd>
<dt><a id="ref-CSSVALIDATE" name=
"ref-CSSVALIDATE">[CSSVALIDATE]</a></dt>
<dd><a href="http://jigsaw.w3.org/css-validator/">W3C CSS Validation
Service</a>, W3C QA Activity, 1997-2004. This service is on-line at
http://jigsaw.w3.org/css-validator.</dd>
<dt><a id="ref-DOMAINS" name="ref-DOMAINS">[DOMAINS]</a></dt>
<dd><cite><a href="http://www.ietf.org/rfc/rfc2606.txt">Reserved Top
Level DNS Names</a></cite>, D. Eastlake, and A. Panitz. The Internet
Society, June 1999. This <abbr title="Request for Comments">RFC</abbr>
is available at http://www.ietf.org/rfc/rfc2606.txt.</dd>
<dt><a id="ref-EDITORS" name="ref-EDITORS">[EDITORS]</a></dt>
<dd><a href="http://www.w3.org/2003/Editors/">W3C Editors Home
Page</a>, Dominique Hazaël-Massieux for the W3C Communications Team,
2003. This list of resources for editors is on-line at
http://www.w3.org/2003/Editors/.</dd>
<dt><a id="ref-EVALUATE" name="ref-EVALUATE">[EVALUATE]</a></dt>
<dd><a href=
"http://www.w3.org/WAI/eval/">Evaluating Web Sites for Accessibility</a>,
This list of tools for evaluating Web sites
for accessibility is on-line at
http://www.w3.org/WAI/eval/.</dd>
<dt><a id="ref-GRM" name="ref-GRM">[GRM]</a></dt>
<dd><a href="http://www.glencoe.com/ps/grm/faqs/">Frequently Asked
Questions</a>, <cite>The Gregg Reference Manual Instructor Site</cite>,
Glencoe/McGraw-Hill, 2000. This FAQ is on-line at
http://www.glencoe.com/ps/grm/faqs.</dd>
<dt><a id="ref-IPRFAQ" name="ref-IPRFAQ">[IPRFAQ]</a></dt>
<dd><a href=
"http://www.w3.org/Consortium/Legal/IPR-FAQ-20000620">Intellectual
Property FAQ</a>, W3C, 20 June 2000. The latest version of this
document is http://www.w3.org/Consortium/Legal/IPR-FAQ.</dd>
<dt><a id="ref-KEYWORDS" name="ref-KEYWORDS">[KEYWORDS]</a></dt>
<dd><cite><a href="http://www.ietf.org/rfc/rfc2119.txt">Key words for
use in RFCs to Indicate Requirement Levels</a></cite>, S. Bradner. The
Internet Society, March 1997. This <abbr title=
"Request for Comments">RFC</abbr> is available at
http://www.ietf.org/rfc/rfc2119.txt.</dd>
<dt><a id="ref-M-W" name="ref-M-W">[M-W]</a></dt>
<dd><cite><a href="http://www.m-w.com/">Merriam-Webster OnLine:
Collegiate Dictionary</a></cite>, 10th Edition. Merriam-Webster,
Incorporated, 2000. This book is on-line at http://www.m-w.com.</dd>
<dt><a id="ref-MANAGE" name="ref-MANAGE">[MANAGE]</a></dt>
<dd><cite><a href="http://www.w3.org/MarkUp/SGML/spec-mgmt">Document
Management for Web Specs</a></cite>, D. Connolly. W3C, 1995-1999. This
guide is on-line at http://www.w3.org/MarkUp/SGML/spec-mgmt.</dd>
<dt><a id="ref-PERSISTENCE" name=
"ref-PERSISTENCE">[PERSISTENCE]</a></dt>
<dd><cite><a href=
"http://www.w3.org/Consortium/Persistence">Persistence
Policy</a></cite>, T. Berners-Lee, 1999. This policy is on-line at
http://www.w3.org/Consortium/Persistence.</dd>
<dt><a id="ref-PLURAL" name="ref-PLURAL">[PLURAL]</a></dt>
<dd><a href=
"http://xml.coverpages.org/properSpellingForPluralOfDTD.html">Infrequently
Asked Questions Concerning the Proper Spelling of 'DTD' in its Plural
Form</a>, R. Cover, updated 4 January 2001 or later. This document is
on-line at
http://xml.coverpages.org/properSpellingForPluralOfDTD.html.</dd>
<dt><a id="ref-PROCESS" name="ref-PROCESS">[PROCESS]</a></dt>
<dd><cite><a href="http://www.w3.org/2004/02/Process-20040205/">World
Wide Web Consortium Process Document</a></cite>, I. Jacobs, Editor.
W3C, 5 February 2004. The latest version of this document is
http://www.w3.org/Consortium/Process.</dd>
<dt><a id="ref-PRONOUNS" name="ref-PRONOUNS">[PRONOUNS]</a></dt>
<dd><a href=
"http://lists.w3.org/Archives/Public/www-international/2000AprJun/0058">
Personal pronouns in specifications</a>, M. Dürst, 13 May 2000. This
email message is
http://lists.w3.org/Archives/Public/www-international/2000AprJun/0058.</dd>
<dt><a id="ref-PUBRULES" name="ref-PUBRULES">[PUBRULES]</a></dt>
<dd><cite><a href="http://www.w3.org/Guide/pubrules">Technical Report
Publication Policy</a></cite>, I. Jacobs, and the W3C Team. W3C,
2000-2006. This document is on-line at
http://www.w3.org/Guide/pubrules.</dd>
<dt><a id="ref-REF-TITLES" name="ref-REF-TITLES">[REF-TITLES]</a></dt>
<dd><a href=
"http://lists.w3.org/Archives/Public/www-html-editor/2000JanMar/0103">please
use titles, not addresses, as link text</a>, D. Connolly, 10 February
2000. This email message is on-line at
http://lists.w3.org/Archives/Public/www-html-editor/2000JanMar/0103.</dd>
<dt><a id="ref-REGISTER-1" name="ref-REGISTER-1">[REGISTER-1]</a></dt>
<dd><a href=
"http://www.w3.org/2002/06/registering-mediatype">How to Register an Internet Media Type for a W3C Specification</a>, J. Reagle, M. Dürst, P. Le Hégaret, 2002-2006. This Web page is on-line at
http://www.w3.org/2002/06/registering-mediatype.</dd>
<dt><a id="ref-REGISTER-2" name="ref-REGISTER-2">[REGISTER-2]</a></dt>
<dd><a href=
"http://lists.w3.org/Archives/Public/www-tag/2006Aug/0012">TAG Position on Use of Unregistered Media Types in W3C Recommendations</a>, N. Mendelsohn, 4 August 2006. This email message is
http://lists.w3.org/Archives/Public/www-tag/2006Aug/0012.</dd>
<dt><a id="ref-SPEC-PROD" name="ref-SPEC-PROD">[SPEC-PROD]</a></dt>
<dd>spec-prod@w3.org. W3C, 1998-2001. <a href=
"http://www.w3.org/Mail/Lists">Subscribe</a> to this public mailing
list at http://www.w3.org/Mail/Lists and view its <a href=
"http://lists.w3.org/Archives/Public/spec-prod/">archive</a> at
http://lists.w3.org/Archives/Public/spec-prod.</dd>
<dt><a id="ref-STYLE-GUIDE" name=
"ref-STYLE-GUIDE">[STYLE-GUIDE]</a></dt>
<dd><cite><a href="http://www.w3.org/Provider/Style/">Style Guide for
Online Hypertext</a></cite>, T. Berners-Lee. 1992-1998. This guide is
on-line at http://www.w3.org/Provider/Style.</dd>
<dt><a id="ref-TR" name="ref-TR">[TR]</a></dt>
<dd><a href="http://www.w3.org/TR/">W3C Technical Reports and
Publications</a>, W3C, 1995-2001. This Web page is on-line at
http://www.w3.org/TR.</dd>
<dt><a id="ref-TRANSLATE" name="ref-TRANSLATE">[TRANSLATE]</a></dt>
<dd><a href="http://www.w3.org/Consortium/Translation/">Translations at
W3C</a>, W3C, 1997-2003. This Web page is on-line at
http://www.w3.org/Consortium/Translation.</dd>
<dt><a id="ref-UNICODE" name="ref-UNICODE">[UNICODE]</a></dt>
<dd><a href=
"http://www.unicode.org/unicode/standard/versions/">Citations and
References</a>, The Unicode Consortium, 2001. These instructions for
citing Unicode are on-line at
http://www.unicode.org/unicode/standard/versions/.</dd>
<dt><a id="ref-VALIDATE" name="ref-VALIDATE">[VALIDATE]</a></dt>
<dd><a href="http://validator.w3.org/">W3C Markup Validation
Service</a>, W3C QA Activity, 1997-2004. This service is on-line at
http://validator.w3.org.</dd>
<dt><a id="ref-WCAG" name="ref-WCAG">[WCAG]</a></dt>
<dd><cite><a href=
"http://www.w3.org/TR/1999/WAI-WEBCONTENT-19990505/">Web Content
Accessibility Guidelines 1.0</a></cite>, W. Chisholm, G. Vanderheiden,
and I. Jacobs, Editors. W3C, 1999. This version of the WCAG
Recommendation is http://www.w3.org/TR/1999/WAI-WEBCONTENT-19990505.
The <a href="http://www.w3.org/TR/WAI-WEBCONTENT/">latest version of
WCAG</a> is available at http://www.w3.org/TR/WAI-WEBCONTENT.</dd>
<dt><a id="ref-XHTML1" name="ref-XHTML1">[XHTML1]</a></dt>
<dd><cite><a href=
"http://www.w3.org/TR/2000/REC-xhtml1-20000126/">XHTML<sup><small>TM</small></sup>
1.0: The Extensible HyperText Markup Language</a></cite>, S. Pemberton
et al. W3C, 2000. This version of XHTML is
http://www.w3.org/TR/2000/REC-xhtml1-20000126. The <a href=
"http://www.w3.org/TR/xhtml1/">latest version of XHTML1</a> is
available at http://www.w3.org/TR/xhtml1.</dd>
<dt><a id="ref-XMLSPEC" name="ref-XMLSPEC">[XMLSPEC]</a></dt>
<dd><cite><a href=
"http://www.w3.org/XML/1998/06/xmlspec-report-v21">Guide to the W3C XML
Specification ("XMLspec") DTD, Version 2.1</a></cite>, E. Maler,
Editor. W3C, 1997-2001. This documentation is on-line at
http://www.w3.org/XML/1998/06/xmlspec-report-v21. The DTD is on-line at
http://www.w3.org/XML/1998/06/xmlspec-v21.dtd.</dd>
<dt><a id="ref-XSLT" name="ref-XSLT">[XSLT]</a></dt>
<dd><cite><a href="http://dev.w3.org/cvsweb/spec-prod/html/">XSLT style
sheets</a></cite>, N. Walsh et al. 2000-2001. These XSLT stylesheets
for XMLspec are on-line at
http://dev.w3.org/cvsweb/spec-prod/html.</dd>
</dl>
<h3><a id="External" name="External">External Links</a></h3>
<p>The prose links to the following references as illustrations. They
are informative, listed here for print use.</p>
<dl>
<dt><a id="ref-CSS2" name="ref-CSS2">[CSS2]</a></dt>
<dd><cite><a href=
"http://www.w3.org/TR/1998/REC-CSS2-19980512/page.html#named-pages">Cascading
Style Sheets, level 2 section 13.3.2</a></cite>, B. Bos, H. W. Lie, C.
Lilley, and I. Jacobs, Editors. W3C, 1998. This example is on-line at
http://www.w3.org/TR/1998/REC-CSS2-19980512/page.html#named-pages.</dd>
<dt><a id="ref-EXCAL" name="ref-EXCAL">[EXCAL]</a></dt>
<dd><a href=
"http://www.eg.bucknell.edu/~excalibr/excalibur.html">Excalibur</a>, R.
Zaccone, 2001. The Excalibur home page is
http://www.eg.bucknell.edu/~excalibr/excalibur.html.</dd>
<dt><a id="ref-HTML" name="ref-HTML">[HTML]</a></dt>
<dd><cite><a href="http://www.w3.org/MarkUp/Wilbur/">Introducing HTML
3.2</a></cite>. W3C, 1996-1999. This example is on-line at
http://www.w3.org/MarkUp/Wilbur.</dd>
<dt><a id="ref-ISPELL" name="ref-ISPELL">[ISPELL]</a></dt>
<dd><a href=
"http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html">International
Ispell</a>, G. Kuenning et al. 1971-2001. The Ispell home page is
http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html.</dd>
<dt><a id="ref-P3PFAQ" name="ref-P3PFAQ">[P3PFAQ]</a></dt>
<dd><cite><a href="http://www.w3.org/P3P/p3pfaq">P3P and Privacy on the
Web FAQ</a></cite>. W3C, 2000-2001. This example is on-line at
http://www.w3.org/P3P/p3pfaq.</dd>
<dt><a id="ref-SCHEMA-DATATYPES" name=
"ref-SCHEMA-DATATYPES">[SCHEMA-DATATYPES]</a></dt>
<dd><cite><a href=
"http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#date">XML Schema
Part 2: Datatypes sections 3.2.9 through 3.2.14.1</a></cite>, P. V.
Biron, and A. Malhotra, Editors. W3C, 2001. The <a href=
"http://www.w3.org/TR/xmlschema-2/">latest version of XML Schema:
Datatypes</a> is available at http://www.w3.org/TR/xmlschema-2.</dd>
<dt><a id="ref-SCHEMA-PRIMER" name=
"ref-SCHEMA-PRIMER">[SCHEMA-PRIMER]</a></dt>
<dd><cite><a href=
"http://www.w3.org/TR/2001/REC-xmlschema-0-20010502/#DerivExt">XML
Schema Part 0: Primer section 4.2</a></cite>, D. Fallside, Editor. W3C,
2001. This example is on-line at
http://www.w3.org/TR/2001/REC-xmlschema-0-20010502/#DerivExt.</dd>
<dt><a id="ref-XML" name="ref-XML">[XML]</a></dt>
<dd><cite><a href=
"http://www.w3.org/TR/2006/REC-xml-20060816/#sec-comments">Extensible
Markup Language (XML) 1.0 (Fourth Edition) section 2.5</a></cite>, , T. Bray, J. Paoli, E. Maler, C. M. Sperberg-McQueen, F. Yergeau, Editors. W3C,
2006. This example is on-line at
http://www.w3.org/TR/2006/REC-xml-20060816/#sec-comments.</dd>
<dt><a id="ref-XML1" name="ref-XML1">[XML1]</a></dt>
<dd><cite><a href="http://www.w3.org/TR/2006/REC-xml-20060816/">Extensible Markup Language (XML) 1.0 (Fourth Edition)</a></cite>, T. Bray, J. Paoli, E. Maler, C. M. Sperberg-McQueen, F. Yergeau, Editors. World Wide Web Consortium, 16 August 2006, edited in place 29 September 2006. This edition of the XML 1.0 Recommendation is http://www.w3.org/TR/2006/REC-xml-20060816/. The <a href="http://www.w3.org/TR/xml/">latest edition of XML 1.0</a> is available at http://www.w3.org/TR/xml/.</dd>
</dl>
<h2><a id="Changes" name="Changes">16. Change History</a></h2>
<ul>
<li>2001-09-25: Added this change history. Added link to
interoperability report in Status section of Candidate Recommendations
and later. Removed IPR sentence in editor's role. Added commas after
<span class="not-en">e.g.</span> and <span class="not-en">i.e.</span>
to match US usage. Added chapter 10 on production. Added
<acronym title="XML Specification DTD">XMLspec</acronym> and
<abbr title="XSL Transformations">XSLT</abbr> references.</li>
<li>2001-10-27: Removed most <abbr title=
"Cascading Style Sheets">CSS</abbr>. Responding to Björn Höhrmann's
comments: Added note to not use "you." Fixed references markup.
Mentioned two free spelling tools. Now say that filename extensions are
permitted when linking to a specific version. Corrected
<code>alt</code> text note to say that the text should replace the
image when possible. Added <code>xml:lang</code> attribute to 11.8.
Clarified reasoning behind not using "click here." Added to description
of archived versions.</li>
<li>2001-10-31: Moved punctuation from miscellaneous to a separate
section</li>
<li>2002-03-19: Removed border and pencil photo</li>
<li>2002-03-31:
<ul>
<li>Removed conformance requirements</li>
<li>Made links to <abbr title="Request for Comments">RFC</abbr>s
<abbr title="File Transfer Protocol">FTP</abbr> per <abbr title=
"Request for Comments">RFC</abbr> Editor</li>
<li>Many editorial corrections thanks to Martin Dürst</li>
<li>Clarified reference links like [XML]</li>
<li>Added <code>abbr</code> and <code>acronym</code> elements and
<code>title</code> attributes throughout</li>
<li>Added <code>cite</code> throughout</li>
<li>Added W3C Web team to 8.3. Added commas between email
addresses</li>
<li>Removed links to old copyright release form and Member
Agreements</li>
<li>Added subtitle</li>
<li>Changed <acronym xml:lang="fr" lang="fr" title=
"Institut National de Recherche en Informatique et Automatique">INRIA</acronym>
from <code>abbr</code> to <code>acronym</code></li>
<li>Removed some wording about errata</li>
</ul>
</li>
<li>2002-04-29:
<ul>
<li>Changed "Acknowledgements" to "Acknowledgments"</li>
<li>Reversed order of References and Acknowledgments in 9</li>
<li>Clarified acronyms and initialisms in 11.5</li>
<li>Changed "XHTML" to "XHTML 1.0" in 11.9</li>
</ul>
</li>
<li>2002-05-23:
<ul>
<li>Added style for dates to I18n</li>
<li>Added image of editor's pencil</li>
</ul>
</li>
<li>2002-07-01:
<ul>
<li>Capitalized Process Document in 11.4</li>
</ul>
</li>
<li>2003-01-06:
<ul>
<li>Added Web terms to 12</li>
</ul>
</li>
<li>2003-02-11:
<ul>
<li>Removed sections covered in pubrules [<cite><a href=
"#ref-PUBRULES">PUBRULES</a></cite>]</li>
<li>Added ,spell comma tool</li>
<li>Removed the former section number 2, Conformance</li>
<li>Removed the former section number 8, The Publishing Process</li>
<li>Renumbered chapters</li>
<li>Added "schemas" to word list</li>
<li>Removed "must" statements</li>
<li>Removed most "should" statements</li>
<li>Added year to date example</li>
<li>Corrected numbering in Linking from Within</li>
</ul>
</li>
<li>2003-04-02:
<ul>
<li>Fixed typo in 9.7</li>
</ul>
</li>
<li>2003-06-30:
<ul>
<li>Added to 4.2 Translations</li>
<li>Added links to the Process Document and to pubrules</li>
<li>Deleted IPR (section 5)</li>
<li>Split Help section between Status and section 7</li>
<li>Moved 7.1.1 Document Title to 7.1, removed 7.1 Head</li>
<li>Removed 7.1.2 Document Identification, 7.1.3 Alternative Formats,
7.1.4 Editors, Authors, and Contributors, 7.1.5 Copyright Notice, 7.4
Acknowledgments, and much of 7.3 Status Section</li>
<li>Removed P3P Note from References</li>
<li>Split 7.5 References into sections</li>
<li>Removed 9.7 RFCs</li>
<li>Split 9.7 RFC 2119 Key Words into its own section</li>
<li>Moved RFC 2606 and example markup to new section 9.8 Using
Examples</li>
<li>Replaced 9.8 Appearance with section on Images</li>
<li>Added Persistence Policy reference</li>
<li>Added "Click Here" reference</li>
<li>Added Editors home page</li>
<li>Renumbered</li>
</ul>
</li>
<li>2003-11-08 to 09:
<ul>
<li>Added 7.1 Bibliography Extractor and renumbered section 7</li>
</ul>
</li>
<li>2004-04-02:
<ul>
<li>Update for new Process Document, Character Model Fundamentals, and
link to QA Tip</li>
</ul>
</li>
<li>2004-08-02:
<ul>
<li>Added TLDs to 11.7</li>
</ul>
</li>
<li>2004-09-02:
<ul>
<li>Updated copyright references</li>
<li>Updated W3C validation services</li>
<li>Added cites</li>
</ul>
</li>
<li>2005-01-20:
<ul>
<li>Changed RFC URIs from rfc-editor.org to ietf.org and from FTP to
HTTP</li>
</ul>
</li>
<li>2005-02-07:
<ul>
<li>Added note on copyright to 11.7</li>
</ul>
</li>
<li>2005-02-08:
<ul>
<li>Added to example reference link in 7.2</li>
</ul>
</li>
<li>2005-05-19:
<ul>
<li>Silent on trailing slashes in 11.6</li>
<li>Also in 11.6, note on URI and href values.</li>
</ul>
</li>
<li>2005-08-17:
<ul>
<li>Added notes on custom paragraph to 5.4.</li>
</ul>
</li>
<li>2005-09-08:
<ul>
<li>Added note on image formats (use of PNG) to 11.8.</li>
<li>Added PLURAL reference to 14 and plurals of acronyms and
abbreviations to 11.2 and 12.</li>
<li>Replaced specifics about alt/longdesc with link to WCAG 2.0
techniques.</li>
</ul>
</li>
<li>2006-01-30:
<ul>
<li>Added pubrules CSS and navigation</li>
<li>Updated link to Technical Report Publication Policy (pubrules)</li>
</ul>
</li>
<li>2006-03-27:
<ul>
<li>Remove unused references</li>
</ul>
</li>
<li>2006-08-10:
<ul>
<li>number sign and hash in 12.</li>
</ul>
</li>
<li>2006-09-14:
<ul>
<li>Added 12. Internet Media Types, renumbered</li>
</ul>
</li>
<li>2006-09-29:
<ul>
<li>XML updated to fourth edition, replaced HTML reference example with XML, added XML reference</li>
</ul>
</li>
<li>2007-01-11:
<ul>
<li>Added business names to 11.7</li>
</ul>
</li>
<li>2007-05-01:
<ul>
<li>Added "at least the first occurrence" in 7.2</li>
</ul>
</li>
</ul>
<h2><a id="ToDo" name="ToDo">17. To Do List</a></h2>
<ul>
<li>2002-03-31:
<ul>
<li>Add Dublin Core and <abbr title=
"Resource Description Framework">RDF</abbr>.</li>
<li>Add <code>elementName</code> and <code>attributeName</code> classes
to base style sheet.</li>
<li>Address one-page and multiple-page versions in 7.1.3.</li>
<li>Add boilerplate for Recommendations to 7.3.</li>
<li>Address references to parts of a technical report in 7.5.</li>
</ul>
</li>
</ul>
<hr/>
<address>
Ian Jacobs, <a href="http://www.w3.org/">W3C</a><br/>
</address>
<p>Last modified: $Date: 2009/06/15 22:02:17 $</p>
<p class="copyright"><a rel="Copyright" href=
"/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 1995-2007
<a href="/"><acronym title=
"World Wide Web Consortium">W3C</acronym></a><sup>®</sup> (<a href=
"http://www.csail.mit.edu/"><acronym title=
"Massachusetts Institute of Technology">MIT</acronym></a>, <a href=
"http://www.ercim.org/"><acronym title=
"European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
<a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C
<a href="/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
<a href="/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>,
<a rel="Copyright" href=
"/Consortium/Legal/copyright-documents">document use</a> and <a rel=
"Copyright" href="/Consortium/Legal/copyright-software">software
licensing</a> rules apply. Your interactions with this site are in
accordance with our <a href=
"/Consortium/Legal/privacy-statement#Public">public</a> and <a href=
"/Consortium/Legal/privacy-statement#Members">Member</a> privacy
statements.</p>
</body>
</html>