FamilySearch Wiki:Manual of Style: Difference between revisions
(Fix links) |
m (fix cat) |
||
| Line 1: | Line 1: | ||
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. | 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 == | == General Principles == | ||
| Line 7: | Line 7: | ||
=== Name a new article === | === Name a new article === | ||
{{main|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. Remove any unnecessary words or punctuation. You may want to run it by experienced wiki contributors. | {{main|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. Remove any unnecessary words or punctuation. You may want to run it by experienced wiki contributors. A correctly formated name for a new article can be very helpful to users. | ||
==== Place names | ==== Place names ==== | ||
Unlike most genealogy software place name conventions, Include the word "county" in the title of an article about a particular county. | Unlike most genealogy software place name conventions, Include the word "county" in the title of an article about a particular county. | ||
==== Abbreviations | ==== Abbreviations ==== | ||
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. | 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]]. | For more information about naming conventions, see also [[Help:Naming conventions]]. | ||
| Line 39: | Line 39: | ||
==== Capitalization ==== | ==== Capitalization ==== | ||
=== | === Source Citations === | ||
=== Geographical Names === | === Geographical Names === | ||
| Line 45: | Line 45: | ||
A proposed style guideline ''[[FamilySearch Wiki:Naming Conventions for Geographic Names|Naming Conventions for Geographic Names]]'' is being [[FamilySearch Wiki talk:Naming Conventions for Geographic Names|discussed]]. Once a [[FamilySearch Wiki:Consensus|consensus]] is reached a guideline will be adopted. | A proposed style guideline ''[[FamilySearch Wiki:Naming Conventions for Geographic Names|Naming Conventions for Geographic Names]]'' is being [[FamilySearch Wiki talk:Naming Conventions for Geographic Names|discussed]]. Once a [[FamilySearch Wiki:Consensus|consensus]] is reached a guideline will be adopted. | ||
=== Acronyms and Abbreviations | === Acronyms and Abbreviations === | ||
== Linking == | == Linking == | ||
| Line 105: | Line 103: | ||
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|Maryland page]], click '''Edit''', and switch to Wikitext view. To see an example of portal code, go to the [http://en.wikipedia.org/wiki/Portal:India India portal on Wikipedia] and click '''Edit this page'''. For more about this topic, see [[FamilySearch Wiki:The Un-Portal Page |The Un-Portal Page]]. | 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|Maryland page]], click '''Edit''', and switch to Wikitext view. To see an example of portal code, go to the [http://en.wikipedia.org/wiki/Portal:India India portal on Wikipedia] and click '''Edit this page'''. For more about this topic, see [[FamilySearch Wiki:The Un-Portal Page |The Un-Portal Page]]. | ||
{{policies and guidelines}} | |||
Revision as of 05:25, 17 April 2010
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]
Naming[edit | edit source]
Name a new article[edit | edit source]
- Main article: 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. Remove any unnecessary words or punctuation. You may want to run it by experienced wiki contributors. A correctly formated name for a new article can be very helpful to users.
Place names[edit | edit source]
Unlike most genealogy software place name conventions, Include the word "county" in the title of an article about a particular county.
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.
Rename an existing article[edit | edit source]
- Main article: Renaming pages
Naming subheadings within articles[edit | edit source]
Formatting[edit | edit source]
Character Formatting[edit | edit source]
Bold[edit | edit source]
Italics[edit | edit source]
Underline[edit | edit source]
Because the use of underline frequently indicates text with a hyperlink that can be clicked to learn more, do not use underline as a way to emphasize text.
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]
interwiki
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.
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]
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]
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.
| ||||||||||||||||||||||||