diff options
author | Danilo G. Baio <dbaio@FreeBSD.org> | 2023-05-21 17:51:54 +0000 |
---|---|---|
committer | Danilo G. Baio <dbaio@FreeBSD.org> | 2023-05-21 17:51:54 +0000 |
commit | 226b58b79dbc99f588ae5240aabe06e6ac6a1dea (patch) | |
tree | e8cf7a6cbbfb6abee5ea6c3c2d80b4883a3fb45c /documentation/content/en/books/fdp-primer | |
parent | f7e514ee7f5b6ccaefb3ff14bca73d3ba7d98a33 (diff) | |
download | doc-226b58b79dbc99f588ae5240aabe06e6ac6a1dea.tar.gz doc-226b58b79dbc99f588ae5240aabe06e6ac6a1dea.zip |
doc: Update source files (en .po), for translations
Diffstat (limited to 'documentation/content/en/books/fdp-primer')
-rw-r--r-- | documentation/content/en/books/fdp-primer/working-copy/_index.po | 5 | ||||
-rw-r--r-- | documentation/content/en/books/fdp-primer/writing-style/_index.po | 396 |
2 files changed, 214 insertions, 187 deletions
diff --git a/documentation/content/en/books/fdp-primer/working-copy/_index.po b/documentation/content/en/books/fdp-primer/working-copy/_index.po index df8858d4be..2cbe791b89 100644 --- a/documentation/content/en/books/fdp-primer/working-copy/_index.po +++ b/documentation/content/en/books/fdp-primer/working-copy/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2022-02-01 09:20-0300\n" +"POT-Creation-Date: 2023-05-21 14:43-0300\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -55,7 +55,8 @@ msgstr "" #: documentation/content/en/books/fdp-primer/working-copy/_index.adoc:58 msgid "" "link:https://git-scm.com/[Git] is used to manage the FreeBSD documentation " -"files. It is obtained by installing the Git package:" +"files. It is obtained by installing the package:devel/git[] package, which " +"also has a lighter flavor called git-lite:" msgstr "" #. type: delimited block . 4 diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.po b/documentation/content/en/books/fdp-primer/writing-style/_index.po index f5e9fecb74..1e212933fe 100644 --- a/documentation/content/en/books/fdp-primer/writing-style/_index.po +++ b/documentation/content/en/books/fdp-primer/writing-style/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2023-04-20 20:56-0300\n" +"POT-Creation-Date: 2023-05-21 14:43-0300\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -41,22 +41,22 @@ msgid "Tips" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:56 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:57 msgid "" "Technical documentation can be improved by consistent use of several " "principles. Most of these can be classified into three goals: _be clear_, " -"_be complete_, and _be concise_. These goals can conflict with each other. " +"_be complete_, and _be concise_. These goals can conflict with each other. " "Good writing consists of a balance between them." msgstr "" #. type: Title === -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:58 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:59 #, no-wrap msgid "Be Clear" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:63 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:64 msgid "" "Clarity is extremely important. The reader may be a novice, or reading the " "document in a second language. Strive for simple, uncomplicated text that " @@ -64,7 +64,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:67 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:68 msgid "" "Avoid flowery or embellished speech, jokes, or colloquial expressions. " "Write as simply and clearly as possible. Simple text is easier to " @@ -72,7 +72,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:72 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:73 msgid "" "Keep explanations as short, simple, and clear as possible. Avoid empty " "phrases like \"in order to\", which usually just means \"to\". Avoid " @@ -82,7 +82,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:76 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:77 msgid "" "Write in a formal style. Avoid addressing the reader as \"you\". For " "example, say \"copy the file to [.filename]#/tmp#\" rather than \"you can " @@ -137,7 +137,7 @@ msgid "Be Concise" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:107 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:104 msgid "" "While features should be documented completely, sometimes there is so much " "information that the reader cannot easily find the specific detail needed. " @@ -148,26 +148,26 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:109 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:106 #, no-wrap msgid "Guidelines" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:113 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:109 msgid "" "To promote consistency between the myriad authors of the FreeBSD " "documentation, some guidelines have been drawn up for authors to follow." msgstr "" #. type: Labeled list -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:114 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:110 #, no-wrap msgid "Use American English Spelling" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:118 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:114 msgid "" "There are several variants of English, with different spellings for the same " "word. Where spellings differ, use the American English variant. \"color\", " @@ -175,42 +175,42 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:124 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:119 msgid "" "The use of British English may be accepted in the case of a contributed " "article, however the spelling must be consistent within the whole document. " -"The other documents such as books, web site, manual pages, etc. will have to " -"use American English." +"The other documents such as books, web site, manual pages, etc. must use " +"American English." msgstr "" #. type: Labeled list -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:126 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:121 #, no-wrap msgid "Do not use contractions" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:130 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:125 msgid "" "Do not use contractions. Always spell the phrase out in full. \"Don't use " "contractions\" is wrong." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:132 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:127 msgid "" "Avoiding contractions makes for a more formal tone, is more precise, and is " "slightly easier for translators." msgstr "" #. type: Labeled list -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:133 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:128 #, no-wrap msgid "Use the serial comma" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:136 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:131 msgid "" "In a list of items within a paragraph, separate each item from the others " "with a comma. Separate the last item from the others with a comma and the " @@ -218,120 +218,120 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:138 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:133 msgid "For example:" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:140 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:135 msgid "This is a list of one, two and three items." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:142 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:137 msgid "" "Is this a list of three items, \"one\", \"two\", and \"three\", or a list of " "two items, \"one\" and \"two and three\"?" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:144 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:139 msgid "It is better to be explicit and include a serial comma:" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:146 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:141 msgid "This is a list of one, two, and three items." msgstr "" #. type: Labeled list -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:146 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:141 #, no-wrap msgid "Avoid redundant phrases" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:149 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:144 msgid "" "Do not use redundant phrases. In particular, \"the command\", \"the file\", " "and \"man command\" are often redundant." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:151 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:146 msgid "For example, commands:" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:153 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:148 msgid "Wrong: Use the `git` command to update sources." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:155 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:150 msgid "Right: Use `git` to update sources." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:157 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:152 msgid "Filenames:" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:159 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:154 msgid "Wrong: ... in the filename [.filename]#/etc/rc.local#..." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:161 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:156 msgid "Right: ... in [.filename]#/etc/rc.local#..." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:163 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:158 msgid "" "Manual page references (the second example uses `citerefentry` with the man:" -"csh[1] entity):." +"csh[1] entity):" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:165 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:160 msgid "Wrong: See `man csh` for more information." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:167 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:162 msgid "Right: See man:csh[1]." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:169 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:164 msgid "" "For more information about writing style, see http://www.bartleby.com/141/" -"[Elements of Style], by William Strunk." +"[Elements of Style] by William Strunk." msgstr "" #. type: Title == -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:171 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:166 #, no-wrap msgid "Style Guide" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:174 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:169 msgid "" "To keep the source for the documentation consistent when many different " "people are editing it, please follow these style conventions." msgstr "" #. type: Title == -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:176 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:171 #, no-wrap msgid "One sentence per line" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:181 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:176 msgid "" "Use Semantic Line Breaks in the documentation, a technique called \"one " "sentence per line\". The idea of this technique is to help the users to " @@ -340,37 +340,37 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:183 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:178 msgid "This is an example which does not use \"one sentence per line\"." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:186 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:181 #, no-wrap msgid "All human beings are born free and equal in dignity and rights. They are endowed with reason and conscience and should act towards one another in a spirit of brotherhood.\n" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:189 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:184 msgid "And this is an example which uses the technique." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:193 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:188 #, no-wrap msgid "" "All human beings are born free and equal in dignity and rights.\n" "They are endowed with reason and conscience and should act towards one another in a spirit of brotherhood.\n" msgstr "" -#. type: Title === -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:196 +#. type: Title == +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:191 #, no-wrap msgid "Acronyms" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:201 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:196 msgid "" "Acronyms should be defined the first time they appear in a document, as in: " "\"Network Time Protocol (NTP)\". After the acronym has been defined, use " @@ -379,18 +379,18 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:203 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:198 msgid "All acronyms should be enclosed using the ` character." msgstr "" #. type: Title == -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:205 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:200 #, no-wrap msgid "Special Character List" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:209 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:204 msgid "" "This list of special characters shows the correct syntax and the output when " "used in FreeBSD documentation. If a character is not on this list, ask " @@ -398,432 +398,458 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:214 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:269 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:209 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:264 #, no-wrap msgid "Name" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:215 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:210 #, no-wrap msgid "Syntax" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:218 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:213 #, no-wrap msgid "Rendered" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:219 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:214 #, no-wrap msgid "Copyright" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:220 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:215 #, no-wrap msgid "+(C)+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:222 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:217 #, no-wrap msgid "(C)" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:223 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:218 #, no-wrap msgid "Registered" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:224 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:219 #, no-wrap msgid "+(R)+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:226 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:221 #, no-wrap msgid "(R)" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:227 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:222 #, no-wrap msgid "Trademark" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:228 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:223 #, no-wrap msgid "+(TM)+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:230 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:225 #, no-wrap msgid "(TM)" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:231 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:226 #, no-wrap msgid "Em dash" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:232 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:227 #, no-wrap msgid "+--+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:234 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:229 #, no-wrap msgid "--" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:235 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:230 #, no-wrap msgid "Ellipses" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:236 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:231 #, no-wrap msgid "+...+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:238 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:233 #, no-wrap msgid "..." msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:239 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:234 #, no-wrap msgid "Single right arrow" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:240 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:235 #, no-wrap msgid "+->+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:242 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:237 #, no-wrap msgid "->" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:243 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:238 #, no-wrap msgid "Double right arrow" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:244 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:239 #, no-wrap msgid "+=>+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:246 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:241 #, no-wrap msgid "=>" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:247 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:242 #, no-wrap msgid "Single left arrow" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:248 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:243 #, no-wrap msgid "+<-+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:250 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:245 #, no-wrap msgid "<-" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:251 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:246 #, no-wrap msgid "Double left arrow" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:252 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:247 #, no-wrap msgid "+<=+" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:254 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:249 #, no-wrap msgid "<=" msgstr "" #. type: Title == -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:257 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:252 #, no-wrap msgid "Linting with Vale" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:262 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:257 msgid "" "To maintain clarity and consistency across all documentation and website " "pages, link:https://vale.sh[Vale] styles have been introduced in the " "documentation tree. link:https://vale.sh[Vale] is a powerful linter for " -"writing customized rules and can be used in multiple scenarios. At this " -"moment link:https://vale.sh[Vale] can be used as a command line tool, for CI/" -"CD pipeline and integrated into editor of choice." +"writing customized rules and can be used in multiple scenarios. Currently " +"link:https://vale.sh[Vale] can be used as a command line tool, for CI/CD " +"pipelines, and integrated into an editor of choice." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:264 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:259 msgid "" -"The following table describes the current rule names and respective severity." +"The following table describes the current rule names and their respective " +"severity." msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:271 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:266 #, no-wrap msgid "Severity" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:272 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:267 #, no-wrap -msgid "BrandTerms" +msgid "FreeBSD.BrandTerms" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:274 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:295 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:269 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:287 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:293 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:296 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:299 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:302 #, no-wrap msgid "error" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:275 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:270 #, no-wrap -msgid "ConsciousLanguage" +msgid "FreeBSD.ConsciousLanguage" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:277 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:283 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:286 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:289 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:292 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:298 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:301 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:272 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:278 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:281 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:284 #, no-wrap msgid "warning" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:278 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:273 #, no-wrap -msgid "Contractions" +msgid "FreeBSD.Contractions" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:280 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:275 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:290 #, no-wrap -msgid "suggestions" +msgid "suggestion" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:281 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:276 #, no-wrap -msgid "EOLSpacing" +msgid "FreeBSD.EOLSpacing" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:284 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:279 #, no-wrap -msgid "Hang" +msgid "FreeBSD.Hang" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:287 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:282 #, no-wrap -msgid "Hyphens" +msgid "FreeBSD.Hyphens" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:290 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:285 #, no-wrap -msgid "Repetition" +msgid "FreeBSD.Spacing" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:293 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:288 #, no-wrap -msgid "Spacing" +msgid "FreeBSD.SuperfluousOptArgInLinks" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:296 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:291 #, no-wrap -msgid "Spelling" +msgid "Vale.Avoid" msgstr "" #. type: Table -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:299 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:294 +#, no-wrap +msgid "Vale.Repetition" +msgstr "" + +#. type: Table +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:297 #, no-wrap -msgid "Weasel" +msgid "Vale.Spelling" +msgstr "" + +#. type: Table +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:300 +#, no-wrap +msgid "Vale.Terms" msgstr "" #. type: Title === -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:304 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:305 #, no-wrap msgid "Current Vale Rules" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:309 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:311 msgid "" -"BrandTerms: Like The FreeBSD Project every major vendors and Companies have " -"specific rules on writing their Brand Name. according to the Copyright rules " -"of The FreeBSD Foundation *freebsd* should be written as *FreeBSD*. Similar " -"to that care should be taken to be respective to other's brand value and " -"write PostgreSQL, Node.js, Let's Encrypt etc. Missing brand names should be " -"added to the [.filename]#.vale/styles/FreeBSD/BrandTerms.yml# in the `doc` " -"repository." +"FreeBSD.BrandTerms: According to the copyright rules of The FreeBSD " +"Foundation, *freebsd* should be written as *FreeBSD*. Similarly, every " +"major vendor and company has specific rules on writing their brand names and " +"trademarks. Care should be taken to be respectful to the brand value of " +"others and to take time to write PostgreSQL, Node.js, Let's Encrypt etc. " +"Missing brand names should be added to the [.filename]#.vale/styles/FreeBSD/" +"BrandTerms.yml# in the `doc` repository." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:311 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:313 msgid "" -"Contractions: Contracted words should not be used. This rule avoids all " -"contractions and suggests full words." +"FreeBSD.ConsciousLanguage: This rule proposes use of conscious language so " +"that sensitive words pointing to the color, age, race, or sexual orientation " +"of people are avoided where possible." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:314 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:316 msgid "" -"Hang: `Hang` is often used to convey the meaning that the application has " -"stopped responding. This rule proposes better wording." +"FreeBSD.Contractions: Contracted words should not be used. This rule avoids " +"all contractions and suggests full words." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:317 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:318 msgid "" -"Repetition: Same words are often typed twice when leaving the keyboard and " -"rejoining the work again. This rule finds repeated words and warns the " -"users." +"FreeBSD.EOLSpacing: In most of the documents EOL spacing is present which is " +"not the desirable situation." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:321 msgid "" -"Weasel: This rule handles avoiding weasel words. The uses of weasel words " -"is controversial so at the moment the list of words are being evaluated and " -"the severity level is marked as warning on. In case a frequently used word " -"is marked as weasel word it should be removed from [.filename]#.vale/styles/" -"FreeBSD/Weasel.yml# in the `doc` repository." +"FreeBSD.Hang: `Hang` is often used to mean that the application has stopped " +"responding. This rule proposes better wording." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:323 msgid "" -"ConsciousLanguage: This rule proposes uses of conscious languages like " -"avoiding the words white/black/master/slave." +"FreeBSD.Hyphens: Often adverbs ending with 'ly' are added with a hyphen " +"which is wrong." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:325 msgid "" -"EOLSpacing: In most of the documents EOL spacing is present which is not the " -"desirable situation." +"FreeBSD.Spacing: Often double spaces are hard to catch with the naked eye " +"and this is addressed here." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:327 msgid "" -"Hyphens: Often adverbs ending with 'ly' are being added with a hyphen which " -"is wrong." +"FreeBSD.SuperfluousOptArgInLinks: Suggest to empty square brackets in `link:" +"` macros when the displayed text coincides with the URL." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:329 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:331 msgid "" -"Spacing: Often double spaces are hard to catch on plain eye which is " -"addressed here." +"Vale.Avoid: Enforces the *DO NOT USE* vocabulary terms for The FreeBSD " +"Project. If any word is found that should not be in the documentation, the " +"word should be added to [.filename]#.vale/styles/Vocab/Terms/reject.txt# in " +"the `doc` repository. The list is empty at the moment." msgstr "" #. type: Plain text #: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:334 msgid "" -"Spelling: At the moment there is a mix of en_US and en_UK spellings in the " -"documentation and website. A custom dictionary from link:https://wordlist." -"aspell.net[Aspell] has been added which uses strictly en_US and do not " -"accept the en_UK variant of any words. It has also an exception list to " -"ignore the FreeBSD specific terms. At the moment the list is a basic one " -"with minimal words just as a proof of concept but if any word is found to be " -"correct and not available in the dictionary the word should be added to the " -"[.filename]#.vale/styles/FreeBSD/spelling-exceptions.txt# in the `doc` " -"repository." +"Vale.Repetition: Same words are often typed twice when leaving the keyboard " +"and rejoining the work again. This rule finds repeated words and warns the " +"users." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:337 +msgid "" +"Vale.Spelling: At the moment there is a mix of en_US and en_GB spellings in " +"the documentation and website. Vale comes with an in built dictionary from " +"which uses strictly en_US and do not accept the en_GB variant of any words." +msgstr "" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:341 +msgid "" +"Vale.Terms: Enforces the *PREFERRED* vocabulary terms for The FreeBSD " +"Project. At the moment the list of terms is empty and the FreeBSD specific " +"terms will be added gradually. If any word is found to be correct and not " +"available in the dictionary the word should be added to the [.filename]#." +"vale/styles/Vocab/Terms/accept.txt# in the `doc` repository." msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:336 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:343 msgid "" "More rules will be introduced in the upcoming days when and where required." msgstr "" #. type: Title === -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:338 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:345 #, no-wrap msgid "Using Vale" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:342 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:349 msgid "" -"link:https://vale.sh[Vale] can be used from command line and from within " -"editor or IDE. package:textproc/vale[] can be installed as following:" +"link:https://vale.sh[Vale] can be used from the command line and from within " +"an editor or IDE. package:textproc/vale[] can be installed as following:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:346 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:353 #, no-wrap msgid "$ pkg install vale\n" msgstr "" #. type: Title ==== -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:349 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:356 #, no-wrap -msgid "Using Vale in command line" +msgid "Using Vale on the command line" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:352 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:359 msgid "" -"Considering the fact that `doc` repository was cloned into [.filename]#~/" -"doc# the following commands are required to run:" +"Assuming that the `doc` repository was cloned into [.filename]#~/doc# the " +"following commands are required to run:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:357 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:364 #, no-wrap msgid "" "% cd ~/doc\n" @@ -831,27 +857,27 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:363 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:370 msgid "" "link:https://vale.sh[Vale] is a CPU and memory intensive program due to the " "nature of the application and can take a while to show any output on the " -"screen. Better way to run the application is on specific folders or files " +"screen. A better way to run the application is on specific folders or files " "rather than the entire `doc` repository as that is already done in the CI " "pipeline." msgstr "" #. type: Title ==== -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:366 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:373 #, no-wrap msgid "Using Vale in editors" msgstr "" #. type: Plain text -#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:370 +#: documentation/content/en/books/fdp-primer/writing-style/_index.adoc:377 msgid "" "link:https://vale.sh[Vale] works with major mainstream editors like package:" "editors/vim[], package:editors/emacs[], package:editors/vscode[]. At the " -"moment the necessary configurations for package:editors/vim[] is described " -"in crossref:editor-config[editor-config-vim, Vim]. Necessary configurations " -"for package:editors/emacs[] is being worked on." +"moment the necessary configuration for package:editors/vim[] is described in " +"crossref:editor-config[editor-config-vim, Vim]. A configuration for package:" +"editors/emacs[] is being worked on." msgstr "" |