736
edits
Difference between revisions of "Instructions to Wiki Editors"
m
Typo*s*
m (→Trusted User Group: typo) |
m (Typo*s*) |
||
| Line 1: | Line 1: | ||
These instructions are written mainly with the | These instructions are written mainly with the editing of the User Manual in mind. Some of the points might also be valid for other parts of the wiki though. | ||
= General Rules = | = General Rules = | ||
| Line 8: | Line 8: | ||
== Spelling and grammar == | == Spelling and grammar == | ||
# 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''. | # 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''. | ||
# 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 | # 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 expanded form ''It does not work''). If in doubt, use the expanded 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. | ||
# '''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. | # '''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 == | == User Manual content == | ||
# 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, | # 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. | ||
== 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 | 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. | ||
= Extensions = | = Extensions = | ||
| Line 41: | Line 41: | ||
Which gives the following result: | Which gives the following result: | ||
<source lang="cpp"> | <source lang="cpp"> | ||
#include <foo.h> | #include <foo.h> | ||
| Line 52: | Line 53: | ||
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. | 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> | <pre> | ||
<syntax type="C++"> | <syntax type="C++"> | ||
| Line 91: | Line 93: | ||
You need to use the <ref> tag to define a reference: | You need to use the <ref> tag to define a reference: | ||
<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 Cite extension<ref>Criezy, ScummVM wiki, 2009</ref>. | ||
</pre> | </pre> | ||
And then to use the <references /> tag as a placeholder (e.g. at the bottom of the page for a footnote): | And then to use the <references /> tag as a placeholder (e.g. at the bottom of the page for a footnote): | ||
<pre> | <pre> | ||
--- Notes --- | --- Notes --- | ||
| Line 108: | Line 113: | ||
== ParserFunctions and StringFunctions == | == ParserFunctions and StringFunctions == | ||
This extension adds logical functions and functions that | This extension adds logical functions and functions that operate on strings to the wiki parser. | ||
'''Link:''' http://www.mediawiki.org/wiki/Extension:ParserFunctions | '''Link:''' http://www.mediawiki.org/wiki/Extension:ParserFunctions | ||