Instructions to Wiki Editors

From ScummVM :: Wiki
Jump to navigation Jump to search

Becoming a wiki editor

This wiki requires an account to edit pages. Accounts are given out on a per-case basis. Please contact sev through IRC, Discord, or e-mail if you would like an account.

As a wiki editor there are some things you cannot do on the wiki. For example, you cannot delete (or un-delete) pages, or edit the wiki interfaces such as the Sidebar. A group of users (trusted users) with slightly more powers than the normal user exists. Membership to this group is decided on a case by case basis by the project leaders.

General Rules

Style guide

All new documentation should follow the Google developer documentation style guide. Older documentation will gradually be brought in line with this guide.

No controversial material

Do not link to illegal content, or document steps that might be illegal. An obvious example is links to so-called abandonware sites. A less obvious example is instructions on how to jailbreak an iPhone or a Wii to install ScummVM.


  • At the top of the page, add the {{Languages}} template (see Template:Languages). If it is the first translation for that page, you will also need to add the template to the english page.
  • If your translated page points to a page that is not yet translated, you might want to link to the not yet existing translated page, create that page and redirect to the english page. That way you will not have to change all the links when you decide to translate the page. For example, if you want to link to User Manual/ScummVM Interface from a German page, but User Manual/ScummVM Interface has not yet been translated to German, you might want to point to User Manual/ScummVM Interface/de anyway and create that page with the following content:
#REDIRECT [[User Manual/ScummVM Interface]]


There are several wiki extensions installed to help you in the editing task.


This extension can be used to present source code with syntax highlighting. As you can guess for us it is mainly useful for C++ code, but it can also be used with other languages.



<syntaxhighlight lang="cpp">
#include <foo.h>

class MyClass {
</syntaxhighlight >

Which gives the following result:

#include <foo.h>

class MyClass {


This extension can be used to generate formulas using the LaTeX math syntax. It replaces MediaWiki's regular TeX based math support (that we cannot use due to server limitations) and the old jsMath and MathJax extensions. It uses the same syntax as all of these, which is described here.

For inline equation use \(...\) and for display style math use instead <math>...</math>.

MathJax produces nice and scalable mathematics, see their website ( for a demonstration.



Skewness(X) = \frac{N}{(N-1)*(N-2)*\sigma(X)^3} * \sum_{i=1}^{N}{(X_i - E(X))^3}

Which gives the following result:

[math]\displaystyle{ Skewness(X) = \frac{N}{(N-1)*(N-2)*\sigma(X)^3} * \sum_{i=1}^{N}{(X_i - E(X))^3} }[/math]


This extension can be used to embed Google spreadsheet into a wiki page.



<googlespreadsheet width="600" height="200" style="width: 50%">Google Docs' key goes here</googlespreadsheet>

Note: To actually embed a spreadsheet, the spreadsheet needs to be published with Google's File > Publish to Web... option. It is not sufficient to just have a shareable link.

ParserFunctions and StringFunctions

This extension adds logical functions and functions that operate on strings to the wiki parser.


Syntax: See and for a list of functions and their syntax.

Dynamic Page List

This extension is quite complex. Basically it can be used to display content from other pages into a wiki page.


Syntax: This extension is invoked with the parser function {‍{#dpl: .... }} or parser tag <DPL>. See the link above for more details and examples.


This extension can be used to create footnotes on a wiki page.



You need to use the <ref> tag to define a reference. You can specify a group if you want several groups of footnotes. You can also specify a name if you want several references to the same footnote.

This is an example of use of the Cite<ref group="note">This is a footnote for the Cite extension</ref> extension<ref>Criezy, ScummVM wiki, 2009</ref>.
We can also use the same reference<ref group="note" name="multiple">This is a note with multiple references</ref> in several places using a name<ref group="note" name="multiple" />.

And then to use the <references /> tag as a placeholder (e.g. at the bottom of the page for a footnote):

<references group="note" />

<references />

This example gives:

This is an example of use of the Cite[note 1] extension[1]. We can also use the same reference[note 2] in several places using a name[note 2].


  1. This is a footnote for the Cite extension
  2. 2.0 2.1 This is a note with multiple references


  1. Criezy, ScummVM wiki, 2009