Difference between revisions of "Wiki editing guide"

From UnReal World Wiki
Jump to: navigation, search
(A guide to editing the wiki)
 
Line 1: Line 1:
UrW wiki uses [https://www.mediawiki.org/wiki/MediaWiki mediawiki] which has a lot of helpful guides and tutorials on [https://www.mediawiki.org/wiki/Help:Editing_pages how to edit a page]. Another useful source for tutorials are [https://en.wikipedia.org/wiki/Help:Contents wikipedia]'s help pages. In this guide, I try to list some useful tips for editing a page and I'll also add links to mediawiki's help page on the subject in the section headers'. In UrW wiki, edits are limited to registered users to avoid vandalism.
+
UrW wiki uses [https://www.mediawiki.org/wiki/MediaWiki MediaWiki] which has a lot of helpful guides and tutorials on [https://www.mediawiki.org/wiki/Help:Editing_pages how to edit a page]. Another useful source for tutorials are [https://en.wikipedia.org/wiki/Help:Contents Wikipedia's] help pages. In this guide, I try to list some useful tips for editing a page and I'll also add links to mediawiki's help page on the subject in the section headers'. In UrW wiki, edits are limited to registered users to avoid vandalism.
  
 
An even shorter guide is wikipedia's [[wikipedia:Help:Cheatsheet|cheatseet]].
 
An even shorter guide is wikipedia's [[wikipedia:Help:Cheatsheet|cheatseet]].
Line 7: Line 7:
 
After you're logged in, you can press the edit tab on the top of an article, or the edit links available next to sections. Also, when clicking a red link, i.e. a link to page that doesn't exist, you are taken to the edit tab of that article.
 
After you're logged in, you can press the edit tab on the top of an article, or the edit links available next to sections. Also, when clicking a red link, i.e. a link to page that doesn't exist, you are taken to the edit tab of that article.
  
For the most part, editing the wiki is really easy: most of the editing is simply writing text, and if you don't know how to do something, you can just check how the it's done in another page (or another mediawiki altogether). Links to other articles in the wiki are generally just words in square brackets, and infoboxes are also often easy to update, you'll just have to find the correct variable to modify (or add it if it's missing). Tables and images/files are a bit more tricky.
+
For the most part, editing the wiki is really easy: most of the editing is simply writing text, and if you don't know how to do something, you can just check how it's done in another page (or another mediawiki altogether). Links to other articles in the wiki are generally just words in square brackets, and infoboxes are also often easy to update, you'll just have to find the correct variable to modify (or add it if it's missing). Tables and images/files are a bit more tricky.
  
 
Next up are some quick tips to things you'll find in the wiki including links, tables, images, templates and infoboxes.
 
Next up are some quick tips to things you'll find in the wiki including links, tables, images, templates and infoboxes.
Line 22: Line 22:
  
  
You can italicize text by using <nowiki>''</nowiki> on both side of the word or words you want to italicize. Bolding text works similarly but you'll just use <nowiki>'''</nowiki> instead. For example:
+
You can italicize text by using <nowiki>''</nowiki> on both sides of the word or words you want to italicize. Bolding text works similarly but you'll just use <nowiki>'''</nowiki> instead. For example:
 
* <nowiki>''Italic text''</nowiki> gives ''Italic text''
 
* <nowiki>''Italic text''</nowiki> gives ''Italic text''
 
* <nowiki>'''Bold text'''</nowiki> gives '''Bold text'''
 
* <nowiki>'''Bold text'''</nowiki> gives '''Bold text'''
  
