welcome: please sign in

Diff for "StyleGuide"

Differences between revisions 2 and 12 (spanning 10 versions)
Revision 2 as of 2007-10-28 00:51:59
Size: 1392
Editor: MichaelOlson
Comment: Remove stray text
Revision 12 as of 2011-04-21 17:17:18
Size: 86
Editor: ec2-175-41-141-30
Comment: mAcUBF <a href="http://eznknjyaqkjc.com/">eznknjyaqkjc</a>
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#pragma section-numbers off

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

[[TableOfContents]]

= 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:

 * If the page is the main page, or exactly one degree away from it, then you should include the following text at the very top of the page.

 * On multi-page guides, such as DomTool.

 * On other pages at the discretion of those who keep the wiki up-to-date.

= 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.

= Writing style =

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

For other pages, it probably doesn't matter.
mAcUBF <a href="http://eznknjyaqkjc.com/">eznknjyaqkjc</a>
----
CategoryNeedsWork

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