From 24ab40b3b462766cc61bada110e66fec66b5207d Mon Sep 17 00:00:00 2001 From: Ecouzens Date: Tue, 27 Feb 2018 09:35:26 -0800 Subject: [PATCH] copy edit and language update Signed-off-by: Ecouzens --- .../reference/collaboration/documentation/images.rst | 4 ++-- .../reference/collaboration/documentation/language.rst | 9 +++++---- .../reference/collaboration/documentation/simple.rst | 6 +++--- .../reference/collaboration/documentation/tables.rst | 10 +++++----- 4 files changed, 15 insertions(+), 14 deletions(-) diff --git a/source/clear-linux/reference/collaboration/documentation/images.rst b/source/clear-linux/reference/collaboration/documentation/images.rst index ee46e817..6ce6ad66 100644 --- a/source/clear-linux/reference/collaboration/documentation/images.rst +++ b/source/clear-linux/reference/collaboration/documentation/images.rst @@ -45,8 +45,8 @@ Follow these guidelines when creating graphics for the |CLOSIA|: * Use only approved image formats. Use either PNG or JPEG bitmap files for screenshots and SVG files for vector graphics. If a figure is not a - photograph or screenshot, please provide figure as a vector graphic to - ensure it can be changed later on. + photograph or screenshot, use the vector graphic file format to ensure + the figure can be changed later. Examples diff --git a/source/clear-linux/reference/collaboration/documentation/language.rst b/source/clear-linux/reference/collaboration/documentation/language.rst index f086ce07..1d7d0303 100644 --- a/source/clear-linux/reference/collaboration/documentation/language.rst +++ b/source/clear-linux/reference/collaboration/documentation/language.rst @@ -3,10 +3,11 @@ Language reference guide ######################## -This section provides you with the accepted use of the English language. It -includes information about words use, punctuation, and grammar. This guide -does not replace a professional writer's review but is intended to help -collaborators submit consistent contributions. +This section describes acceptable usage of the English language in the +|CLOSIA| documentation. It includes information about words use, +punctuation, and grammar. This guide does not replace a professional +writer's review but is intended to help collaborators submit consistent +contributions. To make translations easier and to make the content accessible to non-native speakers, |CLOSIA| uses Simple English. However, we have not implemented any diff --git a/source/clear-linux/reference/collaboration/documentation/simple.rst b/source/clear-linux/reference/collaboration/documentation/simple.rst index 7815e6b1..a67a7e19 100644 --- a/source/clear-linux/reference/collaboration/documentation/simple.rst +++ b/source/clear-linux/reference/collaboration/documentation/simple.rst @@ -13,8 +13,8 @@ makes translation easier, and improves comprehension for people whose first language is not English. |CLOSIA| does not use controlled language, which restricts the writer's -vocabulary to a list of approved words. Some preferences are evidently in -place. +vocabulary to a list of approved words. However, we do strongly recommend +using the language principles described below. Short sentences and paragraphs ****************************** @@ -26,7 +26,7 @@ principle of one main idea in a sentence, plus one additional point if needed. Similarly, restrict your paragraph length to about six sentences. -Remember the basic structure of a paragraph: Introduction, body and +Remember the basic structure of a paragraph: Introduction, body, and conclusion. Both the introduction and the conclusion should be one sentence long. The body of a paragraph should never exceed four sentences. Here less is more. diff --git a/source/clear-linux/reference/collaboration/documentation/tables.rst b/source/clear-linux/reference/collaboration/documentation/tables.rst index fe82c527..3ad59298 100644 --- a/source/clear-linux/reference/collaboration/documentation/tables.rst +++ b/source/clear-linux/reference/collaboration/documentation/tables.rst @@ -17,8 +17,8 @@ Follow these general guidelines: * Indent the contents correctly. This allows the content to be read even if it is not rendered. -* Only create a table if the body of the table is larger than 6, that means - at least 2x3 or 3x2. +* Only create a table if the body of the table contains six or more cells, +which is a minimum table size of at least 2x3 or 3x2. ReST supports several types of tables. |CL| uses grid and :abbr:`CSV-tables (Comma Separated Values tables)`. Grid tables are only @@ -71,9 +71,9 @@ support several layout options. For example: crunchy, now would it?" "Gannet Ripple", 1.99, "On a stick!" -CSV-tables can have a title, the header row is optional and separate from the -rest of the table, each column's width is customizable among others. See the -Sphinx `CSV-tables documentation`_ to learn all the possible options +Some of the options available with CSV-tables are table titles, an optional +header row separate from the rest of the table, and customizable column width. +See the Sphinx `CSV-tables documentation`_ to learn all the possible options available. This template can help you create CSV-tables: