Difference between revisions of "Clicklaw Wikibooks Style Guide"

From Clicklaw Wikibooks
Jump to navigation Jump to search
 
(80 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOGLOSSARY__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.
{{GUIDEPAGE}}


== Page titles and in page headings ==
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 Contributor Guide]], which provides guidance on the technical aspects of editing and updating content. 
 
== Page titles and in-page headings ==


=== Page titles ===
=== Page titles ===
Line 17: Line 19:
The following points apply to in page headings:
The following points apply to in page headings:


* Use "sentence case" for section headings — that is, the initial letter of a title is capitalized; otherwise, capital letters are used only where they would be used in a normal sentence.
* Use ''sentence case'' for section headings — that is, the initial letter of a title is capitalized; otherwise, capital letters are used only where they would be used in a normal sentence.
* 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 28: Line 30:
* Do not use capital letters for legal terms — e.g., "a retainer agreement is a contract between a lawyer and you"; "a will appoints an executor".
* Do not use capital letters for legal terms — e.g., "a retainer agreement is a contract between a lawyer and you"; "a will appoints an executor".
* Do not use capital letters for party names — e.g., "after the claimant files a claim, the respondent has 14 days to reply".
* Do not use capital letters for party names — e.g., "after the claimant files a claim, the respondent has 14 days to reply".
* Use capital letters for the names of prescribed court forms — e.g., "the claimant must file a Notice of Family Claim" — but do not use capital letters for general legal forms — e.g., "a power of attorney enables you to appoint someone to look after your financial affairs".
* Use capital letters for the names of prescribed court forms — e.g., "the claimant must file a Notice of Family Claim" — but do not use capital letters for general legal forms — e.g., "a power of attorney enables you to appoint someone to look after your financial affairs", or "a parenting coordinator agreement sets out in some detail what the parenting coordinator will do".


===Do not use capitals for emphasis===
===Do not use capitals for emphasis===
Line 43: Line 45:
===Compass points===
===Compass points===


Do not capitalize '''directions''' such as ''north'', nor their related forms.   
Do not capitalize ''directions'' such as "north", nor their related forms.   


Capitalize '''names of regions''' if they have attained proper-name status, including informal conventional names — e.g., the Lower Mainland. Do not capitalize descriptive names for regions that have not attained the status of proper names, such as northern British Columbia.
Capitalize ''names of regions'' if they have attained proper-name status, including informal conventional names — e.g., "Lower Mainland". Do not capitalize descriptive names for regions that have not attained the status of proper names, such as "northern British Columbia".


===Institutions===
===Institutions===


Names of particular institutions are proper nouns and require capitals, but generic words for institutions (''university'', ''college'', ''hospital'', ''high school'') do not.
Names of particular institutions are proper nouns and require capitals, but generic words for institutions (e.g., "university", "college", "hospital", "high school") do not.


== Italics ==
== Italics ==
Line 55: Line 57:
Italics may be used ''sparingly'' to emphasize words in sentences (whereas bold is normally not used for this purpose). Generally, the more highlighting in a page, the less its effectiveness.
Italics may be used ''sparingly'' to emphasize words in sentences (whereas bold is normally not used for this purpose). Generally, the more highlighting in a page, the less its effectiveness.


