Difference between revisions of "CpapWiki:Manual of Style"
(→Capitalization) |
(→Capitalization) |
||
Line 44: | Line 44: | ||
== Capitalization == | == Capitalization == | ||
− | + | Capital letters should not be used for emphasis. Use italics instead. | |
:{|style="background:transparent" | :{|style="background:transparent" | ||
|-valign=top | |-valign=top | ||
− | |''Incorrect'': || | + | |''Incorrect'': ||Capital letters should Not be used for emphasis. Use italics instead. |
|-valign=top | |-valign=top | ||
− | |''Incorrect'': || | + | |''Incorrect'': ||Capital letters should NOT be used for emphasis. Use italics instead. |
|-valign=top | |-valign=top | ||
− | |''Correct'': || | + | |''Correct'': ||Capital letters should ''not'' be used for emphasis. Use italics instead. |
|} | |} | ||
Revision as of 11:49, 15 October 2008
The Manual of Style is intended to bring some general guidelines to the way articles and pages should be formatted and structured to help make the CPAPtalk.com CPAP Wiki better. One of the nice things about a wiki is that edits do not have to be perfect since they may always be changed for correction or improvement later on. These guidelines are not "law", but will serve to make the site more uniform, and therefore easier to use. Editors should try to follow these guidelines but there are always exceptions to every rule. Above all, use common sense.
Contents
Article titles
In choosing a title for a new page or article, use the following guidelines.
- Use English.
- Use the singular.
- Avoid special characters.
- Avoid using a, an, or the as the first word.
- Avoid abbreviations.
If the wrong name is chosen for a title, the page can be moved by a Sysop, which will automatically create a redirect from the old title to the new title. Redirects should also be made from all other entries someone might type when looking for your article.
First sentence
The article should begin with a straightforward, declarative first sentence that will help the reader understand what the article contains.
As a general rule, the first (and only the first) appearance of the page title should be in the first sentence, as soon as possible, and should be bolded. Use as few links as possible before and in the bolded title.
If the subject of the page has a common abbreviation or more than one name, the abbreviation (in parenthesis) and each additional name should be bolded on its first appearance.
Sections and headers
Headings provide a table of contents and allow for quick navigation of the article. Here are some guidelines for section titles and headers.
- Try not to change section headings (and sub-headings) too often, because other articles may have linked to a section and changing it would break those links. If you do change a section name, try to find what links to that section and fix the broken links.
- Section names should be unique within a page. This also applies to subsections. Duplication of section names may result in a user arriving at the wrong point on the page after an edit, and may cause difficulty in understanding the page history, or linking to the proper section.
- Links should not be used in headings. Instead link the first appearance of the word in a sentence.
- Capitalize the first word only. Exceptions are proper nouns (names given to individual people, places, companies, or brands), which should be capitalized in a section name, or header.
- Section titles should not be bolded.
- Do not italicize the section name, unless it needs italics (for example: a book title).
- Do not use special characters in headings.
- Try to keep the section title short with preferably 10 words, or less.
- Do not use the title of the whole article as a heading.
- A blank line below the heading is optional. If there are no blank lines above the heading, one line should be added, for readability in the edit window. Only two or more blank lines above or below will change the public appearance of the page by adding more white space.
Capitalization
Capital letters should not be used for emphasis. Use italics instead.
Incorrect: Capital letters should Not be used for emphasis. Use italics instead. Incorrect: Capital letters should NOT be used for emphasis. Use italics instead. Correct: Capital letters should not be used for emphasis. Use italics instead.