Difference between revisions of "FlightGear wiki:Writing about aircraft"

From FlightGear wiki
Jump to: navigation, search
(Subpages: Better navbar documentation.)
m (cat: FlightGear wiki style guides)
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The so called ''aircraft pages'' on the wiki are used to introduce the [[:Category:Controllable craft|controllable craft]] to new FlightGear users — including [[:Category:All aircraft|aircraft]], [[:Category:All spacecraft|spacecraft]], [[:Category:All seacraft|seacraft]], and [[:Category:All vehicles|vehicles]] — as well as serve as an easy to read reference for experienced users.
+
{{Wiki help navbar}}
  
== Aircraft infobox ==
+
The '''aircraft articles''' on the wiki are used to introduce the [[:Category:Controllable craft|controllable craft]] to new FlightGear users — including [[:Category:All aircraft|aircraft]], [[:Category:All spacecraft|spacecraft]], [[:Category:All seacraft|seacraft]], and [[:Category:All vehicles|vehicles]] — as well as serve as an easy to read reference for experienced users.
  
 +
== Aircraft infobox ==
 
The main and very first element of the craft pages is the {{tl|infobox aircraft}} template.  This provides a large amount of information about the FlightGear craft, including:
 
The main and very first element of the craft pages is the {{tl|infobox aircraft}} template.  This provides a large amount of information about the FlightGear craft, including:
  
 
* Craft name.
 