===Titles===
Use italics to bring attention or distinction to a term — e.g., "Whether a party has the right to bring a dispute under a particular act and before a particular court is a question of that party's ''standing'', whereas the ability for a court to hear particular disputes or questions involving particular types of parties is a question of ''jurisdiction''." or "The term ''ex parte'' means without notice."
Use italics for the titles of books or publications of significant length (including wikibooks). The titles of articles, chapters, and other short works are not italicized; they are enclosed in double quotation marks. (See [[Clicklaw Wikibooks Style Guide#Publications|examples below]].)


Do not use quotations for emphasis.


===Titles===
Use italics for the titles of books or publications of greater length (including wikibooks). The titles of articles, chapters, and other short works are not italicized; they are enclosed in double quotation marks. (See [[Clicklaw Wikibooks Style Guide#Publications|examples below]].)


== Lists ==
== Lists ==


=== Bulleted lists ===
=== Bulleted lists ===
When making a bulleted list, put an asterisk before each item to make it a bulleted list item:
Use bulleted lists to break up a list of items. Use numbered lists if the list is a series of steps.
:<code><nowiki>*Bullet point</nowiki></code>
:<code><nowiki>*Bullet point</nowiki></code>


This will appear as:
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:
:*Bullet point
:*Bullet point


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 disability benefits, you must:
 
: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  
:*need help or supervision because of the disability.
:*need help or supervision because of the disability.
When a list is ''very'' brief, you can omit punctuation within the list. For example:
:To make scones you need:
:*flour
:*salt
:*butter
:*baking powder


Where the bulleted list has one or more items that are a full sentence or longer, use periods between the items. For example:
Where the bulleted list has one or more items that are a full sentence or longer, use periods between the items. For example:
Line 82: Line 89:
:Your best bets are:
:Your best bets are:
:* [[Family Law in BC]], for forms, self-help materials and other legal information about family legal issues.
:* [[Family Law in BC]], for forms, self-help materials and other legal information about family legal issues.
:* [[Family Justice Centres]], to make an appointment with a Family Justice Counsellor to discuss custody, guardianship, access or maintenance.  
:* [[Family Justice Centres]], to make an appointment with a counsellor to discuss parenting arrangements, contact or support.  
:* [[Duty Counsel|Family Duty Counsel]] (Provincial or Supreme), for some assistance on the day you have to appear in court.
:* [[Duty Counsel|Family Duty Counsel]] (Provincial or Supreme), for some assistance on the day you have to appear in court.


Line 90: Line 97:


=== Numbered lists ===
=== 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.


You can nest a bulleted list within a numbered list. Use the syntax #* for the bulleted items within the numbered list:
Use numbered lists if the list is a series of steps.  
:<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:
==Quotation marks==
:#First numbered item
 
:#Second numbered item
Use double quotation marks; use single marks for quotes within a quote.
:#*Bullet point
 
:#*Bullet point
Periods and commas go inside quotation marks, but semicolons and colons go outside.
 
Do not use quotations for emphasis. Use italics. [[Clicklaw Wikibooks Style Guide#Emphasis|See Emphasis]].
 
Do not use quotations when clarifying the acronym to be used for a long term. Use parenthesis only. [[Clicklaw Wikibooks Style Guide#Acronyms|See Acronyms]].


== References ==
== References ==
=== Case law ===
When citing a case, use the citation standards in the Canadian Guide to ''Uniform Legal Citation'' (7th Edition), known as the ''McGill Guide''. Names or initials of the parties in the style of cause should be italicized, along with ''v.'', ''Re'', ''(ad litem)'', or any other part of the case name/style of cause. Do not use bold. If the parties are named by initials, use punctuation between the letters. Cite Canadian cases to their neutral citation, and ensure that the link you provide is the short URL resource link provided by CanLII wherever possible. Where no neutral citation is available, use the citation that CanLII provides, and ensure that the parties in the style of cause are as indexed by CanLII. Where a case is not available on CanLII, cite to a printed reporter or electronic service.
Examples of acceptable citations:
:Case with neutral citation, available on CanLII: ''[http://canlii.ca/t/2d35m Domirti v. Domirti]'', 2010 BCCA 472
:Case with neutral citation, available on CanLII, parties identified by initials: ''[http://canlii.ca/t/52lj L.S. v. E.P.]'', 1999 BCCA 393
:Case with no neutral citation, available on CanLII: ''[http://canlii.ca/t/23fjd Wahl v. Pavle]'', 1985 CanLII 861 (BCCA)
:Case with no neutral citation, not on CanLII: ''Mareva Compania Naviera S.A. v. International Bulkcarriers S.A.'', [1980] 1 All E.R. 213


=== Publications ===
=== Publications ===
When referring to a publication that is a book or a manual, put the title in italics:
When referring to a publication that is a book or other longer work, put the title in italics:
:''Law Students' Legal Advice Program Manual''
:''Provincial Court Small Claims Handbook''


When referring to a wikibook, put the title in italics:
When referring to a wikibook, put the title in italics:
:''JP Boyd on Family Law''
:''JP Boyd on Family Law''


When referring to a publication that is not a book, put the title in quotation marks:
When referring to a publication that is a shorter work like a chapter or fact sheet, put the title in quotation marks:
:the fact sheet "Dealing with a Problem Roommate" and the pamphlet "Tenant Info for Renters in British Columbia"
:the fact sheet "Dealing with a Problem Roommate" and the pamphlet "Tenant Info for Renters in British Columbia"


For publication titles, use title case; that is, the first letters of 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''.
For publication titles, use title case; that is, the first letters of 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'').


== Links ==
== Direct quotations and excerpts ==
Think twice about adding paragraphs from reasons for judgment. Pause before pasting in dense legislative text. It may be more helpful to spare the ''legalese'' if your readers are still seeking to understand basic legal principles. Cite and link the original law or case on CanLii for deeper study, but consider if you can convey the pith and substance of the law, without the need to regurgitate its chapter and verse.
 
This said, in some cases it's critical to show readers the exact, verbatim wording from a piece of legislation, court decision, or other source.
 
=== Short quotations ===
Short quotations (less than a paragraph and no more than a few sentences) can be enclosed with quotation marks and reproduced in-line with the text, e.g.:
 
*Section 7 of the ''Guidelines'' says the court is required to consider "the necessity and reasonableness of the expense in relation to the means of the spouses and those of the child."
*In ''[http://canlii.ca/t/1d2x1 Hanson v. Hanson]'', 1999 CanLII 6307 the Supreme Court of Canada cautioned that the courts cannot sanction "the refusal of a parent to take reasonable steps to support his or her children simply because the parent cannot obtain interesting or highly paid employment."
 
=== Longer excerpts ===
 
For longer excerpts, use a block format. Clicklaw Wikibooks has two methods for block formatting depending on the type of source. 
 
==== Block formatting legislation and contracts ====


=== Internal links ===
Clicklaw Wikibooks uses blockquote tags {{tag|blockquote}} (including multiple indentation levels where applicable), and a monospace font (<code><tt></tt></code>) if the excerpt is taken from an act, regulation, contractual agreement or court order (as distinct from reasons for judgment). Doing this distinguishes the codified language and hierarchical structure of these sources compared to the more narrative and natural language flow of other types of content.  
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:  
A block formatted excerpt in a monospace font looks like this:  


:<code><nowiki>[[Name of Page Here]]</nowiki></code>
<blockquote><tt>s. 19(2) The court may impute such amount of income to a spouse as it considers appropriate in the circumstances, which circumstances include the following:</tt></blockquote>
<blockquote><blockquote><tt>(b) the spouse is exempt from paying federal or provincial income tax;</tt></blockquote></blockquote>
<blockquote><blockquote><tt>(c) the spouse lives in a country that has effective rates of income tax that are significantly lower than those in Canada;</tt></blockquote></blockquote>
<blockquote><blockquote><tt>(h) the spouse derives a significant portion of income from dividends, capital gains or other sources that are taxed at a lower rate than employment or business income or that are exempt from tax.</tt></blockquote></blockquote>


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:
Note that subsections (a-h) have additional indentation.


:<code><nowiki>[[I Want to Write a Will | writing a will]]</nowiki></code>
==== Block formatting caselaw and regular text ====
:<code><nowiki>[[Resource List | list of the best sources]]</nowiki></code>


These will appear as:
Longer direct quotations of text written in natural language (like court judgments) are also block formatted, but maintain the default typeface. The block formatted indented excerpt is enclosed in quotations. If the excerpt is longer than one paragraph each paragraph begins with an open quote, but only the final paragraph ends with a close quote.
:* [[I want to write a will | writing a will]]
:* [[Resource List | list of the best sources]]


=== External links ===
A block formatted excerpt of a typical case looks like this:
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:


:<code><nowiki>[http://www.courthouselibrary.ca Courthouse Libraries BC]</nowiki></code>
In [http://canlii.ca/t/1lxpf ''Contino v. Leonelli-Contino''], 2005 SCC 63, the Supreme Court of Canada said this about child support payments where there is shared custody:
:<code><nowiki>[http://www.clicklaw.bc.ca/helpmap Clicklaw HelpMap]</nowiki></code>


These will appear as:
<blockquote>
"[37] The framework of s. 9 requires a two‑part determination: first, establishing that the 40 percent threshold has been met; and second, where it has been met, determining the appropriate amount of support.


:* [http://www.courthouselibrary.ca Courthouse Libraries BC]
"[38] With respect to the second part of the determination [...] courts across the country have struggled to develop an interpretation of s. 9 that is consistent with the Guidelines’ objectives. While the approaches vary widely, they can be divided in two categories. One approach, similar to the approach used by the motions judge, can be described as the “formulaic approach”. The other approach, which may be described as the “discretionary approach”, eschews the use of formulae."
:* [http://www.clicklaw.bc.ca/helpmap Clicklaw HelpMap]
</blockquote>


Where there is an external link that has a Clicklaw page, then link to the Clicklaw page. For example:
== Links ==


:<code><nowiki>[http://www.clicklaw.bc.ca/resource/1082 "Your Welfare Rights: A Guide to BC Employment and Assistance"]</nowiki></code>
=== 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.  


This will appear as:
=== External links ===
:* [http://www.clicklaw.bc.ca/resource/1082 "Your Welfare Rights: A Guide to BC Employment and Assistance"]
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.


== Numbers ==
== Numbers ==
Line 160: Line 188:
* Write 3% or three percent but not three % or 3 % with a space.
* Write 3% or three percent but not three % or 3 % with a space.
* Write telephone numbers with dashes: 1-866-565-4526.
* Write telephone numbers with dashes: 1-866-565-4526.
== Dates ==
* Ordinary references to specific dates in a header or body paragraph should list the ''day, month, year,'' in that order: 10 February 2013.
* In the vast majority of circumstances, write out the full name of the month.
* If the date reference is within a table, chart or graphic or ancillary annotation where condensed formatting is desired, the three letter abbreviation for months is acceptable: 10 Feb 2013.
== Times ==
* Ordinary references to specific times in a header or body paragraph should include figures for the hour and minutes (even if "00") separated by a colon: 4:00pm rather than 4pm.
* Use the 12-hour clock.
* Use "am" or "pm" without punctuation, with no space separating a time figure from the letters: 4:30pm rather than 4:30 pm
* Colons separate hours, minutes, and (rarely required) seconds: 4:30pm.
* If the time reference is within a table, chart, or graphic or ancillary annotation where condensed formatting is desired and the time is an even hour, omitting the null minute figures is acceptable: 4pm, 9am–5pm, 12–1pm.
* Use figures (12:45pm) rather than words (twelve forty-five p.m.).
* Phrases such as "o'clock", "noon", or "midnight", should not be used to reference specific times, however they may be used descriptively if it fits the tone: e.g., "A judge won't stay up past midnight to read your 70 page affidavit."
* To express a range of time, use an en dash (–) with no space: 12:00pm–4:30pm.


== Punctuation ==
== Punctuation ==
Line 169: Line 212:
=== Spaces ===
=== Spaces ===
The number of spaces following the terminal punctuation of a sentence in the wiki markup makes no difference, as the MediaWiki software condenses any number of spaces to just one when rendering the page. That said, modern practice is evolving towards just one space following the terminal punctuation of a sentence.
The number of spaces following the terminal punctuation of a sentence in the wiki markup makes no difference, as the MediaWiki software condenses any number of spaces to just one when rendering the page. That said, modern practice is evolving towards just one space following the terminal punctuation of a sentence.
== Acronyms ==
Do not use period marks for acronyms or abbreviations, e.g.:
:British Columbia = BC
:Attorney General = AG
:Ministry of Children and Family Development = MCFD
If a long phrase, term or name of an institution is better referred to by an acronym, help the reader by defining the acronym the first time it is mentioned. Use parenthesis to enclose the acronym, but avoid quotations or periods, e.g.:
:British Columbia Supreme Court (BCSC)
:public legal education and information (PLEI)
:Family Maintenance Enforcement Program (FMEP)


== Word usage ==
== Word usage ==
====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.
====Try an app to help you edit====
[http://www.hemingwayapp.com Hemingway App] is a free online tool that analyzes your writing's readability and identifies possible problems. It can suggest improvements and help with plain language. The Hemingway App shows you a graded score (e.g. Grade 9), and highlights what's hard to read, what words could be simpler, etc. Just paste in your writing the and Hemingway App instantly provides suggestions and tips for improving readability. You can even edit your writing right there and then to see if you can improve it and bring the reading level down. A grade 9 reading level is ideal.
[[File:Hemingway App Screenshot.png| thumb | link=http://www.hemingwayapp.com| Screenshot from www.hemingwayapp.com]]
====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]
===Avoiding legalese===
Avoid using legalese. These words and expressions are to be avoided:
*in respect of
*to defray
===That and which===
Use ''that'' (not ''which'') to introduce a restrictive relative clause (a clause that is essential to the grammar of the sentence).
==="They" as singular===
In 2017, an editorial decision for ''JP Boyd on Family Law'' was made to use "they" as a singular pronoun. "They" should be used instead of "he or she". If the use of "they" feels awkward, consider revising the sentence structure to avoid the use of a pronoun.
For example, acceptable alternatives to writing "if a party fails to respond, he risks default judgment" include:
*"If a party fails to respond, they risk default judgment."
*"If a party fails to respond, that person risks default judgment."
*"A party who fails to respond risks default judgment."
This decision achieves two advantages:
*it is a clear alternative to the arbitrary assignment of gender in scenarios where the law does not treat people differently based on sex or gender identity
*it recognizes that some people do not identify as only a "he" nor a "she"
===Preferred usage for words===
This alphabetical list features the preferred usage for words:
This alphabetical list features the preferred usage for words:
* Aboriginal child
*Aboriginal child
* Aboriginal parent
*Aboriginal parent
* Aboriginal Affairs and Northern Development Canada (AANDC)
*Aboriginal Affairs and Northern Development Canada (AANDC)
* arbitrator
*arbitrator
* BC
*BC
* Clicklaw Wikibook
*birth certificate
* Convention refugee
*Blue Pages (of the phone book)
* court (as in "go to court"), but "Small Claims Court"
*bylaw
* court registry (but "Supreme Court Registry")
*certificate of divorce
* Crown Counsel
*Clicklaw Wikibook
* duty counsel (but "Family Duty Counsel Program" when it's a specific program)
*Convention refugee
* email
*coordination
* Employment Insurance benefits
*cooperate
* Family Court
*court (as in "go to court"), but "Small Claims Court"
* federal government
*court registry (but "Supreme Court Registry")
* Government Agent office
*Court Services Online
* Government of Canada (but government when used generically)
*Crown Counsel
* Guide (as in "this Guide")
*death certificate
* homepage
*driver's licence
* Indian band
*duty counsel (but "Family Duty Counsel Program" when it's a specific program)
* Indian reserve
*ebook
* Internet
*email
* judge
*Employment Insurance benefits
* lawsuit
*Family Court
* legal aid representation ( but "Legal Aid Representation" when it's a specific program)
*family justice counsellor
* Lower Mainland
*family law arbitrators
* Ministry of Social Development (MSD)
*family law mediators
* online
*federal government
* Residential School
*fulfill
* Resource List (as in "see the [[Resource List]] in this Guide for helpful resources")
*Government Agent office
* Small Claims Court
*Government of Canada (but government when used generically)
* Supreme Court
*Guide (as in "this Guide")
* toll-free
*homepage
* tribal council
*Indian band
* trustee in bankruptcy
*Indian reserve
* website
*internet
* workers' advisers
*judge
* Yellow Pages
*judicial case conference
 
*judicial review
*lawsuit
*legal aid representation ( but "Legal Aid Representation" when it's a specific program)
*legal notices section of the newspaper
*licence (noun)
*license (verb)
*Lower Mainland
*marriage certificate
*marriage commissioner
*Ministry of Children and Family Development (MCFD)
*Ministry of Social Development (MSD)
*Old Age Security
*online
*Parenting After Separation Course
*photo ID
*post office
*practice (noun)
*practise (verb)
*reasons for judgment
*Residential School
*Resource List (as in "see the [[Resource List]] in this Guide for helpful resources")
*Small Claims Court
*Supreme Court
*toll-free
*tribal council
*trustee in bankruptcy
*Vital Statistics Agency
*website
*well-being
*workers' advisers
*workers' compensation
*Yellow Pages


{{Template:Navbox for Clicklaw Wikibooks Guide|type=additional}}
{{Template:Navbox for Clicklaw Wikibooks Guide|type=guides}}
<noinclude>__NOGLOSSARY__</noinclude>
[[Category:Clicklaw Wikibooks Guides]]

Latest revision as of 17:19, 25 June 2019

This is a help page for contributors or users.


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 Contributor Guide, which provides guidance on the technical aspects of editing and updating content.

Page titles and in-page headings

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 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, the first letters of 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 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.)

The following points apply to in page headings:

  • Use sentence case for section headings — that is, the initial letter of a title is capitalized; otherwise, capital letters are used only where they would be used in a normal sentence.
  • 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.

Capital letters

In general terms, resist using capital letters, as they hinder the reader when overused.

Legal terms and forms

  • Do not use capital letters for legal terms — e.g., "a retainer agreement is a contract between a lawyer and you"; "a will appoints an executor".
  • Do not use capital letters for party names — e.g., "after the claimant files a claim, the respondent has 14 days to reply".
  • Use capital letters for the names of prescribed court forms — e.g., "the claimant must file a Notice of Family Claim" — but do not use capital letters for general legal forms — e.g., "a power of attorney enables you to appoint someone to look after your financial affairs", or "a parenting coordinator agreement sets out in some detail what the parenting coordinator will do".

Do not use capitals for emphasis

Do not use capital letters for emphasis; where wording alone cannot provide the emphasis, use italics.

Titles of works

Titles of books and other print works are given in title case — that is, the first letters of 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).

Calendar items

  • Months, days of the week, and holidays start with a capital letter — e.g., June, Monday, Christmas.
  • Seasons are in lower case — e.g., last summer, next fall.

Compass points

Do not capitalize directions such as "north", nor their related forms.

Capitalize names of regions if they have attained proper-name status, including informal conventional names — e.g., "Lower Mainland". Do not capitalize descriptive names for regions that have not attained the status of proper names, such as "northern British Columbia".

Institutions

Names of particular institutions are proper nouns and require capitals, but generic words for institutions (e.g., "university", "college", "hospital", "high school") do not.

Italics

Emphasis

Italics may be used sparingly to emphasize words in sentences (whereas bold is normally not used for this purpose). Generally, the more highlighting in a page, the less its effectiveness.

Use italics to bring attention or distinction to a term — e.g., "Whether a party has the right to bring a dispute under a particular act and before a particular court is a question of that party's standing, whereas the ability for a court to hear particular disputes or questions involving particular types of parties is a question of jurisdiction." or "The term ex parte means without notice."

Do not use quotations for emphasis.

Titles

Use italics for the titles of books or publications of greater length (including wikibooks). The titles of articles, chapters, and other short works are not italicized; they are enclosed in double quotation marks. (See examples below.)

Lists

Bulleted lists

Use bulleted lists to break up a list of items. Use numbered lists if the list is a series of steps.

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:

To qualify for disability benefits, you must:
  • be at least 18 years of age,
  • have a severe mental or physical impairment, and
  • need help or supervision because of the disability.

When a list is very brief, you can omit punctuation within the list. For example:

To make scones you need:
  • flour
  • salt
  • butter
  • baking powder


Where the bulleted list has one or more items that are a full sentence or longer, use periods between the items. For example:

Your best bets are:
  • Family Law in BC, for forms, self-help materials and other legal information about family legal issues.
  • Family Justice Centres, to make an appointment with a counsellor to discuss parenting arrangements, contact or support.
  • Family Duty Counsel (Provincial or Supreme), for some assistance on the day you have to appear in court.

Where a heading for a bulleted list item is appropriate, use a colon after the heading, and a period at the end of the item:

  • Common Experience Payment: A CEP is payable to all former students of Residential Schools.
  • Independent Assessment Process: Under this process, a victim of abuse at a Residential School may apply for additional compensation.

Numbered lists

Use numbered lists if the list is a series of steps.

Quotation marks

Use double quotation marks; use single marks for quotes within a quote.

Periods and commas go inside quotation marks, but semicolons and colons go outside.

Do not use quotations for emphasis. Use italics. See Emphasis.

Do not use quotations when clarifying the acronym to be used for a long term. Use parenthesis only. See Acronyms.

References

Case law

When citing a case, use the citation standards in the Canadian Guide to Uniform Legal Citation (7th Edition), known as the McGill Guide. Names or initials of the parties in the style of cause should be italicized, along with v., Re, (ad litem), or any other part of the case name/style of cause. Do not use bold. If the parties are named by initials, use punctuation between the letters. Cite Canadian cases to their neutral citation, and ensure that the link you provide is the short URL resource link provided by CanLII wherever possible. Where no neutral citation is available, use the citation that CanLII provides, and ensure that the parties in the style of cause are as indexed by CanLII. Where a case is not available on CanLII, cite to a printed reporter or electronic service. Examples of acceptable citations:

Case with neutral citation, available on CanLII: Domirti v. Domirti, 2010 BCCA 472
Case with neutral citation, available on CanLII, parties identified by initials: L.S. v. E.P., 1999 BCCA 393
Case with no neutral citation, available on CanLII: Wahl v. Pavle, 1985 CanLII 861 (BCCA)
Case with no neutral citation, not on CanLII: Mareva Compania Naviera S.A. v. International Bulkcarriers S.A., [1980] 1 All E.R. 213

Publications

When referring to a publication that is a book or other longer work, put the title in italics:

Provincial Court Small Claims Handbook

When referring to a wikibook, put the title in italics:

JP Boyd on Family Law

When referring to a publication that is a shorter work like a chapter or fact sheet, put the title in quotation marks:

the fact sheet "Dealing with a Problem Roommate" and the pamphlet "Tenant Info for Renters in British Columbia"

For publication titles, use title case; that is, the first letters of 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).

Direct quotations and excerpts

Think twice about adding paragraphs from reasons for judgment. Pause before pasting in dense legislative text. It may be more helpful to spare the legalese if your readers are still seeking to understand basic legal principles. Cite and link the original law or case on CanLii for deeper study, but consider if you can convey the pith and substance of the law, without the need to regurgitate its chapter and verse.

This said, in some cases it's critical to show readers the exact, verbatim wording from a piece of legislation, court decision, or other source.

Short quotations

Short quotations (less than a paragraph and no more than a few sentences) can be enclosed with quotation marks and reproduced in-line with the text, e.g.:

  • Section 7 of the Guidelines says the court is required to consider "the necessity and reasonableness of the expense in relation to the means of the spouses and those of the child."
  • In Hanson v. Hanson, 1999 CanLII 6307 the Supreme Court of Canada cautioned that the courts cannot sanction "the refusal of a parent to take reasonable steps to support his or her children simply because the parent cannot obtain interesting or highly paid employment."

Longer excerpts

For longer excerpts, use a block format. Clicklaw Wikibooks has two methods for block formatting depending on the type of source.

Block formatting legislation and contracts

Clicklaw Wikibooks uses blockquote tags <blockquote>...</blockquote> (including multiple indentation levels where applicable), and a monospace font () if the excerpt is taken from an act, regulation, contractual agreement or court order (as distinct from reasons for judgment). Doing this distinguishes the codified language and hierarchical structure of these sources compared to the more narrative and natural language flow of other types of content.

A block formatted excerpt in a monospace font looks like this:

s. 19(2) The court may impute such amount of income to a spouse as it considers appropriate in the circumstances, which circumstances include the following:

(b) the spouse is exempt from paying federal or provincial income tax;

(c) the spouse lives in a country that has effective rates of income tax that are significantly lower than those in Canada;

(h) the spouse derives a significant portion of income from dividends, capital gains or other sources that are taxed at a lower rate than employment or business income or that are exempt from tax.

Note that subsections (a-h) have additional indentation.

Block formatting caselaw and regular text

Longer direct quotations of text written in natural language (like court judgments) are also block formatted, but maintain the default typeface. The block formatted indented excerpt is enclosed in quotations. If the excerpt is longer than one paragraph each paragraph begins with an open quote, but only the final paragraph ends with a close quote.

A block formatted excerpt of a typical case looks like this:

In Contino v. Leonelli-Contino, 2005 SCC 63, the Supreme Court of Canada said this about child support payments where there is shared custody:

"[37] The framework of s. 9 requires a two‑part determination: first, establishing that the 40 percent threshold has been met; and second, where it has been met, determining the appropriate amount of support.

"[38] With respect to the second part of the determination [...] courts across the country have struggled to develop an interpretation of s. 9 that is consistent with the Guidelines’ objectives. While the approaches vary widely, they can be divided in two categories. One approach, similar to the approach used by the motions judge, can be described as the “formulaic approach”. The other approach, which may be described as the “discretionary approach”, eschews the use of formulae."

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.

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.

Numbers

  • In general, write whole numbers one through nine as words, and write all other numbers as numerals: one to five; 21 to 30.
  • For currency, don't use numbers after the decimal point: $25.
  • In general, use a comma to delimit numbers with four or more digits to the left of the decimal point: 1,050.
  • Write 3% or three percent but not three % or 3 % with a space.
  • Write telephone numbers with dashes: 1-866-565-4526.

Dates

  • Ordinary references to specific dates in a header or body paragraph should list the day, month, year, in that order: 10 February 2013.
  • In the vast majority of circumstances, write out the full name of the month.
  • If the date reference is within a table, chart or graphic or ancillary annotation where condensed formatting is desired, the three letter abbreviation for months is acceptable: 10 Feb 2013.

Times

  • Ordinary references to specific times in a header or body paragraph should include figures for the hour and minutes (even if "00") separated by a colon: 4:00pm rather than 4pm.
  • Use the 12-hour clock.
  • Use "am" or "pm" without punctuation, with no space separating a time figure from the letters: 4:30pm rather than 4:30 pm
  • Colons separate hours, minutes, and (rarely required) seconds: 4:30pm.
  • If the time reference is within a table, chart, or graphic or ancillary annotation where condensed formatting is desired and the time is an even hour, omitting the null minute figures is acceptable: 4pm, 9am–5pm, 12–1pm.
  • Use figures (12:45pm) rather than words (twelve forty-five p.m.).
  • Phrases such as "o'clock", "noon", or "midnight", should not be used to reference specific times, however they may be used descriptively if it fits the tone: e.g., "A judge won't stay up past midnight to read your 70 page affidavit."
  • To express a range of time, use an en dash (–) with no space: 12:00pm–4:30pm.

Punctuation

Em dashes between words

Use an em dash when you want to indicate added emphasis, a break in a sentence, or an abrupt change of thought. For example, "In matters of importance, sincerity — not style — is the vital thing."

To form an em dash on most PCs, hold down the ALT key while typing 0151. On a Mac, hold down the ALT key and SHIFT key while typing the dash (-).

Spaces

The number of spaces following the terminal punctuation of a sentence in the wiki markup makes no difference, as the MediaWiki software condenses any number of spaces to just one when rendering the page. That said, modern practice is evolving towards just one space following the terminal punctuation of a sentence.

Acronyms

Do not use period marks for acronyms or abbreviations, e.g.:

British Columbia = BC
Attorney General = AG
Ministry of Children and Family Development = MCFD

If a long phrase, term or name of an institution is better referred to by an acronym, help the reader by defining the acronym the first time it is mentioned. Use parenthesis to enclose the acronym, but avoid quotations or periods, e.g.:

British Columbia Supreme Court (BCSC)
public legal education and information (PLEI)
Family Maintenance Enforcement Program (FMEP)

Word usage

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:

  1. Think about your reader and question what they know or don't know.
  2. Think about questions your readers will have on the topic, and organize your thoughts accordingly.
  3. Summarize main points using headers.
  4. Organize steps or similar information with lists.
  5. Write brief sentences and keep paragraphs short.
  6. Use common phrases and words.
  7. Avoid unnecessary descriptive adverbs and words.
  8. Write in the active voice and keep verb and subject close together.
  9. Ask another reader to evaluate your writing.

Try an app to help you edit

Hemingway App is a free online tool that analyzes your writing's readability and identifies possible problems. It can suggest improvements and help with plain language. The Hemingway App shows you a graded score (e.g. Grade 9), and highlights what's hard to read, what words could be simpler, etc. Just paste in your writing the and Hemingway App instantly provides suggestions and tips for improving readability. You can even edit your writing right there and then to see if you can improve it and bring the reading level down. A grade 9 reading level is ideal.

Screenshot from www.hemingwayapp.com

More on plain language writing

Avoiding legalese

Avoid using legalese. These words and expressions are to be avoided:

  • in respect of
  • to defray

That and which

Use that (not which) to introduce a restrictive relative clause (a clause that is essential to the grammar of the sentence).

"They" as singular

In 2017, an editorial decision for JP Boyd on Family Law was made to use "they" as a singular pronoun. "They" should be used instead of "he or she". If the use of "they" feels awkward, consider revising the sentence structure to avoid the use of a pronoun. For example, acceptable alternatives to writing "if a party fails to respond, he risks default judgment" include:

  • "If a party fails to respond, they risk default judgment."
  • "If a party fails to respond, that person risks default judgment."
  • "A party who fails to respond risks default judgment."

This decision achieves two advantages:

  • it is a clear alternative to the arbitrary assignment of gender in scenarios where the law does not treat people differently based on sex or gender identity
  • it recognizes that some people do not identify as only a "he" nor a "she"


Preferred usage for words

This alphabetical list features the preferred usage for words:

  • Aboriginal child
  • Aboriginal parent
  • Aboriginal Affairs and Northern Development Canada (AANDC)
  • arbitrator
  • BC
  • birth certificate
  • Blue Pages (of the phone book)
  • bylaw
  • certificate of divorce
  • Clicklaw Wikibook
  • Convention refugee
  • coordination
  • cooperate
  • court (as in "go to court"), but "Small Claims Court"
  • court registry (but "Supreme Court Registry")
  • Court Services Online
  • Crown Counsel
  • death certificate
  • driver's licence
  • duty counsel (but "Family Duty Counsel Program" when it's a specific program)
  • ebook
  • email
  • Employment Insurance benefits
  • Family Court
  • family justice counsellor
  • family law arbitrators
  • family law mediators
  • federal government
  • fulfill
  • Government Agent office
  • Government of Canada (but government when used generically)
  • Guide (as in "this Guide")
  • homepage
  • Indian band
  • Indian reserve
  • internet
  • judge
  • judicial case conference
  • judicial review
  • lawsuit
  • legal aid representation ( but "Legal Aid Representation" when it's a specific program)
  • legal notices section of the newspaper
  • licence (noun)
  • license (verb)
  • Lower Mainland
  • marriage certificate
  • marriage commissioner
  • Ministry of Children and Family Development (MCFD)
  • Ministry of Social Development (MSD)
  • Old Age Security
  • online
  • Parenting After Separation Course
  • photo ID
  • post office
  • practice (noun)
  • practise (verb)
  • reasons for judgment
  • Residential School
  • Resource List (as in "see the Resource List in this Guide for helpful resources")
  • Small Claims Court
  • Supreme Court
  • toll-free
  • tribal council
  • trustee in bankruptcy
  • Vital Statistics Agency
  • website
  • well-being
  • workers' advisers
  • workers' compensation
  • Yellow Pages