| Home Page | Recent Changes | Preferences

# Wiki Markup

To edit a wiki page, click on the "Edit text of this page" link at the bottom of the page. This will take you to a page with a text box: in this text box is the text of the wiki page. Press "Save" to store your changes in the wiki. The "preview" button will reload the form page, with the output beneath it.

Wiki markup is essentially plain text, with a few simple control characters that are listed below. You can test these in the Sandbox. Guidelines On Technical Names has conventions on page names and formatting. /Converting from HTML.

## Sections, Paragraphs, Lists and Lines

Start your sections with header lines:

### New Section

#### Subsection

    Start your sections with header lines:

    === New Section
    ==== Subsection

You can break lines without starting a new paragraph. |
    You can break lines \\
    without starting a new paragraph.

- Lists are good:
  - they organize material
  - they look clean

    * Lists are good:
    ** they organize material
    ** they look clean

1. Numbered lists are also good:
   1. very organized
   2. easy to follow

    # Numbered lists are also good
    ## very organized
    ## easy to follow

Definition lists
  lists with definitions
Item to be defined
  the item's definition

    ; Definition lists : lists with definitions
    ; Item to be defined : the item's definition

- Mixing list types is straightforward:
  1. First subitem
  2. Second subitem

    * Mixing list types is straightforward:
    *# First subitem
    *# Second subitem

Another mixed-type list
  A definition with subitems
  - First subitem
  - Second subitem

    ; Another mixed-type  list: A definition with subitems
    ;* First subitem
    ;* Second subitem

Lines can be indented several levels |
    : Lines can be
    :: indented
    ::: several levels
     IF (a line starts with whitespace) THEN
       it will be formatted exactly as typed;
       in a technical looking font;
       lines won't wrap;
     ENDIF
     this is useful for:
       * pasting preformatted text;
       * algorithm descriptions;
       * ascii art;
     IF (a line starts with whitespace) THEN
       it will be formatted exactly as typed;
       in a technical looking font;
       lines won't wrap;
     ENDIF
     this is useful for:
       * pasting preformatted text;
       * algorithm descriptions;
       * ascii art;
A box for an object class path: Actor >> Pawn (UT) >> PlayerPawn |
    A box for an object class path:
    @@ [[Actor]] >> [[Pawn]] >> PlayerPawn
    // UnrealScript source code
    local int Countdown;
    for (Countdown = 10; Countdown >= 0; Countdown--)
      Log(Countdown $ "...");
    00001  // UnrealScript source code
    00002  local int Countdown;
    00003  for (Countdown = 10; Countdown >= 0; Countdown--)
    00004    Log(Countdown $ "...");
You can use `<uscript lines>` to automatically add line numbers. Keep in mind that people might want to copy and paste your code from their web browser, and line numbers must be laboriously removed from the pasted text before it's in a usable form. |
    <uscript>
    // UnrealScript source code
    local int Countdown;
    for (Countdown = 10; Countdown >= 0; Countdown--)
      Log(Countdown $ "...");
    </uscript>

    <uscript lines>
    // UnrealScript source code
    local int Countdown;
    for (Countdown = 10; Countdown >= 0; Countdown--)
      Log(Countdown $ "...");
    </uscript>

> You can put quoted text in a neat box.

> All Wiki formats apply there.

    > You can put quoted text in a neat box.
    > All Wiki formats apply there.

A horizontal dividing line: above

and below.

    A horizontal dividing line: above
    ----
    and below.

## Links, URLs, Images

Link to the Project FAQ. First letter of target is automatically capitalized. Spaces are converted into underscores. To create a new page: start with a link to it, then click on ?. Check out the Guidelines On Page Creation, that's where naming conventions currently live.) |
    Link to the [[Project FAQ]].
Same target, different name: answers. Targets can only contain letters and spaces! |
    Same target, different name: [[Project FAQ|answers]]
[The weather in London]? is a page that doesn't exist yet. You can start it by clicking on the question mark. After creating a page, search for its title and make sure that everyone correctly links to it. |
    [[The weather in London]] is a page that doesn't exist yet.