* Craft name.
* The hangar the craft can be found in (if one exists).
+
* The optional [[FlightGear hangars|hangar]] the craft belongs to.
* 1 or 2 ideal screenshots (or splash screen) of the craft.
+
* 1 or 2 ideal [[:Category:FlightGear screenshots|screenshots]] (or a splash screen) of the craft.
* The craft type, configuration, propulsion and manufacturer information.
+
* The craft [[Template:Infobox aircraft#Craft types|type]], [[Template:Infobox aircraft#Craft configurations|configuration]], [[Template:Infobox aircraft#Craft propulsion|propulsion]] and [[Template:Infobox aircraft#Craft manufacturer|manufacturer]] information.
 
* The author list.
 
* The author list.
* FDM type.
+
* [[Flight Dynamics Model|FDM type]].
 
* The command line name of the craft.
 
* The command line name of the craft.
* The development status.
+
* The [[Aircraft rating system|development status]].
 
* The [[Template:Infobox aircraft#Ready icons|ready icons]] that some craft developers like to use.
 
* The [[Template:Infobox aircraft#Ready icons|ready icons]] that some craft developers like to use.
 
* The development hanger (e.g. if the craft from a 3rd party hangar is hosted in [[FGAddon]]), development website, and development repository.
 
* The development hanger (e.g. if the craft from a 3rd party hangar is hosted in [[FGAddon]]), development website, and development repository.
 
* A download link.
 
* A download link.
* Livery database and forum thread links.
+
* [[FlightGear livery database|Livery database]] and [https://forum.flightgear.org forum] thread links.
* Licensing information.
+
* [[Template:Infobox aircraft#Licensing|Licensing information]].
* The craft type.
+
* The craft category ([[:Category:All aircraft|aircraft]], [[:Category:All spacecraft|spacecraft]], [[:Category:All seacraft|seacraft]], [[:Category:All vehicles|vehicle]]).
  
=== Subpages ===
+
For complete details, please read the {{tl|infobox aircraft}} documentation.
  
To help with translations — so that there is only a single aircraft infobox used for different language pages of the aicraft — subpages and transclusion should be used.  Please see the comprehensive documentation at {{tl|Infobox aircraft#Translations - using subpages}}.
+
=== Aircraft infobox subpage ===
 +
To help with translations — so that there is only a single aircraft infobox used for the different language pages of the craft — [https://www.mediawiki.org/wiki/Help:Subpages subpages] and [https://www.mediawiki.org/wiki/Transclusion transclusion] should be used.  Please see the comprehensive documentation at {{tl|Infobox aircraft#Translations - using subpages}}. To summarise, the first text of the default English article should be:
  
 +
<syntaxhighlight lang="moin">
 +
{{:{{PAGENAME}}/info}}
 +
</syntaxhighlight>
  
== Lower case first letter ==
+
If the aircraft infobox subpage does not already exist, an edit link to the subpage will be added to the article.
  
 +
== If the first title letter is lowercase ==
 
Some craft, for example the [[de Havilland Canada DHC-6 Twin Otter]], begin with a lower case letter.  To handle this, the very first text on the page should be the {{tl|lowercase title}} template.  For ideal spacing, it should be on the same line as the aircraft infobox transclusion:
 
Some craft, for example the [[de Havilland Canada DHC-6 Twin Otter]], begin with a lower case letter.  To handle this, the very first text on the page should be the {{tl|lowercase title}} template.  For ideal spacing, it should be on the same line as the aircraft infobox transclusion:
  
<syntaxhighlight lang="xml">
+
<syntaxhighlight lang="moin">
 
{{lowercase title}}{{:{{PAGENAME}}/info}}
 
{{lowercase title}}{{:{{PAGENAME}}/info}}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
== The lead section ==
 +
The [[Help:Your first article#The lead section|lead section]] should not have a section heading - skipping the heading will place it at the top of the article above the automatically generated TOC (table of contents).
  
== Introduction text ==
+
The name of the aircraft should be bold and in the beginning of the first sentence, for example <code><nowiki>The '''de Havilland Canada DHC-6 Twin Otter''' is a...</nowiki></code>.  The lead section should describe the physical craft as well as some basic information about the craft as developed for FlightGear.
 
+
The introduction text should describe the physical craft as well as some basic information about the craft as developed for FlightGear.  This text should not be within a wiki section - that will allow for the automatically generated TOC (table of contents) to be placed below it.
+
  
 
== Keytable ==
 
== Keytable ==
 
+
For reference, the keyboard shortcuts for the craft should be tabulated.  For this, a [[Help:Tables|table]] with the custom <code>"keytable"</code> class is used together with the {{tl|key press}} template.  For example:
For reference, the keyboard shortcuts for the craft should be tabulated.  For this, a wiki table with the "keytable" class is used together with the {{tl|key press}} template.  For example:
+
  
 
<syntaxhighlight lang="moin">
 
<syntaxhighlight lang="moin">
 
{| class="keytable"
 
{| class="keytable"
!Key
+
! Key
!Function
+
! Function
 
|-
 
|-
 
| {{key press|c}}
 
| {{key press|c}}
Line 58: Line 63:
  
 
{| class="keytable"
 
{| class="keytable"
!Key
+
! Key
!Function
+
! Function
 
|-
 
|-
 
| {{key press|c}}
 
| {{key press|c}}
Line 68: Line 73:
 
|}
 
|}
  
== Review ==
+
== Reviews ==
 
+
Some users like to perform reviews of the FlightGear craft, and this information can be quite useful for new users.  This should be placed below the craft information in its own <code><nowiki>== Review ==</nowiki></code> section.  The {{tl|date}} template can be placed at the start of the review text - the date stamp will allow the reader to check if the review matches the current craft.
Some users like to perform reviews of the FlightGear craft, and this information can be quite useful for new users.  This should be placed below the craft information in its own '''<nowiki>== Review ==</nowiki>''' section.  The {{tl|date}} template can be placed at the start of the review text - the date stamp will allow the reader to check if the review matches the current craft.
+
 
+
=== Subpages ===
+
  
 +
=== Review subpages ===
 
For those feeling ambitious, the review text could even be placed in a wiki subpage.  So in [[Piper PA-32]], for example, the main article could be structured as:
 
For those feeling ambitious, the review text could even be placed in a wiki subpage.  So in [[Piper PA-32]], for example, the main article could be structured as:
  
Line 114: Line 117:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Note the different heading levels ('''==''' vs. '''===''').  A signature or name attached to the review text is not necessary, as that is clearly visible in the history (especially when the review is encapsulated in a subpage).  Eventually a template for standardising the review subpage could be created (that would contain the date, text, and navbar elements).
+
Note the different heading levels (<code><nowiki>==</nowiki></code> vs. <code><nowiki>===</nowiki></code>).  A signature or name attached to the review text is not necessary, as that is clearly visible in the history (especially when the review is encapsulated in a subpage).  Eventually a template for standardising the review subpage could be created (that would contain the date, text, and navbar elements).
  
 
In the above example, the following MediaWiki code uses the {{tl|navbar}} template to add view, talk page, and edit links to the end of the review text:
 
In the above example, the following MediaWiki code uses the {{tl|navbar}} template to add view, talk page, and edit links to the end of the review text:
Line 127: Line 130:
  
 
== Gallery ==
 
== Gallery ==
 
+
The best way to show off the craft is to create a gallery of awesome [[:Category:FlightGear screenshots|screenshots]].  This is placed in its own <code><nowiki>== Gallery ==</nowiki></code> section near the bottom of the article.  These can be [[Help:Upload|uploaded to the wiki]], and then linked to using the [https://www.mediawiki.org/wiki/Help:Images#Rendering_a_gallery_of_images MediaWiki &lt;gallery&gt; tag].  For example, from the [[Cessna 172P]]:
The best way to show off the craft is to create a gallery of awesome screenshots.  This is placed in its own '''<nowiki>== Gallery ==</nowiki>''' section near the bottom of the article.  These can be [[Special:UploadWizard|uploaded to the wiki]], and then linked to using the &lt;gallery&gt; tag.  For example, from the [[Cessna 172P]]:
+
  
 
<syntaxhighlight lang="moin">
 
<syntaxhighlight lang="moin">
Line 149: Line 151:
  
 
== Additional sections ==
 
== Additional sections ==
 
 
Feel free to create new sections as required for documenting the craft.
 
Feel free to create new sections as required for documenting the craft.
 +
 +
== Manufacturer navigation templates ==
 +
For those craft built by well known manufactures, search for and add the corresponding [[:Category:Manufacturer navigation templates|Manufacturer navigation template]] to the bottom of the craft page.  For example for Cessna aircraft, use:
 +
 +
<syntaxhighlight lang="moin">
 +
{{cessna}}
 +
</syntaxhighlight>
 +
 +
To add the following {{tl|navbox}}:
 +
 +
{{cessna}}
 +
 +
If the craft is not listed in the manufacturer navigation template yet, click on the "E" editing link in the navbox.
 +
 +
[[Category:Wiki style guides‎]]

Latest revision as of 17:05, 23 March 2020


The aircraft articles on the wiki are used to introduce the controllable craft to new FlightGear users — including aircraft, spacecraft, seacraft, and vehicles — as well as serve as an easy to read reference for experienced users.

Aircraft infobox

The main and very first element of the craft pages is the {{infobox aircraft}} template. This provides a large amount of information about the FlightGear craft, including:

For complete details, please read the {{infobox aircraft}} documentation.

Aircraft infobox subpage

To help with translations — so that there is only a single aircraft infobox used for the different language pages of the craft — subpages and transclusion should be used. Please see the comprehensive documentation at {{Infobox aircraft#Translations - using subpages}}. To summarise, the first text of the default English article should be:

{{:{{PAGENAME}}/info}}

If the aircraft infobox subpage does not already exist, an edit link to the subpage will be added to the article.

If the first title letter is lowercase

Some craft, for example the de Havilland Canada DHC-6 Twin Otter, begin with a lower case letter. To handle this, the very first text on the page should be the {{lowercase title}} template. For ideal spacing, it should be on the same line as the aircraft infobox transclusion:

{{lowercase title}}{{:{{PAGENAME}}/info}}

The lead section

The lead section should not have a section heading - skipping the heading will place it at the top of the article above the automatically generated TOC (table of contents).

The name of the aircraft should be bold and in the beginning of the first sentence, for example The '''de Havilland Canada DHC-6 Twin Otter''' is a.... The lead section should describe the physical craft as well as some basic information about the craft as developed for FlightGear.

Keytable

For reference, the keyboard shortcuts for the craft should be tabulated. For this, a table with the custom "keytable" class is used together with the {{key press}} template. For example:

{| class="keytable"
! Key
! Function
|-
| {{key press|c}}
| Show/hide cockpit.
|-
| {{key press|Ctrl|w}}
| Center nose wheel.
|}

This results in:

Key Function
c Show/hide cockpit.
Ctrl+w Center nose wheel.

Reviews

Some users like to perform reviews of the FlightGear craft, and this information can be quite useful for new users. This should be placed below the craft information in its own == Review == section. The {{date}} template can be placed at the start of the review text - the date stamp will allow the reader to check if the review matches the current craft.

Review subpages

For those feeling ambitious, the review text could even be placed in a wiki subpage. So in Piper PA-32, for example, the main article could be structured as:

{{:{{PAGENAME}}/info}}

<!-- introduction text -->

== Review ==
{{:{{PAGENAME}}/review}}

== V Speeds ==
<!-- info -->

== Gallery ==
<gallery mode="packed">
<!-- screenshots -->
</gallery>

Then the subpage Piper PA-32/review could be created with the structure:

{{date|2016|10|16}}

=== The Model ===
<!-- text -->

=== Interior ===
<!-- text -->

=== Flying ===
<!-- text -->

=== Improvements needed ===
<!-- text -->

<div style="text-align: right">{{navbar|:{{#titleparts: {{PAGENAME}} | | -1}}/review|text=This review:}}</div>

Note the different heading levels (== vs. ===). A signature or name attached to the review text is not necessary, as that is clearly visible in the history (especially when the review is encapsulated in a subpage). Eventually a template for standardising the review subpage could be created (that would contain the date, text, and navbar elements).

In the above example, the following MediaWiki code uses the {{navbar}} template to add view, talk page, and edit links to the end of the review text:

<div style="text-align: right">{{navbar|:{{#titleparts: {{PAGENAME}} | | -1}}/review|text=This review:}}</div>

To produce:

Gallery

The best way to show off the craft is to create a gallery of awesome screenshots. This is placed in its own == Gallery == section near the bottom of the article. These can be uploaded to the wiki, and then linked to using the MediaWiki <gallery> tag. For example, from the Cessna 172P:

<gallery mode="packed">
c172p-preview5.jpg|Cessna 172P high over Italy
c172p-preview7.jpg|PT-IAO on a soft dirt runway 
c172p-preview0.jpg|Panel view, about to take off
</gallery>

This results in:

Alternatively the {{gallery}} template can be used, though this has been made redundant by the far more flexible MediaWiki <gallery> tag.

Additional sections

Feel free to create new sections as required for documenting the craft.

Manufacturer navigation templates

For those craft built by well known manufactures, search for and add the corresponding Manufacturer navigation template to the bottom of the craft page. For example for Cessna aircraft, use:

{{cessna}}

To add the following {{navbox}}:

If the craft is not listed in the manufacturer navigation template yet, click on the "E" editing link in the navbox.