Difference between revisions of "Help:Markup"

ADVERTISEMENT
From Diablo Wiki
Jump to: navigation, search
(→‎Soft Returns)
m (→‎=Aligning Cells)
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
Wiki pages are designed to be easy to create and edit, and require a minimal amount of technical knowledge. If you can create a forum post, you can edit a wiki page. Read this page for some basic theory and common codes, and you'll be well on your way. Also keep in mind that you can always click the edit tab on an existing page to see how it was formatted.
 
Wiki pages are designed to be easy to create and edit, and require a minimal amount of technical knowledge. If you can create a forum post, you can edit a wiki page. Read this page for some basic theory and common codes, and you'll be well on your way. Also keep in mind that you can always click the edit tab on an existing page to see how it was formatted.
 +
 +
For information on how to create pages, read the [[Help:New article|New article]] help page.
  
  
 
==Wiki Code==
 
==Wiki Code==
−
Wikis use their own syntax (markup) for creating text formatting. Below is a list of common syntax you can use to format your pages. A more extensive guide to wiki editing can be found [http://meta.wikimedia.org/wiki/Help:Editing on Wikimedia's site].
+
Wikis use their own syntax (markup) for formatting text. Below is a list of common syntax you can use to format your pages. A more extensive guide to wiki editing can be found [http://meta.wikimedia.org/wiki/Help:Editing on Wikimedia's site].
  
  
 
===Text Formatting===
 
===Text Formatting===
−
Wiki pages should present information with words and occasional images, in a simple, low-tech format. Wiki pages are more analogous to forum posts or word documents than to modern webpages, and as such only a few commands are necessary. Some of the most useful are:
 
  
−
* ''Italic Text'' <nowiki>''Your Text''</nowiki> (2 apostrophes)<br>
+
{| width="70%"
−
* '''Bold Text''' <nowiki>'''Your Text'''</nowiki> (3 apostrophes)<br>
+
! What you see
−
* '''''Bold Italic Text''''' <nowiki>'''''Your Text'''''</nowiki> (5 apostrophes)<br>
+
! What you type
−
* <u>Underline</u> <nowiki><u>Your Text</u></nowiki>
+
|-
 +
| ''Italic Text''
 +
| <nowiki>''Your Text''</nowiki> (2 apostrophes)
 +
|-
 +
| '''Bold Text'''
 +
| <nowiki>'''Your Text'''</nowiki> (3 apostrophes)
 +
|-
 +
| '''''Bold Italic Text'''''
 +
| <nowiki>'''''Your Text'''''</nowiki> (5 apostrophes)
 +
|-
 +
|  <u>Underline</u>
 +
| <nowiki><u>Your Text</u></nowiki>
 +
|-
 +
| <strike>Strike out</strike>
 +
| <nowiki><strike>Strike out</strike></nowiki>
 +
|-
 +
| Superscripts and subscripts: X<sup>2</sup>, H<sub>2</sub>O
 +
| <nowiki>X<sup>2</sup>, H<sub>2</sub>O</nowiki>
 +
|}
  
  
−
===Section Headers===
+
===Text Layout===
−
To keep pages readable and organized, separate the text into sections. Section headers do this nicely, and are automatically added to the table of contents. Headers should be hierarchical and descending, as needed. There are several levels of headers, and the text so offset by equals signs will display in descending point size and font colour.
 
−
* Heading 1  <nowiki>==Your heading==</nowiki><br>
 
−
* Heading 2  <nowiki>===Your heading===</nowiki><br>
 
−
* Heading 3  <nowiki>====Your heading====</nowiki><br>
 
  
−
The single equal sign is ''not'' used in articles. It's used for the formatting for the title of pages. Use the double equal signs for the first heading and replace any heading hierarchies on article pages that might use the single one.
+
{| width="70%"
 +
! What you see
 +
! What you type
 +
|-
 +
| :Indented text
 +
| <nowiki>: Indented text.</nowiki>
 +
|-
 +
| <center>Centered text</center>
 +
| <nowiki><center>Centered text</center></nowiki>
 +
|-
 +
| <blockquote>The '''blockquote''' command produces block quotations, typically by surrounding them with whitespace.</blockquote>
 +
| <nowiki><blockquote>The '''blockquote''' command produces block quotations, typically by surrounding them with whitespace.</blockquote></nowiki>
 +
|}
  
−
Avoid putting numbers into page headers, since numbers are automatically generated by the wiki table of contents, and will look redundant or even misleading.
 
  
 +
===Footers (Sources/Citations)===
  
−
====The Table of Contents Box====
+
{|
−
Wiki format is pretty clever and can automatically create TOC boxes like you see at the top of the page. A content box is automatically created when you use 4 or more headlines, which are formatted as explained above. All headlines will show up in the TOC, which is very handy.
+
! width="20%" | What you're doing
 +
! width="30%" | What you see
 +
! width="50%" | What you type
 +
|-
 +
| Assigning reference number
 +
| High proportion of women play with their romantic partner <ref>[http://news.bbc.co.uk/1/hi/technology/7796482.stm The virtual battle of the sexes] - BBC 23/12/08</ref>.
 +
| High proportion of women play with their romantic partner <nowiki><ref>[http://news.bbc.co.uk/1/hi/technology/7796482.stm The virtual battle of the sexes] - BBC 23/12/08</ref>.</nowiki>
 +
|-
 +
| Assigning reference id
 +
| Used to reference a single source multiple times in the same article <ref name=incgamers>[http://www.incgamers.com/Columns/59/2010-year-of-the-sandbox 2010: Year Of The Sandbox] - IncGamers 19/02/10</ref>.
 +
| Used to reference a single source multiple times in the same article <nowiki><ref name=incgamers>[http://www.incgamers.com/Columns/59/2010-year-of-the-sandbox 2010: Year Of The Sandbox] - IncGamers 19/02/10</ref></nowiki>.
 +
|-
 +
| Reference a reference id already created
 +
| 2010 promises to be very different from 2009. <ref name="incgamers"/>
 +
| 2010 promises to be very different from 2009. <nowiki><ref name="incgamers"/></nowiki>
 +
|}
  
−
The level structure of the TOC works just as explained above with headlines. It's that simple!
 
  
 +
Add <nowiki><references/></nowiki> where you want the list of citations to appear (usually at the foot of the page), and the list will appear thus:
  
−
===Lists===
+
<references/>
−
Aside from links and tables, covered elsewhere on this page, the most common formatting tool is the list. There are two types: bulleted and numbered, and they are written in exactly the same manner. To create a bullet list, simply place asterisks (*) at the start of each line you want to bullet. If you want a numbered list, use the hash (#) sign. To add subheadings, simply use 2 or more such punctuation signs. The wiki script will automatically arrange them on the page.
 
  
−
<blockquote><pre>
 
−
* Item One
 
−
* Item Two
 
−
** Item Two and a half
 
−
*** Item two and three quarters
 
−
* Item Three.
 
−
</pre></blockquote>
 
  
−
Turns into:
+
===Section Headers===
−
----
+
To keep pages organized, separate the text into sections. Section headers do this nicely, and are automatically added to the table of contents. Headers should be hierarchical and descending, as needed. There are several levels of headers formed by equals signs that will display in descending point size and font colour.
−
* Item One
 
−
* Item Two
 
−
** Item Two and a half
 
−
*** Item two and three quarters
 
−
* Item Three.
 
−
----
 
  
−
Bullet points or numbered lists should be used to organize and format pages, and to present short facts in sequence.
+
{| width="70%"
 +
! What you see
 +
! What you type
 +
|-
 +
| <font style="font-size: 130%; color: #F9E3A0; font-weight: bold; border-bottom: 1px solid #4B100E;">Heading 1</font>
 +
| ==Heading 1==
 +
|-
 +
| <font style="color: #6D8552; border-bottom: none; font-weight: bold; font-size: 110%;">Heading 2</font>
 +
| ===Heading 2===
 +
|-
 +
| <font style="color: #91A07F; border-bottom: none; font-weight: bold; font-size: 100%;">Heading 2</font>
 +
| ===Heading 3===
 +
|}
  
  
−
====Soft Returns====
+
The single equal sign is ''not'' used in articles. It's automatically used for formatting the title of pages. Use the double equal signs for the first heading.
−
The wiki script ignores single returns. For instance, if you type something that looks like this in the edit box:
 
−
----
 
−
This<br>
 
−
line<br>
 
−
has<br>
 
−
a<br>
 
−
lot<br>
 
−
of<br>
 
−
returns.
 
−
----
 
−
Will show up on the page as a plain line of text, without any line breaks. You need to add a <nowiki><br></nowiki> tag to each line you want to format below the next. It's also possible to use pointed or numbered lists for breaks. Read above about lists.
 
  
−
====Preformatted Boxes====
+
Do not put numbers at the beginning of headings as the wiki automatically inserts them in the Table of Contents box.
−
To make a preformatted box, for showing text with fixed width, especially when showing different types of code, simply add one space before it begins, and the wiki script will automatically place it in a red-tinted box with a special outline. For example:
 
  
−
Aren't I dramatic!
 
  
−
Use this tool primarily to show code in explanatory pages, but it's also possible to use it for short notes, since items in this sort of box do not receive additional wiki formatting, and will stretch pages infinitely wide. Use a soft break to keep such lines from running endlessly off to the right, if they are longer than a few words.
+
===The Table of Contents Box===
 +
Wiki format automatically creates ToC boxes like you see at the top of this page, after 4 headings have been created.  If you have only 3 headlines but need a ToC box then type <nowiki>__toc__</nowiki>.
  
  
−
==Creating Links==
+
===Lists===  
−
Creating links is very simple and there are two methods to do so: an external site link for outside sources and an internal site link for content inside the {{WikiTitle}}.
+
One of the most common formatting tool is the list used to present short facts in sequence.
  
  
−
===Internal Links===
+
{| width="70%"
−
An internal site link use two brackets <nowiki>[[ ]]</nowiki> on either side of the title, with an optional title (if specified, separate with a | character). <nowiki>[[Topic|Link Title]]</nowiki>. If you add link brackets to the same article currently shown, the link will turn '''bold''' instead of into a link. It's also possible to modify the link title without changing the link by adding characters after the right side brackets (<nowiki>]]</nowiki>) like this: <nowiki>[[Topic|Link Title]]ing</nowiki>.
+
! What you see
 +
! What you type
 +
|-
 +
|
 +
* Item One
 +
* Item Two
 +
** Item Two and a half
 +
*** Item two and three quarters
 +
* Item Three
 +
| <nowiki>*</nowiki> Item One<br>
 +
<nowiki>*</nowiki> Item Two<br>
 +
<nowiki>**</nowiki> Item Two and a half<br>
 +
<nowiki>***</nowiki> Item two and three quarters<br>
 +
<nowiki>*</nowiki> Item Three
 +
|-
 +
|
 +
# Item One
 +
# Item Two
 +
## Sub item
 +
## Sub item
 +
## Sub item
 +
# Item Three
 +
# Item Four
 +
|
 +
<nowiki>#</nowiki> Item One<br>
 +
<nowiki>#</nowiki> Item Two<br>
 +
<nowiki>##</nowiki> Sub item<br>
 +
<nowiki>##</nowiki> Sub item<br>
 +
<nowiki>##</nowiki> Sub item<br>
 +
<nowiki>#</nowiki> Item Three<br>
 +
<nowiki>#</nowiki> Item Four
 +
|-
 +
|
 +
* Female Classes
 +
**Amazon<br>Assassin<br>Sorceress
 +
* Male Classes
 +
**Barbarian<br>Druid<br>Necromancer<br>Paladin
 +
|
 +
<nowiki>*</nowiki> Female Classes<br>
 +
<nowiki>**</nowiki>Amazon<nowiki><br></nowiki>Assassin<nowiki><br></nowiki>Sorceress<br>
 +
<nowiki>*</nowiki> Male Classes<br>
 +
<nowiki>**</nowiki>Barbarian<nowiki><br></nowiki>Druid<nowiki><br></nowiki>Necromancer<nowiki><br></nowiki>Paladin
 +
|-
 +
|
 +
; List Heading : with an automatic indent
 +
; Bolds it : then will
 +
: list
 +
: your
 +
: items
 +
: below
 +
|
 +
<nowiki>;</nowiki> List Heading<nowiki>:</nowiki> with an automatic indent<br>
 +
<nowiki>;</nowiki> And no bullets<nowiki>:</nowiki> then will<br>
 +
<nowiki>:</nowiki> list<br>
 +
<nowiki>:</nowiki> your<br>
 +
<nowiki>:</nowiki> items<br>
 +
<nowiki>:</nowiki> below<br>
 +
|}
  
−
The following code:
 
−
<blockquote><pre>
 
−
[[Help:Contents]]<br>
 
−
[[Help:Contents|Help]]<br>
 
−
[[Help:Contents|Help]]ing<br>
 
−
[[Help:Contents|Help]]ers<br>
 
−
</pre></blockquote>
 
−
Will look like this:
 
−
----
 
−
[[Help:Contents]]<br>
 
−
[[Help:Contents|Help]]<br>
 
−
[[Help:Contents|Help]]ing<br>
 
−
[[Help:Contents|Help]]ers<br>
 
−
----
 
  
 +
===Soft Returns===
 +
The wiki script ignores single returns. If you wish to create a new paragraph you need to hit return twice to leave one blank line.  If you want to list something directly underneather another line of text then you need to use <nowiki><br></nowiki>
  
−
====Linking to Categories====
 
−
Linking to [[Help:Category|categories]] can be helpful, since the search option will not generally display a category page even if that's the most useful page for their desired information. It's also helpful for newer wiki users who may not know to scroll to the bottom of a page to find the automated category links.
 
  
−
The problem is of course that adding the "<nowiki>[[ ]]</nowiki>" around a category name will only add that page into the category, so to create a clickable link to a category and avoiding this, type: ''"<nowiki>[[:Category:xxxxx]]</nowiki>"'' where "xxxxx" is the name of the Category.
+
===Preformatted Boxes===
  
−
The only difference from actually adding the category is the ":" before the "Category". An optional title is often good to use here, so people don't get confused by the "strange" name. Remember If that page is meant to be in that category, add a tag for it at the end of the page as well.
+
These boxes will go as wide as the text, so to control their width you will need to use <nowiki><br></nowiki>.
  
−
* [[Help:Category|Category help page]]
+
Preformatted boxes are used for:
  
 +
* pasting preformatted text
 +
* algorithm descriptions
 +
* program source code
 +
* ASCII art
  
−
===External Links===
+
You make one by simply adding a space before the beginning of a sentence.
−
External links are made similarly to internal links. The difference is that it uses single brackets (<nowiki>[ ]</nowiki>) and naturally also must contain an external URL. Another difference between internal and external links is that instead of a pipe ("|") to separate the link source with an alternative title, it uses a simple space. This naturally means that it isn't possible to link to pages that uses spaces in the URL. It's easy to distinguish external links in the wiki by the "external link icon" that appears on those links ([http://www.diii.net/ example]).
 
  
−
There are three types of links that can be used; either a clickable URL, a clickable number in brackets, or a clickable link title. The last one work very similar to internal links. Do note that it isn't possible to add letters at the end of an external link to make it part of the link title. The entire link title needs to be within the brackets.
+
Aren't I dramatic!
  
−
====Regular URL Link====
+
==Creating Links==
−
Writing the following:
+
Creating links is very simple and there are two methods to do so: an external site link for outside sources and an internal site link for content inside the {{WikiTitle}}.
−
<blockquote><pre>
 
−
http://www.diii.net/
 
−
</pre></blockquote>
 
−
Will display like this:
 
−
----
 
−
http://www.diii.net/<br>
 
−
----
 
−
In cases where it's needed to whow the whole url, just write it out in the document, and it will automatically be parsed.
 
  
−
====Numbered Link====
+
{| width="100%"
−
Writing the following:
+
! colspan="3" |Internal Links
−
<blockquote><pre>
+
|-
−
[http://www.diii.net/]
+
! What you're Linking to
−
</pre></blockquote>
+
! What you see
−
Will display like this:
+
! What you type
−
----
+
|-
−
[http://www.diii.net/]
+
| Article
−
----
+
| [[Worldstone]]
−
This is a numbered link that is excellent to use when sourcing other pages. It will be numbered from how many similar links are on a document, so the first such link is <nowiki>[1]</nowiki>, and the third one is <nowiki>[3]</nowiki>.
+
| <nowiki>[[Worldstone]]</nowiki>
 +
|-
 +
| Category
 +
| [[:Category:Monk]]
 +
| <nowiki>[[:Category:Monk]]</nowiki>
 +
|-
 +
| Category without the word 'category' displaying
 +
| [[:Category:Classes| Monk]]
 +
| <nowiki>[[:Category:Classes |Monk]]</nowiki>
 +
|-
 +
| Section within an article
 +
| [[Monk#Background| Monk Background]]
 +
| <nowiki>[[Monk#Background]]</nowiki>
 +
|-
 +
| Link to section with own text
 +
| He travelled from his [[The Borderlands|homeland]].
 +
| <nowiki>He travelled from his [[The Borderlands|homeland]]</nowiki>.
 +
|-
 +
| To merge link and text
 +
| She soon become proficient in [[enchant]]ing.
 +
| She soon become proficient in <nowiki>[[enchant]]ing</nowiki>.
 +
|-
 +
| Between the main DiabloWiki and Diablo 2 Wiki
 +
| {{iw|Horadric_Cube Horadric Cube}}
 +
| <nowiki>{{iw|Horadric_Cube Horadric Cube}}</nowiki>
 +
|-
 +
| Directly to an image (not embedded on page)
 +
| [[:Image:Jay_Wilson.jpg| here's Jay Wilson]]
 +
| <nowiki>[[:Image:Jay_Wilson.jpg| here's Jay Wilson]]</nowiki>
 +
|-
 +
| Link to an image
 +
| [[:File:Waypoints-act1.jpg|Waypoint map]]
 +
| <nowiki>[[:File:Waypoints-act1.jpg|Waypoint map]]</nowiki>
 +
|-
 +
! colspan="3" |External Links
 +
|-
 +
| External page as url
 +
| http://www.incgamers.com
 +
| <nowiki>http://www.incgamers.com</nowiki>
 +
|-
 +
| External page as a piece of text
 +
| News at [http://www.incgamers.com IncGamers].
 +
| News at <nowiki>[http://www.incgamers.com IncGamers]</nowiki>.
 +
|-
 +
| External page as a number
 +
| [http://www.incgamers.com]
 +
| <nowiki>[http://www.incgamers.com]</nowiki>
 +
|-
 +
| External page without blue icon
 +
| {{wl|[http://diablo.incgamers.com/ Diablo: IncGamers]}}
 +
| <nowiki>{{wl|[http://diablo.incgamers.com/ Diablo: IncGamers]}}</nowiki>
 +
|}
  
−
====Link in Title====
+
==Images==
−
Writing the following:
+
To insert an image, just add the following code, <nowiki>[[File:filename.jpg]]</nowiki>. Make sure you have the correct file extension. The valid image files for {{WikiTitle}} are:
−
<blockquote><pre>
+
* .gif
−
[http://www.diii.net/ Diii.net with custom title]<br>
+
* .jpg
−
</pre></blockquote>
+
* .png
−
Will display like this:
+
Images are automatically justified to the left side on a page, but it's easy to change this with variables, to make boxes around images and to change their size.
−
----
 
−
[http://www.diii.net/ Diii.net with custom title]<br>
 
−
----
 
−
This is naturally the most commonly used link, and is used much like the internal links.
 
  
−
====External Links Without Icon====
+
See more examples about placing images on the '''[[Help:Image|Image Help page]]'''.
−
It's possible to remove the little external link icon from links, and this is mostly used when linking within the Diablo community, such as links to the other Diablo wiki, or to <span class="plainlinks"> [http://www.diii.net/ Diii.net]</span>.
 
  
−
For simple links that does not contain any odd characters like "?", "=", or "&", you can use the [[Template:wl|Wiki Link template]] like this:
+
===Images as Links===
 +
An image can be used to link elsewhere than its own image page. To do this, simply add a variable to the image like this:
 
<blockquote><pre>
 
<blockquote><pre>
−
{{wl|[http://www.diii.net/ Title]}}<br>
+
[[File:Diablo_III_Logo.jpg|link=http://www.diablowiki.net/]]
 
</pre></blockquote>
 
</pre></blockquote>
−
Will display like this: {{wl|[http://www.diii.net/ Title]}}
+
Will display like this: [[File:Diablo_III_Logo.jpg|100px|link=http://www.diablowiki.net/]]
  
−
For more complex URLs, full html formatting is required. Just add <nowiki>"<span class="plainlinks">"</nowiki> directly in front of your link, and <nowiki>"</span>"</nowiki> directly after for the same effect as above.
+
The size attribute is used here to avoid blowing the image up to a massive size. To learn more about how to use and format images, see the '''[[Help:Image|Image Help page]]'''.
  
 +
This works with both internal and external links.
  
−
==Creating Tables==
+
==Categories==
−
If you are familiar with html then wiki table syntax will seem logical; however, if you are not familiar with html it is still relatively simple to follow.
+
Every page should be slotted into at least one category, to enable others to find it easily. If you are making new articles, it's very important to make sure they are put in the correct category.
 +
* Read more about categories in the [[Help:Category|Category Help page]].
  
−
Here's an example of one of the mediawiki table notations:
 
−
 
−
<nowiki>{|</nowiki>
 
−
<nowiki>! 1</nowiki>
 
−
<nowiki>! 2</nowiki>
 
−
<nowiki>! 3</nowiki>
 
−
<nowiki>|-</nowiki>
 
−
<nowiki>| 4</nowiki>
 
−
<nowiki>| 5</nowiki>
 
−
<nowiki>| 6</nowiki>
 
−
<nowiki>|}</nowiki>
 
  
 +
==Creating Tables==
 +
The syntax for creating table is fairly easy and very logical. Here's a basic example:
 +
----
 +
<nowiki>{|</nowiki><br>
 +
<nowiki>! 1</nowiki><br>
 +
<nowiki>! 2</nowiki><br>
 +
<nowiki>! 3</nowiki><br>
 +
<nowiki>|-</nowiki><br>
 +
<nowiki>| 4</nowiki><br>
 +
<nowiki>| 5</nowiki><br>
 +
<nowiki>| 6</nowiki><br>
 +
<nowiki>|}</nowiki>
 +
----
 
That will look like this:
 
That will look like this:
−
 
 
{|  
 
{|  
 
! 1
 
! 1
Line 186: Line 302:
 
|}
 
|}
  
−
The tables are automatically formatted with the site style so you '''aren't required to add any style elements''' to the tables. The only time you would really need to add an element to the table is if you want to specify a width or want to make a table that is different than the standard {{WikiTitle}} style.
+
The tables are automatically formatted with the site style so you '''aren't required to add any style elements'''. The only time you would need to add an element to the table is if you want to specify a width or want to make a table that is different than the standard {{WikiTitle}} style.
  
 
As you can see the wiki code 'looks' like a table and you can expand on this and format more complex tables. It's easy enough to look at other tables as well, to get inspiration if you want to do more advanced things with it.
 
As you can see the wiki code 'looks' like a table and you can expand on this and format more complex tables. It's easy enough to look at other tables as well, to get inspiration if you want to do more advanced things with it.
  
  
−
==Categories==
+
===Aligning Cells===
−
Categories and subcategories are the backbone of a wiki's navigation. (Especially since the wiki search options aren't very intuitive.) Every page should be slotted into at least one category, to enable other users to find it easily. If you are making new articles, it's very important to make sure they are put in the right category.
+
 
−
* Read more about categories in the [[Help:Category|Category Help page]].
+
Aligning a shorter cell to the top to even out a multi-columned list.
 +
 
 +
{|
 +
|
 +
* Locate the [[Flooded Causeway]]
 +
* Go down to the [[Ruined Cistern]]
 +
* Locate the exit to the [[Path to the Oasis]]
 +
* Locate the [[The Forgotten Ruins]]
 +
| valign="top" |
 +
* Find Kulle's head.
 +
* Return Kulle's head to [[Adria]] at [[Hidden Camp]]
 +
* Listen to Kulle rejoice at being alive again
 +
|}
 +
 
 +
The code reads
 +
<pre>
 +
{|
 +
|
 +
* Locate the [[Flooded Causeway]
 +
* Go down to the [[Ruined Cistern]]
 +
* Locate the exit to the [[Path to the Oasis]]
 +
* Locate the [[The Forgotten Ruins]]
 +
| valign="top" |
 +
* Find Kulle's head.
 +
* Return Kulle's head to [[Adria]] at [[Hidden Camp]]
 +
* Listen to Kulle rejoice at being alive again
 +
|}
 +
</pre>
 +
 
 +
 
  
  
−
===Linking to Categories===
 
−
In order to link directly to a category, add a ":" in front of "Category", like this: [[:Category:Help]], to make it a link instead of adding the article to the category. Optional title is useful. Read more about this in the links section on this page.
 
  
 +
* Read more about tables in the [[Help:Table|Table Help page]].
  
−
==Images==
+
==Try it out!==
−
To insert an image, just add the following code, that you can see is very similar to other wiki links: <nowiki>[[Image:filename.jpg]]</nowiki>. Make sure you don't forget to write the file extension. The valid image files for {{WikiTitle}} are:
+
There is a special [[{{WikiTitle}}:Sandbox|Wiki Sandbox]] that you can try out your editing skills in, without making unnecessary changes to existing articles.
−
* .gif
 
−
* .jpg
 
−
* .png
 
−
Images will automatically be justificated to the left side on a page, but it's easy to change this with variables, to make boxes around images and to change their size. Read more about images on the [[Help:Image|Image Help page]].
 
  
  
 
==Further Reading==
 
==Further Reading==
−
 
 
* [[Help:FAQ|Onsite Wiki FAQ]]
 
* [[Help:FAQ|Onsite Wiki FAQ]]
 
* Advanced image technique placement, making thumbnails, captions, etc can be found in Wikipedia's article on [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax extended image syntax].
 
* Advanced image technique placement, making thumbnails, captions, etc can be found in Wikipedia's article on [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax extended image syntax].
  
−
===Try it out!===
 
−
There is a special [[{{WikiTitle}}:Sandbox|Wiki Sandbox]] that you can try out your editing skills in, without making unnecessary changes to existing articles.
 
  
  
 
{{Help_navbox}}
 
{{Help_navbox}}

Latest revision as of 02:03, 17 November 2013

Wiki pages are designed to be easy to create and edit, and require a minimal amount of technical knowledge. If you can create a forum post, you can edit a wiki page. Read this page for some basic theory and common codes, and you'll be well on your way. Also keep in mind that you can always click the edit tab on an existing page to see how it was formatted.

For information on how to create pages, read the New article help page.


Wiki Code[edit source]

Wikis use their own syntax (markup) for formatting text. Below is a list of common syntax you can use to format your pages. A more extensive guide to wiki editing can be found on Wikimedia's site.


Text Formatting[edit source]

What you see What you type
Italic Text ''Your Text'' (2 apostrophes)
Bold Text '''Your Text''' (3 apostrophes)
Bold Italic Text '''''Your Text''''' (5 apostrophes)
Underline <u>Your Text</u>
Strike out <strike>Strike out</strike>
Superscripts and subscripts: X2, H2O X<sup>2</sup>, H<sub>2</sub>O


Text Layout[edit source]

What you see What you type
 :Indented text : Indented text.
Centered text
 <center>Centered text</center>
The blockquote command produces block quotations, typically by surrounding them with whitespace.
 <blockquote>The '''blockquote''' command produces block quotations, typically by surrounding them with whitespace.</blockquote>


Footers (Sources/Citations)[edit source]

What you're doing What you see What you type
Assigning reference number High proportion of women play with their romantic partner [1]. High proportion of women play with their romantic partner <ref>[http://news.bbc.co.uk/1/hi/technology/7796482.stm The virtual battle of the sexes] - BBC 23/12/08</ref>.
Assigning reference id Used to reference a single source multiple times in the same article [2]. Used to reference a single source multiple times in the same article <ref name=incgamers>[http://www.incgamers.com/Columns/59/2010-year-of-the-sandbox 2010: Year Of The Sandbox] - IncGamers 19/02/10</ref>.
Reference a reference id already created 2010 promises to be very different from 2009. [2] 2010 promises to be very different from 2009. <ref name="incgamers"/>


Add <references/> where you want the list of citations to appear (usually at the foot of the page), and the list will appear thus:

  1. ↑ The virtual battle of the sexes - BBC 23/12/08
  2. ↑ 2.0 2.1 2010: Year Of The Sandbox - IncGamers 19/02/10


Section Headers[edit source]

To keep pages organized, separate the text into sections. Section headers do this nicely, and are automatically added to the table of contents. Headers should be hierarchical and descending, as needed. There are several levels of headers formed by equals signs that will display in descending point size and font colour.

What you see What you type
Heading 1 ==Heading 1==
Heading 2 ===Heading 2===
Heading 2 ===Heading 3===


The single equal sign is not used in articles. It's automatically used for formatting the title of pages. Use the double equal signs for the first heading.

Do not put numbers at the beginning of headings as the wiki automatically inserts them in the Table of Contents box.


The Table of Contents Box[edit source]

Wiki format automatically creates ToC boxes like you see at the top of this page, after 4 headings have been created. If you have only 3 headlines but need a ToC box then type __toc__.


Lists[edit source]

One of the most common formatting tool is the list used to present short facts in sequence.


What you see What you type
  • Item One
  • Item Two
    • Item Two and a half
      • Item two and three quarters
  • Item Three
 * Item One

* Item Two
** Item Two and a half
*** Item two and three quarters
* Item Three

  1. Item One
  2. Item Two
    1. Sub item
    2. Sub item
    3. Sub item
  3. Item Three
  4. Item Four

# Item One
# Item Two
## Sub item
## Sub item
## Sub item
# Item Three
# Item Four

  • Female Classes
    • Amazon
      Assassin
      Sorceress
  • Male Classes
    • Barbarian
      Druid
      Necromancer
      Paladin

* Female Classes
**Amazon<br>Assassin<br>Sorceress
* Male Classes
**Barbarian<br>Druid<br>Necromancer<br>Paladin

List Heading 
with an automatic indent
Bolds it 
then will
list
your
items
below

; List Heading: with an automatic indent
; And no bullets: then will
: list
: your
: items
: below


Soft Returns[edit source]

The wiki script ignores single returns. If you wish to create a new paragraph you need to hit return twice to leave one blank line. If you want to list something directly underneather another line of text then you need to use <br>


Preformatted Boxes[edit source]

These boxes will go as wide as the text, so to control their width you will need to use <br>.

Preformatted boxes are used for:

  • pasting preformatted text
  • algorithm descriptions
  • program source code
  • ASCII art

You make one by simply adding a space before the beginning of a sentence. 

Aren't I dramatic!

Creating Links[edit source]

Creating links is very simple and there are two methods to do so: an external site link for outside sources and an internal site link for content inside the DiabloWiki.

Internal Links
What you're Linking to What you see What you type
Article Worldstone [[Worldstone]]
Category Category:Monk [[:Category:Monk]]
Category without the word 'category' displaying Monk [[:Category:Classes |Monk]]
Section within an article Monk Background [[Monk#Background]]
Link to section with own text He travelled from his homeland. He travelled from his [[The Borderlands|homeland]].
To merge link and text She soon become proficient in enchanting. She soon become proficient in [[enchant]]ing.
Between the main DiabloWiki and Diablo 2 Wiki Horadric Cube {{iw|Horadric_Cube Horadric Cube}}
Directly to an image (not embedded on page) here's Jay Wilson [[:Image:Jay_Wilson.jpg| here's Jay Wilson]]
Link to an image Waypoint map [[:File:Waypoints-act1.jpg|Waypoint map]]
External Links
External page as url http://www.incgamers.com http://www.incgamers.com
External page as a piece of text News at IncGamers. News at [http://www.incgamers.com IncGamers].
External page as a number [1] [http://www.incgamers.com]
External page without blue icon Diablo: IncGamers {{wl|[http://diablo.incgamers.com/ Diablo: IncGamers]}}

Images[edit source]

To insert an image, just add the following code, [[File:filename.jpg]]. Make sure you have the correct file extension. The valid image files for DiabloWiki are:

  • .gif
  • .jpg
  • .png

Images are automatically justified to the left side on a page, but it's easy to change this with variables, to make boxes around images and to change their size.

See more examples about placing images on the Image Help page.

Images as Links[edit source]

An image can be used to link elsewhere than its own image page. To do this, simply add a variable to the image like this: 

[[File:Diablo_III_Logo.jpg|link=http://www.diablowiki.net/]]

Will display like this: Diablo III Logo.jpg

The size attribute is used here to avoid blowing the image up to a massive size. To learn more about how to use and format images, see the Image Help page.

This works with both internal and external links.

Categories[edit source]

Every page should be slotted into at least one category, to enable others to find it easily. If you are making new articles, it's very important to make sure they are put in the correct category.


Creating Tables[edit source]

The syntax for creating table is fairly easy and very logical. Here's a basic example:

{|
! 1
! 2
! 3
|-
| 4
| 5
| 6
|}

That will look like this:

1 2 3
4 5 6

The tables are automatically formatted with the site style so you aren't required to add any style elements. The only time you would need to add an element to the table is if you want to specify a width or want to make a table that is different than the standard DiabloWiki style.

As you can see the wiki code 'looks' like a table and you can expand on this and format more complex tables. It's easy enough to look at other tables as well, to get inspiration if you want to do more advanced things with it.


Aligning Cells[edit source]

Aligning a shorter cell to the top to even out a multi-columned list.

  • Find Kulle's head.
  • Return Kulle's head to Adria at Hidden Camp
  • Listen to Kulle rejoice at being alive again

The code reads 

{|
| 
* Locate the [[Flooded Causeway]
* Go down to the [[Ruined Cistern]]
* Locate the exit to the [[Path to the Oasis]]
* Locate the [[The Forgotten Ruins]]
| valign="top" |
* Find Kulle's head.
* Return Kulle's head to [[Adria]] at [[Hidden Camp]]
* Listen to Kulle rejoice at being alive again
|}



Try it out![edit source]

There is a special Wiki Sandbox that you can try out your editing skills in, without making unnecessary changes to existing articles.


Further Reading[edit source]


Wiki Help Index [e]
• Help Contents

• Community Portal
• Markup - Create article - Sandbox
• Help FAQ
• Wiki Support
• Category Structure
• DiabloWiki Policies
• Help Category
• Link us

 • Wiki Tools

• Article History
• Boilerplates
• Deleting pages
• Disambiguations
• Moving Articles
• Redirects
• Stubs
• Templates

 • Glossary

• Articles
• Categories
• Images
• Linking
• Tables
• Talk Pages
• Vandalism

Retrieved from "https://dev.diablowiki.net/index.php?title=Help:Markup&oldid=68056"