FamilySearch Wiki:Manual of Style: Difference between revisions

From FamilySearch Wiki
(added measurements section)
(added currncies section)
Line 248: Line 248:
Major editing work on a page that will not be finished for an extended time may confuse visitors to the page. To avoid this, it is recommend that lengthy or long term editing preparations are worked on in a [[FamilySearch Wiki:Sandbox|sandbox]] you create. Be sure to add a link in the "Discussion" page of where the planned changes will be posted, to the sandbox where the planned changes are being worked on. This will allow comments on the new content until it is moved from the sandbox page to the page that needs the changes. {{further|FamilySearch Wiki:About the Sandbox}}  
Major editing work on a page that will not be finished for an extended time may confuse visitors to the page. To avoid this, it is recommend that lengthy or long term editing preparations are worked on in a [[FamilySearch Wiki:Sandbox|sandbox]] you create. Be sure to add a link in the "Discussion" page of where the planned changes will be posted, to the sandbox where the planned changes are being worked on. This will allow comments on the new content until it is moved from the sandbox page to the page that needs the changes. {{further|FamilySearch Wiki:About the Sandbox}}  


<br>


== Measurements  ==


== Measurements ==
'''Metric or U.S.''' If measurements are needed, they can be written in metric or U.S. systems. The same system should be used throughout the article. It is recommended that the contributor provide the measurement in both systems. Metric may be listed first with the U.S. equivalent in parentheses, or the U.S. measurement may be listed first with the metric equivalent in parentheses. The same order should be used throughout the article. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: Many narrow-gauge railroads in the Maine forests were 2 ft (610 mm) wide. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: Many narrow-gauge railroads in the Maine forests were 610 mm (2 ft) wide. <br>


'''Metric or U.S.''' If measurements are needed, they can be written in metric or U.S. systems. The same system should be used throughout the article. It is recommended that the contributor provide the measurement in both systems. Metric may be listed first with the U.S. equivalent in parentheses, or the U.S. measurement may be listed first with the metric equivalent in parentheses. The same order should be used throughout the article. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: Many narrow-gauge railroads in the Maine forests were 2 ft (610 mm) wide. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: Many narrow-gauge railroads in the Maine forests were 610 mm (2 ft) wide. <br>
'''Including a unit.''' Always include the unit of measurement with the number (for example, yard, meter, quart, and so on). Standard abbreviations may be used if they do not have more than one meaning.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: Staten Island in New York City covers 59 square miles (153 square kilometers). <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: Staten Island in New York City covers 59 sq mi (153 km2).<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Incorrect: Staten Island in New York City covers 59m. <br><br>  


'''Including a unit.''' Always include the unit of measurement with the number (for example, yard, meter, quart, and so on). Standard abbreviations may be used if they do not have more than one meaning.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: Staten Island in New York City covers 59 square miles (153 square kilometers). <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: Staten Island in New York City covers 59 sq mi (153 km2).<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Incorrect: Staten Island in New York City covers 59m. <br><br>
== Currencies  ==
 
'''Listing costs of services.''' When referring users to a site or institution that charges for its services, it is appropriate to let users know there will be a charge. However, because prices change often, it is best to avoid listing the exact cost of the services. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: There is a fee to get a copy of a deceased ancestor’s Social Security application. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Incorrect: There is a US$27-$29 fee to get a copy of a deceased ancestor’s Social Security application.  
 
'''Identifying the currency listed.''' If it is important to indicate an amount of money, indicate both the amount and which currency is listed (Canadian dollars, Japanese yen, Mexican pesos, British pounds, and so on). Frequently, an abbreviation for the country is listed in front of the amount (for example, US$25). The original price and the equivalent in today’s money may be listed. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: In 1800, a private in the British infantry was paid 1 shilling a day. <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Correct: For the Louisiana Territory, the United States paid France US$15,000,000.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Incorrect: For the Louisiana Territory, the United States paid France almost $190 million in today’s money. <br><br>
 
<br>  


== Related articles  ==
== Related articles  ==


{{policies and guidelines}}
{{policies and guidelines}}

Revision as of 21:12, 20 June 2011

