Help:Editing
From ManicDigger
This Editing help will teach you some of the basics of wiki editing.
For best learning, be sure to have an editing page opened in another tab or window.
The best page to start is maybe your personal page or your own discussion. If you are a registered user, you can find both in the top right corner.
There you can introduce yourself or test some of the basics.
Contents |
Basic knowledge
Editing a wikipage is not as easy as you might know it from your OpenOffice Suit or Microsoft Word Program. Text that you enter in the editing window, also appears as plain text in the wikipage. But you also can make use of headlines and other formats to make your page look better.
Text formatting
Headlines
When you write text between two "=" signs, it is used as a headline. More "=" signs can make your headline bigger or smaller.
This code:
=Example 1= That is the biggest headline. The titles for all the wiki pages use this automatically. Since Heading 1 is used for the titles of individual pages, it is not used very much, if at all. Try not use it, as excessive use of it can be seen as spam. ==Example 2== This is the most common headline used for editing. It is used for structuring your page. This headline element can also be found in the editing bar, that is the small blue bar above your editing window. ===Example 3=== This is a smaller headline that is not underlined. Use it when you have to structure bigger text in smaller segments. ====Example 4==== The headlines get more and more smaller. Just remember that headlines should be used for structuring your page, not for marking important text. Headlines are no replacement for bold and italic text. =====Example 5===== ======Example 6======results in:
Example 1
That is the biggest headline. The titles for all the wiki pages use this automatically. Since Heading 1 is used for the titles of individual pages, it is not used very much, if at all. Try not use it, as excessive use of it can be seen as spam.
Example 2
This is the most common headline used for editing. It is used for structuring your page. This headline element can also be found in the editing bar, that is the small blue bar above your editing window.
Example 3
This is a smaller headline that is not underlined. Use it when you have to structure bigger text in smaller segments.
Example 4
The headlines get more and more smaller. Just remember that headlines should be used for structuring your page, not for marking important text.
Headlines are no replacement for bold and italic text.
Example 5
Example 6
Bold and Italic Text
You can use bold text for showing keywords and important facts.You can make text bold by embedding it into three ' signs (single quotation mark). An easy example:
The next words are written in bold: '''This text is bold.'''results in:
The next words are written in bold: This text is bold.
You can also make text italic by embedding two ' signs (single quotation mark).
It is good to show facts that are interesting or if you wish to break the flow of the text. Do not use bold text too often because your page edits might be considered spam, but using it sometimes can result in an easier to read page.
Again, an easy example:
''Italic'' text can be used for marking ''interesting'' facts.'''''This text is written bold and italic.'''''results in:
Italic text can be used for marking interesting facts.This text is written bold and italic.
Links
In a wiki page, links are very important. You should use them to link to other wiki pages.
There are also external links, that can lead to other pages than those in the wiki.
You can link a phrase by putting [[ at the start and ]] at the end.
This will result in a link to another wiki page that has your phrase as the title.
When you want to try out a link, use your browsers back- button to get back to this page.
For example[[Wood]]links to the page about Wood:
You can also use external links to link to other pages, for example wikipedia.[1] links to wikipedia.
The code for this external link was:
[http://www.wikipedia.org/]You can also use alternate names for your links. For example I can link to Wikipedia but this time it says "Wikipedia→" and not [1]→. The code for this was:
[http://www.wikipedia.org/ Wikipedia]
This also works with internal links. As a small example:
[[Crafting|This shows you how to craft.]]
results in:
You can also do this by using your editing bar.(The small bar above the editing window)
Coding Tables and <nowiki>
Sometimes, you maybe want to give an example of the code.
For this, there are Coding Tables.
You see them used on this page very often.
This is the way a coding table looks.
You can create a coding table yourself by leaving a space after a new line, followed by your text.
This will be displayed as:
Your text.
<nowiki>
You can use <nowiki> when you want to exclude something from formatting.(<nowiki> at start and at the end</nowiki>)
For example:
Is this text '''bold''' or ''italic?'' Maybe <big>big?</big>
Will display as: Is this text '''bold''' or ''italic?'' Maybe <big>big?</big>
<nowiki> + Coding Table = <pre>
If you don't want to have formatting and want to include your code in a coding table, you can use <pre> and </pre>.
This is also useful if you don't like the method of creating Coding tables with a space at the start.
'''Example'''
The code was:
<pre> '''Example''' </pre>
Big , Sub- and Superscripted Text
You can use big, subscripted and superscripted text.
It should not be used for marking interesting facts or structuring, this three formatting Elements have not that much uses.
Big text can be used for headlines in tables and on discussion pages to mark important facts. Be sure to use it seldom, else it is spam.
You can also use it for headlines, but most times the built-in headlines are much better.
Big text headlines don't appear in the table of contents.
You can make text big by putting a <big> at the start and a </big> at the end.
Subscripted and superscripted text can be used for mathematical and chemical formulas.
It is not very useful in the Manic Digger Wiki, but it is good to know when you need it.
You can make superscripted text by placing a <sup> at the start and a </sup> at the end and subscripted text by placing a <sub> at the start and a </sub> at the end.
An example for big, sub- and superscripted text:
This text can turn <big>big</big>. You can even use bold, italic and big text at <big>'''''once!'''''</big> <sub>But don't do that, really not as it is spam.</sub> 5<sup>3</sup>=125results in:
This text can turn big. You can even use bold, italic and big text at once!
But don't do that, really as it is spam. 53=125
Images
You can use images to show content and textures.
In this small tutorial I will teach you how to embed images into your page.
The first example image shows the default wood block texture of Manic Digger:
[[File:Wood.JPG]]Notice that the image was uploaded.
If you link to a file that is not existing it will show a red link and, if you click the link, will prompt you to upload the file. For example feel free to upload the default Grass texture (needed): Create a new image(32x32 pixels) and copy the texture from the default terrain.png into the new image. Save it as a *.jpg file.
Then click on the following red link:
Be aware that the image will show on some pages, so be sure to pick the right texture. If you uploaded your image (or somebody else did), you will see the default Grass texture instead of the red link.
Embedding Images
You can modify the image and embed it another way:Now let's take a look at the way the image was embedded:
[[File:Railconnections.jpg|thumb|right|alt:Different rails.|All possible Connections for [[Rail]]s.]]
The File itself is displayed via "File:". You should already know that from the previous examples.
Now there are set various options divided by a |.
The first option is "thumb". This means that the image is rendered as a thumbnail.
Caption text will be displayed below it and it will be eventually resized.
The next option is "right". This changes the way the image is aligned, other examples would be "left" and "none": With "none", the image is at the left, text can't be next to it. With "left", the image is left-aligned, but text can be ot it's right.
After that, there is a option consisting of "alt:" and a text behind this. This text will be read by screenreaders and will be displayed if somebody can't display the image.
The last option is the caption text. This is the text rendered below the image. If you don't choose "thumb" as an option, the text will appear if you hover over the image instead.
There is much more you can do. For extended image syntax, take a look at Wikipedia.
Tables
Tables are used to organize information.
For example there is a table at Crafting that shows all possible Crafting Recipes.
A simple table can look like this:
| Head 1 | Head 2 | Head 3 |
|---|---|---|
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
| Cell 7 | Cell 8 | Cell 9 |
The code for this is relativly simple:
{| border=1
|+Example Table
!Head 1||Head 2||Head 3
|-
|Cell 1||Cell 2||Cell 3
|-
|Cell 4||Cell 5||Cell 6
|-
|Cell 7||Cell 8||Cell 9
|}
The table starts with {| and ends with |}. After the table start there is "border=1" The table could also be without borders. The same table again, but without "border=1":
| Head 1 | Head 2 | Head 3 |
|---|---|---|
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
| Cell 7 | Cell 8 | Cell 9 |
Then there comes a caption prefixed by "|+".This is displayed on top of the table. After that, the different cells are defined. First the top cells: Because there is a "!" instead of "|" it is a heading.Headings are printed bold. After each cell there comes a ||, indicating a new cell on the same row. Instead of "Cell 1||Cell 2", there could also be: <pre> |Cell 1 |Cell 2 </pre> The first layout is faster to read, but if the cells content is long, it is better to write it on a new line. After every second line there comes a "|-". This indicates that the row is ending there and a new row is started.
This are just the basics. You can customise your table further:
- By adding images
- By adding background and font colours
- By modifying the table's structure
As an more difficult example let's take a look at a part of the crafting table:
(You maybe have to scroll to the right if you can't see the whole code)
| Input | Addition | → | Output |
|---|---|---|---|
| → | |||
| → |
{| style="background: white; width: 55%; border: 1px solid black; color:black; align:left; font-size:110%"
|- style="background: #46c; color:white"
! '''Input''' || '''Addition''' ||'''→'''|| '''Output'''
|-
|[[File:Stone.JPG]] [[Stone]], 4 || ||style="background: #46c;color: white;text-align: center"|'''→'''||style="background: #ccf"|[[File:Brick.JPG]] [[Brick]]
|-
|[[File:Brick.JPG]] [[Brick]], 2|| ||style="background: #46c;color: white;text-align: center"|'''→'''||style="background: #ccf"|[[File:Roof.jpg]] [[Roof]]
|}
The first option is "style=background: white". This is written in the top of the table, directly at the start.
That means that every cell will have a white background if no color is given.
Then there are more style options for the whole table, they are divided with ";".
The table:
- is 55% of the wiki page width
- has a 1px wide, black border around it.
- is left aligned
- has a font size of 110%
Then there comes a new line and the heading:
| Input | Addition | → | Output |
|---|
|- style="background: #46c; color:white" ! '''Input''' || '''Addition''' ||'''→'''|| '''Output'''
A style is defined again, this time just used for the next row.
The heading:
- has a font size of 110% (whole table)
- is center-aligned (because it is a heading)
- has white text-color
- has a background with color #46c (blue)
#46c is blue in the hexadecimal system. It is not complicated.
The three characters can go from 0 to f, where 0 means no colour and f means full colour.(0,1,2,3,4,5,6,7,8,9,a,b,c,d,e,f)
The first value stands for red, second for green and third for blue colour. Some example colours below:
| #f00 | |
| #f80: | |
| #ff0: | |
| #0f0: | |
| #00f: | |
| #0ff: | |
| #fff: | |
| #999: | |
| #000: | |
| #559: | |
| #aaf: |
After explaining the colours, let's move to the next lines:
| → | |||
| → |
... |[[File:Stone.JPG]] [[Stone]], 4 || ||style="background: #46c;color: white;text-align: center"|'''→'''||style="background: #ccf"|[[File:Brick.JPG]] [[Brick]] |- |[[File:Brick.JPG]] [[Brick]], 2|| ||style="background: #46c;color: white;text-align: center"|'''→'''||style="background: #ccf"|[[File:Roof.jpg]] [[Roof]] |}
Those lines should now be no problem to understand.Just some facts:
- || || will generate an empty cell in-between
- "text-align" aligns the text inside the cells.
Advanced Table Classes
You can specify a table class at the start. This allows even further uses and customization.
| Alphabetic | Numeric | Date | Unsortable |
|---|---|---|---|
| d | 20 | 2008-11-24 | This |
| b | 8 | 2004-03-01 | column |
| a | 6 | 1979-07-23 | cannot |
| c | 4 | 1492-12-08 | be |
| e | 0 | 1601-08-13 | sorted. |
{| class="sortable" border="1"
|+ '''class="sortable"'''
|-
! scope="col" | Alphabetic
! scope="col" | Numeric
! scope="col" | Date
! scope="col" class="unsortable" | Unsortable
|-
| d || 20 || 2008-11-24 || This
|-
| b || 8 || 2004-03-01 || column
|-
| a || 6 || 1979-07-23 || cannot
|-
| c || 4 || 1492-12-08 || be
|-
| e || 0 || 1601-08-13 || sorted.
|}
(taken from Wikipedia)
Example tables and their code
Now, without comments some examples of tables:
{|style="background: #f9f9f9; color: #000;border: 1px dashed #006; width: 100%"
|<code>faked coding table</code>
|<code>For more space inside coding tables</code>
|<code>Use this</code>
|-
| || ||<code>because of</code>
|-
| || ||<code>better organization!</code>
|}
faked coding table
| For more space inside coding tables
| Use this
|
because of
| ||
better organization!
|
{|class="sortable" style="border: 2px solid black; background: #aaa"
|+ '''Manic Digger nightly builds'''
|scope="col" style="background: #333; color:white"|Date
|scope="col" class="unsortable" style="background: #333; color:white"|Type
|scope="col" class="unsortable" style="background: #333; color:white"|Important changes
|scope="col" class="unsortable" style="background: #333; color:white"|Download Link
|-
|Insert data here
|}
| Date | Type | Important changes | Download Link |
| 11.11.2011 | executable | Added Carrots | Not Available |
Manic Digger Wiki Guidelines
The previous tutorials were about wiki editing, but they were not always specially for this wiki. Some guidelines for this wiki:
- When creating pages about blocks:
Use the Template:Block.
Attention, this is no replacement for detailed wikitext.
Be sure to include as much information about the block.(Uses? Does the block spawn naturally?)
Include Crafting recipes, if existing. You can copy the relevant crafting recipes from Crafting or you can take a look at Template:Crafting, Template:Crafting1 or Template:Crafting2.
- Divide between suggestions and features.
Explains itself. If your page is a suggestion, or a part of it, state so at the page using the suggestion template.
Also if features on your page will exist only in a future update, state so at the page.
If a page is a suggestion, there is the Template:Suggestion. You can use it with:
{{Suggestion}}
----
{{Suggestion|1|part}}
| This page is a suggestion. | |
| Features on this page might be in a future version of Manic Digger. |
| This part of the page is a suggestion. | |
| Features on this part of the page might be in a future version of Manic Digger. |
For further information, see Template:Suggestion.
- For marking a page as not finished, use the Template:Progress:
{{progress|72}}
The second value will specify the finished percentage of the page.
- In this wiki you don't need to include sources if your source is Manic Digger itself.
In some wikis like wikipedia you need to have always your sources included. Here you can use the game as a source, i.e. if you see in-game that dirt has no gravity, you can simply write it on the page without having to state that you found it out in-game.
However, if your source is not the game,it is nice when you include a reference at the bottom of the page or in the text as a small external link. ([2])
- Don't spam. Don't insert non-sense stuff into pages.
This is a very important rule. Not following it can be followed by a warning and a ban. If you see non-sense stuff or spam, it would be nice if you remove it. The adminstrators have enough to do.
If you don't know if somthing is non-sense, you can state so at the discussion page.

