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
|
# SOME DESCRIPTIVE TITLE
# Copyright (C) YEAR Free Software Foundation, Inc.
# This file is distributed under the same license as the live-manual package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: live-manual 5.0~a2-1\n"
"POT-Creation-Date: 2015-08-23 11:04+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"
#. type: Plain text
#: en/about_manual.ssi:92 en/about_manual.ssi:100 en/about_manual.ssi:108
#: en/about_manual.ssi:116 en/about_manual.ssi:124 en/about_manual.ssi:132
#: en/appendix_style-guide.ssi:124 en/appendix_style-guide.ssi:134
#: en/appendix_style-guide.ssi:144 en/appendix_style-guide.ssi:154
#: en/appendix_style-guide.ssi:164 en/appendix_style-guide.ssi:177
#: en/examples.ssi:14 en/examples.ssi:30 en/examples.ssi:40 en/examples.ssi:54
#: en/examples.ssi:67 en/examples.ssi:83 en/examples.ssi:93
#: en/examples.ssi:106 en/examples.ssi:114 en/examples.ssi:124
#: en/examples.ssi:134 en/examples.ssi:149 en/examples.ssi:157
#: en/examples.ssi:165 en/examples.ssi:173 en/examples.ssi:189
#: en/examples.ssi:203 en/examples.ssi:211 en/examples.ssi:219
#: en/examples.ssi:235 en/examples.ssi:249 en/examples.ssi:257
#: en/examples.ssi:265 en/examples.ssi:285 en/examples.ssi:293
#: en/examples.ssi:302 en/examples.ssi:312 en/project_bugs.ssi:62
#: en/project_coding-style.ssi:30 en/project_coding-style.ssi:40
#: en/project_coding-style.ssi:53 en/project_coding-style.ssi:63
#: en/project_coding-style.ssi:94 en/project_coding-style.ssi:102
#: en/project_coding-style.ssi:112 en/project_coding-style.ssi:123
#: en/project_contributing.ssi:34 en/project_contributing.ssi:45
#: en/project_contributing.ssi:59 en/project_contributing.ssi:68
#: en/project_contributing.ssi:79 en/project_contributing.ssi:87
#: en/project_git.ssi:8 en/project_git.ssi:16 en/project_git.ssi:24
#: en/project_git.ssi:34 en/project_git.ssi:44 en/project_git.ssi:56
#: en/project_procedures.ssi:39 en/project_procedures.ssi:51
#: en/user_basics.ssi:50 en/user_basics.ssi:58 en/user_basics.ssi:68
#: en/user_basics.ssi:86 en/user_basics.ssi:100 en/user_basics.ssi:113
#: en/user_basics.ssi:121 en/user_basics.ssi:159 en/user_basics.ssi:167
#: en/user_basics.ssi:179 en/user_basics.ssi:190 en/user_basics.ssi:198
#: en/user_basics.ssi:210 en/user_basics.ssi:218 en/user_basics.ssi:226
#: en/user_basics.ssi:238 en/user_basics.ssi:250 en/user_basics.ssi:260
#: en/user_basics.ssi:270 en/user_basics.ssi:288 en/user_basics.ssi:319
#: en/user_basics.ssi:335 en/user_basics.ssi:343 en/user_basics.ssi:363
#: en/user_basics.ssi:390 en/user_basics.ssi:406
#: en/user_customization-binary.ssi:18 en/user_customization-contents.ssi:24
#: en/user_customization-contents.ssi:33 en/user_customization-contents.ssi:51
#: en/user_customization-installer.ssi:32
#: en/user_customization-installer.ssi:44
#: en/user_customization-packages.ssi:14 en/user_customization-packages.ssi:22
#: en/user_customization-packages.ssi:40 en/user_customization-packages.ssi:53
#: en/user_customization-packages.ssi:67 en/user_customization-packages.ssi:95
#: en/user_customization-packages.ssi:106
#: en/user_customization-packages.ssi:114
#: en/user_customization-packages.ssi:138
#: en/user_customization-packages.ssi:151
#: en/user_customization-packages.ssi:161
#: en/user_customization-packages.ssi:171
#: en/user_customization-packages.ssi:195
#: en/user_customization-packages.ssi:211
#: en/user_customization-packages.ssi:290
#: en/user_customization-packages.ssi:302
#: en/user_customization-packages.ssi:312
#: en/user_customization-packages.ssi:326
#: en/user_customization-packages.ssi:342
#: en/user_customization-packages.ssi:359 en/user_customization-runtime.ssi:14
#: en/user_customization-runtime.ssi:26 en/user_customization-runtime.ssi:44
#: en/user_customization-runtime.ssi:56 en/user_customization-runtime.ssi:75
#: en/user_customization-runtime.ssi:83 en/user_customization-runtime.ssi:92
#: en/user_customization-runtime.ssi:121 en/user_customization-runtime.ssi:131
#: en/user_customization-runtime.ssi:139 en/user_customization-runtime.ssi:148
#: en/user_customization-runtime.ssi:157 en/user_customization-runtime.ssi:172
#: en/user_customization-runtime.ssi:202 en/user_customization-runtime.ssi:210
#: en/user_customization-runtime.ssi:219 en/user_customization-runtime.ssi:229
#: en/user_customization-runtime.ssi:237 en/user_customization-runtime.ssi:245
#: en/user_customization-runtime.ssi:253 en/user_customization-runtime.ssi:261
#: en/user_customization-runtime.ssi:269 en/user_customization-runtime.ssi:277
#: en/user_customization-runtime.ssi:285 en/user_installation.ssi:38
#: en/user_installation.ssi:48 en/user_installation.ssi:56
#: en/user_installation.ssi:66 en/user_installation.ssi:74
#: en/user_installation.ssi:82 en/user_installation.ssi:106
#: en/user_installation.ssi:121 en/user_installation.ssi:134
#: en/user_managing_a_configuration.ssi:22
#: en/user_managing_a_configuration.ssi:32
#: en/user_managing_a_configuration.ssi:55
#: en/user_managing_a_configuration.ssi:67
#: en/user_managing_a_configuration.ssi:76 en/user_overview.ssi:34
#: en/user_overview.ssi:47 en/user_overview.ssi:55
msgid "code{"
msgstr ""
#. type: Plain text
#: en/about_manual.ssi:96 en/about_manual.ssi:104 en/about_manual.ssi:112
#: en/about_manual.ssi:120 en/about_manual.ssi:128 en/about_manual.ssi:136
#: en/appendix_style-guide.ssi:128 en/appendix_style-guide.ssi:138
#: en/appendix_style-guide.ssi:148 en/appendix_style-guide.ssi:158
#: en/appendix_style-guide.ssi:173 en/appendix_style-guide.ssi:182
#: en/examples.ssi:20 en/examples.ssi:34 en/examples.ssi:44 en/examples.ssi:61
#: en/examples.ssi:71 en/examples.ssi:89 en/examples.ssi:102
#: en/examples.ssi:110 en/examples.ssi:118 en/examples.ssi:128
#: en/examples.ssi:141 en/examples.ssi:153 en/examples.ssi:161
#: en/examples.ssi:169 en/examples.ssi:177 en/examples.ssi:197
#: en/examples.ssi:207 en/examples.ssi:215 en/examples.ssi:231
#: en/examples.ssi:239 en/examples.ssi:253 en/examples.ssi:261
#: en/examples.ssi:269 en/examples.ssi:289 en/examples.ssi:298
#: en/examples.ssi:308 en/examples.ssi:324 en/project_bugs.ssi:66
#: en/project_coding-style.ssi:36 en/project_coding-style.ssi:47
#: en/project_coding-style.ssi:59 en/project_coding-style.ssi:70
#: en/project_coding-style.ssi:98 en/project_coding-style.ssi:106
#: en/project_coding-style.ssi:119 en/project_coding-style.ssi:130
#: en/project_contributing.ssi:41 en/project_contributing.ssi:55
#: en/project_contributing.ssi:64 en/project_contributing.ssi:73
#: en/project_contributing.ssi:83 en/project_contributing.ssi:90
#: en/project_git.ssi:12 en/project_git.ssi:20 en/project_git.ssi:28
#: en/project_git.ssi:38 en/project_git.ssi:48 en/project_git.ssi:60
#: en/project_procedures.ssi:47 en/project_procedures.ssi:92
#: en/user_basics.ssi:54 en/user_basics.ssi:62 en/user_basics.ssi:72
#: en/user_basics.ssi:91 en/user_basics.ssi:105 en/user_basics.ssi:117
#: en/user_basics.ssi:125 en/user_basics.ssi:163 en/user_basics.ssi:171
#: en/user_basics.ssi:184 en/user_basics.ssi:194 en/user_basics.ssi:202
#: en/user_basics.ssi:214 en/user_basics.ssi:222 en/user_basics.ssi:230
#: en/user_basics.ssi:242 en/user_basics.ssi:254 en/user_basics.ssi:264
#: en/user_basics.ssi:274 en/user_basics.ssi:311 en/user_basics.ssi:323
#: en/user_basics.ssi:339 en/user_basics.ssi:347 en/user_basics.ssi:374
#: en/user_basics.ssi:394 en/user_basics.ssi:410
#: en/user_customization-binary.ssi:25 en/user_customization-contents.ssi:29
#: en/user_customization-contents.ssi:43 en/user_customization-contents.ssi:55
#: en/user_customization-installer.ssi:38
#: en/user_customization-installer.ssi:49
#: en/user_customization-packages.ssi:18 en/user_customization-packages.ssi:26
#: en/user_customization-packages.ssi:45 en/user_customization-packages.ssi:59
#: en/user_customization-packages.ssi:71
#: en/user_customization-packages.ssi:100
#: en/user_customization-packages.ssi:110
#: en/user_customization-packages.ssi:118
#: en/user_customization-packages.ssi:143
#: en/user_customization-packages.ssi:157
#: en/user_customization-packages.ssi:167
#: en/user_customization-packages.ssi:177
#: en/user_customization-packages.ssi:201
#: en/user_customization-packages.ssi:216
#: en/user_customization-packages.ssi:294
#: en/user_customization-packages.ssi:306
#: en/user_customization-packages.ssi:316
#: en/user_customization-packages.ssi:330
#: en/user_customization-packages.ssi:355
#: en/user_customization-packages.ssi:364 en/user_customization-runtime.ssi:18
#: en/user_customization-runtime.ssi:30 en/user_customization-runtime.ssi:48
#: en/user_customization-runtime.ssi:69 en/user_customization-runtime.ssi:79
#: en/user_customization-runtime.ssi:88 en/user_customization-runtime.ssi:97
#: en/user_customization-runtime.ssi:125 en/user_customization-runtime.ssi:135
#: en/user_customization-runtime.ssi:144 en/user_customization-runtime.ssi:153
#: en/user_customization-runtime.ssi:162 en/user_customization-runtime.ssi:180
#: en/user_customization-runtime.ssi:206 en/user_customization-runtime.ssi:215
#: en/user_customization-runtime.ssi:223 en/user_customization-runtime.ssi:233
#: en/user_customization-runtime.ssi:241 en/user_customization-runtime.ssi:249
#: en/user_customization-runtime.ssi:257 en/user_customization-runtime.ssi:265
#: en/user_customization-runtime.ssi:273 en/user_customization-runtime.ssi:281
#: en/user_customization-runtime.ssi:289 en/user_installation.ssi:42
#: en/user_installation.ssi:52 en/user_installation.ssi:62
#: en/user_installation.ssi:70 en/user_installation.ssi:78
#: en/user_installation.ssi:86 en/user_installation.ssi:111
#: en/user_installation.ssi:128 en/user_installation.ssi:139
#: en/user_managing_a_configuration.ssi:28
#: en/user_managing_a_configuration.ssi:43
#: en/user_managing_a_configuration.ssi:61
#: en/user_managing_a_configuration.ssi:72
#: en/user_managing_a_configuration.ssi:80 en/user_overview.ssi:41
#: en/user_overview.ssi:51 en/user_overview.ssi:59
msgid "}code"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:2
msgid ":B~ Style guide"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:4
msgid "1~style-guide Style guide"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:6
msgid "2~ Guidelines for authors"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:8
msgid ""
"This section deals with some general considerations to be taken into account "
"when writing technical documentation for live-manual. They are divided into "
"linguistic features and recommended procedures."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:10
#, no-wrap
msgid "*{Note:}* Authors should first read {Contributing to this document}#how-to-contribute\n"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:12
msgid "3~ Linguistic features"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:14
msgid "_* /{Use plain English}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:16
msgid ""
"Keep in mind that a high percentage of your readers are not native speakers "
"of English. So as a general rule try to use short, meaningful sentences, "
"followed by a full stop."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:18
msgid ""
"This does not mean that you have to use a simplistic, naive style. It is a "
"suggestion to try to avoid, as much as possible, complex subordinate "
"sentences that make the text difficult to understand for non-native speakers "
"of English."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:20
msgid "_* /{Variety of English}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:22
msgid ""
"The most widely spread varieties of English are British and American so it "
"is very likely that most authors will use either one or the other. In a "
"collaborative environment, the ideal variety would be \"International English"
"\" but it is very difficult, not to say impossible, to decide on which "
"variety among all the existing ones, is the best to use."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:24
msgid ""
"We expect that different varieties may mix without creating "
"misunderstandings but in general terms you should try to be coherent and "
"before deciding on using British, American or any other English flavour at "
"your discretion, please take a look at how other people write and try to "
"imitate them."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:26
msgid "_* /{Be balanced}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:28
msgid ""
"Do not be biased. Avoid including references to ideologies completely "
"unrelated to live-manual. Technical writing should be as neutral as "
"possible. It is in the very nature of scientific writing."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:30
msgid "_* /{Be politically correct}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:32
msgid ""
"Try to avoid sexist language as much as possible. If you need to make "
"references to the third person singular preferably use \"they\" rather than "
"\"he\" or \"she\" or awkward inventions such as \"s/he\", \"s(he)\" and the "
"like."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:34
msgid "_* /{Be concise}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:36
msgid ""
"Go straight to the point and do not wander around aimlessly. Give as much "
"information as necessary but do not give more information than necessary, "
"this is to say, do not explain unnecessary details. Your readers are "
"intelligent. Presume some previous knowledge on their part."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:38
msgid "_* /{Minimize translation work}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:40
msgid ""
"Keep in mind that whatever you write will have to be translated into several "
"other languages. This implies that a number of people will have to do an "
"extra work if you add useless or redundant information."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:42
msgid "_* /{Be coherent}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:44
msgid ""
"As suggested before, it is almost impossible to standardize a collaborative "
"document into a perfectly unified whole. However, every effort on your side "
"to write in a coherent way with the rest of the authors will be appreciated."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:46
msgid "_* /{Be cohesive}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:48
msgid ""
"Use as many text-forming devices as necessary to make your text cohesive and "
"unambiguous. (Text-forming devices are linguistic markers such as "
"connectors)."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:50
msgid "_* /{Be descriptive}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:52
msgid ""
"It is preferable to describe the point in one or several paragraphs than "
"merely using a number of sentences in a typical \"changelog\" style. "
"Describe it! Your readers will appreciate it."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:54
msgid "_* /{Dictionary}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:56
msgid ""
"Look up the meaning of words in a dictionary or encyclopedia if you do not "
"know how to express certain concepts in English. But keep in mind that a "
"dictionary can either be your best friend or can turn into your worst enemy "
"if you do not know how to use it correctly."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:58
msgid ""
"English has the largest vocabulary that exists (with over one million "
"words). Many of these words are borrowings from other languages. When "
"looking up the meaning of words in a bilingual dictionary the tendency of a "
"non-native speaker of English is to choose the one that sounds more similar "
"in their mother tongue. This often turns into an excessively formal "
"discourse which does not sound quite natural in English."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:60
msgid ""
"As a general rule, if a concept can be expressed using different synonyms, "
"it is a good advice to choose the first word proposed by the dictionary. If "
"in doubt, choosing words of Germanic origin (Usually monosyllabic words) is "
"often the right thing to do. Be warned that these two techniques might "
"produce a rather informal discourse but at least your choice of words will "
"be of wide use and generally accepted."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:62
msgid ""
"Using a dictionary of collocations is recommended. They are extremely "
"helpful when it comes to know which words usually occur together."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:64
msgid ""
"Again it is a good practice to learn from the work of others. Using a search "
"engine to check how other authors use certain expressions may help a lot."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:66
msgid "_* /{False friends, idioms and other idiomatic expressions}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:68
msgid ""
"Watch out for false friends. No matter how proficient you are in a foreign "
"language you cannot help falling from time to time in the trap of the so "
"called \"false friends\", words that look similar in two languages but whose "
"meanings or uses might be completely different."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:70
msgid ""
"Try to avoid idioms as much as possible. \"Idioms\" are expressions that may "
"convey a completely different meaning from what their individual words seem "
"to mean. Sometimes, idioms might be difficult to understand even for native "
"speakers of English!"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:72
msgid "_* /{Avoid slang, abbreviations, contractions...}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:74
msgid ""
"Even though you are encouraged to use plain, everyday English, technical "
"writing belongs to the formal register of the language."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:76
msgid ""
"Try to avoid slang, unusual abbreviations that are difficult to understand "
"and above all contractions that try to imitate the spoken language. Not to "
"mention typical irc and family friendly expressions."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:78
msgid "3~ Procedures"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:80
msgid "_* /{Test before write}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:82
msgid ""
"It is important that authors test their examples before adding them to live-"
"manual to ensure that everything works as described. Testing on a clean "
"chroot or VM can be a good starting point. Besides, it would be ideal if the "
"tests were then carried out on different machines with different hardware to "
"spot possible problems that may arise."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:84
msgid "_* /{Examples}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:86
msgid ""
"When providing an example try to be as specific as you can. An example is, "
"after all, just an example."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:88
msgid ""
"It is often better to use a line that only applies to a specific case than "
"using abstractions that may confuse your readers. In this case you can "
"provide a brief explanation of the effects of the proposed example."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:90
msgid ""
"There may be some exceptions when the example suggests using some "
"potentially dangerous commands that, if misused, may cause data loss or "
"other similar undesirable effects. In this case you should provide a "
"thorough explanation of the possible side effects."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:92
msgid "_* /{External links}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:94
msgid ""
"Links to external sites should only be used when the information on those "
"sites is crucial when it comes to understanding a special point. Even so, "
"try to use links to external sites as sparsely as possible. Internet links "
"are likely to change from time to time resulting in broken links and leaving "
"your arguments in an incomplete state."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:96
msgid ""
"Besides, people who read the manual offline will not have the chance to "
"follow those links."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:98
msgid ""
"_* /{Avoid branding and things that violate the license under which the "
"manual is published}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:100
msgid ""
"Try to avoid branding as much as possible. Keep in mind that other "
"downstream projects might make use of the documentation you write. So you "
"are complicating things for them if you add certain specific material."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:102
msgid ""
"live-manual is licensed under the GNU GPL. This has a number of implications "
"that apply to the distribution of the material (of any kind, including "
"copyrighted graphics or logos) that is published with it."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:104
msgid "_* /{Write a first draft, revise, edit, improve, redo if necessary}/"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:106
msgid ""
"Brainstorm!. You need to organize your ideas first in a logical sequence of "
"events."
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:108
msgid ""
"Once you have somehow organized those ideas in your mind write a first draft."
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:110
msgid ""
"Revise grammar, syntax and spelling. Keep in mind that the proper names of "
"the releases, such as ${testing} or sid, should not be capitalized when "
"referred to as code names. In order to check the spelling you can run the "
"\"spell\" target. i.e. #{make spell}#"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:112
msgid "Improve your statements and redo any part if necessary."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:114
msgid "_* /{Chapters}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:116
msgid ""
"Use the conventional numbering system for chapters and subtitles. e.g. 1, "
"1.1, 1.1.1, 1.1.2 ... 1.2, 1.2.1, 1.2.2 ... 2, 2.1 ... and so on. See markup "
"below."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:118
msgid ""
"If you have to enumerate a series of steps or stages in your description, "
"you can also use ordinal numbers: First, second, third ... or First, Then, "
"After that, Finally ... Alternatively you can use bulleted items."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:120 en/appendix_style-guide.ssi:214
msgid "_* /{Markup}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:122
msgid ""
"And last but not least, live-manual uses {SiSU}http://www.sisudoc.org/ to "
"process the text files and produce a multiple format output. It is "
"recommended to take a look at {SiSU's manual}http://www.sisudoc.org/sisu/en/"
"html/sisu_manual/markup.html to get familiar with its markup, or else type:"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:126
#, no-wrap
msgid " $ sisu --help markup\n"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:130
msgid "Here are some markup examples that may prove useful:"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:132
msgid "For emphasis/bold text:"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:136
#, no-wrap
msgid "*{foo}* or !{foo}!\n"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:140
msgid "produces: *{foo}* or !{foo}!. Use it to emphasize certain key words."
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:142
msgid "For italics:"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:146
msgid "/{foo}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:150
msgid "produces: /{foo}/. Use them e.g. for the names of Debian packages."
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:152
msgid "For monospace:"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:156
msgid "#{foo}#"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:160
msgid ""
"produces: #{foo}#. Use it e.g. for the names of commands. And also to "
"highlight some key words or things like paths."
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:162
msgid "For code blocks:"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:166
#, no-wrap
msgid " code{\n"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:169
#, no-wrap
msgid ""
" $ foo\n"
" # bar\n"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:171
#, no-wrap
msgid " }code\n"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:175
msgid "produces:"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:180
#, no-wrap
msgid ""
" $ foo\n"
" # bar\n"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:184
msgid ""
"Use #{code{}# to open and #{}code}# to close the tags. It is important to "
"remember to leave a space at the beginning of each line of code."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:186
msgid "2~guidelines-translators Guidelines for translators"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:188
msgid ""
"This section deals with some general considerations to be taken into account "
"when translating the contents of live-manual."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:190
msgid ""
"As a general recommendation, translators should have read and understood the "
"translation rules that apply to their specific languages. Usually, "
"translation groups and mailing lists provide information on how to produce "
"translated work that complies with Debian quality standards."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:192
#, no-wrap
msgid "*{Note:}* Translators should also read {Contributing to this document}#how-to-contribute. In particular the section {Translation}#translation\n"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:194
msgid "3~ Translation hints"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:196
msgid "_* /{Comments}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:198
msgid ""
"The role of the translator is to convey as faithfully as possible the "
"meaning of words, sentences, paragraphs and texts as written by the original "
"authors into their target language."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:200
msgid ""
"So they should refrain from adding personal comments or extra bits of "
"information of their own. If they want to add a comment for other "
"translators working on the same documents, they can leave it in the space "
"reserved for that. That is, the header of the strings in the *{po}* files "
"preceded by a number sign *{#}*. Most graphical translation programs can "
"automatically handle those types of comments."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:202
msgid "_* /{TN, Translator's Note}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:204
msgid ""
"It is perfectly acceptable however, to include a word or an expression in "
"brackets in the translated text if, and only if, that makes the meaning of a "
"difficult word or expression clearer to the reader. Inside the brackets the "
"translator should make evident that the addition was theirs using the "
"abbreviation \"TN\" or \"Translator's Note\"."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:206
msgid "_* /{Impersonal sentences}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:208
msgid ""
"Documents written in English make an extensive use of the impersonal form "
"\"you\". In some other languages that do not share this characteristic, this "
"might give the false impression that the original texts are directly "
"addressing the reader when they are actually not doing so. Translators must "
"be aware of that fact and reflect it in their language as accurately as "
"possible."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:210
msgid "_* /{False friends}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:212
msgid ""
"The trap of \"false friends\" explained before especially applies to "
"translators. Double check the meaning of suspicious false friends if in "
"doubt."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:216
msgid ""
"Translators working initially with *{pot}* files and later on with *{po}* "
"files will find many markup features in the strings. They can translate the "
"text anyway, as long as it is translatable, but it is extremely important "
"that they use exactly the same markup as the original English version."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:218
msgid "_* /{Code blocks}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:220
msgid ""
"Even though the code blocks are usually untranslatable, including them in "
"the translation is the only way to score a 100% complete translation. And "
"even though it means more work at first because it might require the "
"intervention of the translators if the code changes, it is the best way, in "
"the long run, to identify what has already been translated and what has not "
"when checking the integrity of the .po files."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:222
msgid "_* /{Newlines}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:224
msgid ""
"The translated texts need to have the exact same newlines as the original "
"texts. Be careful to press the \"Enter\" key or type *{\\n}* if they appear "
"in the original files. These newlines often appear, for instance, in the "
"code blocks."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:226
msgid ""
"Make no mistake, this does not mean that the translated text needs to have "
"the same length as the English version. That is nearly impossible."
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:228
msgid "_* /{Untranslatable strings}/"
msgstr ""
#. type: Plain text
#: en/appendix_style-guide.ssi:230
msgid "Translators should never translate:"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:232
msgid "The code names of releases (which should be written in lowercase)"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:234
msgid "The names of programs"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:236
msgid "The commands given as examples"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:238
msgid "Metadata (often between colons *{:metadata:}*)"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:240
msgid "Links"
msgstr ""
#. type: Bullet: ' - '
#: en/appendix_style-guide.ssi:241
msgid "Paths"
msgstr ""
|