Skip to content

Commit 649bc24

Browse files
authored
Merge pull request #187 from StyleGuides/dev
Fix #186 Missing line continuation prompts.
2 parents 92d9aca + f208c19 commit 649bc24

2 files changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@ WritingStyleGuide
22
=================
33

44
A guide to writing clear, concise, and consistent technical documentation.
5+
6+
The Red Hat Style Guide and Word Usage Dictionary is a joint effort by various groups within Red Hat.
7+
8+
It covers recommended design practices, how to write for translation, common mistakes to avoid, rules for everyday punctuation, grammar, and sources of information for the less common cases.
9+
10+
It is based on The IBM Style Guide but differs in several key areas, uses the Merriam-Webster Collegiate Dictionary and American Heritage Dictionary as spelling references, and the Chicago Manual of Style (17th Ed.) for further grammatical and style decisions.

en-US/Design.xml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -249,22 +249,23 @@ $ vi myFile.txt
249249

250250
</example>
251251
<para>
252-
If the commands are long, complex, or wrap over multiple lines, use the following design to help optimize clarity, and to make it easy for users to copy and paste the command if required:
252+
If the commands are long, complex, or wrap over multiple lines, use the following design to help optimize clarity.
253+
If you are documenting commands on a different operating system, update the prompts and line continuation characters to suit.
253254
</para>
254255
<example>
255256
<title>Documenting Long Commands</title>
256257

257258
<screen># tar --selinux -czvf config_files.tar.gz /etc/katello \
258-
/etc/elasticsearch /etc/candlepin /etc/pulp /etc/gofer \
259-
/etc/grinder /etc/pki/katello /etc/pki/pulp /etc/qpidd.conf \
260-
/etc/sysconfig/katello /etc/sysconfig/elasticsearch \
261-
/root/ssl–build /var/www/html/pub/* /var/lib/katello
259+
> /etc/elasticsearch /etc/candlepin /etc/pulp /etc/gofer \
260+
> /etc/grinder /etc/pki/katello /etc/pki/pulp /etc/qpidd.conf \
261+
> /etc/sysconfig/katello /etc/sysconfig/elasticsearch \
262+
> /root/ssl–build /var/www/html/pub/* /var/lib/katello
262263

263264
# cd /var/lib/katello
264265

265266
# myCommand --option funky --color=true \
266-
--config_file=&lt;replaceable&gt;/home/user/config.conf&lt;/replaceable&gt; \
267-
--output_file=&lt;replaceable&gt;/home/user/output.txt&lt;/replaceable&gt;</screen>
267+
> --config_file=&lt;replaceable&gt;/home/user/config.conf&lt;/replaceable&gt; \
268+
> --output_file=&lt;replaceable&gt;/home/user/output.txt&lt;/replaceable&gt;</screen>
268269

269270
</example>
270271

0 commit comments

Comments
 (0)