Difference between revisions of "Instructions to Wiki Editors"

Jump to navigation Jump to search

Instructions to Wiki Editors (view source)

Revision as of 03:18, 25 October 2018

1,744 bytes added ,  03:18, 25 October 2018
→‎Cite: - Update Cite syntax
m (Typo*s*)
(→‎Cite: - Update Cite syntax)
(10 intermediate revisions by 3 users not shown)
Line 14: Line 14:
# 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''.
# 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''.
# ScummVM is distributed on many platforms. When giving instructions on encoding audio or similar tasks, try to cover at least Linux, Mac OS X and Windows. Most of the users will have one of these operating system.
# ScummVM is distributed on many platforms. When giving instructions on encoding audio or similar tasks, try to cover at least Linux, Mac OS X and Windows. Most of the users will have one of these operating system.
== Translation ==
* To translate a page into a different language, create a new page by adding the ''/lang'' postfix, where lang is the language code for the translation. For example, the translation of [[User Manual/Introduction]] in German is in [[User Manual/Introduction/de]].
* At the top of the page, add the ''<nowiki>{{Languages}}</nowiki>'' 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:
<nowiki>#REDIRECT [[User Manual/ScummVM Interface]]</nowiki>


== Trusted User Group ==
== Trusted User Group ==
As a normal user there are things you cannot do on the wiki. For example you cannot delete and undelete pages or edit the wiki interfaces (e.g. modify the [[MediaWiki:Sidebar|Sidebar]]). A group of users with slightly more powers than normal user exists. Membership to this group is decided on a case by case basis by [[User:Fingolfin|Fingolfin]] and [[User:Sev|Sev]]. If you want to be added to the group then contact them (e.g. by e-mail or on IRC) and they might accede to your request.
As a normal user there are things you cannot do on the wiki. For example you cannot delete and undelete pages or edit the wiki interfaces (e.g. modify the [[MediaWiki:Sidebar|Sidebar]]). A group of users with slightly more powers than normal user exists. Membership to this group is decided on a case by case basis by the project leaders. If you want to be added to the group then contact them (e.g. by e-mail or on IRC) and they might accede to your request.


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


== SyntaxHighlight GeSHi ==
== SyntaxHighlight ==
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.
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
'''Link:''' https://www.mediawiki.org/wiki/Extension:SyntaxHighlight


'''Syntax:'''
'''Syntax:'''


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


Line 37: Line 45:
     ~MyClass();
     ~MyClass();
};
};
</source>
</syntaxhighlight >
</pre>
</pre>


Which gives the following result:
Which gives the following result:


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


Line 50: Line 58:
     ~MyClass();
     ~MyClass();
};
};
</source>
</syntaxhighlight >
 
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.


<pre>
== SimpleMathJax ==
<syntax type="C++">
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 [http://meta.wikimedia.org/wiki/Help:Formula described here].
#include <foo.h>


class MyClass {
For inline equation use <code>\(...\)</code> and  for display style math use instead  <code>&lt;math&gt;...&lt;/math&gt;</code>.
public:
    MyClass();
    ~MyClass();
};
</syntax>
</pre>


== JsMath ==
MathJax produces nice and scalable mathematics, see their website (http://www.mathjax.org/) for a demonstration.  
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 [http://meta.wikimedia.org/wiki/Help:Formula described here].


'''Link:''' http://www.mediawiki.org/wiki/Extension:JsMath
'''Link:''' https://www.mediawiki.org/wiki/Extension:SimpleMathJax


'''Syntax:'''
'''Syntax:'''
Line 84: Line 82:
Skewness(X) = \frac{N}{(N-1)*(N-2)*\sigma(X)^3} * \sum_{i=1}^{N}{(X_i - E(X))^3}
Skewness(X) = \frac{N}{(N-1)*(N-2)*\sigma(X)^3} * \sum_{i=1}^{N}{(X_i - E(X))^3}
</math>
</math>
== GoogleDocs4MW ==
This extension can be used to embed Google spreadsheet into a wiki page.
'''Link:''' https://www.mediawiki.org/wiki/Extension:GoogleDocs4MW
'''Syntax:'''
<pre>
<googlespreadsheet width="600" height="200" style="width: 50%">Google Docs' key goes here</googlespreadsheet>
</pre>
'''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.


== Cite ==
== Cite ==
Line 95: Line 107:


<pre>
<pre>
This is an example of use of the Cite extension<ref>Criezy, ScummVM wiki, 2009</ref>.
This is an example of use of the <ref group="footnotes">Cite</ref> extension<ref>Criezy, ScummVM wiki, 2009</ref>.
</pre>
</pre>


Line 101: Line 113:


<pre>
<pre>
--- Notes ---
==Notes==
<references group="footnotes" />
 
==References==
<references />
<references />
</pre>
</pre>
Line 107: Line 122:
This example gives:
This example gives:


This is an example of use of the Cite extension<ref>Criezy, ScummVM wiki, 2009</ref>.
This is an example of use of the <ref group="footnotes">Cite</ref> extension<ref>Criezy, ScummVM wiki, 2009</ref>.
 
==Notes==
<references group="footnotes" />


--- Notes ---
==References==
<references />
<references />


Retrieved from "https://wiki.scummvm.org/index.php?title=Special:MobileDiff/13174...24644"

Navigation menu