Difference between revisions of "Clicklaw Wikibooks Contributor Guide"

Jump to navigation Jump to search
no edit summary
Line 63: Line 63:
#Click on the "Edit" tab or click on the "edit" link beside a particular section (if you only want to edit the text for a certain section of a page).<br /><br />[[File:Editing_a_page_on_the_wiki.png | border|800px | link=]]<br /><br />
#Click on the "Edit" tab or click on the "edit" link beside a particular section (if you only want to edit the text for a certain section of a page).<br /><br />[[File:Editing_a_page_on_the_wiki.png | border|800px | link=]]<br /><br />
#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=]]
==Undoing changes==
One of the best things about this wiki platform is that each page has a "History" of older versions, including the one you just saved over. You (or another person) can always undo an edit and restore an older version of a page.
When viewing a page's history tab:
* Selecting '''Undo''' on the current version will show you the difference between it and the next most recent version, and you can then select "Save page" to restore the earlier of the two versions.
* Selecting '''Rollback''' on the current version of a page will undo all of the recent changes by the contributor who had saved that current version, with the effect of rewinding the page back to the most recent version saved by someone other than that contributor.


==Basic editing tools and formatting==
==Basic editing tools and formatting==
Line 278: Line 271:
|}
|}


== Using the "Watchlist" ==
==Undoing changes==
One of the best things about this wiki platform is that each page has a "History" of older versions, including the one you just saved over. You (or another person) can always undo an edit and restore an older version of a page.
 
When viewing a page's history tab:
* Selecting '''Undo''' on the current version will show you the difference between it and the next most recent version, and you can then select "Save page" to restore the earlier of the two versions.
* Selecting '''Rollback''' on the current version of a page will undo all of the recent changes by the contributor who had saved that current version, with the effect of rewinding the page back to the most recent version saved by someone other than that contributor.
 
