FlightGear wiki:Style guide – Article disposition: Difference between revisions

Jump to navigation Jump to search
→‎Article disposition: + References section; + Clarifications on good ways to link to related and external resources; + Links to relevant templates and categories
(+- first section → lead section)
(→‎Article disposition: + References section; + Clarifications on good ways to link to related and external resources; + Links to relevant templates and categories)
 
Line 17: Line 17:
=== Subheading ===
=== Subheading ===
Some text...
Some text...
== References ==
<references />


== Related content ==
== Related content ==
Line 23: Line 26:


=== Forum topics ===
=== Forum topics ===
* [Some_link_to_a_forum_topic Forum topic title] - Some description
* {{forum link|t=Some topic number|title=Some forum topic title}} - Some description


=== Mailing list threads ===
=== Mailing list threads ===
Line 29: Line 32:


=== Source code ===
=== Source code ===
* [Some_link_to_a_forum topic] - Some description
* {{Some repository template}} - Some description


== External links ==
== External links ==
Line 44: Line 47:


; Infobox or navbox
; Infobox or navbox
: Often an ''infobox'' or ''navbox'' will follow.  An ''infobox'' will contain more detailed information about a piece of software, an aircraft, an airport etc. that is the topic of the article and a ''navbox'' could help the reader find his way around a series of or similar articles.
: Often an ''infobox'' or ''navbox'' will follow.  An ''infobox'' will contain more detailed information about a piece of software, an aircraft, an airport etc. that is the topic of the article and a ''navbox'' could help the reader find his way around a series of or similar articles. See also [[:Category:Infobox templates]] and [[:Category:Navigation templates]]


; Images
; Images
Line 50: Line 53:


; Lead section
; Lead section
: The ''lead section'' of an article should be a ''short summary'' of the article.  Preferably the '''page title in bold''' should be within the first sentence of the lead section.
: The ''lead section'' or ''introduction'' should be a ''short summary'' of the article.  Preferably the '''page title in bold''' should be within the first sentence of the lead section.
: '''''Note''': This short summary of the article should help a reader to quickly figure out if he found the page he was looking for, as well as help him grasp the main concepts of the article.''
: '''''Note''': This short summary of the article should help a reader to quickly figure out if he found the page he was looking for, as well as help him grasp the main concepts of the article.''


; Article text
; Article text
: The article text that follows is preferably broken up in not too long, but not too short ''sections''.  Often it would help the reader if there are images  and tables to help understand the article text.  Sometimes it is a good thing to mark more some important words differently.
: The article text that follows is preferably broken up in not too long, but not too short ''sections''.  Often it would help the reader if there are images  and tables to help understand the article text.  Sometimes it is a good thing to mark more some important words differently.
; References
: If you have references to sources in your article, consider using using <code><nowiki><ref></nowiki></code> tags and a ''References'' section.
: If you have several references to different pages or sections in your sources you can split up the references section into a ''Footnotes'' and a ''Sources'' subsection, listing the footnotes with <code><nowiki><references /></nowiki></code> and the sources with links, {{tl|cite web}}, {{tl|forum link}} etc. 


; Links to related content
; Links to related content
: ''Links'' to related FlightGear resources, like other articles, forum topics, source files etc. can be put in the end, though in general it is preferable to have internal wikilinks within the article text the first time a concept or term is mentioned.
: ''Links'' to related FlightGear resources, like other articles, forum topics, source files etc. can be put in the end, though in general it is preferable to have internal wikilinks within the article text the first time a concept or term is mentioned.
: For links to forum topics, please use {{tl|forum link}}.
: For links to source code files, please use some of the [[:Category:Repository link templates|repository link templates]] as these more easily can be updated if FlightGear move the source from one host to another.
: For links to source code files, please use some of the [[:Category:Repository link templates|repository link templates]] as these more easily can be updated if FlightGear move the source from one host to another.


; Links to external resources
; Links to external resources
: Links to external resources should be put at the very end of the article.
: Links to external resources should be put at the very end of the article, for example using {{tl|cite web}}.


; Navbox
; Navbox
: Many pages end with a ''navbox'' with for example other aircraft by the same manufacturer.
: Many pages end with a ''navbox'' with for example other aircraft by the same manufacturer. See also [[:Category:Navigation templates]]


; Language links and categories
; Language links and categories

Navigation menu