329
edits
FlightGear wiki:Manual of Style: Difference between revisions
Jump to navigation
Jump to search
Merged FlightGear_wiki:Style_guide; minor fixes
(→Related content: + FlightGear wiki:FlightGear screenshot categories, Template:Informative template) |
(Merged FlightGear_wiki:Style_guide; minor fixes) |
||
| Line 1: | Line 1: | ||
{{shortcut|FGW:MOS}} | {{shortcut|FGW:MOS}} | ||
| Line 8: | Line 7: | ||
== Article titles, headings, and sections == | == Article titles, headings, and sections == | ||
=== Article titles === | === Article titles === | ||
* Use sentence case, not title case. The initial letter of a title is capitalized (except in rare cases, such as eBay), but otherwise, capital letters are used only where they would be used in a normal sentence ({{xt|List of developed airports}}, not {{!xt|List of Developed Airports}}). | * Use sentence case, not title case. The initial letter of a title is capitalized (except in rare cases, such as eBay), but otherwise, capital letters are used only where they would be used in a normal sentence ({{xt|List of developed airports}}, not {{!xt|List of Developed Airports}}). Also, keep in mind that the wiki software automatically capitalizes the initial letter of a namespace/page title in its address. | ||
* Titles should be precise enough to unambiguously define the topical scope of the article ({{xt|Boeing 747}}, not {{!xt|747}}). | * Titles should be precise enough to unambiguously define the topical scope of the article ({{xt|Boeing 747}}, not {{!xt|747}}). | ||
* The characters <code># < > [ ] | { }</code> are reserved by the wiki software and can not be used. | |||
=== Section organization === | === Section organization === | ||
| Line 32: | Line 32: | ||
===Calendar items=== | ===Calendar items=== | ||
* '''Months, days of the week, and holidays''' start with a capital letter ({{xt|June}}, {{xt|Monday}}. | * '''Months, days of the week, and holidays''' start with a capital letter ({{xt|June}}, {{xt|Monday}}). | ||
===Celestial bodies=== | ===Celestial bodies=== | ||
* When used generally, the words '''<nowiki />''sun'', ''earth'', and ''moon''<nowiki />''' do not take capitals ({{xt|The sun was peeking over the mountain top}}, except when the term names a specific astronomical body ({{xt|The Moon orbits the Earth}}. | * When used generally, the words '''<nowiki />''sun'', ''earth'', and ''moon''<nowiki />''' do not take capitals ({{xt|The sun was peeking over the mountain top}}), except when the term names a specific astronomical body ({{xt|The Moon orbits the Earth}}). | ||
===Compass points=== | ===Compass points=== | ||
| Line 109: | Line 109: | ||
==== Specific recommendations ==== | ==== Specific recommendations ==== | ||
*Using too many quotes is incompatible with the encyclopedic writing style. | * Using too many quotes is incompatible with the encyclopedic writing style. | ||
*As a matter of style, quoteboxes should generally be avoided as they draw special attention to the opinion of one source, and present that opinion as though the project endorses it. Instead of using quoteboxes to highlight its notability, explain its importance before introducing the quote or in an introduction to the quote. | * As a matter of style, quoteboxes should generally be avoided as they draw special attention to the opinion of one source, and present that opinion as though the project endorses it. Instead of using quoteboxes to highlight its notability, explain its importance before introducing the quote or in an introduction to the quote. | ||
*The wiki is not a list or repository of loosely associated topics such as quotations. | * The wiki is not a list or repository of loosely associated topics such as quotations. | ||
*Do not insert any number of quotations in a stand-alone quote section. | * Do not insert any number of quotations in a stand-alone quote section. | ||
*A quotation that does not directly relate to the topic of the article or directly support the information as it is presented should not be used. | * A quotation that does not directly relate to the topic of the article or directly support the information as it is presented should not be used. | ||
*Intersperse quotations with original prose that comments on those quotations instead of constructing articles out of quotations with little or no original prose. | * Intersperse quotations with original prose that comments on those quotations instead of constructing articles out of quotations with little or no original prose. | ||
*Longer quotations may be hidden in the reference as a footnote to facilitate verification by other editors without sacrificing readability. | * Longer quotations may be hidden in the reference as a footnote to facilitate verification by other editors without sacrificing readability. | ||
== Punctuation == | == Punctuation == | ||
| Line 266: | Line 266: | ||
'''Initial capitalization:''' The wiki software does not require that wikilinks begin with an upper-case character. Only capitalize the first letter where this is naturally called for. | '''Initial capitalization:''' The wiki software does not require that wikilinks begin with an upper-case character. Only capitalize the first letter where this is naturally called for. | ||
'''Linking in discussion pages:''' When adding a wikilink to a discussion page, it is preferable to use [[Help:Formatting#Permalinks_and_links_to_diffs|permalinks]] instead of ordinary links, since the content may have changed a lot before the next reader reads the comment. To highlight a specific edit, it might also be useful to link to a [[Help:Formatting#Permalinks_and_links_to_diffs|diff]]. | |||
=== External links === | === External links === | ||
Do not use external links in the body of an article. Articles can include an ''external links'' section at the end, pointing to further information outside the wiki as distinct from citing sources. The standard format is a primary heading, <code>==External links==</code>, followed by a bulleted list of links. Identify the link and briefly indicate its relevance to the article. For example: | Do not use external links in the body of an article. Articles can include an ''external links'' section at the end, pointing to further information outside the wiki as distinct from citing sources. The standard format is a primary heading, <code>==External links==</code>, followed by a bulleted list of links. Identify the link and briefly indicate its relevance to the article: avoid linking to commercial and unrelated web sites, in essence ''spam''. For example: | ||
:<code><nowiki>* [http://flightgear.org Official website]</nowiki></code> | :<code><nowiki>* [http://flightgear.org Official website]</nowiki></code> | ||
:<code><nowiki>* [ | :<code><nowiki>* [https://sourceforge.net/p/flightgear/codetickets/ Bug tracker]</nowiki></code> | ||
These will appear as: | These will appear as: | ||
:* [http://flightgear.org Official website] | :* [http://flightgear.org Official website] | ||
:* [ | :* [https://sourceforge.net/p/flightgear/codetickets/ Bug tracker] | ||
== Miscellaneous == | == Miscellaneous == | ||
| Line 306: | Line 308: | ||
== Reference == | == Reference == | ||
This document contains a selection of relevant sections from [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia:Manual of Style] | This document contains a selection of relevant sections from [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia:Manual of Style]. | ||
== Related content == | == Related content == | ||