Commit 44ed3255 authored by sajolida's avatar sajolida
Browse files

Remove unnecessary levels of list

parent ba41ddf7
......@@ -7,14 +7,14 @@
Use *administration password*. Avoid *root password* even though many
Linux users would use it.
- *For example:*
*For example:*
- [[Set up an administration password
|doc/first_steps/welcome_screen/administration_password]] when
you start Tails.
- [[Set up an administration password
|doc/first_steps/welcome_screen/administration_password]] when
you start Tails.
- Start Tails and [[set up an administration
password|doc/first_steps/welcome_screen/administration_password]].
- Start Tails and [[set up an administration
password|doc/first_steps/welcome_screen/administration_password]].
<a id="anchors"></a>
......@@ -23,50 +23,52 @@
Use HTML anchors to provide shortcuts when pointing people to sections
inside a page.
- *For example*:
Keep them as short as possible as they appear in the URL.
- `<a id="2014">` in `doc/about/finances` to be able to point to
`https://tails.boum.org/finances#2014`.
Use hyphens instead of underscores to separate words.
- Keep them as short as possible as they appear in the URL.
*For example*:
- Use hyphens instead of underscores to separate words.
- `<a id="2014">` in `doc/about/finances` to be able to point to
`https://tails.boum.org/finances#2014`.
<a id="boot"></a>
- **boot** vs **start**
- Use *start* and *restart* as much as possible to refer to starting a
computer on Tails; *boot* is almost always unecessary jargon.
Use *start* and *restart* as much as possible to refer to starting a
computer on Tails; *boot* is almost always unecessary jargon.
- You might use *boot* when the word is displayed to the user by the
computer or when writing for a technical audience, like in our
design documentation.
You might use *boot* when the word is displayed to the user by the
computer or when writing for a technical audience, like in our
design documentation.
- Use *Boot Loader* when referring to either *GRUB* or *SYSLINUX*.
Use *boot* when referring to *boot options*, which are only
documented for workarounds or a technical audience.
- *For example:*
*For example*:
- The Boot Loader is the first screen that appears when starting Tails.
- When starting Tails, add the <span class="command">toram</span>
boot option. See our instructions on [[adding a boot option using
the Boot Loader|doc/advanced_topics/boot_options]].
- Use *Boot Menu* and *Boot Menu key* when referring to the BIOS
screen that allows choosing from which device to start from.
- To make the display work properly, [[add the following boot option using the
Boot Loader|doc/advanced_topics/boot_options]] when starting Tails:
[[!img install/inc/screenshots/bios_boot_menu.png link="no" alt=""]]
nouveau.noaccel=1
- Use *boot* when referring to *boot options*, which are only
documented for workarounds or a technical audience.
- **Boot Menu** and **Boot Loader**
- *For example*:
Use *Boot Loader* when referring to either *GRUB* or *SYSLINUX*.
*For example:*
- When starting Tails, add the <span class="command">toram</span>
boot option. See our instructions on [[adding a boot option using
the Boot Loader|doc/advanced_topics/boot_options]].
- The Boot Loader is the first screen that appears when starting Tails.
- To make the display work properly, [[add the following boot option using the
Boot Loader|doc/advanced_topics/boot_options]] when starting Tails:
Use *Boot Menu* and *Boot Menu key* when referring to the BIOS
screen that allows choosing from which device to start from.
nouveau.noaccel=1
[[!img install/inc/screenshots/bios_boot_menu.png link="no" alt=""]]
<a id="bulleted-lists"></a>
......@@ -90,11 +92,11 @@
Refer to Debian and Ubuntu versions primarily by their numbers, and additionally
by their codenames.
- *For example*:
*For example*:
- Tails 3.0 is based on Debian 9 (Stretch)
- Tails 3.0 is based on Debian 9 (Stretch)
- *Tails Installer* is available on Ubuntu 15.10 (Wily Werewolf) or later.
- *Tails Installer* is available on Ubuntu 15.10 (Wily Werewolf) or later.
<a id="earlier"></a>
......@@ -106,21 +108,21 @@
Don't use "regular expressions" like *Tails 2.1.&#42;*.
- *For example:*
*For example:*
- If you are running macOS 10.10 (Yosemite) or earlier
- 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
unnecessarily from present to future tense when present tense is
sufficient to express a sequence of steps or events.
Whenever possible, use present, not future, tense. Don't switch
unnecessarily from present to future tense when present tense is
sufficient to express a sequence of steps or events.
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.
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>
......@@ -129,9 +131,9 @@ the progressive or perfect tense.
Use a non-breaking thin space (HTML entity: `&#8239;`) or a space to separate
groups of three digits.
- *For example*:
*For example*:
- $50&#8239;000
- $50&#8239;000
See [[!wikipedia Decimal_separator#Digit_grouping]] and [[!wikipedia
ISO_31-0#Numbers]].
......@@ -148,31 +150,31 @@ the progressive or perfect tense.
Make sure to clarify that you are referring to an application (and
not, for example, a set of files or disks):
- *For example*:
*For example*:
- In the title of sections
- In the title of sections
- When first referring to the application in a section
- When first referring to the application in a section
- *Use*:
*Use*:
- The <span class="application">Files</span> browser
- The <span class="application">Files</span> browser
- The <span class="application">Disks</span> utility
- The <span class="application">Disks</span> utility
Otherwise, use the short name of the application as it appears in the menus when giving
instructions to be executed inside Tails.
- *For example*:
*For example*:
- Open */live/persistence/TailsData_unlocked/dotfiles* in *Files*.
- Open */live/persistence/TailsData_unlocked/dotfiles* in *Files*.
Prepend "*GNOME*" when giving instructions to be executed outside of
Tails.
- *For example*:
*For example*:
- Install <span class="application">GNOME Disks</span> in Debian.
- Install <span class="application">GNOME Disks</span> in Debian.
<a id="graphics-card"></a>
......@@ -198,14 +200,14 @@ the progressive or perfect tense.
text easy to read for the majority of people using USB sticks than to
be exhaustive and always mention DVDs, implicitly or explicitly.
- *For example*:
*For example*:
- Tails runs on a USB stick that you can plug in and use on almost
any computer.
- Tails runs on a USB stick that you can plug in and use on almost
any computer.
- It is not possible to install Tails on a hard disk. Tails is
designed to be a live system running from a removable media: USB
stick or DVD.
- It is not possible to install Tails on a hard disk. Tails is
designed to be a live system running from a removable media: USB
stick or DVD.
<a id="network-interface"></a>
......@@ -242,27 +244,27 @@ the progressive or perfect tense.
- **procedures** (a series of steps)
- Keep the number of steps low within a procedure (for example, below
10, ideally 7). For longer procedures, split them and give each
section a title.
Keep the number of steps low within a procedure (for example, below
10, ideally 7). For longer procedures, split them and give each
section a title.
- Add a blank line between each step.
Add a blank line between each step.
- Rely on the automatic numbered of Markdown and number all the steps
with `1.`
Rely on the automatic numbered of Markdown and number all the steps
with `1.`
See also the *Microsoft Manual of Style: Procedures and technical
content*.
- *For example*:
*For example*:
<pre>
1. Make sure that you are connected to the Internet.
<pre>
1. Make sure that you are connected to the Internet.
1. Start <span class="application">Software Sources</span>.
1. Start <span class="application">Software Sources</span>.
1. Click on the <span class="guilabel">PPAs</span> button and then choose to <span class="button">Add a new PPA&hellip;</span>.
</pre>
1. Click on the <span class="guilabel">PPAs</span> button and then choose to <span class="button">Add a new PPA&hellip;</span>.
</pre>
<a id="right-click"></a>
......@@ -274,10 +276,10 @@ the progressive or perfect tense.
Always clarify how to do right-click on Mac:
- *For example:*
*For example:*
- Right-click (on Mac, click with two fingers) on the file and
choose <span class="guimenuitem">Share via OnionShare</span>.
- Right-click (on Mac, click with two fingers) on the file and
choose <span class="guimenuitem">Share via OnionShare</span>.
<a id="secure-boot"></a>
......@@ -304,24 +306,24 @@ the progressive or perfect tense.
- **update** vs **upgrade**
- Use **upgrade** to refer to the replacement of a previous version of
Tails by another.
Use **upgrade** to refer to the replacement of a previous version of
Tails by another.
- *For example:*
*For example:*
- If you know someone you trust who already did the upgrade, you can
upgrade your Tails by cloning from their Tails.</p>
- If you know someone you trust who already did the upgrade, you can
upgrade your Tails by cloning from their Tails.</p>
- You might use **update** to refer to other operations that update
some data or software outside of Tails releases.
You might use **update** to refer to other operations that update
some data or software outside of Tails releases.
- *For example:*
*For example:*
- Make sure to update your *dotfiles* each time you use the **init**
command of *keyringer*.
- Make sure to update your *dotfiles* each time you use the **init**
command of *keyringer*.
- The packages from your list of additional software will be updated
automatically when you connect to the Internet.
- The packages from your list of additional software will be updated
automatically when you connect to the Internet.
<a id="vulnerability"></a>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment