Help:Editing

From Spring
Jump to navigationJump to search

This page contains tips on editing wiki pages, for full details of editing the Wiki see User's Guide

Basic Editing

  • Choose what you want to do:
    1. Make a new page
      Type the URL of the page you want to create into the address bar.
      EG: http://springrts.com/wiki/Page_that_doesnt_exist
    2. Edit an existing page
      Goto the page you want to edit, either through Links, or a URL.
  • Then, click the 'Edit this page' link at the bottom.
  • A page with a text box in the middle of it will appear.
  • Enter text into this box.
  • To insert formatting, click the formatting buttons above the text box.
  • For a full list of formatting tags, and their effects, see below
  • Click the 'Preview Page' button below the text box to preview the page.
  • Fix any errors you spot.
  • Click 'Save page' next to the Preview button.
  • You're Done!


Dont worry if you stuff things up. Its very easy to fix. Any changes that are made are automatically logged, and we can easily revert to an old version if you totally screw a page up. And if your still worried of messing something up, you can always play around in your own user page first.

Markup

The following HTML elements are currently permitted, however most of the useful ones have a convenient shorthand (see table below):


Sections, paragraphs, lists and lines

What it looks like What you type

Start your sections with header lines:

Note: Single equal signs work for formatting headings, however as a convention for this wiki, do not use them.


New section

Subsection

Sub-subsection


== New section ==

=== Subsection ===

==== Sub-subsection ====

Newline:

A single newline has no effect on the layout.

But an empty line starts a new paragraph.

(<p> disables this paragraphing until </p> or the end of the section)

(in Cologne Blue two newlines and a div tag give just one newline; in the order newline, div tag, newline, the result is two newlines)


A single
newline
has no
effect on the
layout.

But an empty line
starts a new paragraph.
You can break lines
without starting a new paragraph.

Sufficient as wikitext code is <br>, the XHTML code <br /> is not needed, the system produces this code.

You can break lines<br>
without starting a new paragraph.
  • Lists are easy to do:
    • start every line with a star
      • more stars means deeper levels
  • A newline
  • in a list

marks the end of the list.

  • Of course
  • you can
  • start again.
* Lists are easy to do:
** start every line with a star
*** more stars means deeper levels
*A newline
*in a list  
marks the end of the list.
*Of course
*you can
*start again.

  1. Numbered lists are also good
    1. very organized
    2. easy to follow
  2. A newline
  3. in a list

marks the end of the list.

  1. New numbering starts
  2. with 1.
# Numbered lists are also good
## very organized
## easy to follow
#A newline
#in a list  
marks the end of the list.
#New numbering starts
#with 1.
  • You can even do mixed lists
    1. and nest them
      • like this
        or have newlines
        inside lists
* You can even do mixed lists
*# and nest them
*#* like this<br>or have newlines<br>inside lists
  • You can also
    • break lines
      inside lists
      like this
* You can also
**break lines<br>inside lists<br>like this
Definition list
list of definitions
item
the item's definition
; Definition list : list of definitions
; item : the item's definition
A colon indents a line or paragraph.

A manual newline starts a new paragraph.

  • This is primarily for displayed material, but is also used for discussion on Talk pages.
: A colon indents a line or paragraph.
A manual newline starts a new paragraph.
IF a line of plain text starts 
with a space THEN
  it will be formatted exactly
    as typed;
  in a fixed-width font;
  lines won't wrap;
ENDIF
this is useful for:
  * pasting preformatted text;
  * algorithm descriptions;
  * program source code
  * ASCII art;
  * chemical structures;

WARNING If you make it wide, you force the whole page to be wide and hence less readable. Never start ordinary lines with spaces.

(see also below)
 IF a line of plain text starts 
with a space THEN
   it will be formatted exactly
     as typed;
   in a fixed-width font;
   lines won't wrap;
 ENDIF
 this is useful for:
   * pasting preformatted text;
   * algorithm descriptions;
   * program source code
   * ASCII art;
   * chemical structures;
Centered text.
<center>Centered text.</center>
A horizontal dividing line: above

and below.

(However, in most cases a section header is more useful. The horizontal dividing line should only be used if what follows is logically part of the same section; otherwise that part would be hidden in the TOC.)
A horizontal dividing line: above
----
and below. 

Summarizing the effect of a single newline: no effect in general, but it ends a list item or indented part; thus changing some text into a list item, or indenting it, is more cumbersome if it contains newlines, they have to be removed; see also Don't use line breaks (wikipedia).

More markup

Posting code

If (not horse) then
 GameOver()
end

use like:

<code><pre>CODE HERE</pre></code>

<code> tags alone fails sometimes.


Linking to forum threads

random wip, page 4

use like:

{{forumlink|topic=8864&start=60|title=random wip, page 4}}


Linking to engine source files

rts/Sim/Units/UnitDefHandler.cpp

use like:

{{sourcelink|file=rts/Sim/Units/UnitDefHandler.cpp}}


Linking to github commits

7d3830a0

use like:

{{Sourcelinkhash|7d3830a01c7e81377c1fd3369658d95b82979612}}


Footnotes

The adult horse weights up to 500 metric tons.[1]
Rest of page
..
..

use like:

<ref>wikipedia says so,http://en.wikipedia.org/wiki/Rollie_Free</ref> <references/>

Red Warning Text

ATTENTION: This wiki is serious business!

use like:

<span class="warning">ATTENTION: This wiki is serious business!</span>

Newly added to engine version XY

Spring.Blabla (blubber) New in version 95.0

use like:

Spring.Blabla (blubber) {{new|95.0}}