2019-11-11 13:41:34 -08:00
|
|
|
Style Guide
|
|
|
|
|
===========
|
|
|
|
|
|
2019-12-21 13:44:03 -08:00
|
|
|
- Program names use the same capitalization you use in the main menu.
|
2019-11-11 16:02:14 -08:00
|
|
|
|
|
|
|
|
- Use code directives for input into the command line.
|
2019-11-11 23:33:23 -08:00
|
|
|
|
2020-05-27 16:47:31 -07:00
|
|
|
- Use :guilabel:`Button` for buttons and checkboxes.
|
2019-11-12 11:10:10 -08:00
|
|
|
|
|
|
|
|
- Use :kbd:`Shortcut` for keyboard shortcuts and buttons you press.
|
2019-11-12 11:12:32 -08:00
|
|
|
|
2020-05-26 21:44:29 -07:00
|
|
|
- Use :menuselection:`Item --> Subitem` for things in menus and context menus.
|
|
|
|
|
|
2019-12-21 13:44:03 -08:00
|
|
|
- Use the - for bullet pointed lists usually at the beginning of lists of features.
|
2019-12-21 13:51:02 -08:00
|
|
|
|
2020-05-26 19:14:46 -07:00
|
|
|
- Use oxford commas for easier adding or removing features.
|
2019-12-23 23:08:18 -08:00
|
|
|
|
2021-06-21 12:05:12 -07:00
|
|
|
- Use .. Warning:: if doing something wrong can cause data loss or machine not to boot.
|
|
|
|
|
|
2020-05-26 20:34:21 -07:00
|
|
|
- Order sections Summary --> Usage --> Screenshot (if one or two) --> Version --> How To Launch --> Customizing (If necessary)
|
2019-12-21 13:51:02 -08:00
|
|
|
|
|
|
|
|
Sections
|
|
|
|
|
--------
|
|
|
|
|
|
2020-05-26 21:39:11 -07:00
|
|
|
- Start each program or section being underlines with =
|
|
|
|
|
|
2019-12-29 21:17:05 -08:00
|
|
|
- Have - put under them for a section about a program.
|
2019-12-22 11:59:09 -08:00
|
|
|
|
|
|
|
|
- Keep screenshots near the text that describes them
|
