You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
manual/StyleGuide.rst

30 lines
906 B

5 years ago
Style Guide
===========
- Program names use the same capitalization you use in the main menu.
- Use code directives for input into the command line.
4 years ago
- Use :guilabel:`Button` for buttons and checkboxes.
- Use :kbd:`Shortcut` for keyboard shortcuts and buttons you press.
- Use :menuselection:`Item --> Subitem` for things in menus and context menus.
- Use the - for bullet pointed lists usually at the beginning of lists of features.
- Use oxford commas for easier adding or removing features.
- Use .. Warning:: if doing something wrong can cause data loss or machine not to boot.
- Order sections Summary --> Usage --> Screenshot (if one or two) --> Version --> How To Launch --> Customizing (If necessary)
Sections
--------
- Start each program or section being underlines with =
- Have - put under them for a section about a program.
5 years ago
- Keep screenshots near the text that describes them