Difference between revisions of "Help:Wiki markup cheatsheet"

From RimWorld Wiki
Jump to navigation Jump to search
m (Thought I'd add some I knew of)
m
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
{{navbar help}}
  
This is a simple guide about the special markup language used to edit RimWorld Wiki, and is not a full guide. RimWorld Wiki runs [https://www.mediawiki.org/wiki/MediaWiki MediaWiki] with the [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic] extension.
+
{| class="wikitable" align="center" style="width:100%;"
 +
|colspan="3" align="center" style="text-align:center;" |
 +
<h2 style="margin:.5em; margin-top:.1em; margin-bottom:.1em; border-bottom:0; font-weight:bold;">Wiki markup cheatsheet</h2>
 +
|-<!--WORKS ANYWHERE IN THE TEXT-->
 +
| colspan=3 style="text-align: center;" |
 +
'''Works anywhere in the text'''
 +
|-<!--COLUMN HEADINGS--> style="padding:0.3em; font-size: 0.9em; text-align:center;"
 +
! style="width:30%" | Description
 +
! You type
 +
! style="width:30%" | You get
 +
|-<!--1ST ROW 1ST COLUMN-->
 +
|Italics{{Anchor|Italic text}}, bold{{Anchor|Bold text}}, and both{{Anchor|bold and italic}}
 +
|<!--2ND COLUMN-->
 +
<code><nowiki>''italics'', '''bold''', and '''''both'''''</nowiki></code>
 +
|<!--3RD COLUMN-->
 +
''italics'', '''bold''', and '''''both'''''
 +
|-<!--HORIZONTAL LINE-->
 +
|colspan="3" style="border-top:1px solid #cee0f2;"|
 +
|-<!--2ND ROW 1ST COLUMN-->
 +
|[[wikipedia:Wikipedia:Manual_of_Style|Link]]{{Anchor|Internal link}} to another page
 +
|
 +
<code><nowiki>[[Help:Starting a new page]]</nowiki></code><br />
 +
<code><nowiki>[[Help:Links]]</nowiki></code>
 +
|
 +
[[Help:Starting a new page]]<br />[[Help:Links]]
 +
|-
 +
|colspan="3" |
 +
|-
 +
|
 +
"[[Help:Links|Pipe]]" a link to change the link's destination
 +
|
 +
<code><nowiki>[[Help:Editing pages|Edit a page]]</nowiki></code>
 +
|
 +
[[Help:Editing pages|Edit a page]]
 +
|-
 +
|colspan="3" |
 +
|-
 +
|
 +
Link to a section
 +
|
 +
<code><nowiki>[[Images#Link_behavior]]</nowiki></code><br>
 +
<code><nowiki>[[Images#Link_behavior|Link behavior and images]]</nowiki></code>
 +
|
 +
[[Images#Link behavior]]<br>
 +
[[Images#Link behavior|Link behavior and images]]
 +
|-
 +
|colspan="3" |
 +
|-
 +
|[[Links|Red link]]
 +
<div style="padding: 0.7em .5em; font-size:0.9em;">''red links in articles help by showing desired pages to be created''</div>
 +
|
 +
<code><nowiki>[[a red link]]</nowiki></code>
 +
|
 +
[[a red link]]
 +
|-
 +
|colspan="3" |
 +
|-
 +
|Signature{{Anchor|Signature}}
 +
<div style="padding: 0.7em .5em; font-size:0.9em;">''sign your contributions when posting to a [[mw:Help:Talk_pages|talk page]]''</div>
 +
|
 +
<code><nowiki>~~~~</nowiki></code>
  
==Basic Markup==
+
<span style="font-size:0.9em;">''do not sign in an article, only on talk pages''</span>
 
+
|
{| {{STDT| sortable}}
+
[[Special:Mypage|Username]] ([[Special:Mytalk|talk]]) {{CURRENTTIME}}, {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} (UTC)
! Effect !! What you type !! What shows up
+
|-
 +
|colspan="3" |
 +
|-
 +
|Plain website
 +
|
 +
<code><nowiki>https://www.mediawiki.org</nowiki></code>
 +
|
 +
https://www.mediawiki.org
 +
|-
 +
|colspan="3" |
 +
|-
 +
|Link a website
 +
|
 +
<code><nowiki>[https://www.mediawiki.org]</nowiki></code>
 +
|
 +
[https://www.mediawiki.org]
 +
|-
 +
|colspan="3" |
 +
|-
 +
|Link and name a website
 +
|
 +
<code><nowiki>[https://www.mediawiki.org MediaWiki]</nowiki></code>
 +
|
 +
[https://www.mediawiki.org MediaWiki]
 +
|-
 +
|colspan="3" |
 +
|-
 +
|[[Wikipedia:STRIKE|Strike]] your [[Wikipedia:TALK|talk page]] comment
 +
<div style="padding: 0.7em .5em; font-size:0.9em;">''to show your previous comment is outdated''</div>
 +
|
 +
<code><nowiki><s>This page is missing important infomation.</s></nowiki></code>
 +
|
 +
<s>This page is missing important infomation.</s>
 +
|-
 +
|colspan="3" |
 
|-
 
|-
! Bold (Wiki)
+
|Hide text somewhere for editors
| <code><nowiki>'''foo''' </nowiki></code> || | '''foo'''
+
<div style="padding: 0.7em .5em; font-size:0.9em;">''Essentially leaving comments in an article''</div>
 +
|
 +
<code><nowiki><!--Check the help section for assistance with templates!--></nowiki></code>
 +
|
 +
<!--Check the help section for assistance with templates!-->
 
|-
 
|-
! Italics (Wiki)
+
|colspan="3" |
| <code><nowiki>''foo''</nowiki></code> || | ''foo''
 
 
|-
 
|-
! Bold italics (Wiki)
+
|[[Help:Images|Show an image]]
| <code><nowiki>'''''foo'''''</nowiki></code> || | '''''foo'''''
+
<div style="padding: 0.7em .5em; font-size:0.9em;">''for uploading, see the [[Help:Managing files]]
 +
''</div>
 +
{{Anchor|Thumbnail image}}
 +
|
 +
<code><nowiki>[[File:Bedroll east.png|thumb|Caption]]</nowiki></code>
 +
|
 +
[[File:Bedroll east.png|thumb|Caption]]
 
|-
 
|-
! Bold (HTML)
+
|colspan="3" |
| <code><nowiki><b>foo</b></nowiki></code> || | <b>foo</b>
 
 
|-
 
|-
! Italics (HTML)
+
|Add a page to a category
| <code><nowiki><i>foo</i></nowiki></code> || | <i>foo</i>
+
|<code><nowiki>[[Category:Category name]]</nowiki></code><br><br><span style="font-size:0.9em;">''place near the bottom of a page''</span>
 +
|<span style="font-size:0.9em;">''shows''</span> "Category name" <span style="font-size:0.9em;">''in a bar at bottom when the page is previewed or saved''</span>
 
|-
 
|-
! Strikethrough (HTML)
+
|colspan="3" |
| <code><nowiki><s>foo</s></nowiki></code> || | <s>foo</s>
 
 
|-
 
|-
! Underline (HTML)
+
| Link to a category or file
| <code><nowiki><u>foo</u></nowiki></code> || | <u>foo</u>
+
|
 +
<code><nowiki>[[:Category:Help]]</nowiki></code><br />
 +
<code><nowiki>[[:File:Medicine.png]]</nowiki></code>
 +
| [[:Category:Help]]<br />[[:File:Medicine.png]]
 +
|-<!--WORKS ONLY AT THE BEGINNING OF LINES-->
 +
| colspan="3" style="text-align: center;" |
 +
'''Works only at the beginning of lines'''
 +
|-<!--COLUMN HEADINGS--> style="padding:0.3em; font-size: 0.9em; text-align:center;"
 +
! style="width:30%" | Description
 +
! You type
 +
! style="width:30%" | You get
 
|-
 
|-
! Comment (HTML)
+
|Redirect to another page{{Anchor|Redirect to another page}}
| <code><nowiki><!-- This is a comment which only shows in editing --></nowiki></code> || | Only shown in edit<!-- This is a comment you won't see unless editing -->
+
<div style="padding: 0.7em .5em; font-size:0.9em;">''redirects must be placed at the start of the first line''</div>
 +
|
 +
<code><nowiki>#REDIRECT [[About RimWorld]]</nowiki></code>
 +
|
 +
[[File:Redirectltr black.PNG|30px|link=]] [[About RimWorld]]
 
|-
 
|-
! Internal Link
+
|colspan="3"|
| <code><nowiki>[[Main Page]]</nowiki></code> || | [[Main Page]]
 
 
|-
 
|-
! External Link
+
|Redirect to a section of another page
| <code><nowiki>[https://en.wikipedia.org/wiki/Help:Wiki_markup Wikipedia:Help:Wiki markup]</nowiki></code> || | [https://en.wikipedia.org/wiki/Help:Wiki_markup Wikipedia:Help:Wiki markup]
+
|
 +
<code><nowiki>#REDIRECT [[About RimWorld#The tactics engine]]</nowiki></code>
 +
|
 +
[[File:Redirectltr black.PNG|30px|link=]] [[About RimWorld#The tactics engine]]
 
|-
 
|-
! Read as plain text
+
|colspan="3" |
| <code><nowiki><nowiki>[[foo]]</nowiki></nowiki></code> || | <nowiki>[[foo]]</nowiki>
 
 
|-
 
|-
|}
+
|[[Help:Formatting#Level 2|Section headings]]{{Anchor|Section headings}}<br>
==Headings==
+
<div style="padding: 0.7em .5em; font-size:0.9em;">''a Table of Contents will automatically be generated when four headings are added to an article''</div>
Heading 1 is the default if none is specified.
+
|
<pre>
+
<code><nowiki>==Level 2==</nowiki></code><br>
=Heading 1=
+
<code><nowiki>===Level 3===</nowiki></code><br>
==Heading 2==
+
<code><nowiki>====Level 4====</nowiki></code><br>
===Heading 3===
+
<code><nowiki>=====Level 5=====</nowiki></code><br>
====Heading 4====
+
<code><nowiki>======Level 6======</nowiki></code>
=====Heading 5=====
+
 
======Heading 6======
 
</pre>
 
  
==Common templates to use==
+
<span style="font-size:0.9em">''do not use''&nbsp; =Level 1=&nbsp; ''as it is for page titles''</span>
Documentation can be seen in detail on each template's page.
+
|
  
[[Template:Define]] is used for infoboxes (drug, material, textile, food, medical items and exotic items, check [[Template:Define/doc]] for all supported item types.)<br />
+
==Level 2==
[[Template:Infobox main]] is used for infoboxes (everything else not supported by [[Template:Define]])<br />
+
===Level 3===
[[Template:Asof]] is used to reference different versions of RimWorld.<br />
+
====Level 4====
[[Template:STDT]] is used for tables.<br />
+
=====Level 5=====
[[Template:List]] is to list the items in a category.<br />
+
======Level 6======
[[Template:Icon]] is used to display pictures the size of icons, inline with text.
+
|-
 +
|colspan="3" |
 +
|-
 +
|[[Help:Formatting|Bulleted list]]{{Anchor|Bulleted list}}
 +
|
 +
<code>* One</code><br>
 +
<code>* Two</code><br>
 +
<code>** Two point one</code><br>
 +
<code>* Three</code>
 +
|
 +
* One
 +
* Two
 +
** Two point one
 +
* Three
 +
|-
 +
|colspan="3" |
 +
|-
 +
|[[Help:Formatting|Numbered list]]{{Anchor|Numbered list}}
 +
|
 +
<code># One</code><br>
 +
<code># Two</code><br>
 +
<code>## Two point one</code><br>
 +
<code># Three</code>
 +
|
 +
# One
 +
# Two
 +
## Two point one
 +
# Three
 +
|-
 +
|colspan="3" |
 +
|-
 +
|Indenting text{{Anchor|Indenting text}}
 +
<div style="padding: 0.7em .5em; font-size:0.9em;">''this is used when replying on a talk page, to make it easier to follow conversations.''</div>
 +
|
 +
<code><nowiki>no indent (normal)</nowiki></code><br>
 +
<code><nowiki>:first indent</nowiki></code><br>
 +
<code><nowiki>::second indent</nowiki></code><br>
 +
<code><nowiki>:::third indent</nowiki></code><br>
 +
<code><nowiki>::::fourth indent</nowiki></code><br>
 +
|
 +
no indent (normal)<br>
 +
:first indent
 +
::second indent
 +
:::third indent
 +
::::fourth indent
 +
|}
  
[[Template:Stat]] is used to define a stat.<br />
+
== See also ==
[[Template:Property with Page]] is used to define the properties included in infoboxes.
+
* [https://meta.wikimedia.org/wiki/Help:Reference_card MediaWiki reference card]
  
[[Category:Help pages]]
+
[[Category:Help]]

Revision as of 04:54, 4 August 2019


Wiki markup cheatsheet

Works anywhere in the text

Description You type You get
ItalicsTemplate:Anchor, boldTemplate:Anchor, and bothTemplate:Anchor

''italics'', '''bold''', and '''''both'''''

italics, bold, and both

LinkTemplate:Anchor to another page

[[Help:Starting a new page]]
[[Help:Links]]

Help:Starting a new page
Help:Links

"Pipe" a link to change the link's destination

[[Help:Editing pages|Edit a page]]

Edit a page

Link to a section

[[Images#Link_behavior]]
[[Images#Link_behavior|Link behavior and images]]

Images#Link behavior
Link behavior and images

Red link
red links in articles help by showing desired pages to be created

[[a red link]]

a red link

SignatureTemplate:Anchor
sign your contributions when posting to a talk page

~~~~

do not sign in an article, only on talk pages

Username (talk) 16:34, 20 April 2024 (UTC)

Plain website

https://www.mediawiki.org

https://www.mediawiki.org

Link a website

[https://www.mediawiki.org]

[1]

Link and name a website

[https://www.mediawiki.org MediaWiki]

MediaWiki

Strike your talk page comment
to show your previous comment is outdated

<s>This page is missing important infomation.</s>

This page is missing important infomation.

Hide text somewhere for editors
Essentially leaving comments in an article

<!--Check the help section for assistance with templates!-->

Show an image
for uploading, see the Help:Managing files

Template:Anchor

[[File:Bedroll east.png|thumb|Caption]]

Caption
Add a page to a category [[Category:Category name]]

place near the bottom of a page
shows "Category name" in a bar at bottom when the page is previewed or saved
Link to a category or file

[[:Category:Help]]
[[:File:Medicine.png]]

Category:Help
File:Medicine.png

Works only at the beginning of lines

Description You type You get
Redirect to another pageTemplate:Anchor
redirects must be placed at the start of the first line

#REDIRECT [[About RimWorld]]

30px About RimWorld

Redirect to a section of another page

#REDIRECT [[About RimWorld#The tactics engine]]

30px About RimWorld#The tactics engine

Section headingsTemplate:Anchor
a Table of Contents will automatically be generated when four headings are added to an article

==Level 2==
===Level 3===
====Level 4====
=====Level 5=====
======Level 6======


do not use  =Level 1=  as it is for page titles

Level 2

Level 3

Level 4

Level 5
Level 6
Bulleted listTemplate:Anchor

* One
* Two
** Two point one
* Three

  • One
  • Two
    • Two point one
  • Three
Numbered listTemplate:Anchor

# One
# Two
## Two point one
# Three

  1. One
  2. Two
    1. Two point one
  3. Three
Indenting textTemplate:Anchor
this is used when replying on a talk page, to make it easier to follow conversations.

no indent (normal)
:first indent
::second indent
:::third indent
::::fourth indent

no indent (normal)

first indent
second indent
third indent
fourth indent

See also