Skip to content

Commit 3074e54

Browse files
sbmetzbergerhoffer
andauthored
Update user-replaced value guidance for output (#310)
* Update user-replaced value guidance for output * Update supplementary_style_guide/style_guidelines/formatting.adoc Co-authored-by: Andrea Hoffer <[email protected]> * Updated ambiguity about sample value formatting * Removed command lines from code blocks * Matched format of output example to format of code block example --------- Co-authored-by: Andrea Hoffer <[email protected]>
1 parent 08738e4 commit 3074e54

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

supplementary_style_guide/style_guidelines/formatting.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ Ensure that user-replaced values have the following characteristics:
123123
* Lowercase, unless the rest of the related text is uppercase or another capitalization scheme
124124
* Italicized
125125
* If the user-replaced value is referencing a value in code or in a command that is normally monospace, also use monospace for the user-replaced value
126+
* If you want to use a user-replaced value in example output, format the replaceable value with italics and in angle brackets. Alternatively, if you choose to use an example value instead, do not italicize the example value and do not place it in angle brackets.
126127

127128
.Example AsciiDoc: User-replaced value in a paragraph
128129

@@ -154,6 +155,28 @@ $ oc describe node __<node_name>__
154155
----
155156
====
156157

158+
.Example AsciiDoc: User-replaced value in an output example
159+
160+
[subs="+quotes"]
161+
----
162+
connection.id: __<profile_name>__
163+
connection.uuid: b6cdfa1c-e4ad-46e5-af8b-a75f06b79f76
164+
connection.type: 802-3-ethernet
165+
connection.interface-name: enp7s0
166+
----
167+
168+
This renders as:
169+
170+
====
171+
[subs="+quotes"]
172+
----
173+
connection.id: __<profile_name>__
174+
connection.uuid: b6cdfa1c-e4ad-46e5-af8b-a75f06b79f76
175+
connection.type: 802-3-ethernet
176+
connection.interface-name: enp7s0
177+
----
178+
====
179+
157180
[[user-replaced-values-xml]]
158181
== User-replaced values for XML
159182

0 commit comments

Comments
 (0)