mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-10-04 16:08:27 +00:00
Merge pull request #92 from ECouzens/collab-guide-update
copy edit and language update
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user