Actions

Help

Wiki markup

From Retro CDN

Revision as of 10:15, 23 January 2024 by SorachiJirachi (talk | contribs) (Created page with "'''← Help: Contents''' This page is a tutorial for learning to work with the essential rules of wiki-formatted text, or "wikitext". Wikitext is designed to be as si...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Help: Contents

This page is a tutorial for learning to work with the essential rules of wiki-formatted text, or "wikitext". Wikitext is designed to be as simple as possible so that an article may be quickly typed and styled without having to take a break to type out long HTML codes. The goal is to make it as easy as possible to channel your thoughts into writing the perfect article (or even a not-so-perfect article!).

Text formatting

Creating italicized or bold text is the simplest rule – simply use the apostrophe character in groups of two or three to create the style. (Be sure to use the "straight" apostrophe and not the curved "smart quote" characters used in some text editors and word processors.)


What you type What you see
''italicized text'' italicized text
'''bold text''' bold text
'''''italicized and bold text''''' italicized and bold text


To create a tabbed list or a block of text using a monospace font, start the line with a space. (Be sure not to make the line too long, or it will stretch the page horizontally!) Text can also be indented in blockquotes using the colon character.


What you type What you see

 Preformatted text

Preformatted text
:Indented text
Indented text

Lists

Both unordered and numbered lists are simple to create as well: simply use the asterisk or hash characters at the beginning of a line to create the entry. To create nested lists, simply add an extra asterisk or hash to the front of the line. You can even mix and match the kinds of list in a single group!

To create a definition, start the line with a semicolon, and follow the term to be defined with a colon, then the definition. This will bold the term, and indent the definition on the following line.

What you type What you see
* Item One
* Item Two
  • Item One
  • Item Two
# Item One
# Item Two
  1. Item One
  2. Item Two
* Item One
** Item Two
  • Item One
    • Item Two
* Item One
*# Item Two
  • Item One
    1. Item Two
; term : definition
term 
definition

Links and URLs

In a wiki, it's important to help build the web by creating links to other articles in every appropriate context. For example, if you were editing pages within Sega Retro, you would use the following techniques to create "free links" to other Sega Retro articles:

What you type What you see
[[Sega Mega Drive]] Sega Mega Drive
[[Streets of Rage 2|The second game in the ''Streets of Rage'' series]] The second game in the Streets of Rage series
[[Plinker's Canyon#Death Wish II|as seen in ''Death Wish II'']] as seen in Death Wish II
[[This article doesn't exist]] This article doesn't exist
[[Sega Retro:Scanning]] Sega Retro:Scanning
[[Sega Retro:Scanning|Scanning Guide]] Scanning Guide

You can also make external links to other websites. For example, if you wanted to link to pages on Sonic Retro from Sega Retro, you would do so using the following formatting rules:

What you type What you see
[[sonic:Knuckles the Echidna]] sonic:Knuckles the Echidna
[[sonic:Knuckles the Echidna|Knuckles the Echidna]] Knuckles the Echidna
[[sonic:Sonic Labyrinth|''Sonic Labyrinth'']] Sonic Labyrinth
http://www.sonicretro.org/ http://www.sonicretro.org/
[http://www.sonicretro.org/] [1]
[http://www.sonicretro.org/ Sonic Retro] Sonic Retro

sonic: is but one of a number of codes recognized across the entire Retro platform:

Code Website What you type What you see
sonic: Sonic Retro [[sonic:Sonic Labyrinth|''Sonic Labyrinth'']] Sonic Labyrinth
sega: Sega Retro [[sega:Golden Axe II|''Golden Axe II'']] Golden Axe II
nec: NEC Retro [[nec:Bonk's Revenge|''Bonk's Revenge'']] Bonk's Revenge
cdn: RetroCDN [[cdn:Help:Contents|Help:Contents]] Help:Contents
wikipedia: Wikipedia [[wikipedia:Shigeru Miyamoto|Shigeru Miyamoto]] Shigeru Miyamoto

Sections

If an article is long enough, you can divide the page into different sections. The Retro family of wiki's will automatically generate a table of contents based on the content for all articles with more than three sections.

You can also create a horizontal divider by using four dashes in a row.

What you type What you see
 == Header Two ==  Header Two      
 === Header Three ===  Header Three
 ==== Header Four ====  Header Four
 ===== Header Five =====  Header Five
 ====== Header Six ======   Header Six
 ----

Images and other media

See: Help: Image markup

Tables

See: Help: Table markup

Mathematical formulae

See: Help: Math markup

Variables

The MediaWiki software has a number of built-in variables for common elements that may change depending on the date.

Code Effect
{{CURRENTMONTH}} 11
{{CURRENTMONTHNAME}} November
{{CURRENTMONTHNAMEGEN}} November
{{CURRENTDAY}} 15
{{CURRENTDAYNAME}} Friday
{{CURRENTYEAR}} 2024
{{CURRENTTIMESTAMP}} 20241115152608
{{NUMBEROFARTICLES}} 36

NUMBEROFARTICLES is the number of pages in the main namespace which contain a link and are not a redirect (i.e. number of articles, stubs containing a link, and disambiguation pages).

See also

Suppressing markup

It's also possible to tell MediaWiki to ignore any of the above rules using a simple tag:

What you type What you see
<nowiki>'''text here'''</nowiki> '''text here'''