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
|
<!-- ==================== GRAMMAR_USAGE Pat Costello wrote this section ================ -->
<chapter id="grammar">
<title>Grammar and Usage Guidelines</title>
<para> This chapter contains an alphabetical list of grammar and usage
guidelines for use in GNOME documentation. Many of these guidelines are only
applicable to English-language usage, see the
<ulink url="http://www.bartleby.com/61/">
<citetitle>American Heritage Dictionary </citetitle></ulink> and the
<ulink
url="http://www.press.uchicago.edu/Misc/Chicago/cmosfaq/cmosfaq.html">
<citetitle>Chicago Manual of Style</citetitle></ulink>. </para>
<variablelist>
<varlistentry>
<term>Abbreviations</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2" align="left"><colspec colname="col1"
colwidth="0.32*" align="left"/><colspec colname="col2" colwidth="1.68*"
align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0"
align="left" valign="top">
<para> A shortened form of a word or phrase that takes the
place of the full word or phrase, for example Dr., a.m., p.m., and so on.
</para>
<para> Apply the following rules when you use abbreviations:
</para>
<itemizedlist>
<listitem>
<para> Avoid creating new abbreviations. Unfamiliar
abbreviations can confuse rather than clarify a concept. </para>
</listitem>
<listitem>
<para> Do not explain or expand familiar abbreviations.
</para>
</listitem>
<listitem>
<para> Do not include familiar abbreviations in the
glossary of your manual. </para>
</listitem>
</itemizedlist> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Adjectives</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" colsep="0" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" valign="top" align="left">
<para> Use adjectives with caution. If an adjective is
necessary to differentiate between items, then use adjectives. In all cases,
test whether the phrase can stand alone without the adjective. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Acronyms</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> A term that represents a multi-word term. Typically,
acronyms are formed in the following ways: </para>
<itemizedlist>
<listitem>
<para> From the first letters of each word in a compound
term, for example Table of Contents (TOC). </para>
</listitem>
<listitem>
<para> From recognizable parts of a compound term, such
as GNU Object Model Environment (GNOME). </para>
</listitem>
</itemizedlist>
<para> Apply the following rules when you use acronyms:
</para>
<itemizedlist>
<listitem>
<para> On the first occurrence of an acronym, spell out
the full term, with the acronym in parentheses. </para>
</listitem>
<listitem>
<para> Do not spell out the full compound for well-known
acronyms, unless you think the information is useful for readers. </para>
</listitem>
<listitem>
<para> Avoid creating new acronyms. Unfamiliar acronyms
can confuse rather than clarify a concept. </para>
</listitem>
<listitem>
<para> Write the acronym in uppercase letters, unless
there is a compelling case for lowercase. </para>
</listitem>
<listitem>
<para> Include the acronym and the full term in the
glossary of your manual. </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Adverbs</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" colsep="0" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" valign="top" align="left">
<para> Use adverbs with caution. If an adverb is necessary to
qualify the function of a component, then use an adverb. In all cases, test
whether the phrase can stand alone without the adverb. Classic superfluous
adverbs are: <emphasis>simply, easily, quickly</emphasis>. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Anthropomorphism</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<itemizedlist>
<listitem>
<para> Do not apply emotions, desires, or opinions to
software applications. </para>
</listitem>
<listitem>
<para> Do not apply a sense of location or dimension to a
software application. You can not be <emphasis>in</emphasis> a text editor.
</para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Apostrophe</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<itemizedlist>
<listitem>
<para> Do not use apostrophes to denote possession.
</para>
</listitem>
<listitem>
<para> Do not use apostrophes to denote contractions.
</para>
</listitem>
<listitem>
<para> Do not use apostrophes to denote plurals. </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Articles</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Do not use the definite article
<emphasis>the</emphasis> to begin any of the following items: </para>
<itemizedlist>
<listitem>
<para> Manual titles </para>
</listitem>
<listitem>
<para> Chapter titles </para>
</listitem>
<listitem>
<para> Headings </para>
</listitem>
<listitem>
<para> Figure captions </para>
</listitem>
<listitem>
<para> Table captions </para>
</listitem>
<listitem>
<para> Callouts </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Brackets</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<itemizedlist>
<listitem>
<para> Do not use brackets [such as these] as a
substitute for parentheses (such as these). </para>
</listitem>
<listitem>
<para> Use brackets for optional command line entries.
</para>
</listitem>
<listitem>
<para> Do not use angle brackets to indicate variables in
text, instead use the <emphasis>replaceable</emphasis> tag. </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Capitalization</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Capitalize in the following situations: </para>
<itemizedlist>
<listitem>
<para> All letters in acronyms, unless the acronym is a
well-known exception</para>
</listitem>
<listitem>
<para> Initial letter of the first word in a list</para>
</listitem>
<listitem>
<para> Initial letter of the first word in a
callout</para>
</listitem>
<listitem>
<para> Initial letter of a key name, such as the
<keycap>Shift</keycap> key</para>
</listitem>
<listitem>
<para> Initial letter of a sentence. Avoid starting a
sentence with a command name or application name that has a lowercase initial
letter</para>
</listitem>
<listitem>
<para> Initial letter of a complete sentence after a
colon</para>
</listitem>
</itemizedlist>
<para> Do not capitalize in the following situations: </para>
<itemizedlist>
<listitem>
<para> A compound term that is followed by an
abbreviation or an acronym</para>
</listitem>
<listitem>
<para> When you want to emphasize something</para>
</listitem>
<listitem>
<para> Variable names</para>
</listitem>
<listitem>
<para> The initial letter of the first word following a
colon, if the word is part of an incomplete sentence</para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Captions</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" colsep="0" align="left"/>
<colspec colname="col2" colwidth="1.68*" colsep="0" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" valign="top" align="left">
<itemizedlist>
<listitem>
<para> Use the same rules as for headings, for all
captions accompanying figures and tables.</para>
</listitem>
<listitem>
<para> Do not put a period at the end of a
caption.</para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Colon</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use a colon in the following situations:
<itemizedlist>
<listitem>
<para> To introduce a list </para>
</listitem>
<listitem>
<para> Before an explanation </para>
</listitem>
<listitem>
<para> After an introduction </para>
</listitem>
</itemizedlist> </para>
<para> Do not use a colon in the following situations:
<itemizedlist>
<listitem>
<para> To introduce a figure or a table </para>
</listitem>
<listitem>
<para> To introduce headings </para>
</listitem>
<listitem>
<para> At the end of an introduction to a procedure
</para>
</listitem>
</itemizedlist> </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Column headings</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" colsep="0" align="left"/>
<colspec colname="col2" colwidth="1.68*" colsep="0" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" valign="top" align="left">
<itemizedlist>
<listitem>
<para> Use the same rules as for headings. </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Comma</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2">
<colspec colname="col1" colwidth="0.32*" align="left"/>
<colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use commas in the following situations: </para>
<itemizedlist>
<listitem>
<para> To separate items in a series </para>
</listitem>
<listitem>
<para> To separate the parts of a sentence </para>
</listitem>
<listitem>
<para> To separate nonrestrictive phrases </para>
</listitem>
<listitem>
<para> Instead of dashes to set off appositives </para>
</listitem>
<listitem>
<para> With <emphasis>for example</emphasis> and similar
expressions </para>
</listitem>
</itemizedlist>
<para> Do not use commas in the following situations: </para>
<itemizedlist>
<listitem>
<para> In a series of adjectives used as one modifier
</para>
</listitem>
<listitem>
<para> Between two short independent clauses </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Commands</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Do not use commands as verbs. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Contractions</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Do not use contractions such as
<emphasis>can't</emphasis>, <emphasis>don't</emphasis>, or
<emphasis>isn't</emphasis>. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Dash</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Do not use the em dash or the en dash. Use a paragraph
break or a colon instead, where you want to create an introductory piece of
text. If you have several items that you want to introduce, then you can use a
variable list. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Ellipsis</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use an ellipsis in the following situations: </para>
<itemizedlist>
<listitem>
<para> To show that you have omitted something from a
sentence </para>
</listitem>
<listitem>
<para> To indicate a pause when you quote displayed text
</para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Fractions</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<itemizedlist>
<listitem>
<para> Use numerals for fractions in tables and in units
of measurement, but spell out fractions in prose. </para>
</listitem>
<listitem>
<para> Use a space between a numeral and a related
fraction, if there is a possible ambiguity. For example: 1 1/2 instead of 11/2.
</para>
</listitem>
<listitem>
<para> If a fraction is used in a compound modifier,
insert a hyphen between the fraction and the unit of measurement. </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Gender</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> See <xref linkend="fundamentals-9"/>. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Grammar</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"/><colspec
colname="col2" colwidth="1.68*"/>
<tbody>
<row>
<entry colname="col1" colsep="0" rowsep="0">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0">
<para> Use standard American English grammar rules, see the
<ulink
url="http://www.press.uchicago.edu/Misc/Chicago/cmosfaq/cmosfaq.html">
<citetitle>Chicago Manual of
Style</citetitle></ulink>.</para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Headings</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use the following capitalization rules in headings:
</para>
<itemizedlist>
<listitem>
<para> Initial uppercase letter for the first word and the last word, regardless of part of
speech </para>
</listitem>
<listitem>
<para> Initial uppercase letter for all nouns, adjectives, and verbs </para>
</listitem>
<listitem>
<para> Initial uppercase letter for conjunctions of four
letters or longer </para>
</listitem>
<listitem>
<para> Initial uppercase letter for prepositions of four
letters or longer </para>
</listitem>
<listitem>
<para> Initial uppercase letter for prepositions that are part of a
phrasal verb </para>
</listitem>
<listitem>
<para> All lowercase letters for conjunctions, articles,
and prepositions of less than four letters </para>
</listitem>
</itemizedlist>
<para> See <xref linkend="infodesign-2"/> for more
information about headings. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Hyphen</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use hyphens in the following situations: </para>
<itemizedlist>
<listitem>
<para> With a numeral in a compound modifier </para>
</listitem>
<listitem>
<para> To prevent ambiguity </para>
</listitem>
<listitem>
<para> With some standard prefixes and suffixes. Use the
<ulink url="http://www.bartleby.com/61/">
<citetitle>American Heritage
Dictionary</citetitle></ulink> for guidance </para>
</listitem>
<listitem>
<para> In spelled-out fractions </para>
</listitem>
<listitem>
<para> In variable names of two or more words, such as
<replaceable> directory-name</replaceable>. Note:
<replaceable>filename</replaceable> is an exception.
</para>
</listitem>
</itemizedlist>
<para> Do not use hyphens in the following situations:
</para>
<itemizedlist>
<listitem>
<para> For industry-accepted terms </para>
</listitem>
<listitem>
<para> To construct verbs </para>
</listitem>
<listitem>
<para> With an adverb ending in <emphasis>ly</emphasis>
</para>
</listitem>
<listitem>
<para> With numerals as single modifiers </para>
</listitem>
<listitem>
<para> With a word that is listed as unhyphenated in the
<ulink url="http://www.bartleby.com/61/">
<citetitle>American Heritage
Dictionary</citetitle></ulink>, and that uses a common prefix </para>
</listitem>
<listitem>
<para> With trademarked terms </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Latin terms</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Do not use Latin terms. Use an equivalent English term
instead. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Like</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Do not use the term <emphasis>like</emphasis> to
denote equivalence or similarity. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Lists</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Introduce a list with a complete sentence that ends
with a colon. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Numbers</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Spell out numbers in the following situations: </para>
<itemizedlist>
<listitem>
<para> Numbers from zero through nine unless the number
is part of a measurement. </para>
</listitem>
<listitem>
<para> Approximations. </para>
</listitem>
<listitem>
<para> Extreme values such as
<emphasis>million</emphasis>, but precede the value with a numeral </para>
</listitem>
<listitem>
<para> Any number that begins a sentence </para>
</listitem>
<listitem>
<para> A number that is immediately followed by a
numeral, for example: two 10 MB files </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Numerals</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use numerals in the following situations: </para>
<itemizedlist>
<listitem>
<para> The number 10 or greater </para>
</listitem>
<listitem>
<para> Negative numbers </para>
</listitem>
<listitem>
<para> Most fractions </para>
</listitem>
<listitem>
<para> Percentages </para>
</listitem>
<listitem>
<para> Decimals </para>
</listitem>
<listitem>
<para> Measurements </para>
</listitem>
<listitem>
<para> Units of time smaller than one second </para>
</listitem>
<listitem>
<para> References to bits and bytes </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Parentheses</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use parentheses in the following situations: </para>
<itemizedlist>
<listitem>
<para> To contain the abbreviation of a term on the first
occurrence of the full term </para>
</listitem>
<listitem>
<para> In man page references, specifically the section
number </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Period</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use a period in the following situations: </para>
<itemizedlist>
<listitem>
<para> To end a sentence </para>
</listitem>
<listitem>
<para> In file and directory names </para>
</listitem>
<listitem>
<para> In abbreviations that can be mistaken for words,
such as a.m. and U.S. </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Punctuation</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use standard American English punctuation rules. In
addition to the specific points of punctuation in this section, see also the
<ulink
url="http://www.press.uchicago.edu/Misc/Chicago/cmosfaq/cmosfaq.html">
<citetitle>Chicago Manual of Style</citetitle></ulink>.
</para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Punctuation in numbers</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<itemizedlist>
<listitem>
<para> Do not use a comma in numerals of four digits.
</para>
</listitem>
<listitem>
<para> Use a comma in numerals of more than four digits.
</para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Quotation marks</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<itemizedlist>
<listitem>
<para> Use quotation marks to indicate material that is
taken verbatim from another source. </para>
</listitem>
<listitem>
<para> Do not use quotation marks to excuse terms from
legitimacy. If the term is not legitimate, then use another term. If you must
use that term, declare the term in the glossary and make the term legitimate.
</para>
</listitem>
</itemizedlist> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Semicolon</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Do not use semicolons. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Spelling</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<para> Use standard American English spelling rules, see the
<ulink url="http://www.bartleby.com/61/">
<citetitle>American Heritage
Dictionary</citetitle></ulink> for guidelines. </para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Titles</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*" colsep="0"
align="left"/><colspec colname="col2" colwidth="1.68*" colsep="0"
align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" valign="top" align="left">
<para> For manual titles use the same rules as for headings.
</para> </entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term>Units</term>
<listitem>
<informaltable frame="none">
<tgroup cols="2"><colspec colname="col1" colwidth="0.32*"
align="left"/><colspec colname="col2" colwidth="1.68*" align="left"/>
<tbody>
<row valign="top">
<entry colname="col1" colsep="0" rowsep="0"
align="left" valign="top">
<para> Rules: </para> </entry>
<entry colname="col2" colsep="0" rowsep="0" valign="top"
align="left">
<itemizedlist>
<listitem>
<para> Use standard abbreviations for units of
measurements, do not invent your own abbreviations. </para>
</listitem>
<listitem>
<para> See <xref linkend="units"/> for a list of units
relevant to the GNOME Desktop. For further guidelines, see the
<citetitle>IEEE Standard Dictionary of Electrical and
Electronics Terms</citetitle>. </para>
</listitem>
<listitem>
<para> Use periods for abbreviated units that might be
mistaken for a word. </para>
</listitem>
<listitem>
<para> Most standard abbreviations of units account for
both singular and plural usage. </para>
</listitem>
<listitem>
<para> Insert a space between the numeral and the unit of
measurement. </para>
</listitem>
</itemizedlist></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
</variablelist>
</chapter>
|