You can force the end of a section with <nowiki><div style="clear: both"></div></nowiki>, e.g. if you have image's you want to have in a certain section. There's an example of how image's work if the section is not ended in the images section of this article.
+
You can force the end of a section with <nowiki><div style="clear: both"></div></nowiki>, e.g. if you have images you want to have in a certain section. There's an example of how images work if the section is not ended in the images section of this article.
  
 
===[https://www.mediawiki.org/wiki/Help:Links Links]===
 
===[https://www.mediawiki.org/wiki/Help:Links Links]===
  
Links to other pages in the wiki are marked by writing a pair of square brackets on both sides of the other articles title, e.g.
+
Links to other pages in the wiki are marked by writing a pair of square brackets on both sides of the other article's title, e.g.
  
 
* <nowiki>[[Watercraft]]</nowiki> Links to the page [[Watercraft]]
 
* <nowiki>[[Watercraft]]</nowiki> Links to the page [[Watercraft]]
 
* <nowiki>[[Watercraft]]s</nowiki> Also links to the page [[Watercraft]]. This time the link looks like this though: [[Watercraft]]s
 
* <nowiki>[[Watercraft]]s</nowiki> Also links to the page [[Watercraft]]. This time the link looks like this though: [[Watercraft]]s
* <nowiki>[[Watercraft|punts and rafts]]</nowiki> Also links to the page [[Watercraft]]. The page that is linked to is simply separated by a | sign and the actual link looks like this: [[Watercraft|punts and rafts]].
+
* <nowiki>[[Watercraft|punts and rafts]]</nowiki> Also links to the page [[Watercraft]]. The page that the link is to is simply separated by a | sign and the actual link looks like this: [[Watercraft|punts and rafts]].
 
* <nowiki>[[Linen undershirt]]</nowiki> Links to the page [[Linen undershirt]]
 
* <nowiki>[[Linen undershirt]]</nowiki> Links to the page [[Linen undershirt]]
 
* <nowiki>[[Linen Undershirt]]</nowiki> Notice the capital letter in Undershirt. This links to the page [[Linen Undershirt&redirect=no|Linen Undershirt]] which is different than the previous page and doesn't exist or is a redirect.
 
* <nowiki>[[Linen Undershirt]]</nowiki> Notice the capital letter in Undershirt. This links to the page [[Linen Undershirt&redirect=no|Linen Undershirt]] which is different than the previous page and doesn't exist or is a redirect.
  
To remedy situations where the same page has title or spelling variations, a redirect page can be created. For example, the ''Linen Undershirt'' page could be redirected to the existing ''Linen undershirt'' page like this:
+
To remedy situations where the same page has title or spelling variations, redirect pages can be created. For example, the ''Linen Undershirt'' page could be redirected to the existing ''Linen undershirt'' page like this:
  
 
* <nowiki>#REDIRECT:[[Linen undershirt]]</nowiki>
 
* <nowiki>#REDIRECT:[[Linen undershirt]]</nowiki>
Line 53: Line 53:
 
Images are included in an article using the File syntax which is quite complex. Images often need to be used in quite specific ways in articles and it's best to refer to [https://www.mediawiki.org/wiki/Help:Images mediawiki] or [https://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax wikipedia] for detailed instructions.
 
Images are included in an article using the File syntax which is quite complex. Images often need to be used in quite specific ways in articles and it's best to refer to [https://www.mediawiki.org/wiki/Help:Images mediawiki] or [https://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax wikipedia] for detailed instructions.
  
Some example's from the wiki:
+
Some examples from the wiki:
 
* <nowiki>[[File:Settlement collage.png|frame|right|border|Types of settlements clockwise from top left: village, single house, fortified village and kota camp.]]</nowiki> gives the image from the [[Settlement]] article. [[File:Settlement collage.png|frame|right|border|Types of settlements clockwise from top left: village, single house, fortified village and kota camp.]]
 
* <nowiki>[[File:Settlement collage.png|frame|right|border|Types of settlements clockwise from top left: village, single house, fortified village and kota camp.]]</nowiki> gives the image from the [[Settlement]] article. [[File:Settlement collage.png|frame|right|border|Types of settlements clockwise from top left: village, single house, fortified village and kota camp.]]
 
* <nowiki>[[File:Fat.png|right|border|24px|Chunk of fat]]</nowiki> gives the image from the [[Fat]] article. [[File:Fat.png|right|border|24px|Chunk of fat]]
 
* <nowiki>[[File:Fat.png|right|border|24px|Chunk of fat]]</nowiki> gives the image from the [[Fat]] article. [[File:Fat.png|right|border|24px|Chunk of fat]]
Line 77: Line 77:
 
</pre>
 
</pre>
  
The same table without "<nowiki><pre></pre></nowiki>" tags used to prevent the table from being drawn:
+
The same table without <nowiki><pre></pre></nowiki> tags used to prevent the table from being drawn:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 95: Line 95:
 
Templates are a way to use the same information or formatting in multiple pages. They are used by typing the template's name in double curly brackets <nowiki>{{}}</nowiki>. Any page can be used as a template but often they are written in a special Template page and the page titled ''Something template'' contains instructions for the template's use.
 
Templates are a way to use the same information or formatting in multiple pages. They are used by typing the template's name in double curly brackets <nowiki>{{}}</nowiki>. Any page can be used as a template but often they are written in a special Template page and the page titled ''Something template'' contains instructions for the template's use.
  
Generally templates simply insert the contents of what's in their page to the page they are included in. This can be done in useful ways though, as will be shown in the subsection talking about UrW wiki's infoboxes, which are also templates.
+
Generally templates simply insert the contents of what's in their page to the page they are included in. This can be done in useful ways though, as will be shown in the subsection discussing UrW wiki's infoboxes, which also are templates.
  
Examples of template's used in UrW wiki:
+
Examples of templates used in UrW wiki:
  
 
* <nowiki>{{key|space}}</nowiki> gives {{key|space}}. It has a [[Template:Key|fancy template page]] that looks different when included in a page.
 
* <nowiki>{{key|space}}</nowiki> gives {{key|space}}. It has a [[Template:Key|fancy template page]] that looks different when included in a page.
 
* <nowiki>{{I for imagination}}</nowiki> gives the ''[[I for imagination]]'' tag: {{I for imagination}}
 
* <nowiki>{{I for imagination}}</nowiki> gives the ''[[I for imagination]]'' tag: {{I for imagination}}
* <nowiki><blockquote>{{:fat}}</blockquote> copies the content's of the ''[[Fat]]'' page in a quote box:
+
* <nowiki><blockquote>{{:fat}}</blockquote> copies the contents of the ''[[Fat]]'' page in a quote box:
 
<blockquote>{{:fat}}</blockquote>
 
<blockquote>{{:fat}}</blockquote>
  
 
====Infoboxes====
 
====Infoboxes====
  
Infoboxes are a type of template that gives an infobox, like all the [[item list|items]] and [[plants]] have on their individual pages. They have a lot of parameters to fill when used but the parameters don't necessarily need a value. Missing parameter's will be visible in the infobox in triple curly brackets, e.g. <nowiki>{{{skin}}}</nowiki>. Unfortunately infoboxes use an image which has the same name as the page that it's on so our example's image won't work.
+
Infoboxes are a type of template that create an infobox, like all the [[item list|items]] and [[plants]] have on their individual pages. They have a lot of parameters to fill when used but the parameters don't necessarily need a value. Missing parameters will be visible in the infobox in triple curly brackets, e.g. <nowiki>{{{skin}}}</nowiki>. Unfortunately infoboxes get their title and image name from the page they are on so our example's image won't work.
  
An example of a filled infobox:
+
An example of a filled infobox ([[Lynx]]):
 
<pre>
 
<pre>
 
{{Infobox Animal
 
{{Infobox Animal
Line 157: Line 157:
 
}}
 
}}
  
Notice the broken image link,which can't be fixed (without tampering with the template), and the <nowiki>{{{skin}}}</nowiki>, which could be fixed by adding the line
+
Notice the title, broken image link, which can't be fixed (without tampering with the template), and the <nowiki>{{{skin}}}</nowiki>, which could be fixed by adding the line
  
 
  <nowiki>| skin =</nowiki>
 
  <nowiki>| skin =</nowiki>
  
 
somewhere in the infobox template.
 
somewhere in the infobox template.

Revision as of 20:55, 27 February 2017

UrW wiki uses MediaWiki which has a lot of helpful guides and tutorials on how to edit a page. Another useful source for tutorials are Wikipedia's help pages. In this guide, I try to list some useful tips for editing a page and I'll also add links to mediawiki's help page on the subject in the section headers'. In UrW wiki, edits are limited to registered users to avoid vandalism.

An even shorter guide is wikipedia's cheatseet.

Quick wiki guide

After you're logged in, you can press the edit tab on the top of an article, or the edit links available next to sections. Also, when clicking a red link, i.e. a link to page that doesn't exist, you are taken to the edit tab of that article.

For the most part, editing the wiki is really easy: most of the editing is simply writing text, and if you don't know how to do something, you can just check how it's done in another page (or another mediawiki altogether). Links to other articles in the wiki are generally just words in square brackets, and infoboxes are also often easy to update, you'll just have to find the correct variable to modify (or add it if it's missing). Tables and images/files are a bit more tricky.

Next up are some quick tips to things you'll find in the wiki including links, tables, images, templates and infoboxes.

By the way, you can use the <nowiki></nowiki> tags to escape wiki markup.

Headers and general markup

When editing an article, you may want to divide it into sections and subsections and even subsubsections. Section headers are text written between a number of = signs, e.g.

  • ==Quick wiki guide== is the level 2 header which is the biggest header that should be used when editing.
  • ===Links=== are the subsection headers in this guide.
  • ====Infoboxes==== You'll rarely need headers this size or smaller.


You can italicize text by using '' on both sides of the word or words you want to italicize. Bolding text works similarly but you'll just use ''' instead. For example:

  • ''Italic text'' gives Italic text
  • '''Bold text''' gives Bold text

You can force the end of a section with <div style="clear: both"></div>, e.g. if you have images you want to have in a certain section. There's an example of how images work if the section is not ended in the images section of this article.

Links

Links to other pages in the wiki are marked by writing a pair of square brackets on both sides of the other article's title, e.g.

  • [[Watercraft]] Links to the page Watercraft
  • [[Watercraft]]s Also links to the page Watercraft. This time the link looks like this though: Watercrafts
  • [[Watercraft|punts and rafts]] Also links to the page Watercraft. The page that the link is to is simply separated by a | sign and the actual link looks like this: punts and rafts.
  • [[Linen undershirt]] Links to the page Linen undershirt
  • [[Linen Undershirt]] Notice the capital letter in Undershirt. This links to the page Linen Undershirt which is different than the previous page and doesn't exist or is a redirect.

To remedy situations where the same page has title or spelling variations, redirect pages can be created. For example, the Linen Undershirt page could be redirected to the existing Linen undershirt page like this:

  • #REDIRECT:[[Linen undershirt]]

External links can be written in multiple ways:


Images

Images are included in an article using the File syntax which is quite complex. Images often need to be used in quite specific ways in articles and it's best to refer to mediawiki or wikipedia for detailed instructions.

Some examples from the wiki:

  • [[File:Settlement collage.png|frame|right|border|Types of settlements clockwise from top left: village, single house, fortified village and kota camp.]] gives the image from the Settlement article.
    Types of settlements clockwise from top left: village, single house, fortified village and kota camp.
  • [[File:Fat.png|right|border|24px|Chunk of fat]] gives the image from the Fat article.
    Chunk of fat


Tables

Tables can be a bit owerwhelming at first as each cell is written separately using the wiki markup. First there is the part that tells the wiki that the information is a table and how it should look. Then the information of each cell is written starting from the top left corner of the table and moving from left to right, and after reaching the end of a row, starting again from the row below. Using your browser's search function (usually ctrl + F) helps considerably in finding the correct row.

Here's an example of how a simple table looks in wiki markup:

{| class="wikitable"
|-
|row 1 cell 1
|row 1 cell 2
|-
|row 2 cell 1
|row 2 cell 2
|-
|row 3 cell 1
|row 3 cell 2
|}

The same table without <pre></pre> tags used to prevent the table from being drawn:

row 1 cell 1 row 1 cell 2
row 2 cell 1 row 2 cell 2
row 3 cell 1 row 3 cell 2


Templates

Templates are a way to use the same information or formatting in multiple pages. They are used by typing the template's name in double curly brackets {{}}. Any page can be used as a template but often they are written in a special Template page and the page titled Something template contains instructions for the template's use.

Generally templates simply insert the contents of what's in their page to the page they are included in. This can be done in useful ways though, as will be shown in the subsection discussing UrW wiki's infoboxes, which also are templates.

Examples of templates used in UrW wiki:

The following information is rated I for Imagination. It is largely based on the editor's or forum's imagination and is probably a poor attempt at humor. Trusting any of the following information is at the reader's own risk.


  • <blockquote>{{:fat}}</blockquote> copies the contents of the ''[[Fat]]'' page in a quote box: <blockquote>{{:fat}}</blockquote> ====Infoboxes==== Infoboxes are a type of template that create an infobox, like all the [[item list|items]] and [[plants]] have on their individual pages. They have a lot of parameters to fill when used but the parameters don't necessarily need a value. Missing parameters will be visible in the infobox in triple curly brackets, e.g. <nowiki>{{{skin}}}. Unfortunately infoboxes get their title and image name from the page they are on so our example's image won't work.

An example of a filled infobox (Lynx):

{{Infobox Animal
| type = Land Mammal
| regions =
| terrain =
| weight =
| speed =
| movement = Walk
| health =
| weapon =
| trap = [[Big deadfall trap]]
| bait = [[Badger]] (cut), [[Squirrel]] (cut)
| water =
| avgProtection =
| warmthProtection = 
| tearProtection =
| edgeProtection =
| squeezeProtection =
| pointProtection =
| bluntProtection =
| butcher       = 17-23 lb lynx cuts, 3 lb lynx-skin, 0.3 lb lynx fat
}}

This gives the following infobox:

Wiki editing guide
File:Wiki editing guide.png
Basic Info
Type: Land Mammal
Regions: '
Terrain: '
Skin: {{{skin}}}
Statistics
Weight: '
Speed: '
Movement Types: Walk
Health: '
Hunting Information
Best Weapon: '
Trap Type: Big deadfall trap
Bait: Badger (cut), Squirrel (cut)
Armor Protection
Average: '
Warmth: '
Tear: '
Edge: '
Squeeze: '
Point: '
Blunt: '
Butcher Yield
Butcher: 17-23 lb lynx cuts, 3 lb lynx-skin, 0.3 lb lynx fat

Notice the title, broken image link, which can't be fixed (without tampering with the template), and the {{{skin}}}, which could be fixed by adding the line

| skin =

somewhere in the infobox template.