Redirect one article title to another by putting text like this in its first line. |
    #REDIRECT [[Project FAQ]]
External link: [Wikipedia] |
    External link: [http://www.wikipedia.org Wikipedia]
Or just give the URL: http://www.wikipedia.com. Email addresses: mychaeel@beyondunreal.com Good idea since it makes a printout more useful. Links to .zip files get a fancy box around them and are best used in a paragraph of their own. Links to image files display the images inline. |
    Or just give the URL: http://www.wikipedia.com. \\
    Email addresses: mychaeel@beyondunreal.com
Interlinks to other wikis: Tarquin (see InterWiki for the list of prefixes) |
    Interlinks to other wikis: [[UseMod:Tarquin]]
A picture: Upload images with the [Image Uploader]. It'll give you details about how to insert an image in a Wiki page after you have uploaded the image. Block and floating images with captions are also possible. |
    A picture: @inline@wikilogo-small

## Character Formatting

italic, bold, bold and colored. Use also in formulas: F = m a. |
    ''italic'', '''bold''', ''''bold and colored''''.
    Use also in formulas: '''F''' = ''m'' '''a'''.
Smileys are displayed as images |
    Smileys :rolleyes: are displayed as images :-)
A typewriter font for `technical terms`. |
    A typewriter font for <tt>technical terms</tt>.
Typewriter font, and no parsing: `[[link]] :-)` |
    Typewriter font, and no parsing: <code>[[link]] :-)</code>
To escape characters, i.e., interpret them as characters, not formatting commands: < | === |
    To escape characters, i.e. interpret them as characters,
    not formatting commands: <nowiki> < | === </nowiki>
You can strike out stuff and insert new stuff. Useful for editing. |
    You can <strike>strike out</strike> stuff
    and <u>insert new stuff</u>

#### Special Characters

Two hyphens make a dash – like this |
    Two hyphens make a dash -- like this
Three (or more) hyphens — make a longer dash |
    Three (or more) hyphens --- make a longer dash
An arrow for menu commands: File → Save |
    An arrow for menu commands: File -> Save
Sign your name: The sequence `~``~~` will insert your user name. Use it at the start of a line to quickly create thread discussions, like this (this will also work with lines indented with the `:` character): Tarquin: Good point, well made. Use it at the end of a line to sign a comment like this:

Good point, well made. —Tarquin

`~``~~ Good point, well made.`
`Good point, well made. ~``~~`

#### Umlauts and Accents

À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï Ñ Ò Ó Ô Õ Ö Ø Ù Ú Û Ü ß à á â ã ä å æ
ç è é ê ë ì í
î ï ñ ò ó ô õ
ö ø ù ú û ü ÿ

    &Agrave; &Aacute; &Acirc;  &Atilde; &Auml;   &Aring;  &AElig;
    &Ccedil; &Egrave; &Eacute; &Ecirc;  &Euml;   &Igrave; &Iacute;
    &Icirc;  &Iuml;   &Ntilde; &Ograve; &Oacute; &Ocirc;  &Otilde;
    &Ouml;   &Oslash; &Ugrave; &Uacute; &Ucirc;  &Uuml;   &szlig;
    &agrave; &aacute; &acirc;  &atilde; &auml;   &aring;  &aelig;
    &ccedil; &egrave; &eacute; &ecirc;  &euml;   &igrave; &iacute;
    &icirc;  &iuml;   &ntilde; &ograve; &oacute; &ocirc;  &otilde;
    &ouml;   &oslash; &ugrave; &uacute; &ucirc;  &uuml;   &yuml;

#### Punctuation

¿ ¡ « » § ¶ † ‡ • & (literal ampersand) |
    &iquest; &iexcl; &laquo; &raquo; &sect; &para;
    &dagger; &Dagger; &bull;
    &amp;

#### Evil Stuff

™ © ® ¢ € ¥ £ ¤ (Always use the code, these characters can mess up fonts on certain browsers.) |
    &trade; &copy; &reg; &cent; &euro; &yen; &pound; &curren;

