Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
tails
tails
Commits
0fe4de1a
Commit
0fe4de1a
authored
Feb 02, 2019
by
sajolida
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add anchors for all entires
parent
4239ae99
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
38 additions
and
2 deletions
+38
-2
wiki/src/contribute/how/documentation/style_guide.mdwn
wiki/src/contribute/how/documentation/style_guide.mdwn
+38
-2
No files found.
wiki/src/contribute/how/documentation/style_guide.mdwn
View file @
0fe4de1a
[[!meta title="Documentation style guide"]]
<a id="administration-password"></a>
- **administration password** vs **root password**
Use *administration password*. Avoid *root password* even though many
...
...
@@ -14,6 +16,8 @@
- Start Tails and [[set up an administration
password|doc/first_steps/startup_options/administration_password]].
<a id="anchors"></a>
- **anchors** (HTML anchors)
Use HTML anchors to provide shortcuts when pointing people to sections
...
...
@@ -28,6 +32,8 @@
- Use hyphens instead of underscores to separate words.
<a id="boot"></a>
- **boot** vs **start**
- Use *start* and *restart* as much as possible to refer to starting a
...
...
@@ -53,6 +59,8 @@
[[using the <span class="application">Boot Loader
Menu</span>|doc/first_steps/startup_options#boot_loader_menu]].
<a id="bulleted-lists"></a>
- **bulleted lists**
Refer to this article from NN/g on [presenting bulleted
...
...
@@ -66,6 +74,8 @@
in a separate PO string in PO files by the PO plugin when building
the website.
<a id="debian-versions"></a>
- **Debian and Ubuntu versions**
Refer to Debian and Ubuntu versions primarily by their numbers, and additionally
...
...
@@ -77,6 +87,8 @@
- *Tails Installer* is available on Ubuntu 15.10 (Wily Werewolf) or later.
<a id="earlier"></a>
- **earlier** and **later**
Use to refer to versions of software.
...
...
@@ -89,6 +101,8 @@
- If you are running macOS 10.10 (Yosemite) or earlier
<a id="future-tense"></a>
- **future tense**
Whenever possible, use present, not future, tense. Don't switch
...
...
@@ -99,7 +113,7 @@ Present tense is easier to read than past or future tense. Simple verbs
are easier to read and understand than complex verbs, such as verbs in
the progressive or perfect tense.
<a id="digit
_
grouping"></a>
<a id="digit
-
grouping"></a>
- **digit grouping**
...
...
@@ -113,7 +127,7 @@ the progressive or perfect tense.
See [[!wikipedia Decimal_separator#Digit_grouping]] and [[!wikipedia
ISO_31-0#Numbers]].
<a id="gnome
_
application"></a>
<a id="gnome
-
application"></a>
- **GNOME applications: <i>Files</i>, <i>Disks</i>, etc.**
...
...
@@ -151,11 +165,15 @@ the progressive or perfect tense.
- Install <span class="application">GNOME Disks</span> in Debian.
<a id="graphics-card"></a>
- **graphics card**
And not *graphics adapters*, *graphics*, *graphical hardware*, or
*video card*.
<a id="media"></a>
- **media** and **installation media**
Use only in rare occasions where it is especially relevant to mention
...
...
@@ -174,12 +192,16 @@ the progressive or perfect tense.
designed to be a live system running from a removable media: USB
stick or DVD.
<a id="network-interface"></a>
- **network interface**, **Wi-Fi interface**
And not *card*, *device*, or *adapter*.
Still, **USB Wi-Fi adapters** are USB dongles that provide a Wi-Fi interface.
<a id="persistence-feature"></a>
- **persistence feature**
To refer to the features available in the configuration of the
...
...
@@ -194,6 +216,8 @@ the progressive or perfect tense.
The word *persistence* can be omitted if it is redundant from the context
(for example on [[doc/first_steps/persistence/configure]]).
<a id="procedures"></a>
- **procedures** (a series of steps)
- Keep the number of steps low within a procedure (for example, below
...
...
@@ -218,17 +242,23 @@ the progressive or perfect tense.
1. Click on the <span class="guilabel">PPAs</span> button and then choose to <span class="button">Add a new PPA…</span>.
</pre>
<a id="secure-boot"></a>
- **Secure Boot**
Capitalize as a brand or feature. Writing *secure boot* would make it
sound more like a magic security feature (which it is not).
<a id="serial-comma"></a>
- **serial comma**
Place a [[!wikipedia serial comma]] immediately before the
coordinating conjunction (usually *and* or *or*) in a series of three
or more terms.
<a id="startup-options"></a>
- **startup options**
To refer to the kernel command line options that can be specified from
...
...
@@ -239,10 +269,14 @@ the progressive or perfect tense.
- Adding `radeon.dpm=0` to the [[startup
options|/doc/first_steps/startup_options#boot_menu]].
<a id="tails-greeter"></a>
- **<span class="application">Tails Greeter</span>**
Without an article. Not *the Greeter*. Note the formatting as an application.
<a id="update"></a>
- **update** vs **upgrade**
- Use **upgrade** to refer to the replacement of a previous version of
...
...
@@ -264,6 +298,8 @@ the progressive or perfect tense.
- The packages from your list of additional software will be updated
automatically when you connect to the Internet.
<a id="vulnerability"></a>
- **vulnerability** or **security vulnerability**
And not *hole* or *issue*.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment