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

266 bytes removed ,  03:18, 25 October 2018
→‎Cite: - Update Cite syntax
(→‎SyntaxHighlight: Update information about extension)
(→‎Cite: - Update Cite syntax)
(4 intermediate revisions by 2 users not shown)
Line 19: Line 19:


* 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.
'''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>
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:
* 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:
Line 41: Line 37:


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


Line 49: 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 62: Line 58:
     ~MyClass();
     ~MyClass();
};
};
</source>
</syntaxhighlight >
 
The extension also now supports using the ''syntaxhighlight'' tag instead of ''source'', which can help if the code itself contains the source tag:


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


== MathJax ==
For inline equation use <code>\(...\)</code> and  for display style math use instead  <code>&lt;math&gt;...&lt;/math&gt;</code>.
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 extension. It uses the same syntax as both of these, which is [http://meta.wikimedia.org/wiki/Help:Formula described here].


The following math environments are defined for inline style math:
* <code>\(...\)</code> and
* <code>&lt;math&gt;...&lt;/math&gt;</code>.
And the following math environments are defined for display style math:
* <code>\[...\]</code>,
* <code>\begin{...}...\end{...}</code> and
* <code>:&lt;math&gt;...&lt;/math&gt;</code>.
MathJax produces nice and scalable mathematics, see their website (http://www.mathjax.org/) for a demonstration.  
MathJax produces nice and scalable mathematics, see their website (http://www.mathjax.org/) for a demonstration.  
This extension also enables the usage of <code>\label{}</code> and <code><nowiki>\eqref{}</nowiki></code> tags with automatic formula numbering.


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


'''Syntax:'''
'''Syntax:'''
Line 101: 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 112: 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 118: Line 113:


<pre>
<pre>
--- Notes ---
==Notes==
<references group="footnotes" />
 
==References==
<references />
<references />
</pre>
</pre>
Line 124: 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/22733...24644"

Navigation menu