#### Subscript and Superscript

x2 |
    x<sub>2</sub>
x2 |
    x<sup>2</sup>

#### Greek Characters

α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ σ ς τ υ φ χ ψ ω |
    &alpha;   &beta; &gamma; &delta;  &epsilon; &zeta; &eta;
    &theta;   &iota; &kappa; &lambda; &mu;      &nu;   &xi;
    &omicron; &pi;   &rho;   &sigma;  &sigmaf;  &tau;  &upsilon;
    &phi;     &chi;  &psi;   &omega;
Α Β Γ Δ Ε Ζ Η Θ Ι Κ Λ Μ Ν Ξ Ο Π Ρ Σ Τ Υ Φ Χ Ψ Ω |
    &Alpha;   &Beta; &Gamma; &Delta;  &Epsilon; &Zeta;    &Eta;
    &Theta;   &Iota; &Kappa; &Lambda; &Mu;      &Nu;      &Xi;
    &Omicron; &Pi;   &Rho;   &Sigma;            &Tau;     &Upsilon;
    &Phi;     &Chi;  &Psi;   &Omega;

#### Math Characters

∫ ∑ ∏ √ ± ∞ ≈ ∝ ≡ ≠ ≤ ≥ → × · ÷ ∂ ′ ″ ∇ ‰ ° ⋅ &there4; ℵ ø ∈ ∋ ∩ ∪ ⊂ ⊃ ⊆ ⊇
¬ ∧ ∨ ∃ ∀ ⇒ ⇔
(Note: not all of these work in all browsers and on all systems)

    &int;    &sum;    &prod;   &radic; &plusmn; &infin;
    &asymp;  &prop;   &equiv;  &ne;     &le;     &ge;    &rarr;
    &times;  &middot; &divide; &part;   &prime;  &Prime; &nabla;
    &permil; &deg;    &sdot;   &there4; &alefsym;
    &oslash; &isin;   &ni;     &cap;    &cup;    &sub;   &sup;  &sube; &supe;
    &not;    &and;    &or;     &exist;  &forall; &rArr;  &hArr;

#### Hard Spaces

x2 ≥ 0 Otherwise would look like this: x2≥0 This is useful in formulas. |
    x<sup>2</sup>&nbsp;&nbsp;&nbsp;&ge;&nbsp;&nbsp;&nbsp;0

#### ASCII Art Integrals

Start every line with a blank.
      ∞  -x2
      ∫ e   dx = √π
     -∞
      &infin;  -x<sup>2</sup>
      &int; e   dx = &radic;&pi;
     -&infin

## Tables

bAlwaysRelevant | Notoriously overconfident.
bHidden | Lacks self assurance.

    | bAlwaysRelevant | Notoriously overconfident.
    | bHidden | Lacks self assurance.

### A complex table

First | Second | Third
upper left | upper middle | right side
right aligned | centered | left aligned
bottom row spans three columns

    |||^ <wiki>=== A complex table ===</wiki>        |
    |^ '''First'''   |^ '''Second''' |^ '''Third'''  |
    |  upper left    |  upper middle | right side    |
    |> right aligned |^ centered     |< left aligned |
    |||^ bottom row spans three columns              |

To use sophisticated paragraph markup (like headings or lists) in a table cell, enclose it in `<wiki>...</wiki>`. The amount of whitespace between table cells is irrelevant for the resulting formatting.

See also:

- Wookee – More information about the formatter.
- MetaTopics – Other topics about the project.

Parts of the markup table are borrowed from [Wikipedia].

Mcspanky: How do you create a list item that's longer than one paragraph? e.g.:

1. The First Step

2. The Second Step
   This step is really great. You'll love doing it.

3. The Third Step

Mychaeel: Use the <wiki>...</wiki> tags to enclose your multiple paragraphs. (You can do that everywhere where otherwise just a single paragraph would be permitted.)

Kuhal: Is there a simple way to have a double-spaced numbered list?

1. item 1
2. item 2
3. item 3

My yuck way:

1. blah 1

2. blah 2

