3,220
edits
Difference between revisions of "Clicklaw Wikibooks Style Guide"
From Clicklaw Wikibooks
Clicklaw Wikibooks Style Guide (view source)
Revision as of 01:10, 22 March 2013
, 01:10, 22 March 2013no edit summary
m (moved Wiki Style Guide to Clicklaw Wikibooks Style Guide) |
|||
| Line 1: | Line 1: | ||
This style guide | This style guide for [[Clicklaw Wikibooks]] aims to help contributors produce Wikibooks with consistent and clear language, layout, and formatting. The goal is to make Clicklaw Wikibooks easier and more intuitive to use. See the [[Clicklaw Wikibooks Cheatsheet]] for shortcuts for commonly used wiki commands. | ||
== Page | == Page Titles and In Page Headings == | ||
=== Page | === Page Titles === | ||
The title of a page should be in plain language (as a description of the topic or, for [[Legal Help for British Columbians]], a question), concise, and consistent with the titles of related pages. | The title of a page should be in plain language (as a description of the topic or, for [[Legal Help for British Columbians]], a question), concise, and consistent with the titles of related pages. | ||
The following points are | The following points are important with page titles: | ||
* | * Each page title on Clicklaw Wikibooks has to be unique, so make your page title as specific as possible. For example, use "Making Changes in Child Support" rather than "Making Changes". | ||
* Use "title case" in page titles; that is, all words should be capitalized except for articles (''the'', ''a'', ''an''), prepositions (''in'', ''of'', ''to'', ''from'', ''with'', etc.), and conjunctions (''and'', ''but'', ''for'', ''or'' and ''nor''). | |||
=== In | === In Page headings === | ||
Headings within a page are produced by typing multiple equal signs. A primary section heading is written ==Words in heading==, a subsection below it is written ===Words in heading===, and so on (a maximum of five levels is possible). Spaces between the equal signs and the heading text are optional, and will not affect the way the heading is displayed. The heading must be typed on a separate line. Include one blank line above the heading, and optionally one blank line below it, for readability in the edit window. (Only two or more consecutive blank lines will add more white space in the public appearance of the page.) | Headings within a page are produced by typing multiple equal signs. A primary section heading is written ==Words in heading==, a subsection below it is written ===Words in heading===, and so on (a maximum of five levels is possible). Spaces between the equal signs and the heading text are optional, and will not affect the way the heading is displayed. The heading must be typed on a separate line. Include one blank line above the heading, and optionally one blank line below it, for readability in the edit window. (Only two or more consecutive blank lines will add more white space in the public appearance of the page.) | ||
| Line 16: | Line 17: | ||
The following points apply to in page headings: | The following points apply to in page headings: | ||
* Use | * Use "title case" for section headings; that is, all words should be capitalized except for articles (''the'', ''a'', ''an''), prepositions (''in'', ''of'', ''to'', ''from'', ''with'', etc.), and conjunctions (''and'', ''but'', ''for'', ''or'' and ''nor''). | ||
* Headings should not normally contain links, especially where only part of a heading is linked. | * Headings should not normally contain links, especially where only part of a heading is linked. | ||
* Section and subsection headings should preferably be unique within a page; otherwise section links may lead to the wrong place. | * Section and subsection headings should preferably be unique within a page; otherwise section links may lead to the wrong place. | ||
| Line 22: | Line 23: | ||
== Lists == | == Lists == | ||
=== Bulleted | === Bulleted Lists === | ||
When making a bulleted list, put an asterisk before each item to make it a bulleted list item: | When making a bulleted list, put an asterisk before each item to make it a bulleted list item: | ||
:<code><nowiki>*Bullet point</nowiki></code> | :<code><nowiki>*Bullet point</nowiki></code> | ||
| Line 33: | Line 34: | ||
Where the bulleted list has items that are less than a full sentence, you can use commas between the items. For example: | Where the bulleted list has items that are less than a full sentence, you can use commas between the items. For example: | ||
:To qualify for | :To qualify for Persons with Disabilities benefits, you must: | ||
:*be at least 18 years of age, | :*be at least 18 years of age, | ||
:*have a severe mental or physical impairment, and | :*have a severe mental or physical impairment, and | ||
| Line 49: | Line 50: | ||
:* Independent Assessment Process: Under this process, a victim of abuse at a Residential School may apply for additional compensation. | :* Independent Assessment Process: Under this process, a victim of abuse at a Residential School may apply for additional compensation. | ||
=== Numbered | === Numbered Lists === | ||
When making a numbered list, put a pound sign (#) before each item to make it a numbered list item. Note that you should have no space between the pound sign and the beginning of the item, and no spaces between list items. | When making a numbered list, put a pound sign (#) before each item to make it a numbered list item. Note that you should have no space between the pound sign and the beginning of the item, and no spaces between list items. | ||
| Line 77: | Line 78: | ||
== Links == | == Links == | ||
=== Internal | === Internal Links === | ||
Make links only where they are relevant and helpful in the context: Excessive use of hyperlinks can be distracting, and may slow the reader down. | Make links only where they are relevant and helpful in the context: Excessive use of hyperlinks can be distracting, and may slow the reader down. | ||
| Line 94: | Line 95: | ||
=== External | === External Links === | ||
Minimize using external links in the main body of a page; include only external links that are to essential resources or information. For other external links, look to include those in an external links section at the end, pointing to further information outside the Clicklaw wiki. The standard format for making an external link is: | Minimize using external links in the main body of a page; include only external links that are to essential resources or information. For other external links, look to include those in an external links section at the end, pointing to further information outside the Clicklaw wiki. The standard format for making an external link is: | ||
| Line 120: | Line 121: | ||
== Punctuation == | == Punctuation == | ||
=== Hyphens between | === Hyphens between Words === | ||
Put spaces between the hyphen and the word - like this. | Put spaces between the hyphen and the word - like this. | ||
