Difference between revisions of "Instructions to Wiki Editors"

Jump to navigation Jump to search
→‎Extensions: Add GoogleDocs4MW in the list of extensions
(→‎General Rules: Add instructions to translate the wiki.)
(→‎Extensions: Add GoogleDocs4MW in the list of extensions)
(6 intermediate revisions by 2 users not shown)
Line 16: Line 16:


== Translation ==
== 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]].
* 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 bottom 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.
* 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.


'''Note:''' There seems to be a small bug in the template for the moment with the detection of the page. If the bar does not have the correct list of languages, you can specify the page explicitly in the template:
'''Note:''' There seems to be a small bug in the template for the moment with the detection of the page. If the bar does not have the correct list of languages, you can specify the page explicitly in the template:
  <nowiki>{{Languages|User Manual/Introduction}}</nowiki>
  <nowiki>{{Languages|User Manual/Introduction}}</nowiki>
The page name given to the template should always be the english page.
The page name given to the template should always be 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:'''
Line 61: Line 64:
</source>
</source>


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.
The extension also now supports using the ''syntaxhighlight'' tag instead of ''source'', which can help if the code itself contains the source tag:


<pre>
<pre>
<syntax type="C++">
<syntaxhighlight lang="xml">
#include <foo.h>
    <header path="include/foo.h" />
    <source path="src/foo.cpp" />
</syntaxhighlight>
</pre>
 
== SimpleMathJax ==
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].


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 93: Line 95:
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 ==
TrustedUser
2,147

edits

Navigation menu