Instructions to Wiki Editors

From ScummVM :: Wiki
Revision as of 23:21, 9 February 2010 by Fingolfin (talk | contribs) (→‎JsMath: Added link to Help:Formula page in the MetaWiki)
Jump to navigation Jump to search

These instructions are written mainly with the edition of the User Manual in mind. Some of the points might also be valid for other parts of the wiki though.

General Rules

No controversial material

The basic rule is to keep in mind that we do not want problems with right holders and therefore we do not want to have links to illegal content or to document steps that might be illegal. An obvious example is links to so-called abandonware sites. Another less obvious example is instructions on how to jailbreak an iPhone or a Wii so that we can install ScummVM. We should write the instructions starting from the assumption that the device is already jail-broken.

Spelling and grammar

  1. For consistency sake it is better to use the American English spelling everywhere rather than mix British and American English spellings. That means that you should prefer color and finalize over colour and finalise.
  2. Please do not use contractions (e.g If you've navigated for If you have navigated). They are usually used in spoken English but not much in written English, although there are some exceptions (e.g. It doesn't work is fine for non formal written English, as is the expended form It does not work). If in doubt use the expended form. Also the User Manual is a bit more formal than for example an e-mail; and as such contractions that might be fine in an e-mail are not necessarily fine in the User Manual.
  3. Do not use very complex grammatical structure or abstruse words (abstruse meaning difficult to comprehend and being an example of words to avoid). Keep in mind that many ScummVM users are not native English speakers and may not speak English as well as you do.

User Manual content

  1. Try to place yourself in the head of a complete newbie and make very explicit some information that might not be obvious for everybody. For example, instead of Navigate to the correct directory you might want to write Navigate to the directory that contains the game files.
  2. ScummVM is distributed on many platforms. When giving instructions on encoding audio or similar tasks try to cover at least Linux, Windows and Mac OS X. Most of the users will have one of these operating system.

Extensions

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

SyntaxHighlight GeSHi

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.

Link: http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi

Syntax:

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

class MyClass {
public:
    MyClass();
    ~MyClass();
};
</source>

Which gives the following result:

#include <foo.h>

class MyClass {
public:
    MyClass();
    ~MyClass();
};

Historically, we used a slightly different extension (also based on GeSHi) with a different syntax. For backward compatibility the extension now installed has been customized to also support this other syntax.

<syntax type="C++">
#include <foo.h>

class MyClass {
public:
    MyClass();
    ~MyClass();
};
</syntax>

JsMath

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 uses the same syntax, which is described here.

Link: http://www.mediawiki.org/wiki/Extension:JsMath

Syntax:

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

Which gives the following result:

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

Cite

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

Link: http://www.mediawiki.org/wiki/Extension:Cite/Cite.php

Syntax:

You need to use the <ref> tag to define a reference:

This is an example of use of the Cite extension<ref>Criezy, ScummVM wiki, 2009</ref>.

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

--- Notes ---
<references />

This example gives:

This is an example of use of the Cite extension[1].

--- Notes ---

  1. Criezy, ScummVM wiki, 2009

ParserFunctions and StringFunctions

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

Link: http://www.mediawiki.org/wiki/Extension:ParserFunctions

Syntax: See http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions and http://www.mediawiki.org/wiki/Extension:StringFunctions 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.

Link: http://semeb.com/dpldemo/index.php?title=Dynamic_Page_List

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