Help:Formatting: Difference between revisions

Jump to navigation Jump to search

Help:Formatting (view source)

Revision as of 23:10, 28 November 2013

3,720 bytes added ,  28 November 2013
Rewritten the page all the way down to the Links heading
m (Johan G moved page Help:Tutorial to Help:Editing: Moving page to more fitting name, see Help:Editing#Rewrite and move to Help:Editing)
(Rewritten the page all the way down to the Links heading)
Line 1: Line 1:
The Wiki is a collaboratively edited document. This tutorial may help you to understand how to write content using the software.
The basics of '''editing''' the wiki will be gone through on this help page.  You, the users, can collaboratively edit this wiki and help each other out to extend and improve this wiki.


The following pages will discuss  features of Wiki, giving style and content guidance, information about the Wiki community, and important Wiki policies and conventions.
== Typical article layout ==
;Messageboxes
:A typical article page could begin with one or more ''messageboxes'' telling the reader something about the article, like that it is outdated due to new developments.


This is a basic ''tutorial'', not an extensive manual.
;Infobox or navbox
:The message boxes are often followed by either a ''infobox'' about a software, an aircraft etc. or a ''navbox'' to help the reader find his way around an article series.


==Formatting==
;Short summary
'''Formatting Wiki articles''' is a bit different from writing on a standard word processor. Instead of a strict ("what you see is what you get") approach, Wiki uses text codes to create particular elements of the page (e.g. headings). This "language" is known as '''Wikitext''' (or '''Wiki-markup''') and is designed for ease of editing.
:An ''short summary'' of the article should precede the article text, even before the first heading, preferably containing the '''title of the article in bold''' within the first sentence.  This summary would help a reader to quickly figure out if he found the page he was looking for, as well as help a him grasp the main concepts of an article a bit faster.
 
;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.
 
;Links
:''Links'' to related content and to external resources should be put in the end, though in general having the internal links within the article text is preferable.
 
;Navbox
:Many pages end with a ''navbox'' with for example other aircraft by the same manufacturer.
 
;Language links and categories
All articles should end with one or more ''categories'', who often is preceded by ''language links''.
 
<nowiki>{{Some messagebox}}
{{Some infobox or navbox}}
 
A '''generic article layout''' would be something like this.
 
== Heading ==
Some text...
 
== Related content ==
* [[Some page]]
 
== External links ==
* [Some link] Some description
 
{{Some navbox}}
 
[[en:Some language link]]
 
[[Category:Some category]]</nowiki>
 
== Basic text formatting ==
Wiki editing is a bit different from editing text in a word processor.  You will not see what the text will look like until you click the preview button.  In order to have the text human editable it uses a markup language that is considerably simpler than the HTML that is used in the resulting web page.  This markup is often called wiki markup or wikitext and is the same one as the one used on Wikipedia which uses the same software, MediaWiki.


=== Bold and italics ===
=== Bold and italics ===
The most commonly used wiki tags are '''bold''' and ''italics''. '''Bolding''' and ''italicizing'' are done by surrounding a word or phrase with multiple apostrophes (<tt>'</tt>):
Bold and italics are marked using two, three or five apostrophes '''<nowiki>'</nowiki>''' on each side of the text section to be emphasized.


{| style="border:none; text-align:left;"
{| class="wikitable" width="60%"
|-<!--COLUMN HEADINGS-->
! width="30%" | What you type
| style="background:#E6F2FF; padding:0.3em; text-align:center;"|'''You type'''
! width="30%" | What you get
| style="background:#E6F2FF; padding:0.3em; text-align:center;"|'''You get'''
|-
|-<!--1ST ROW-->
|
|<tt><nowiki>''italic''</nowiki></tt>
<nowiki>''Italics''</nowiki>
|''italic''
| ''Italics''
|-<!--2ND ROW-->
|-
|
<nowiki>'''Bold'''</nowiki>
| '''Bold'''
|-
|
|
<tt><nowiki>'''bold'''</nowiki></tt>
<nowiki>'''''Bold italics'''''</nowiki>
|'''''Bold italics'''''
|}
 
=== A few useful HTML tags ===
Yes you can use HTML tags in a wiki page.  Usually it is not needed, but in a few cases they can be very helpful.
 
{| class="wikitable" width="60%"
! width="30%" | What you type
! width="30%" | What you get
|-
|
|
'''bold'''
<nowiki>V<sub>NE</sub></nowiki>
|-<!--3RD ROW-->
| V<sub>NE</sub>
|-
|
|
<tt><nowiki>'''''bold italic'''''</nowiki></tt>
<nowiki>ft<sup>2</sup></nowiki>
| ft<sup>2</sup>
|-
|
<nowiki><!-- Comment --></nowiki>
|
|}
 
Apart from the HTML tags there is also some wiki tags, a few of them more useful than the others.
 
{| class="wikitable" width="60%"
! width="30%" | What you type
! width="30%" | What you get
|-
|
|
'''''bold italic'''''
<nowiki>&lt;nowiki&gt;'''Bold'''&lt;/nowiki&gt;</nowiki>
| <nowiki>'''Bold'''</nowiki>
|}
|}


===Headings and subheadings===
== Lists and indentation ==
Headings and subheadings are an easy way to improve the organization of an article. If you can see two or more distinct topics being discussed, you can break up the article by inserting a heading for each '''section'''.
Lists and numbered lists can be done in wiki markup. Unfortunately numbered lists can not be started from an arbitrary number. Do note that both list and indentation markup must start right at the left margin.
 
Indentation is usually the way that comments from different users are separated.


Headings can be created like this:
{| class="wikitable" width="60%"
! width="30%" | What you type
! width="30%" | What you get
|-
|
<nowiki>* Item
** Item
*** Item</nowiki>
|
* Item
** Item
*** Item
|-
|
<nowiki># Item
# Item
## Item
## Item
### Item</nowiki>
|
# Item
# Item
## Item
## Item
### Item
|-
|
<nowiki># Item
#* Item
#* Item
# Item
#* Item</nowiki>
|
# Item
#* Item
#* Item
# Item
#* Item
|-
|
<nowiki>;Term
:Definition


* <tt><nowiki>== Heading ==</nowiki></tt>
;Term:  Definition</nowiki>
* <tt><nowiki>=== Subheading ===</nowiki></tt>
|
;Term
:Definition


If an article has at least four headings, a table of contents will automatically be generated.
;Term:  Definition


=== HTML ===
|-
HTML code can be used in pages to produce more advanced formatting such as colors, tables, and edit page layout. However, you do not need to know HTML to use Wiki and follow formatting conventions.
|
<nowiki>No indentation
:Indentation
::Indentation</nowiki>
|
No indentation
:Indentation
::Indentation
|}




==Wiki links==
=== Headings and subheadings ===
Headings and subheadings are an easy way to improve the organization of an article.  If you can see two or more distinct topics being discussed, you can break up the article in sections by inserting headings.  There are several heading levels, of which level one is reserved for the page title. Do note that heading markup must start right at the left margin.
 
If a page has more than four headings a table of contents will be generated automatically.  In some cases you might want one even before that.  That can be done by adding the magic word <code><nowiki>__TOC__</nowiki></code>.  In some rare cases you would want to suppress the table of contents generation.  That can be done with another magic word, <code><nowiki>__NOTOC__</nowiki></code>, though this is most often undesirable.
 
Having the page broken up in sections will make it easier for the reader to find his way around the page, as well as help him understand the context of the page and how the pieces fits together.
 
{| class="wikitable" width="60%"
! width="30%" | What you type
! width="30%" | What you get
|-
|
<nowiki>== Level 2 ==</nowiki>
|
== Level 2 ==
|-
|
<nowiki>=== Level 3 ===</nowiki>
|
=== Level 3 ===
|-
|
<nowiki>==== Level 4 ====</nowiki>
|
==== Level 4 ====
|}
 
== Links ==
'''Linking''' Wiki articles together is very important. These easily created links allow users to access information related to the article they are reading and greatly add to Wiki's utility.
'''Linking''' Wiki articles together is very important. These easily created links allow users to access information related to the article they are reading and greatly add to Wiki's utility.


===When to link===
=== When to link ===
The easiest way to learn when to link may be to look at Wiki articles for examples.
The easiest way to learn when to link may be to look at Wiki articles for examples.


===How to link===
=== How to link ===
If you want to make a link to another Wiki page (called a <em>wiki link</em>) you have to put it in double square brackets, like this:
If you want to make a link to another Wiki page (called a <em>wiki link</em>) you have to put it in double square brackets, like this:
:<tt><nowiki>[[Aircraft]]</nowiki></tt> = [[Aircraft]]
:<tt><nowiki>[[Aircraft]]</nowiki></tt> = [[Aircraft]]
Line 65: Line 212:
Please check your links to ensure they point to the correct article.
Please check your links to ensure they point to the correct article.


===Categories===
=== Categories ===
You can also put the article in a category with others in a related topic. Just type <nowiki>[[Category:]]</nowiki>, and put the name of the category between the colon and the brackets.
You can also put the article in a category with others in a related topic. Just type <nowiki>[[Category:]]</nowiki>, and put the name of the category between the colon and the brackets.


Line 76: Line 223:
:[[:Category:Aircraft]]
:[[:Category:Aircraft]]


===Redirects===
=== Redirects ===
Pages need redirects if:
Pages need redirects if:
* they have abbreviations (eg. ''HUD'' redirect to ''Head-up display'').
* they have abbreviations (eg. ''HUD'' redirect to ''Head-up display'').
Retrieved from "https://wiki.flightgear.org/Special:MobileDiff/64862"

Navigation menu