Difference between revisions of "Clicklaw Wikibooks Contributor Guide"

Jump to navigation Jump to search

Clicklaw Wikibooks Contributor Guide (view source)

Revision as of 21:43, 4 June 2013

1,454 bytes added ,  21:43, 4 June 2013
→‎Basic editing tools
Line 55: Line 55:
#You can make changes to the text in the edit window, and click on the “Save page” button to save your changes.<br /><br />[[File:Editing_a_page_on_the_wiki_2.png |border| 900px | link=]]
#You can make changes to the text in the edit window, and click on the “Save page” button to save your changes.<br /><br />[[File:Editing_a_page_on_the_wiki_2.png |border| 900px | link=]]


==Basic editing tools==
==Basic editing tools and formatting==
Clicklaw Wikibooks uses a  simple markup language to control how content looks, but to start off, you don't need to know much about this markup language. Buttons along the top of the edit window frame do most of the formatting and wiki markup for you.  
Clicklaw Wikibooks uses a  simple markup language to control how content looks, but to start off, you don't need to know much about this markup language. Buttons along the top of the edit window frame do most of the formatting and wiki markup for you.  


Select a portion of text while in the edit screen, and then click one of the buttons to apply that formatting. The buttons you see below have the following functions:
[[File:Editing tools explained.gif]]
# '''Bold''': Simply select with your cursor the words you need to make bold, then click button #1.
 
# '''Italics''': Follow the same steps above, but click button #2 to create text in italics.
Select a portion of text while in the edit screen, and then click one of the buttons to apply that formatting. The buttons have the following functions:
# '''Internal Link''': One page in a wiki often naturally leads to another page on the same wiki. For example, here is a link to the [[Clicklaw Wikibooks Style Guide]], which is also useful because it tells you when bold and italics are used. To make an internal link click button #3. You will see <tt><nowiki>[[Link title]]</nowiki></tt>. Replace <tt>Link title</tt> with the exact name of the page, leaving the square brackets intact, i.e. <tt>Clicklaw Wikibooks Style Guide</tt>, and you're done. Don't forget to hit "Save page."
 
# '''External Link''': Examples of external links include any link to another website, or even a PDF or DOC file from somewhere online. Cases on CanLII, for instance, will be referenced by an external link. The simplest way to insert an external link is to just type the full URL, including the <tt>http://</tt> prefix. Typing "<tt>For more information on the Court of Appeal process, visit <nowiki>http://www.courtofappealbc.ca</nowiki></tt>" into the edit screen and hitting "Save page" will show up as this: "For more information on the Court of Appeal process, visit the Court of Appeal BC Online Help Guide at http://www.courtofappealbc.ca". But most of the time, you will want the link to appear as the name of the resource itself underlined. Click button #4 and you will see <tt><nowiki>[http://www.example.com link title]</nowiki></tt>. Replace <tt>www.example.com</tt> and insert the URL you want to send readers to, <tt>www.courtofappealbc.ca</tt>. Now replace <tt>link title</tt> with the words you want your link to read as, for example <tt>Court of Appeal BC Online Help Guide</tt>. The proper external link should appear in the edit screen as "<tt>For more information on the Court of Appeal process, visit the <nowiki>[http://www.courtofappealbc.ca Court of Appeal BC Online Help Guide]</nowiki></tt>". Save the page. This text should appear as "For more information on the Court of Appeal process, visit the [http://www.courtofappealbc.ca Court of Appeal BC Online Help Guide]".  
=== Bold ===
In the edit screen, selecting text then clicking button #1 will apply the wiki markup to make the text appear bold.
Bold text is rarely called for by the [[Clicklaw Wikibooks Style Guide]]. Italics are preferred for giving emphasis. That said, it is sometimes appropriate to bold the first word in a list item.
You can create bold text manually by enclosing one or more words in sets of three apostrophes.  
Typing:
:<code><nowiki>I want to make '''this text''' bold.</nowiki></code>
Will look like this when you save or preview the page:
:I want to make '''this text''' bold.
 
=== Italics ===
In the edit screen, selecting text then clicking button #2 will apply the wiki markup to make the text appear in italics.
Use Italics sparingly to add emphasis to words that are unfamiliar or to disambiguate ones that the reader might mistake. Italics are used to cite cases, legislation or certain other sources. Consult the [[Clicklaw Wikibooks Style Guide]] for guidelines on when to use italics.
To create italic text manually, enclose one or more words in sets of two apostrophes.
Typing:
:<code><nowiki>An ''arquebus'' is an early muzzle-loaded firearm, while an ''aquabus'' is a motorized boat.</nowiki></code>
Will look like this when you save or preview the page:
:An ''arquebus'' is an early muzzle-loaded firearm, while an ''aquabus'' is a motorized boat.


[[File:Editing tools explained.gif]]
=== Links ===
==== Internal Link ====
One page in a wiki often naturally leads to another page on the same wiki. For example, here is a link to the [[Clicklaw Wikibooks Style Guide]], which is also useful because it tells you when bold and italics are used. To make an internal link click button #3. You will see <code><nowiki>[[Link title]]</nowiki></code>. Replace <code>Link title</code> with the exact name of the page (leaving the square brackets where they are) and you're done. Don't forget to hit "Save page."
Typing:
:<code><nowiki>Editors are encouraged to read the [[Clicklaw Wikibooks Style Guide]].</nowiki></code>
Will look like this when you save or preview the page:
:Editors are encouraged to read the [[Clicklaw Wikibooks Style Guide]].
Note: twin square brackets are used for internal links.
 
==== External Link ====
Examples of external links include any link to another website, or even a PDF or DOC file available somewhere online. Cases on CanLII, for instance, require external links. The simplest way to insert an external link is to just type the full URL, including the <code><nowiki>http://</nowiki></code> prefix.
Typing:
:<code><nowiki>For more information on the Court of Appeal process, visit http://www.courtofappealbc.ca</nowiki></code>
Will look like this when you save or preview the page:
:For more information on the Court of Appeal process, visit http://www.courtofappealbc.ca.
Much of the time, you won't want the link to appear so obvious. To have other words appear with links to online resources, select the text you want to contain the link, then click button #4. You will see
:<code><nowiki>[http://www.example.com link title]</nowiki></code>.
Replace <code><nowiki>www.example.com</nowiki></code> with the correct URL you want to send readers to (e.g.<code><nowiki>www.courtofappealbc.ca</nowiki></code>). Now replace <code>link title</code> with the words you want to contain the link (e.g.<code>Court of Appeal BC Online Help Guide</code>.
Typing:
:<code><nowiki>For more information, visit the Court of Appeal BC's [http://www.courtofappealbc.ca Online Help Guide].</nowiki></code>
Will look like this when you save or preview the page:
:For more information, visit the Court of Appeal BC's [http://www.courtofappealbc.ca Online Help Guide].


==Lists==
==Lists==
Retrieved from "https://stagewiki.clicklaw.bc.ca/index.php?title=Special:MobileDiff/13411"

Navigation menu