welcome: please sign in

Diff for "StyleGuide"

Differences between revisions 1 and 10 (spanning 9 versions)
Revision 1 as of 2007-10-28 00:50:43
Size: 1443
Editor: MichaelOlson
Comment: Move from RewriteGoals and flesh out
Revision 10 as of 2011-04-21 04:42:55
Size: 84
Editor: 82
Comment: Got it! Thakns a lot again for helping me out!
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 probably be best to use "you" (second-person) when writing the MemberManual.

The AdminManual (basically just a re-org of NewServerSetup) should be in third-person.
Got it! Thakns a lot again for helping me out!
----
CategorySystemAdministration

Got it! Thakns a lot again for helping me out!


CategorySystemAdministration

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