deploy: a225f27

index.html

@@ -3015,6 +3015,7 @@ <h1>Red Hat supplementary style guide for product documentation</h1>
 </li>
 <li><a href="#formatting">Formatting</a>
 <ul class="sectlevel3">
+<li><a href="#commands-in-code-blocks">Commands in code blocks</a></li>
 <li><a href="#date-formats">Date formats</a></li>
 <li><a href="#man-pages">Man page references</a></li>
 <li><a href="#non-breaking-spaces">Non-breaking spaces</a></li>
@@ -4047,6 +4048,67 @@ <h5 id="_principle_5_error_recovery_verification_and_troubleshooting"><a class="
 <div class="sect2">
 <h3 id="formatting"><a class="anchor" href="#formatting"></a><a class="link" href="#formatting">Formatting</a></h3>
 <div class="sect3">
+<h4 id="commands-in-code-blocks"><a class="anchor" href="#commands-in-code-blocks"></a><a class="link" href="#commands-in-code-blocks">Commands in code blocks</a></h4>
+<div class="paragraph">
+<p>Use a single command per code block for each procedure step. This approach helps with readability and makes it possible for the copy button in code blocks to work correctly.</p>
+</div>
+<div class="paragraph">
+<p>By default, use bold formatting for commands in code blocks to visually distinguish the commands from their lead-in sentences and from the command prompts and example outputs. For consistency, use bold formatting for commands even when no command output is shown in the code block.</p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>To apply formatting in a code block, you must use the <code>quotes</code> <a href="https://docs.asciidoctor.org/asciidoc/latest/subs/apply-subs-to-blocks/">AsciiDoc substitution</a>.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="literalblock">
+<div class="title">Example AsciiDoc: A command and its output in a code block</div>
+<div class="content">
+<pre>Verify that the `libvirt` default network is active and configured to start automatically:</pre>
+</div>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>[subs="+quotes"]
+----
+# *virsh net-list --all*
+Name      State    Autostart   Persistent
+--------------------------------------------
+default   active   yes         yes
+----</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>This example renders as follows in HTML:</p>
+</div>
+<div class="exampleblock">
+<div class="content">
+<div class="paragraph">
+<p>Verify that the <code>libvirt</code> default network is active and configured to start automatically:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre># <strong>virsh net-list --all</strong>
+Name      State    Autostart   Persistent
+--------------------------------------------
+default   active   yes         yes</pre>
+</div>
+</div>
+</div>
+</div>
+<div class="paragraph">
+<p>For commands and command outputs in code blocks, observe the correct markup for user-replaced values, as described in <a href="#user-replaced-values">User-replaced values</a> and <a href="#user-replaced-values-xml">User-replaced values for XML</a>.</p>
+</div>
+</div>
+<div class="sect3">
 <h4 id="date-formats"><a class="anchor" href="#date-formats"></a><a class="link" href="#date-formats">Date formats</a></h4>
 <div class="paragraph">
 <p>Follow the <em>IBM Style</em> guide advice of <em>day Month year</em> for date formats, for example, 3 October 2019.</p>
@@ -4288,7 +4350,7 @@ <h4 id="user-replaced-values"><a class="anchor" href="#user-replaced-values"></a
 </div>
 </div>
 <div class="paragraph">
-<p>This renders as:</p>
+<p>This example renders as follows in HTML:</p>
 </div>
 <div class="exampleblock">
 <div class="content">
@@ -4305,18 +4367,18 @@ <h4 id="user-replaced-values"><a class="anchor" href="#user-replaced-values"></a
 <div class="content">
 <pre>[subs="+quotes"]
 ----
-$ oc describe node __&lt;node_name&gt;__
+$ *oc describe node __&lt;node_name&gt;__*
 ----</pre>
 </div>
 </div>
 <div class="paragraph">
-<p>This renders as:</p>
+<p>This example renders as follows in HTML:</p>
 </div>
 <div class="exampleblock">
 <div class="content">
 <div class="listingblock">
 <div class="content">
-<pre>$ oc describe node <em>&lt;node_name&gt;</em></pre>
+<pre>$ <strong>oc describe node <em>&lt;node_name&gt;</em></strong></pre>
 </div>
 </div>
 </div>
@@ -4334,7 +4396,7 @@ <h4 id="user-replaced-values"><a class="anchor" href="#user-replaced-values"></a
 </div>
 </div>
 <div class="paragraph">
-<p>This renders as:</p>
+<p>This example renders as follows in HTML:</p>
 </div>
 <div class="exampleblock">
 <div class="content">
@@ -4386,7 +4448,7 @@ <h4 id="user-replaced-values-xml"><a class="anchor" href="#user-replaced-values-
 </div>
 </div>
 <div class="paragraph">
-<p>This renders as:</p>
+<p>This example renders as follows in HTML:</p>
 </div>
 <div class="exampleblock">
 <div class="content">
@@ -4407,7 +4469,7 @@ <h4 id="user-replaced-values-xml"><a class="anchor" href="#user-replaced-values-
 </div>
 </div>
 <div class="paragraph">
-<p>This renders as:</p>
+<p>This example renders as follows in HTML:</p>
 </div>
 <div class="exampleblock">
 <div class="content">
@@ -21514,7 +21576,7 @@ <h5 id="bit-64-x86"><a class="anchor" href="#bit-64-x86"></a><a class="link" hre
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-02 16:08:00 UTC
+Last updated 2024-02-20 17:38:09 UTC
 </div>
 </div>
 <!-- Nav bar -->