From 3d9f18cbc346ae3e6fa757bba78b47f2bef4d229 Mon Sep 17 00:00:00 2001 From: daobrien Date: Mon, 13 Feb 2023 15:16:49 +1000 Subject: [PATCH] Closes #365 Remove DocBook references. --- en-US/Design.xml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index 7bb1591..4648444 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -63,7 +63,7 @@ Gerunds should be avoided elsewhere. See . - + File Names, Commands, and Related Terms @@ -567,10 +567,13 @@ $ vi myFile.txt To describe how to view and edit files, such as configuration files, scripts, and so on, do not include editor names as part of the guidance, unless the topic is about a specific editor, or is otherwise necessary to achieve a wanted result. - For example, do not refer to cat or vi if you need to tell readers to "view the my-script file". If you need to tell readers to edit a file and add or remove content, write "Edit the my-script file and add the following content:" and then include the required content in a <screen> block. Use <code> tags to highlight the text to change. Include some surrounding text in the file for context. Do not use line numbers as a reference point because they can change. + For example, do not refer to cat or vi if you need to tell readers to "view the my-script file". + If you need to tell readers to edit a file and add or remove content, write "Edit the my-script file and add the following content:" and then include the required content in a code block and highlight the text to change. + Include some surrounding text in the file for context. + Do not use line numbers as a reference point because they can change. - If the file to edit is empty or does not exist, do not use <code> tags to highlight any content to add. + If the file to edit is empty or does not exist, do not highlight any content to add. You can also use here documents to describe how to create a file with required content. The syntax of here documents varies by system, shell, language, and so on. The following example creates the my-script file in the current directory, with the example content.