Difference between revisions of "Clicklaw Wikibooks Contributor Guide"

Jump to navigation Jump to search
no edit summary
Line 1: Line 1:
{{GUIDEPAGE}}
{{GUIDEPAGE}}
This is a guide for editors and contributors with Clicklaw Wikibooks accounts. It contains instructions for editing content.
This is a guide for contributors with Clicklaw Wikibooks accounts. It contains instructions for editing content. If you are not a ''Wikibooks'' editor contributor, but handle your organization's content on the main ''Clicklaw'' main [http://www.clicklaw.bc.ca Clicklaw website], see the [[Clicklaw Website Contributor Guide]].
Read on to learn about:
* Getting your account set up
* Logging in
* Making edits to pages
The [[Clicklaw Wikibooks Contributor Guide]] will get editors and contributors started. If you are not a ''Wikibooks'' editor or contributor, but handle your organization's content on the main ''Clicklaw'' main [http://www.clicklaw.bc.ca Clicklaw website], see the [[Clicklaw Website Contributor Guide]].


==Getting started==
This guide is to be used in conjunction with the [[Clicklaw Wikibooks Style Guide]], which aims to help contributors produce consistent and clear language, layout, and formatting.  
===Accounts and contributor bio pages===
====Account and password setup====
Unless your organization uses a single organization-wide account for making edits, each contributor will receive a username and bio page. Users set their own password when they open their invitation to set up an account. By default usernames are the editor's first and last name separated by a space, e.g. "Nate Russell". Usernames for organizations' accounts may be the full name of the organization, e.g. "Peoples' Law Schoool", an acronym, e.g. "LSLAP" (for Law Students Legal Advice Program), or program name, e.g. "Dial-A-Law" for the Canadian Bar Association BC Branch's Dial-A-Law program.
 
