Help:Formatting: Difference between revisions

Jump to navigation Jump to search
editing → formatting + some minor changes
m (Johan G moved page Help:Editing to Help:Formatting: More appropriate title for the page)
(editing → formatting + some minor changes)
Line 1: Line 1:
This page is about '''editing''' a wiki page.  We will go through the general disposition of articles on this wiki, basic wiki editing, when and how to add links to other wiki pages and articles as well as a few other things.  The more advanced editing are will not be dealt with on this page though.
This page is about '''formatting''' the text on a wiki page.  We will go through the general disposition of articles on this wiki, basic wiki formatting or ''markup'', when and how to add links to other wiki pages and articles as well as a few other things.  The more advanced formatting are will only be briefly mentioned on this page though.


== Typical article disposition ==
== Typical article disposition ==
;Messageboxes
Consider this a recommendationThough most of the articles follow this convention some don't.
:One or more ''messageboxes'' could sometimes begin typical article pageThe messageboxes would tell a reader or editor something about the article, like for example that it is outdated due to new developments.


;Infobox or navbox
<nowiki>{{Some messagebox}}
: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.
{{Some other messagebox}}


;First section
{{Some infobox or navbox}}
:The ''first section'' of an article should be a ''short summary'' of the article or an ingress.  Preferably the '''page title in bold''' should be within the first sentence or the first section.
:This short summary of the article 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
[[File:Some image.jpg|thumb|Some caption.]]
:All articles should end with one or more ''categories''. They are preceded by ''language links'', if there is any translations of that page.
[[File:Some other image.jpg|thumb|Some other caption]]
 
<nowiki>{{Some messagebox}}
{{Some infobox or navbox}}


A '''generic article disposition''' would look something like this.
A '''generic article disposition''' would look something like this.


== Heading ==
== Heading ==
Some text...
=== Subheading ===
Some text...
Some text...


Line 43: Line 31:


[[Category:Some category]]</nowiki>
[[Category:Some category]]</nowiki>
;Messageboxes
:One or more ''messageboxes'' could sometimes begin typical article page.  The messageboxes would tell a reader or editor something about the article, like for example that it is outdated due to new developments.
;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.
;Images
:Many articles would be helped by additional images.  While it is often a good idea to have at least one of them on top of the article, as this will help a reader to figure out if he landed on the right article and what it is about.  While they can all be in the beginning of the article text, they can just as well be spread out within the article.  Most of the time having just thumbnail images will be preferable.
;First section
:The ''first section'' of an article should be a ''short summary'' of the article or an ingress.  Preferably the '''page title in bold''' should be within the first sentence or the first section.
:This short summary of the article 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'' separated by headings and subheadings.  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 to related content
:''Links'' to related content, like other articles forum topics etc. can be put in the end, though in general having the internal wikilinks within the article text is preferable.
;Links to external resources
:Links to external resources should be put at the very end of the article.
;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''. They are preceded by ''language links'', if there is any translations of that page.


== Preview and edit summary ==
== Preview and edit summary ==
Line 48: Line 64:


You are highly encouraged to always add an edit summary as this will help follow the changes done to a page.
You are highly encouraged to always add an edit summary as this will help follow the changes done to a page.
You can mark edits as being a minor edit if they are very small, like spelling corrections or changing things not visible in the page, like adding, changing or removing categories or language links.


== Basic text formatting ==
== 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.
Wiki formatting is a bit different from formatting 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.


=== Paragraphs ===
=== Paragraphs ===

Navigation menu