A style guide or style manual is a set of standards for design and writing of documents, either for general use or for a specific publication or organization. Web site style guides focus on a publication's visual and technical aspects, prose style, best usage, grammar, punctuation, spelling, and fairness. The consistent use of style guidelines provides uniformity in style and formatting of wiki articles, which makes the articles easier for readers to understand and use.

General Principles[edit | edit source]

Respectful interactions. Comments and editing should be made with respect for other users and contributors.

Alternate opinions of information. How genealogists do family history is very individualized. Rather than editing and reediting and article, alternate information or methods may be added in a section such as "Other ways to find the information".

Appropriate content. Content and images must be appropriate to the FamilySearch Research Wiki. Inappropriate content or links will be removed.

Neutrality. Articles should be as neutral as possible. Descriptions should be factual and avoidnegative or positive judgements ("settlers from western Europe" rather than "poor, uneducated peasants"). Hype should be avoided ("The greatest thing since sliced bread!").

Simplicity. Writing should be clear and simple. When a term is used that may be unfamiliar to people (for example, gazetteer), it should be defined the first time it appears in the body of an article. Avoid using specialized terms or acronymns when a common term is available. As much as possible, the information should be understandable for every user, even if English is not the user's first language.

Naming[edit | edit source]

Name a new article[edit | edit source]

Main article: FamilySearch Wiki:Name a new article

Before creating a new article, take the time to think of a name that clearly explains in a few words the content of the article.

  • Unique titles. No two articles may have the same title.
  • A wiki search should be done for the proposed title to ensure that there is not an existing article with that title.
  • Avoid duplication of articles. If an article already exists for the same topic, contributors should edit the existing article rather than create a new article.
  • Specific but short titles. Titles should be as short as possible but specific enugh that users can identify the topic of the article when it appears in the search results. Avoid clever but unclear titles. Remove any unnecessary words or punctuation.
  • Common terms. Titles should use common terms that users might search for. A well formatted name for a new article can be very helpful to users and make it easier for search engines to guide users to the most relevant wiki article.
  • You may want to run it by experienced wiki contributors.

Capitalization in titles
[edit | edit source]

In titles, use sentence-style capitalization, which means that only the first word and proper nouns are capitalized. (For some wiki capabilities, sentence capitalization is required.) Do not list words all in capitals unless the word is an acronym.

  Exception: The historical records collections in FamilySearch.org use book title capitalization.

                 Correct: Cemetery records for St. Joseph County, Michigan

                 Correct: Finding newspaper records

                 Incorrect: Finding Newspaper Records

                 Correct: Using GEDCOM files to share family history

                 Incorrect: FAMILY HISTORY CENTERS

                 Correct: Canada Ontario Births (FamilySearch Historical Records)

Place names[edit | edit source]

Places listed in ascending order. If a city or county is listed in a title, at least the state, province, or country where the place is located should also be listed. The place is listed in ascending order (smallest place to largest). Unlike most genealogy software place name conventions, Include the word "county" in the title of an article about a particular county.

  Exception: The titles of historical records collections in FamilySearch.org list places in descending order.

                 Correct: Utah Salt Lake County Death Registers (FamilySearch Historical Records)

                 Correct: Canada Ontario Births (FamilySearch Historical Records)

Places that have had different names or jurisdictions. If a place has had more than one name or been in more than one jurisdiction (county, state, province, country and so on), the current name and jurisdiction should be used in the title. If the article gives information about the place only when it had a specific name or jurisdiction, use those in the title. Redirects can be used to make sure users will find the article regardless of the name or jurisdiction they search for.

Non English place names. Generally, if a country is listed in the title, use the English name (for example, Germany rather than Deutschland). Search engines pull up a different list of articles depending on the place that is listed in the title. Redirects can be used to make sure users will find the article regardless of which spelling is used.

Places and dates in titles. If the place, country, or time period is important to the content of the article, include them in the title of the article. Add the word county in the title if the article is about a county.

                 Correct: Birth records for Farmington, Utah, from 1890 to 1925

                 Correct: Orange County, California

                 Incorrect: Orange, California

Diacritics and quotation marks
[edit | edit source]

