welcome: please sign in

The following 172 words could not be found in the dictionary of 7 words (including 7 LocalSpellingWords) and are highlighted below:
about   Adam   and   apply   are   as   at   away   Bad   bar   basic   be   Because   beginning   best   beween   Chlipala   clearly   command   commands   considerations   content   Contents   Coop   copy   could   date   degree   Depth   describes   Description   different   discretion   distinction   distract   do   doesn   Dom   easily   easy   email   exactly   Exim   explains   filter   first   following   foo   For   for   from   front   globally   Good   guides   hack   headings   Here   how   If   in   include   instead   into   is   it   It   just   keep   left   Level   level   levels   line   logical   look   main   making   Manual   matter   may   Member   Michael   more   multi   my   new   no   normal   not   numbering   numbers   Of   of   off   old   Olson   on   On   one   ones   or   other   out   page   pages   paste   Perhaps   person   placed   Point   probably   procmail   put   reason   Remaining   revising   right   second   section   Section   sections   seen   separate   should   size   so   split   stands   start   style   such   Table   taken   Template   template   text   than   that   The   the   then   there   This   this   those   to   Tool   top   turn   turned   turns   two   ugly   unnumbered   up   use   used   using   very   view   we   when   who   Why   wiki   with   would   writing   Writing   you   your  

Clear message
Edit

StyleGuide

This page explains the considerations that should be taken when writing pages in the HCoop wiki.

Template

Here's a basic template to apply when making new pages and revising old ones.

Description of page.  I.e.: This page describes how to filter your email using
procmail and Exim.

## Every page should have a table of contents
[[TableOfContents]]

Remaining content of page, split into logical sections.

Section numbers

The following text, when placed at the beginning of a page, turns off numbering of headings.

#pragma section-numbers off

This should be used:

Level of headings

If section numbers are turned off, then start with first-level headings.

If section numbers are left on, then start with second-level headings. The reason for this is that the numbers in front of first-level headings look ugly and distract from the content of the page.

Depth of headings

For the MemberManual, there should be no more than two levels of headings, so that the distinction beween different levels may be clearly seen.

Writing commands

If you are writing a command, then put it on a separate line, so that it stands out and is easy to copy and paste.

Bad: my-command foo bar.

Good:

my-command foo bar

Point of view

It would be best to use "you" (second-person) when writing the MemberManual.

For other pages, it probably doesn't matter.

StyleGuide (last edited 2011-04-22 22:58:16 by ClintonEbadi)