| | 1 | = Rules for working on the user guide = |
| | 2 | |
| | 3 | To achieve a consistent result, all authors have to respect a few rules. |
| | 4 | |
| | 5 | == Formatting == |
| | 6 | In general, it's a good idea to look into existing pages and maybe copy and paste sections whose formatting fits your purposes. |
| | 7 | There are a couple of CSS classes to get a consistent appearance: |
| | 8 | |
| | 9 | ||'''Code'''||'''Comment'''|| |
| | 10 | ||'''''Text boxes'''''|||| |
| | 11 | ||<div class="box-info"><div>||To make tips or infos more visible. Use sparingly. [http://www.haiku-os.org/docs/userguide/en/applications/drivesetup.html Example]|| |
| | 12 | ||<div class="box-stop"><div>||To point out some critical issue. [http://www.haiku-os.org/docs/userguide/en/applications/drivesetup.html Example]|| |
| | 13 | ||<div class="box-warning"><div>||To warn about serious consequences. [http://www.haiku-os.org/docs/userguide/en/applications/diskprobe.html Example]|| |
| | 14 | ||'''''Terminal output'''''|||| |
| | 15 | ||<pre class="terminal"><div>||For Terminal in/output. [http://www.haiku-os.org/docs/userguide/en/index.html Example]|| |
| | 16 | ||'''''In-text formatting'''''|||| |
| | 17 | ||<span class="key"></span>||For keyboard shortcuts. Use uppercase. Keys are separated with non-breaking spaces.|| |
| | 18 | ||||''Example:'' <span class="key">ALT</span> <span class="key">C</span>|| |
| | 19 | ||<span class="cli"></span>||For command line applications.|| |
| | 20 | ||||''Example:'' <span class="cli">catattr</span>|| |
| | 21 | ||<span class="app"></span>||For applications.|| |
| | 22 | ||||''Example:'' <span class="app">ActivityMonitor</span>|| |
| | 23 | ||<span class="path"></span>||For paths.|| |
| | 24 | ||||''Example:'' <span class="path">/boot/home/config/be</span>|| |
| | 25 | ||<span class="menu"></span>||For menu items. Separate menu, submenu, item with a " | ".|| |
| | 26 | ||||''Example:'' <span class="menu">Font | Size | Increase</span>|| |
| | 27 | ||<span class="button"></span>||For buttons.|| |
| | 28 | ||||''Example:'' <span class="button">Apply</span>|| |
| | 29 | |
| | 30 | === In General === |
| | 31 | ==== Images ==== |
| | 32 | * Screenshots should be cropped to the window borders with a transparent background (think of the yellow window tab). |
| | 33 | * No mouse pointer in the picture, unless it shows some action requiring the mouse. |
| | 34 | * Images are normally PNG, their width and height tags are ''not'' used to make changing files possible without touching the text. |
| | 35 | |
| | 36 | ==== Tables ==== |
| | 37 | Tables should be used if you have a couple of e.g. buttons or menus that are to be explained with a short text (e.g. see [http://www.haiku-os.org/docs/userguide/en/twitcher.html at bottom of Twitcher]. Between the object (button or menu) and the explanation should be a 15 pixel wide empty column. To avoid unwanted linebreaks and align text to the top, use the class "onelinetop" of a cell.[[BR]] |
| | 38 | ''Example:'' <tr><td class="onelinetop">Longest menu item</td> <td width="15"> </td><td>Explanatory text</td></tr> |
