From b2f84b186b85a40e9372c251ca394daa156044e8 Mon Sep 17 00:00:00 2001 From: daobrien Date: Thu, 29 Jul 2021 13:17:38 +1000 Subject: [PATCH 1/2] Addressing #257 --- en-US/Design.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index a8e10e5..02c02a4 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -369,8 +369,8 @@ $ vi myFile.txt # cd /var/lib/katello # myCommand --option funky --color=true - --config_file=<replaceable>/home/user/config.conf</replaceable> - --output_file=<replaceable>/home/user/output.txt</replaceable> + --config_file=/home/user/config.conf + --output_file=/home/user/output.txt @@ -379,12 +379,12 @@ $ vi myFile.txt
Referring to Replaceable Paths - To refer to a path that users need to replace with something that is specific to their system, use <replaceable> tags, the correct syntax for the system and object in question, and an indicative name. + To refer to a path that users need to replace with something that is specific to their system, use the appropriate markup for your content, the correct syntax for the system and object in question, and an indicative name. Use a leading slash if the absolute path is required. Referring to Replaceable Paths on Linux Systems - "Mount the ISO file in <filename><replaceable>/path/to/iso/file</replaceable></filename>." + "Mount the ISO file in /path/to/iso/file." @@ -393,7 +393,7 @@ $ vi myFile.txt Referring to Replaceable Paths on Microsoft Windows Systems - "Mount the ISO file in <filename><replaceable>C:\path\to\iso\file</replaceable></filename>." + "Mount the ISO file in C:\path\to\iso\file." @@ -401,10 +401,10 @@ $ vi myFile.txt For example: - A PATH variable for Bash might appear as <replaceable>/usr/bin:/usr/local/bin</replaceable>. + A PATH variable for Bash might appear as /usr/bin:/usr/local/bin. - A package path in Lua might appear as <replaceable>local.share.lua</replaceable>. + A package path in Lua might appear as local.share.lua.
From c888939aae72b6676278b947d5297ffc472ce44b Mon Sep 17 00:00:00 2001 From: daobrien Date: Thu, 29 Jul 2021 13:17:38 +1000 Subject: [PATCH 2/2] Closes #257 --- en-US/Design.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index a8e10e5..02c02a4 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -369,8 +369,8 @@ $ vi myFile.txt # cd /var/lib/katello # myCommand --option funky --color=true - --config_file=<replaceable>/home/user/config.conf</replaceable> - --output_file=<replaceable>/home/user/output.txt</replaceable> + --config_file=/home/user/config.conf + --output_file=/home/user/output.txt @@ -379,12 +379,12 @@ $ vi myFile.txt
Referring to Replaceable Paths - To refer to a path that users need to replace with something that is specific to their system, use <replaceable> tags, the correct syntax for the system and object in question, and an indicative name. + To refer to a path that users need to replace with something that is specific to their system, use the appropriate markup for your content, the correct syntax for the system and object in question, and an indicative name. Use a leading slash if the absolute path is required. Referring to Replaceable Paths on Linux Systems - "Mount the ISO file in <filename><replaceable>/path/to/iso/file</replaceable></filename>." + "Mount the ISO file in /path/to/iso/file." @@ -393,7 +393,7 @@ $ vi myFile.txt Referring to Replaceable Paths on Microsoft Windows Systems - "Mount the ISO file in <filename><replaceable>C:\path\to\iso\file</replaceable></filename>." + "Mount the ISO file in C:\path\to\iso\file." @@ -401,10 +401,10 @@ $ vi myFile.txt For example: - A PATH variable for Bash might appear as <replaceable>/usr/bin:/usr/local/bin</replaceable>. + A PATH variable for Bash might appear as /usr/bin:/usr/local/bin. - A package path in Lua might appear as <replaceable>local.share.lua</replaceable>. + A package path in Lua might appear as local.share.lua.