In article titles, you may use words with diacritics or letters that do not appear in the English alphabet however, the search engine may not display the article if users search for the English version of the word. Quotation marks should be avoided in article titles.

Punctuation
[edit | edit source]

Do not end the title with punctuation.

                 Correct: Finding newspaper records

                 Incorrect: Finding newspaper records.

Abbreviations
[edit | edit source]

Abbreviations, including US postal codes, should not be used in article titles or text because abbreviations can mean different things in different parts of the world. For example, the abbreviation CA could mean either California or Canada, depending on the reader's nationality.

For more information about naming conventions, see also Help:Naming conventions.

Italics[edit | edit source]

In a title, italicize only the titles of books and ships.

Rename an existing article[edit | edit source]

Renaming (moving) an article or page means giving it another name. In other words, the content on a page contained under one title is moved to a new page with a different title. The page is "renamed." Renaming an existing article may be desired if you find that the article title was misspelled or is ambiguous.

Main article: Help:Renaming a page


Naming subheadings within articles[edit | edit source]

Organizing information. In an article, subheadings or sections should be used to organize the content and keep similar information together. Subheadings should help users scan an article to find the information they need.

Guidelines for subheadings/section titles. Use the guidelines for article titles with the following differences.


Formatting[edit | edit source]

Character Formatting[edit | edit source]

Font[edit | edit source]

Regardless of the font you paste into the wiki edit screen, your work will be saved in the system's default font.

Bold[edit | edit source]

In rare cases, if a word must be emphasized, use bold.

Italics[edit | edit source]

Use italics if a word must be emphasized. List book titles in italics. Do not use italics for quoted text.

Underline[edit | edit source]

Because the use of underline indicates text with a hyperlink that can be clicked to learn more, do not use underline as a way to emphasize text.Do not underline book titles.

Capitalization[edit | edit source]

Source Citations[edit | edit source]

Geographical Names[edit | edit source]

A proposed style guideline Naming Conventions for Geographic Names is being discussed. Once a consensus is reached a guideline will be adopted.

Acronyms and Abbreviations[edit | edit source]

Linking[edit | edit source]

Main article: FamilySearch Wiki:Linking


Linking to other articles in FamilySearch wiki[edit | edit source]

Linking through the use of page section templates[edit | edit source]

Other possible templates to create include:

  • {{Subarticle}} - see Wikipedia's Template:Subarticle for details
  • {{Cat also}} - see Wikipedia's Template:Cat also for details

Linking through the use of metatemplates[edit | edit source]

Linking to other Websites[edit | edit source]

Links should not display the full URL[edit | edit source]

Many URLs (website addresses) are long and not reader-friendly. For readability's sake, links should not include the full URL of the destination page. There may be extremely rare instances where displaying the full URL is desirable, but this should be the exception, not the rule, and should be done only if there is a compelling reason.

Example 1: a link by itself[edit | edit source]

Correct: FamilySearch

Incorrect: http://www.familysearch.org/eng/default.asp

Example 2: a link in context[edit | edit source]

Correct: Order United States military records online.

Incorrect: Go to https://eservices.archives.gov/orderonline/start.swe?SWECmd=GotoView&SWEView=GPEA+Product+Detail+-+Features+View+FFO&SWEHo=eservices.archives.gov&SWETS=1199728061&SWEPostnApplet=GPEA+Product+Form

https://eservices.archives.gov/orderonline/start.swe?SWECmd=GotoView&SWEView=GPEA+Product+Detail+-+Features+View+FFO&SWEHo=eservices.archives.gov&SWETS=1199728061&SWEPostnApplet=GPEA+Product+Form to order United States military records online.

Click here to order United States military records online.

Clearly, the first link is much easier to read, takes less space, and helps users understand what they will find by clicking the link.

Free web sites[edit | edit source]

"For pay" web sites[edit | edit source]

If you refer to a subscription website or one which has a charge to obtain information, use the "$" to indicate that there may be a fee for the site.

OCLC/WorldCat[edit | edit source]

Using the {{WorldCat}} template for these links will allow the links to be easily updated if the web address changes.

FHLC[edit | edit source]

