<?xml version="1.0" encoding="utf-8"?><!DOCTYPE article  PUBLIC '-//OASIS//DTD DocBook XML V4.4//EN'  'http://www.docbook.org/xml/4.4/docbookx.dtd'><article><articleinfo><title>StyleGuide</title><revhistory><revision><revnumber>13</revnumber><date>2011-04-22 22:58:16</date><authorinitials>ClintonEbadi</authorinitials><revremark>Revert to revision 11.</revremark></revision><revision><revnumber>12</revnumber><date>2011-04-21 17:17:18</date><authorinitials>ec2-175-41-141-30.ap-southeast-1.compute.amazonaws.com</authorinitials><revremark>mAcUBF  &lt;a href=&quot;http://eznknjyaqkjc.com/&quot;&gt;eznknjyaqkjc&lt;/a&gt;</revremark></revision><revision><revnumber>11</revnumber><date>2011-04-21 05:45:52</date><authorinitials>ClintonEbadi</authorinitials><revremark>Revert to revision 9.</revremark></revision><revision><revnumber>10</revnumber><date>2011-04-21 04:42:55</date><authorinitials>82.160.79.187</authorinitials><revremark>Got it! Thakns a lot again for helping me out!</revremark></revision><revision><revnumber>9</revnumber><date>2009-09-13 11:41:51</date><authorinitials>AdamChlipala</authorinitials><revremark>spam</revremark></revision><revision><revnumber>8</revnumber><date>2009-09-13 05:56:47</date><authorinitials>94.102.48.202</authorinitials><revremark>While environmental performance ranks behind safety and economics in priorities in the, [[http://ccan.ozlabs.org/Wiki/asia-pacific-airline-354|asia pacific airline]]safe landings, takeoffs and taxiing</revremark></revision><revision><revnumber>7</revnumber><date>2008-07-07 04:27:55</date><authorinitials>localhost</authorinitials><revremark>converted to 1.6 markup</revremark></revision><revision><revnumber>6</revnumber><date>2007-10-28 02:17:54</date><authorinitials>MichaelOlson</authorinitials><revremark>Follow up on comment</revremark></revision><revision><revnumber>5</revnumber><date>2007-10-28 02:16:06</date><authorinitials>MichaelOlson</authorinitials><revremark>Add Depth of Headings section</revremark></revision><revision><revnumber>4</revnumber><date>2007-10-28 02:09:13</date><authorinitials>AdamChlipala</authorinitials><revremark>Comment</revremark></revision><revision><revnumber>3</revnumber><date>2007-10-28 01:05:58</date><authorinitials>MichaelOlson</authorinitials><revremark>Add Writing Command section</revremark></revision><revision><revnumber>2</revnumber><date>2007-10-28 00:51:59</date><authorinitials>MichaelOlson</authorinitials><revremark>Remove stray text</revremark></revision><revision><revnumber>1</revnumber><date>2007-10-28 00:50:43</date><authorinitials>MichaelOlson</authorinitials><revremark>Move from RewriteGoals and flesh out</revremark></revision></revhistory></articleinfo><para>This page explains the considerations that should be taken when writing pages in the HCoop wiki. </para><section><title>Template</title><para>Here's a basic template to apply when making new pages and revising old ones. </para><screen><![CDATA[Description of page.  I.e.: This page describes how to filter your email using
procmail and Exim.
]]><![CDATA[
## Every page should have a table of contents
[[TableOfContents]]
]]><![CDATA[
Remaining content of page, split into logical sections.]]></screen></section><section><title>Section numbers</title><para>The following text, when placed at the beginning of a page, turns off numbering of headings. </para><screen><![CDATA[#pragma section-numbers off]]></screen><para>This should be used: </para><itemizedlist><listitem><para>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. </para></listitem><listitem><para>On multi-page guides, such as <ulink url="https://wiki.hcoop.net/StyleGuide/DomTool#">DomTool</ulink>. </para></listitem><listitem><para>On other pages at the discretion of those who keep the wiki up-to-date. </para></listitem></itemizedlist></section><section><title>Level of headings</title><para>If section numbers are turned off, then start with first-level headings. </para><para>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. </para><itemizedlist><listitem override="none"><para>Why not hack on the style instead? --<ulink url="https://wiki.hcoop.net/StyleGuide/AdamChlipala#">AdamChlipala</ulink> </para><itemizedlist><listitem override="none"><para>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.  --<ulink url="https://wiki.hcoop.net/StyleGuide/MichaelOlson#">MichaelOlson</ulink> </para></listitem></itemizedlist></listitem></itemizedlist></section><section><title>Depth of headings</title><para>For the <ulink url="https://wiki.hcoop.net/StyleGuide/MemberManual#">MemberManual</ulink>, there should be no more than two levels of headings, so that the distinction beween different levels may be clearly seen. </para></section><section><title>Writing commands</title><para>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. </para><para>Bad: <code>my-command foo bar</code>. </para><para>Good: </para><screen><![CDATA[my-command foo bar]]></screen></section><section><title>Point of view</title><para>It would be best to use &quot;you&quot; (second-person) when writing the <ulink url="https://wiki.hcoop.net/StyleGuide/MemberManual#">MemberManual</ulink>. </para><para>For other pages, it probably doesn't matter. </para></section></article>