TrustedUser
2,147
edits
Difference between revisions of "Instructions to Wiki Editors"
Jump to navigation
Jump to search
Instructions to Wiki Editors (view source)
Revision as of 21:00, 11 October 2009
, 21:00, 11 October 2009Add list of installed extensions
(→Spelling and grammar: changed "American spelling" to "American English spelling". Also changed "English" to "British", which was supposedly meant in this case.) |
(Add list of installed extensions) |
||
| Line 1: | Line 1: | ||
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. | 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 == | == No controversial material == | ||
| Line 12: | 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, Windows and Mac OS X. 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, 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:''' | |||
<pre> | |||
<source lang="cpp"> | |||
#include <foo.h> | |||
class MyClass { | |||
public: | |||
MyClass(); | |||
~MyClass(); | |||
}; | |||
</source> | |||
</pre> | |||
Which gives the following result: | |||
<source lang="cpp"> | |||
#include <foo.h> | |||
class MyClass { | |||
public: | |||
MyClass(); | |||
~MyClass(); | |||
}; | |||
</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. | |||
<pre> | |||
<syntax type="C++"> | |||
#include <foo.h> | |||
class MyClass { | |||
public: | |||
MyClass(); | |||
~MyClass(); | |||
}; | |||
</syntax> | |||
</pre> | |||
== 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: | |||
<pre> | |||
This is an example of use of the Cite extension<ref>Criezy, ScummVM wiki, 2009</ref>. | |||
</pre> | |||
And then to use the <references /> tag as a placeholder (e.g. at the bottom of the page for a footnote): | |||
<pre> | |||
--- Notes --- | |||
<references /> | |||
</pre> | |||
This example gives: | |||
This is an example of use of the Cite extension<ref>Criezy, ScummVM wiki, 2009</ref>. | |||
--- Notes --- | |||
<references /> | |||
== 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. | |||