FamilySearch Wiki:Manual of Style: Difference between revisions
(→Draft Pages or Sandboxes: copyedit, plus add {{further}} link) |
WilliamsDa (talk | contribs) (added instructions about article titles) |
||
Line 9: | Line 9: | ||
{{main|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. <br> | {{main|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. <br> | ||
*No two articles may have the same title. <br> | *'''Unique titles.''' No two articles may have the same title. <br> | ||
*A wiki search should be done for the proposed title to ensure that there is not an existing article with that title. <br> | *A wiki search should be done for the proposed title to ensure that there is not an existing article with that title.<br> | ||
*Remove any unnecessary words or punctuation. A | *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. <br> | *You may want to run it by experienced wiki contributors. <br> | ||
Line 148: | Line 150: | ||
== Draft Pages or Sandboxes == | == Draft Pages or Sandboxes == | ||
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. | 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}} | ||
{{further|FamilySearch Wiki:About the Sandbox}} | |||
== Related articles == | == Related articles == | ||
{{policies and guidelines}} | {{policies and guidelines}} |
Revision as of 10:03, 17 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]
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.
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.
Punctuation[edit | edit source]
Do not end the title with punctuation.
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]
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]
- FamilySearch Wiki:Linking
- Help:Create an internal link
- Help:Create an external link
- Help:Advanced Linking
- Help:Section - the content under "Section linking" appears to be incorrect. A review is needed.
- Help:Wiki markup
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]
- See Category:Metatemplates for a list of metatemplates available for use
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]
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]
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
Related articles[edit | edit source]
|