Using the {{FHL}} template for these links will allow the links to be easily updated if the web address changes.

Record Search[edit | edit source]

Using the {{RecordSearch}} template for these links will allow the links to be easily updated if the web address changes.

Wikipedia[edit | edit source]

Using the {{Wikipedia}} template for these links will allow the links to be easily updated if the web address changes.

Maps[edit | edit source]

Preferred terms[edit | edit source]

Preferred terms. The following terms are preferred.

FamilySearch.org or the FamilySearch website

                 (Do not refer to the website as FamilySearch. Legally, FamilySearch is the name of the organization responsible for FamilySearch.org and other family history projects.)

                 Correct: You can search historical record collections at FamilySearch.org.

                 Incorrect: You can search historical record collections at FamilySearch.

FamilySearch Research Wiki (just "wiki" is also acceptable)

                 Correct: Creating a new article in the FamilySearch Research Wiki

                 Incorrect: Creating a new article in the FamilySearch wiki

Latin abbreviations. Do not use ca., etc., e.g., or viz. Use simple English instead.

                 ca. (Use "about")

                 e.g. (Use "for example.")

                 etc. (Use "and so on" or "and so forth.")

                 i.e. (This term actually means "that is," and is often used incorrectly to mean "for example." Depending on meaning, use "that is," "such as," or "for example.")

                 viz. (Use "namely.")

Box layout: columns vs. portals[edit | edit source]

Authors desiring to display a wiki page's content in boxes should use tables within columns instead of using sub-pages within portals. To see the code that allows one to layout columns and tables, go to the Maryland page, click Edit, and switch to Wikitext view. To see an example of portal code, go to the India portal on Wikipedia and click Edit this page. For more about this topic, see The Un-Portal Page.

Draft Pages or Sandboxes[edit | edit source]

Major editing work on a page that will not be finished for an extended time may confuse visitors to the page. To avoid this, it is recommend that lengthy or long term editing preparations are worked on in a sandbox you create. Be sure to add a link in the "Discussion" page of where the planned changes will be posted, to the sandbox where the planned changes are being worked on. This will allow comments on the new content until it is moved from the sandbox page to the page that needs the changes.

Further information: FamilySearch Wiki:About the Sandbox


Measurements[edit | edit source]

Metric or U.S. If measurements are needed, they can be written in metric or U.S. systems. The same system should be used throughout the article. It is recommended that the contributor provide the measurement in both systems. Metric may be listed first with the U.S. equivalent in parentheses, or the U.S. measurement may be listed first with the metric equivalent in parentheses. The same order should be used throughout the article.
                 Correct: Many narrow-gauge railroads in the Maine forests were 2 ft (610 mm) wide.
                 Correct: Many narrow-gauge railroads in the Maine forests were 610 mm (2 ft) wide.

Including a unit. Always include the unit of measurement with the number (for example, yard, meter, quart, and so on). Standard abbreviations may be used if they do not have more than one meaning.
                 Correct: Staten Island in New York City covers 59 square miles (153 square kilometers).
                 Correct: Staten Island in New York City covers 59 sq mi (153 km2).
                 Incorrect: Staten Island in New York City covers 59m.

Currencies[edit | edit source]

Listing costs of services. When referring users to a site or institution that charges for its services, it is appropriate to let users know there will be a charge. However, because prices change often, it is best to avoid listing the exact cost of the services.
                 Correct: There is a fee to get a copy of a deceased ancestor’s Social Security application.
                 Incorrect: There is a US$27-$29 fee to get a copy of a deceased ancestor’s Social Security application.

Identifying the currency listed. If it is important to indicate an amount of money, indicate both the amount and which currency is listed (Canadian dollars, Japanese yen, Mexican pesos, British pounds, and so on). Frequently, an abbreviation for the country is listed in front of the amount (for example, US$25). The original price and the equivalent in today’s money may be listed.
                 Correct: In 1800, a private in the British infantry was paid 1 shilling a day.
                 Correct: For the Louisiana Territory, the United States paid France US$15,000,000.
                 Incorrect: For the Louisiana Territory, the United States paid France almost $190 million in today’s money.


Related articles[edit | edit source]