==Advanced features==
===The "Watchlist"===
Account holders, including all editors and contributors, have the option of adding pages to a watchlist so they can follow content that they are responsible for and receive a notification when the pages are altered. You receive email notifications (see [[Clicklaw Wikibooks Contributor Guide#Email notification | setting up email notificaiton]]) or be shown an overview of the changes from the [[Special:Watchlist | Watchlist]] page.
Account holders, including all editors and contributors, have the option of adding pages to a watchlist so they can follow content that they are responsible for and receive a notification when the pages are altered. You receive email notifications (see [[Clicklaw Wikibooks Contributor Guide#Email notification | setting up email notificaiton]]) or be shown an overview of the changes from the [[Special:Watchlist | Watchlist]] page.


Line 303: Line 304:
[[File:Email_notification_watchlist.png  |border| 900px | link=]]
[[File:Email_notification_watchlist.png  |border| 900px | link=]]


==Disabling Glossary/Terminology Popups==
===Disabling Glossary/Terminology Popups===
Terms that appear along with their definitions on the [[Terminology]] page will automatically be detected the first time they appear on any article in the Clicklaw Wiki. In general, this saves work, since no manual coding is required to ensure that a legal term will include a definition. The automatic nature of this process, however, will result in false-positives in cases where a defined term also has a common meaning in addition to a legal one (the terms "hearing", and "order" for example).
Terms that appear along with their definitions on the [[Terminology]] page will automatically be detected the first time they appear on any article in the Clicklaw Wiki. In general, this saves work, since no manual coding is required to ensure that a legal term will include a definition. The automatic nature of this process, however, will result in false-positives in cases where a defined term also has a common meaning in addition to a legal one (the terms "hearing", and "order" for example).
To exclude defined terms from appearing with their pop-up definition (and where it is the first time the term has been used on a page), you should bracket the term with the HTML element:
To exclude defined terms from appearing with their pop-up definition (and where it is the first time the term has been used on a page), you should bracket the term with the HTML element:
Line 314: Line 315:
at the end of the text of a page.
at the end of the text of a page.


==Plain language writing==
==Additional resources==
===A short definition of "Plain English"===
 
===Style guide===
The [[Clicklaw Wikibooks Style Guide]] highlights key style and word usage for pages on Clicklaw Wikibooks.
 
===MediaWiki manual===
The [http://www.mediawiki.org/ MediaWiki] website also includes excellent support material — for example, instructions on [http://www.mediawiki.org/wiki/Help:Navigation navigating a wiki], [http://www.mediawiki.org/wiki/Help:Editing_pages editing pages], and [http://www.mediawiki.org/wiki/User_hub much more]. (MediaWiki is free, open source software that powers Clicklaw Wikibooks, as well as the hugely popular Wikipedia.)
 
===Plain language writing===
====A short definition of "Plain English"====
Brian Garner, from ''Legal Writing in Plain English,'' 2001, pp xiv:
Brian Garner, from ''Legal Writing in Plain English,'' 2001, pp xiv:
<blockquote><tt>A word about "plain English." The phrase certainly shouldn't connote drab and dreary language. Actually, plain English is typically quite interesting to read. It's robust and direct—the opposite of gaudy, pretentious language. You achieve plain English when you use the simplest, most straightforward way of expressing an idea. You can still choose interesting words. But you'll avoid fancy ones that have everyday replacements meaning precisely the same thing.</tt>
<blockquote><tt>A word about "plain English." The phrase certainly shouldn't connote drab and dreary language. Actually, plain English is typically quite interesting to read. It's robust and direct—the opposite of gaudy, pretentious language. You achieve plain English when you use the simplest, most straightforward way of expressing an idea. You can still choose interesting words. But you'll avoid fancy ones that have everyday replacements meaning precisely the same thing.</tt>
</blockquote>
</blockquote>


===Plain language tips===
====Plain language tips====
We are writing with the public reader in mind, not lawyers or other legal advocates. Depending on the wikibook, you may need to aim for a very low reading level. For example, [[Legal Help for British Columbians]] serves very basic information so people can take the first step towards finding help for their common legal problem. [[JP Boyd on Family Law]], on the other hand, presumes a higher reading level, since it offers motivated self-represented individuals a slightly more detailed description of family law. Both groups of readers benefit from plain language writing methods.   
We are writing with the public reader in mind, not lawyers or other legal advocates. Depending on the wikibook, you may need to aim for a very low reading level. For example, [[Legal Help for British Columbians]] serves very basic information so people can take the first step towards finding help for their common legal problem. [[JP Boyd on Family Law]], on the other hand, presumes a higher reading level, since it offers motivated self-represented individuals a slightly more detailed description of family law. Both groups of readers benefit from plain language writing methods.   
Some tips to consider when writing or reviewing legal information for the public:
Some tips to consider when writing or reviewing legal information for the public:
Line 333: Line 342:
# Ask another reader to evaluate your writing.
# Ask another reader to evaluate your writing.


===More on plain language writing===
====More on plain language writing====
* [http://www.cba.org/cba/practicelink/cs/plainlanguage1.aspx CBA PracticeLink: Plain language legal writing]
* [http://www.cba.org/cba/practicelink/cs/plainlanguage1.aspx CBA PracticeLink: Plain language legal writing]
* [http://www.plainlanguage.gov/examples/before_after/index.cfm Before and After Comparisons from www.plainlanguage.gov]
* [http://www.plainlanguage.gov/examples/before_after/index.cfm Before and After Comparisons from www.plainlanguage.gov]
* [http://www.plainlanguage.gov/whatisPL/definitions/Kimble.cfm Joe Kimble, ''The Elements of Plain Language'' in the ''Michigan Bar Journal'', October 2002]
* [http://www.plainlanguage.gov/whatisPL/definitions/Kimble.cfm Joe Kimble, ''The Elements of Plain Language'' in the ''Michigan Bar Journal'', October 2002]
==Additional resources==
The [[Clicklaw Wikibooks Style Guide]] highlights key style and word usage for pages on Clicklaw Wikibooks.
The [http://www.mediawiki.org/ MediaWiki] website also includes excellent support material — for example, instructions on [http://www.mediawiki.org/wiki/Help:Navigation navigating a wiki], [http://www.mediawiki.org/wiki/Help:Editing_pages editing pages], and [http://www.mediawiki.org/wiki/User_hub much more]. (MediaWiki is free, open source software that powers Clicklaw Wikibooks, as well as the hugely popular Wikipedia.)


=== Note about updating resources in Legal Help for British Columbians ===
=== Note about updating resources in Legal Help for British Columbians ===

Navigation menu