-
Notifications
You must be signed in to change notification settings - Fork 25
Expand file tree
/
Copy pathB.xml
More file actions
433 lines (366 loc) · 14.1 KB
/
B.xml
File metadata and controls
433 lines (366 loc) · 14.1 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
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Conventions_for_Writers_and_Editors.ent">
%BOOK_ENTITIES;
]>
<chapter id="b">
<title>B</title>
<variablelist>
<varlistentry id="back-end">
<term>back end, back-end</term>
<listitem>
<para>
<emphasis>n.</emphasis> Two words. Refers to software that performs the final stages of a process, or tasks that are not visible to the user. For example, "each back end provides a set of calls."
</para>
<para>
<emphasis>adj.</emphasis> Hyphenate. For example, "when the back-end database processes a search operation…"
</para>
<para>
Do not use "backend."
</para>
<para>
See also <xref linkend="front-end" />
</para>
</listitem>
</varlistentry>
<varlistentry id="back-up">
<term>backup, back up</term>
<listitem>
<para>
Depending on usage, this could appear in either of two ways:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>adj.</emphasis> One word. For example, "store the backup copies of important files in a secure location."
</para>
</listitem>
<listitem>
<para>
<emphasis>n.</emphasis> One word. For example, "create a backup of your important files."
</para>
</listitem>
<listitem>
<para>
<emphasis>v.</emphasis> Two words. For example, "always back up important files."
</para>
</listitem>
</itemizedlist>
<para>
Do not use the hyphenated form, "back-up."
</para>
</listitem>
</varlistentry>
<varlistentry id="backtrace">
<term>backtrace</term>
<listitem>
<para>
<emphasis>n.</emphasis> "Backtrace" is the most common term used to refer to a stack trace (or stack backtrace), which is a report of the active stack frames (that is, function calls) at a certain point in time during the execution of a program. In contrast, the Python programming language calls its stack trace a "traceback," possibly because the stack frames are printed in the opposite order of those presented by gdb, the GNU Debugger. "Traceback" is the preferred term when referring to a Python stack trace.
</para>
</listitem>
</varlistentry>
<varlistentry id="backwards">
<term>backwards</term>
<listitem>
<para>
Avoid using "backwards" unless you are stating that something has "backwards compatibility."
</para>
</listitem>
</varlistentry>
<varlistentry id="backwards-compatible">
<term>backwards compatible</term>
<listitem>
<para>
Correct. Use to refer to something that is compatible with older equipment or previous versions of software. See also <xref linkend="forwards-compatible" />.
</para>
</listitem>
</varlistentry>
<varlistentry id="bandwidth">
<term>bandwidth</term>
<listitem>
<para>
Correct. Bandwidth can refer to a range within a band of frequencies or wavelengths, or the amount of data that can be transmitted in a fixed amount of time.
</para>
</listitem>
</varlistentry>
<varlistentry id="bare-metal">
<term>bare metal, bare-metal</term>
<listitem>
<para>
<emphasis>n.</emphasis> Two words.
</para>
<para>
<emphasis>adj.</emphasis> Hyphenate.
</para>
</listitem>
</varlistentry>
<varlistentry id="basically">
<term>basically</term>
<listitem>
<para>
Do not use. For example, removing the word "basically" in the following sentence strengthens it: "This is how it is basically done." See also <xref linkend="simply" />.
</para>
</listitem>
</varlistentry>
<varlistentry id="because-since-as">
<term>because, since, as</term>
<listitem>
<para>
Do not use "since" or "as" to mean "because"; it is ambiguous. Use "because" to refer to a reason. Use "since" and "as" to indicate the passage of time.
</para>
</listitem>
</varlistentry>
<varlistentry id="below">
<term>below</term>
<listitem>
<para>
Do not use to refer to information mentioned "below," or later in a document. When documents are converted to online format, the information may no longer be "below." Use a cross-reference instead.
</para>
</listitem>
</varlistentry>
<varlistentry id="big-data">
<term>big data</term>
<listitem>
<para>
<emphasis>n., adj.</emphasis> Always use lowercase. Do not capitalize except at the beginning of a sentence, or if it is part of a Red Hat product, service, solution, or business unit name. See also <xref linkend="cloud" />. Big data is also never hyphenated, per AP style, even when used as a complex adjective.
</para>
</listitem>
</varlistentry>
<varlistentry id="bimodal-it">
<term>bimodal IT</term>
<listitem>
<para>
Gartner phrase for the combination of traditional (mode 1 or type 1) and modern (mode 2 or type 2) IT infrastructure and resources. There are many ways to talk about this combination approach; be sure you use the right phrase for your audience. Using only the Gartner term can alienate other analysts or those not familiar with Gartner's phrasing.
</para>
<para>
The practice of having both modes together is often referred to as hybrid, agile, or modern IT.
</para>
<note>
<para>
Hybrid IT is a more general term, e.g. it could mean on-premise plus public cloud. Agile and modern IT can both carry an implication of "mode 2", so when using those terms, be specific about the exact technology combination you mean.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry id="bimonthly">
<term>bimonthly, biweekly, semiweekly, semimonthly</term>
<listitem>
<para>
People have trouble remembering if biweekly means "every two weeks" or "twice a week." Semiweekly has a similar problem. Even though both terms have clear dictionary definitions, we recommend that you avoid them in favor of clear communication.
</para>
<para>
Instead of biweekly, write "every two weeks" or "every other week."
</para>
<para>
Instead of semiweekly or semimonthly, write "twice a week."
</para>
</listitem>
</varlistentry>
<varlistentry id="bind">
<term>BIND</term>
<listitem>
<para>
This is correct when referring to the DNS software. Do not use Bind.
</para>
</listitem>
</varlistentry>
<varlistentry id="bios">
<term>BIOS</term>
<listitem>
<para>
Correct. The plural form is BIOSes.
</para>
</listitem>
</varlistentry>
<varlistentry id="bit-rate">
<term>bit rate</term>
<listitem>
<para>
Correct. Do not use "bitrate."
</para>
</listitem>
</varlistentry>
<varlistentry id="boolean">
<term>Boolean</term>
<listitem>
<para>
Correct. Named after George Boole, who first developed the concept.
</para>
<para>
According to <citetitle>The IBM Style Guide</citetitle>, it is acceptable to use "boolean" in API programming information when it refers to a primitive return type.
</para>
</listitem>
</varlistentry>
<varlistentry id="boot">
<term>boot</term>
<listitem>
<para>
<emphasis>v.</emphasis> To load the first piece of software that starts a computer. Because the operating system is essential for running all other programs, it is usually the first piece of software loaded during the boot process.
</para>
<para>
<emphasis>n.</emphasis> Refers to the starting-up of a computer, which involves loading the operating system and other basic software. A cold boot refers to starting a computer that is turned off. A warm boot refers to resetting a computer that is already running.
</para>
<para>
Boot is an abbreviation of bootstrap, which in olden days was a strap attached to the top of your boot that you could pull to help get your boot on. Hence, the expression "pull oneself up by the bootstraps." Similarly, bootstrap utilities help the computer get started.
</para>
</listitem>
</varlistentry>
<varlistentry id="boot-disk">
<term>boot disk</term>
<listitem>
<para>
Two words. Do not use "boot diskette."
</para>
</listitem>
</varlistentry>
<varlistentry id="boot-loader">
<term>boot loader</term>
<listitem>
<para>
Two words. Do not use "bootloader."
</para>
</listitem>
</varlistentry>
<varlistentry id="bottleneck">
<term>bottleneck</term>
<listitem>
<para>
One word. Do not use "bottle neck" or "bottle-neck."
</para>
<para>
A bottleneck refers to the delay in transmission of data through the circuits of a computer's microprocessor or over a TCP/IP network. The delay typically occurs when a system's bandwidth cannot support the amount of information being relayed at the speed it is being processed. There are, however, many factors that can create a bottleneck in a system.
</para>
</listitem>
</varlistentry>
<varlistentry id="bpp">
<term>bpp</term>
<listitem>
<para>
Initialism for bits per pixel. All letters are lowercase, unless at the beginning of a sentence. Use a non-breaking space between the numeral and the units. For example, "16 bpp," not "16bpp."
</para>
</listitem>
</varlistentry>
<varlistentry id="bps-bps">
<term>Bps, bps</term>
<listitem>
<para>
The abbreviation of bytes per second is Bps. The abbreviation of bits per second is bps. To avoid confusion, do not use at the beginning of a sentence. See also <xref linkend="bandwidth" />.
</para>
</listitem>
</varlistentry>
<varlistentry id="breadcrumb-trail">
<term>breadcrumb trail</term>
<listitem>
<para>
See <citetitle>The IBM Style Guide</citetitle> for initial guidance on how to use this term.
</para>
<note>
<para>
Do not confuse the breadcrumb trail with the name of the actual page in a user interface. The final breadcrumb in the trail is the name of the page, unless the page itself offers a distinct title. The breadcrumb trail indicates the path taken to reach the current page.
</para>
<mediaobject id="breadcrumb-trail-example">
<imageobject>
<imagedata fileref="images/breadcrumb-trail-example.png" scalefit="1" align="center"/></imageobject>
<textobject>
<phrase>
Example breadcrumb trail, showing <guilabel>Disks</guilabel> as the actual name of the page.
</phrase>
</textobject>
<caption>
<para>
Example breadcrumb trail, showing <guilabel>Disks</guilabel> as the actual name of the page.
</para>
</caption>
</mediaobject>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>break</term>
<listitem>
<para>
(<emphasis>v.</emphasis>) Do not use to mean "break the system" or similar. For example, "applying an unapproved patch might break the system." Choose an alternative such "cause the system to fail."
</para>
</listitem>
</varlistentry>
<varlistentry id="bring-up">
<term>bring up</term>
<listitem>
<para>
Do not use. Use "open" instead.
</para>
</listitem>
</varlistentry>
<varlistentry id="britain">
<term>Britain</term>
<listitem>
<para>
If referring to the language, say "English." If referring to the country, say the United Kingdom of Great Britain and Northern Ireland, or the UK. Using Britain or British is usually wrong and to some implies a specific subjective statement about the state of Northern Ireland.
</para>
</listitem>
</varlistentry>
<varlistentry id="broadcast">
<term>broadcast</term>
<listitem>
<para>
To simultaneously send the same message to multiple recipients. Broadcasting is a useful feature in email systems. It is also supported by some fax systems.
</para>
<para>
In networking, a distinction is made between broadcasting and multicasting. Broadcasting sends a message to everyone on the network whereas multicasting sends a message to a select list of recipients.
</para>
</listitem>
</varlistentry>
<varlistentry id="btrfs">
<term>Btrfs</term>
<listitem>
<para>
A copy-on-write file system for Linux. Use a capital "B" when referring to the file system. When referring to tools, commands, and other utilities related to the file system, be faithful to those utilities.
</para>
<para>
See <ulink url="http://en.wikipedia.org/wiki/Btrfs" /> for more information on this file system.
</para>
<para>
See <ulink url="http://en.wikipedia.org/wiki/List_of_file_systems" /> for a list of file system names and how to present them.
</para>
</listitem>
</varlistentry>
<varlistentry id="bug-fix">
<term>bug fix</term>
<listitem>
<para>
Two words. Do not use "bugfix."
</para>
</listitem>
</varlistentry>
<varlistentry id="built-in">
<term>built-in</term>
<listitem>
<para>
<emphasis>adj.</emphasis> Hyphenate. Do not use "builtin" unless referring specifically to "Bash builtins" or if it is otherwise a proper noun.
</para>
</listitem>
</varlistentry>
<varlistentry id="bunches-of">
<term>bunches of</term>
<listitem>
<para>
Do not use, unless "bunch" is a specific term used in the software being documented. Use "many" or some other alternative instead.
</para>
</listitem>
</varlistentry>
<varlistentry id="button">
<term>button</term>
<listitem>
<para>
Describe a GUI button as a "button," not a "pushbutton" or "push-button."
</para>
<para>
Ordinarily you would not include the text "button" in a procedure or description. For example, "Click <guibutton>OK</guibutton> to continue" is perfectly acceptable. It may be necessary to distinguish between buttons and links; for example, "Click the <guibutton>Download</guibutton> link."
</para>
<para>
See also <xref linkend="documenting-ui"/>.
</para>
</listitem>
</varlistentry>
</variablelist>
</chapter>