style_guide.mdwn 2.19 KB
Newer Older
1 2
[[!meta title="Documentation style guide"]]

sajolida's avatar
sajolida committed
3
- **bulleted lists**
4 5 6 7

  Refer to this article from NN/g on [presenting bulleted
  lists](https://www.nngroup.com/articles/presenting-bulleted-lists/).

cbrownstein's avatar
cbrownstein committed
8
- **Debian and Ubuntu versions**
sajolida's avatar
sajolida committed
9

cbrownstein's avatar
cbrownstein committed
10 11
  Refer to Debian and Ubuntu versions primarily by their numbers, and additionally
  by their codenames.
sajolida's avatar
sajolida committed
12

sajolida's avatar
sajolida committed
13 14 15
  * *For example*:
    - Tails 3.0 is based on Debian 9 (Stretch)
    - *Tails Installer* is available on Ubuntu 15.10 (Wily Werewolf) or later.
16 17 18 19 20 21 22 23 24 25 26

- **digit grouping**

  Use a thin space (HTML entity: ` `) or a space to separate
  groups of three digits.

  * *For example*:
    - $50 000

  See [[!wikipedia Decimal_separator#Digit_grouping]] and [[!wikipedia
  ISO_31-0#Numbers]].
27

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
- **<i>Files</i>**, **<i>Disks</i>**, etc.

  To refer to GNOME applications:

  - Use their short name as it appears in the menus when giving
    instructions to be executed inside Tails.

    *For example*:
    - Open */live/persistence/TailsData_unlocked/dotfiles* in *Files*.

  - Prepend "*GNOME*" when giving instructions to be executed outside of
    Tails.

    *For example*:
    - Install GNOME Disks in Debian.
43

sajolida's avatar
sajolida committed
44 45
- **graphics card**

46 47
  And not *graphics adapters*, *graphics*, *graphical hardware*, or
  *video card*.
sajolida's avatar
sajolida committed
48

sajolida's avatar
sajolida committed
49 50 51 52 53 54
- **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.

55 56 57
- **persistence feature**

  To refer to the features available in the configuration of the
58
  *persistent storage*.
59

60 61
  - *For example*: when the [[<span class="guilabel">Additional
    Software</span> persistence feature|doc/first_steps/persistence/configure#additional_software]] is activated.
62 63 64 65

  The word *persistence* can be omitted if it is redundant from the context
  (for example on [[doc/first_steps/persistence/configure]]).

sajolida's avatar
sajolida committed
66 67 68 69 70 71 72
- **startup options**

  To refer to the kernel command line options that can be specified from
  the *Boot Loader Menu*.

  * *For example:* Adding `radeon.dpm=0` to the [[startup
    options|/doc/first_steps/startup_options#boot_menu]].
73

sajolida's avatar
sajolida committed
74
- **<span class="application">Tails Greeter</span>**
75

sajolida's avatar
sajolida committed
76
  Without an article. Not *the Greeter*. Note the formatting as an application.