3. blah 3

Mychaeel: Like HTML, Wiki markup is supposed to be logical, not physical. Don't worry about spacing, it might look different in every style set anyway.

HunterKiller: This is the complete list of accepted smileys, from the Wookee:

`:)` | `:-)` | `=)` | `;)` | `;-)` | `:P` | `:-P` | `=P` | `:D` | `:-D` | `=D` | `:(` | `:-(` | `=(` | `o_O` | `O_o` | `O_O` | `:/` | `:-/` | `=/`

`:rolleyes:` | `:cheesy:` | `:cool:` | `:pissed:` | `:shocked:` | `:tup:` | `:tdown:` | `:stupid:` | `:eek:` | `:confused:` | `:angry:` | `:hmm:`

Wormbo: It doesn't seem to be complete yet, but we're still investigating.

Balu: Is there a way to add anchors on pages? e.g. to link from one point on the same page to another?

Mychaeel: No. On the other hand, if a page becomes so large that you need anchors in it, you might better consider splitting it into multiple pages.

Pingz: Too bad. With the new UnrealScript Keywords page i can see the usefulness of linking to an anchor so that you can point the reader directly to a definition within a bigger page.

El Muerte TDS: ok why doesn't -- work in preformatting, it's truncated to a single -

Mychaeel: "`--`" becomes an n-dash "–". In a monospaced font, that looks more or less exactly like the normal dash "-". For that matter,

      This is ''truly'' preformatted text -- as you can see.

      This text is merely put in a monospaced font with   whitespace   preserved – but formatting still works.

Ben 2500: why is this called evil stuff ™ © ® ¢ € ¥ £ ¤

Wormbo: Probably because it is evil. It messes up the font of the 'Edit this page' text box.

inio: Also, those symbols all represent money (or ownership of property). Money is the root of all evil.

JF: Actually, it is the love of money that is the root of all evil.

EntropicLqd: Is there any way of seeing all of the ways of embedding images into a page without uploading an image? I don't have an image to upload - but want to embed an existing image into the page. I'm having to hunt around the Wiki for information on how to do it.

inio: Here's a page with an embedded external image. Here's a page that avoids the embedding. Is there a better way to avoid the embedding than that? (If you're confused by the avoiding embedding: "%67" == "g")

Mychaeel: Adding "?bleh" or something like that to the image URL. (Perhaps "?link" for clarity, even though it really doesn't matter.)

I don't know if this is the place to note it, or even if it can be fixed, but there is an incompatibility with Opera and how the Wiki script parses code blocks. I took a quick look at the source and noticed that code blocks are constructed with CSS tags. While there isn't a problem with this under normal circumstances, having a PRE tag inside of a SPAN tag creates a little problem; the long lines of text wander off the edge of the screen without a horizontal scroll bar. It also breaks the boundaries of the CSS-applied borders and background color. What I want to know is, would it take a heckofa lot of codebashing to fix this? It doesn't bother me too much, because I use Opera and Internet Exploder interchangably (given Opera's poor use of IFRAMES, Flash, ActiveX, and VBScript and IE's tendancy to Explode with popups ).

Tarquin: Maybe ask people to break their long lines of code sensibly? Mych uses Opera, so I expect he's aware of this problem.

WheatPuppet: Go Mych!

inio: Is it OK if I copy this page down to the top of the commentary to my own Wookee-based wiki?

Wormbo: This page was initially copied from Wikipedia IIRC. So go ahead as long as you don't claim you wrote it yourself etc.

inio: Well, Project Copyright is pretty clear on the "link, don't copy" policy, so I figured I better ask. I fully expected the answer to be yes though.

The Unreal Engine Documentation Site

Wiki Community

Topic Categories

Image Uploads

Random Page

Recent Changes

Offline Wiki

Unreal Engine

Console Commands

Terminology

Mapping Topics

Mapping Lessons

UnrealEd Interface

Questions&Answers

Scripting Topics

Scripting Lessons

Making Mods

Class Tree

Questions&Answers

Modeling Topics

Questions&Answers

Log In