TrustedUser, Bureaucrats, Administrators
442
edits
Difference between revisions of "Instructions to Wiki Editors"
Jump to navigation
Jump to search
Tidies up the page - removes references to writing the user manual, adds reference to style guide etc
m (→Cite: Simplify empty tags) |
(Tidies up the page - removes references to writing the user manual, adds reference to style guide etc) |
||
| Line 1: | Line 1: | ||
==Becoming a wiki editor== | |||
This wiki requires an account to edit pages. Accounts are given out on a per-case basis. Please contact [[user:sev|sev]] through IRC, Discord, or e-mail if you would like an account. | |||
= | ===Joining the trusted user group=== | ||
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 [[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. | |||
== | ==General Rules == | ||
== | ===Style guide=== | ||
All new documentation should follow the [https://developers.google.com/style 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. | |||
== 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 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. | *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: | *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> | <nowiki>#REDIRECT [[User Manual/ScummVM Interface]]</nowiki> | ||
== | ==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 == | === 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. | ||
| Line 58: | Line 53: | ||
~MyClass(); | ~MyClass(); | ||
}; | }; | ||
</syntaxhighlight > | </syntaxhighlight> | ||
== SimpleMathJax == | ===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]. | 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]. | ||
| Line 83: | Line 78: | ||
</math> | </math> | ||
== GoogleDocs4MW == | ===GoogleDocs4MW=== | ||
This extension can be used to embed Google spreadsheet into a wiki page. | This extension can be used to embed Google spreadsheet into a wiki page. | ||
| Line 97: | Line 92: | ||
'''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. | '''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=== | ||
This extension can be used to create footnotes on a wiki page. | This extension can be used to create footnotes on a wiki page. | ||
| Line 132: | Line 127: | ||
<references /> | <references /> | ||
== ParserFunctions and StringFunctions == | ===ParserFunctions and StringFunctions=== | ||
This extension adds logical functions and functions that operate on strings to the wiki parser. | This extension adds logical functions and functions that operate on strings to the wiki parser. | ||
| Line 139: | Line 134: | ||
'''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. | '''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 == | ===Dynamic Page List=== | ||
This extension is quite complex. Basically it can be used to display content from other pages into a wiki page. | This extension is quite complex. Basically it can be used to display content from other pages into a wiki page. | ||
'''Link:''' https://www.mediawiki.org/wiki/Extension:DynamicPageList_(third-party) | '''Link:''' https://www.mediawiki.org/wiki/Extension:DynamicPageList_(third-party) | ||
'''Syntax:''' This extension is invoked with the parser function {‍{#dpl: .... }} or parser tag <DPL>. See the link above for more details and examples. | '''Syntax:''' This extension is invoked with the parser function {‍<nowiki>{#dpl: .... }} or parser tag </nowiki><DPL>. See the link above for more details and examples. | ||