Difference between revisions of "Clicklaw Wikibooks Style Guide"

Jump to navigation Jump to search
no edit summary
Line 1: Line 1:
{{GUIDEPAGE}}
{{GUIDEPAGE}}


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.  
This style guide for [[Clicklaw Wikibooks]] aims to help contributors produce Wikibooks with consistent and clear language, layout, and formatting. This guide is to be used in conjunction with the [[Clicklaw Wikibooks Style Guide]], which provides guidance on the technical aspects of editing and updating content.


== Page titles and in-page headings ==
== Page titles and in-page headings ==
Line 68: Line 68:
=== Bulleted lists ===
=== Bulleted lists ===
Use bulleted lists to break up a list of items. Use numbered lists if the list is a series of steps.  
Use bulleted lists to break up a list of items. Use numbered lists if the list is a series of steps.  
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>
This will appear as:
:*bullet point
:*bullet point


Where the bulleted list has items that are less than a full sentence, use commas between the items, start each item with a lowercase letter, and use a conjunction after the second-to-last item. For example:
Where the bulleted list has items that are less than a full sentence, use commas between the items, start each item with a lowercase letter, and use a conjunction after the second-to-last item. For example:
Line 107: Line 99:


Use numbered lists if the list is a series of steps.  
Use numbered lists if the list is a series of steps.  
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.
You can nest a bulleted list within a numbered list. Use the syntax #* for the bulleted items within the numbered list:
:<code><nowiki>#First numbered item</nowiki></code>
:<code><nowiki>#Second numbered item</nowiki></code>
:<code><nowiki>#*Bullet point</nowiki></code>
:<code><nowiki>#*Bullet point</nowiki></code>
This will appear as:
:#First numbered item
:#Second numbered item
:#*Bullet point
:#*Bullet point


==Quotation marks==
==Quotation marks==
Line 157: Line 135:
=== Internal links ===
=== 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.  
To make an internal link, use two square brackets to open the link, followed by the name of the linked page, followed by two closing square brackets:
:<code><nowiki>[[Name of Page Here]]</nowiki></code>
Use a vertical bar "|" (the "pipe" symbol) to create a link while labeling it with a different name than the linked page. The first term inside the brackets is the name of the linked page (the page you would be taken to), while anything you type after the vertical bar is what that link looks like on the original page. Here are examples:
:<code><nowiki>[[I Want to Write a Will | writing a will]]</nowiki></code>
:<code><nowiki>[[Resource List | list of the best sources]]</nowiki></code>
These will appear as:
:* [[I want to write a will | writing a will]]
:* [[Resource List | list of the best sources]]


=== External links ===
=== 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 Clicklaw Wikibooks. 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 Clicklaw Wikibooks.  
 
:<code><nowiki>[http://www.courthouselibrary.ca Courthouse Libraries BC]</nowiki></code>
:<code><nowiki>[http://www.clicklaw.bc.ca/helpmap Clicklaw HelpMap]</nowiki></code>
 
These will appear as:
 
:* [http://www.courthouselibrary.ca Courthouse Libraries BC]
:* [http://www.clicklaw.bc.ca/helpmap Clicklaw HelpMap]
 
Where there is an external link that has a Clicklaw page, then link to the Clicklaw page. For example:
 
:<code><nowiki>the fact sheet [http://www.clicklaw.bc.ca/resource/1012 "Persons with Disabilities (PWD) Benefit Application"]</nowiki></code>
 
This will appear as:
:* the fact sheet [http://www.clicklaw.bc.ca/resource/1012 "Persons with Disabilities (PWD) Benefit Application"]


== Numbers ==
== Numbers ==

Navigation menu