Honorifics, e.g. "Judge" or "QC", are not included in the username, although honorifics can be mentioned elsewhere. If you are an editor but have not yet received an email invitation with your account, contact [http://mailto:editor@clicklaw.bc.ca editor@clicklaw.bc.ca]. Editors set their own passwords and can change their email address using the "Preferences" tab.
====Contributor bio pages====
Editors and contributors with usernames receive a bio page. See [[:Category:Contributor Bio |bio page examples]]. The bio page will link to your content and include your name and a brief professional biography at a minimum. It may also include a link your firm's website, a profile picture, and contact information (phone, email, social media). Bio pages credit and introduce contributors, but Courthouse Libraries BC must not be seen to be promoting certain lawyers over others. Self-laudatory claims and adjectives should be avoided.
To set up the bio page, we require:
* 100-250 word bio
* website URL, email, and social media accounts (optional)
* profile photo portrait at least 150 px wide (optional)
* any phone number, email or social media accounts you want to include
Those who supply no photo will have a generic profile graphic displayed.
As a matter of style and for consistency of tone, lawyers are referred to in the third person and by their first name. The Clicklaw Wikibooks coordinator may edit bios for length and tone.
 
===Authors, editors and reviewers===
Clicklaw Wikibooks houses content for several organizations with publications. Each publication, or wikibook title, may have its own culture and arrangement with people tasked with updating it. An partner organization's work will be carried out by contributors, and these people might be staff of that organization with no wiki skills, freelance contractors who've done wiki work before, or volunteer lawyers, judges, advocates, etc. with a wide range of ability. Some wikibooks, such as those produced by [[Peoples Law School]], are administered by a small team of editors only, while other wikibooks, such as ''[[JP Boyd on Family Law]]'', involve [[:Category:JP Boyd on Family Law Contributors|numerous collaborators]] all of who are volunteers.


===Before you edit===
===Before you edit===
Line 38: Line 16:


See [[#Undoing changes |Undoing Changes]].
See [[#Undoing changes |Undoing Changes]].
====If we haven't taught you how to do it, ask us how (or leave it be)====
A minimum knowledge of the tools is required. Other than knowing how to log in, navigate around, and where to find things like the "Edit" tab, you will need to know how to:
# create (or fix) links to cases, legislation, other web resources,
# make lists (like this numbered list),
# create emphasis for key words or documents using ''italics'', or in rare cases '''bold''',
# divide pages with section headings and subheadings,
# indent paragraphs or blocks of text,
# create text in a <tt>plain format</tt> (for legislation excerpts), and
# understand a few technical things—like the limited things you need to:
#*change what ''alert boxes'' are saying on pages,
#*work with your contributor bio page,
#*understand some of the weird coding and know what to leave alone,
#*''maybe'' change the contents of tables, and
#*participate in Discussion pages (these are locked down so only editors can see Discussions about a page).
This page tells you how to do these things. You are not expected to do anything technically beyond what is explained here.
If you have questions, email us at [mailto:wikisupport@clicklaw.bc.ca wikisupport@clicklaw.bc.ca]
===Logging in to your new account===
Everyone who contributes to Clicklaw Wikibooks will be given an account. All of your work is linked to your account, so it’s important to use the same account every time.
#You will receive an email from "wikisupport@clicklaw.bc.ca" containing your username and password.
#Go to http://wiki.clicklaw.bc.ca/.
#Use the "Log in" button at the top right to log in with the username and password supplied in the email.
#Change your password to something secure that you will remember (if you need to find the Change Password page, it’s http://wiki.clicklaw.bc.ca/index.php?title=Special:ChangePassword).
[[File:Logging_in_to_your_new_account.png | border|link=]]
====Setting up your Watchlist and alerts====
There are thousands of pages on Clicklaw Wikibooks, but are you responsible for more than half a dozen?
Click the ''star'' icon on all pages assigned to you (include your contributor bio page). This lets you monitor a page and know if someone changes it or leaves feedback. Do this once for all your pages at the account setup stage, and also ensure that your preferences are set to receive email alerts for changes
Steps for [[Clicklaw Wikibooks Contributor Guide#Adding pages to watchlist|adding pages to your watchlist]] and [[Clicklaw Wikibooks Contributor Guide#Email notifications for watchlist|setting up email alerts for changes to pages on your watchlist]] are discussed below.
Organizations with one username and account for editing might handle dozens of pages, but organizations should still take this step.


===The "Edit" screen===
===The "Edit" screen===
Are you at the page you want to edit? Are you logged in? If yes, you can start editing.
Are you at the page you want to edit? Are you logged in? If yes, you can start editing. Please refer to the [[Clicklaw Wikibooks Style Guide]] before/while making edits.
#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=]]
Line 102: Line 45:
[[File:Edit toolbar italic.png|framed|link=]]
[[File:Edit toolbar italic.png|framed|link=]]
In the edit screen, selecting text then clicking the Italic button will apply the wiki markup to make the text appear in italics.  
In the edit screen, selecting text then clicking the Italic button 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.  
Use Italics sparingly to add emphasis to words that are unfamiliar or to disambiguate ones that the reader might mistake. Italics are also used to cite cases, legislation or certain other sources.  


To create italic text manually, enclose one or more words in sets of two apostrophes.
To create italic text manually, enclose one or more words in sets of two apostrophes.
Line 407: Line 350:
===MediaWiki manual===  
===MediaWiki manual===  
The [http://www.mediawiki.org/ MediaWiki] website also includes excellent support material — 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 and the hugely popular Wikipedia.)
The [http://www.mediawiki.org/ MediaWiki] website also includes excellent support material — 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 and the hugely popular Wikipedia.)
===Plain language writing===
====A short definition of "Plain English"====
Brian Garner, from ''Legal Writing in Plain English,'' 2001, pp xiv:
<blockquote>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.
</blockquote>
====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 low reading level. [[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]] 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:
# Think about your reader and question what they know or don't know. 
# Think about questions your readers will have on the topic, and organize your thoughts accordingly.
# Summarize main points using headers.
# Organize steps or similar information with lists.
# Write brief sentences and keep paragraphs short.
# Use common phrases and words.
# Avoid unnecessary descriptive adverbs and words.
# Write in the active voice and keep verb and subject close together.
# Ask another reader to evaluate your writing.
====More on plain language 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/whatisPL/definitions/Kimble.cfm Joe Kimble, ''The Elements of Plain Language'' in the ''Michigan Bar Journal'', October 2002]


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

Navigation menu