= Rules for working on the user guide = To achieve a consistent result, all authors have to respect a few rules. == Formatting == In general, it's a good idea to look into existing pages and maybe copy and paste sections whose formatting fits your purposes. There are a couple of CSS classes to get a consistent appearance: ||'''Code'''||'''Comment'''|| |||| ||'''''Text boxes'''''|||| ||
||To make tips or infos more visible. Use sparingly. [http://www.haiku-os.org/docs/userguide/en/applications/drivesetup.html Example]|| ||
||To point out some critical issue. [http://www.haiku-os.org/docs/userguide/en/applications/drivesetup.html Example]|| ||
||To warn about serious consequences. [http://www.haiku-os.org/docs/userguide/en/applications/diskprobe.html Example]|| || || ||'''''Terminal output'''''|||| ||
||For Terminal in/output. [http://www.haiku-os.org/docs/userguide/en/index.html Example]||
|| ||
||'''''In-text formatting'''''||||
||{{{}}}||For keyboard shortcuts. Use uppercase. Keys are separated with non-breaking spaces.||
||||''Example:'' {{{}}}ALT{{{}}} {{{C}}}||
||{{{}}}||For command line applications.||
||||''Example:'' {{{}}}catattr{{{}}}||
||{{{}}}||For applications.||
||||''Example:'' {{{}}}ActivityMonitor{{{}}}||
||{{{}}}||For paths.||
||||''Example:'' {{{}}}/boot/home/config/be{{{}}}||
||{{{}}}||For menu items. Separate menu, submenu, item with a " | ".||
||||''Example:'' {{{}}}Font | Size | Increase{{{}}}||
||{{{}}}||For buttons.||
||||''Example:'' {{{}}}Apply{{{}}}||

=== In General ===
==== Images ====
 * Screenshots should be cropped to the window borders with a transparent background (think of the yellow window tab).
 * No mouse pointer in the picture, unless it shows some action requiring the mouse.
 * Images are normally PNG, their width and height tags are ''not'' used to make changing files possible without touching the text.

==== Tables ====
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]]
''Example:'' {{{}}}Longest menu item{{{  }}}Explanatory text{{{}}}