1 #pragma section-numbers off
3 This page explains the considerations that should be taken when writing pages in the HCoop wiki.
9 Here's a basic template to apply when making new pages and revising old ones.
12 Description of page. I.e.: This page describes how to filter your email using
15 ## Every page should have a table of contents
18 Remaining content of page, split into logical sections.
23 The following text, when placed at the beginning of a page, turns off numbering of headings.
26 #pragma section-numbers off
31 * 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.
33 * On multi-page guides, such as DomTool.
35 * On other pages at the discretion of those who keep the wiki up-to-date.
39 If section numbers are turned off, then start with first-level headings.
41 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.
42 Why not hack on the style instead? --AdamChlipala
43 Because the size of the normal unnumbered headings look about right. Perhaps we should just turn section numbering off globally. I could do that easily. --MichaelOlson
47 For the MemberManual, there should be no more than two levels of headings, so that the distinction beween different levels may be clearly seen.
51 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.
53 Bad: {{{my-command foo bar}}}.
63 It would be best to use "you" (second-person) when writing the MemberManual.
65 For other pages, it probably doesn't matter.