View source for Texvc/fr

<languages />
{{Lowercase title}}
{{Historical|1=La version originale de texvc écrite en Ocaml est arrêtée depuis MediaWiki 1.32. Elle est dorénavant [https://github.com/wikimedia/texvcjs portée en JavaScript] et devient une dépendance de [[Mathoid]].}}
<span lang="en" dir="ltr" class="mw-content-ltr">'''texvc''' is one of many external programs that are necessary for the typing of formulas in MediaWiki.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This program is mentioned in the manual of the installation of MediaWiki, see [[Special:MyLanguage/Extension:Math#Installation of texvc|Math]].</span>

<span lang="en" dir="ltr" class="mw-content-ltr">texvc is a shortened version of '''TeX validator and converter'''.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It validates [[w:AMS-LaTeX|AMS-LaTeX]] [[w:mathematical expressions|mathematical expressions]] and converts them to [[w:HTML|HTML]], [[w:MathML|MathML]], or [[w:Portable Network Graphics|PNG]] graphics.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It was written by [[w:User:Taw|Tomasz Wegrzanowski]] and integrated into [[MediaWiki]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The MediaWiki functionality that used this external program was moved to {{ll|Extension:Math}} in {{ll|MediaWiki 1.18}}.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
When {{ll|Extension:Math}} is installed, texvc is located at
</div>

<syntaxhighlight lang="bash" style="overflow:auto;">
$IP/extensions/Math/math/texvc
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">where $IP denotes the directory where MediaWiki was installed.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">texvc in its turn requires three additional programs: [[w:Objective caml|ocaml]], [[w:LaTeX|LaTeX]] and [[w:dvipng|dvipng]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">These three programs do not come with a distribution of MediaWiki.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">These programs should be downloaded manually and installed under the special (not default!) names, specific for each server.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In particular, if one already has [[w:LaTeX|LaTeX]] installed under any other place, then, by default, it will not be used and the wiki-format of the formulas will not be supported.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The process of this installation of texvc, [[w:Objective caml|ocaml]], [[w:LaTeX|LaTeX]] and [[w:dvipng|dvipng]] is described in the special text file $IP/extensions/Math/math/README; that file is copy-pasted below:</span>

<span id="About_texvc"></span>
== À propos du texvc ==

<div lang="en" dir="ltr" class="mw-content-ltr">
texvc takes LaTeX-compatible equations and produces formatted output in HTML, MathML, and (via LaTeX/dvipng) rasterized PNG images.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Input data is parsed and scrutinized for safety, and the output includes an estimate of whether the code is simple enough that HTML rendering will look acceptable.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The program was written by Tomasz Wegrzanowski for use with MediaWiki; it's included as part of the [[MediaWiki]] package and is under the GPL license.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Please report bugs at [https://bugzilla.wikimedia.org/enter_bug.cgi?product=MediaWiki%20extensions&component=Math+%28texvc%29 Bugzilla] with "MediaWiki extensions" as product and "Math (texvc)" as component.
</div>

<span id="Setup"></span>
== Installation ==

<span id="Requirements"></span>
=== Exigences ===

<div lang="en" dir="ltr" class="mw-content-ltr">
* OCaml 3.06 or later is required to compile texvc; this can be acquired from http://caml.inria.fr/ if your system doesn't have it available.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* The makefile requires GNU make.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Rasterization is done via LaTeX, dvipng. These need to be installed and in the PATH: latex, dvipng
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* AMS* packages (amscls, amsmath) for LaTeX also need to be installed. Without AMS* some equations will render correctly while others won't render. Most distributions of TeX already contain AMS*. In Debian/Ubuntu you need to install texlive.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* To work properly with rendering non-ASCII Unicode characters, a supplemental TeX package is needed (cjk-latex in Debian)
</div>

=== Installation ===

<div lang="en" dir="ltr" class="mw-content-ltr">
==== From a package ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Debian and Ubuntu packages of texvc are available, see [[User:Legoktm/Packages/texvc]].
</div>

:<code> sudo apt-get install texvc</code>

<div lang="en" dir="ltr" class="mw-content-ltr">
On older systems the package might be named <code>mediawiki-math-texvc</code>.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
On FreeBSD, this is provided by the <code>print/texvc</code> port.
</div>

<syntaxhighlight lang=bash>
    # Through packages
    $ pkg install texvc
    
    # Through ports
    $ cd /usr/ports/print/texvc
    $ make install
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
If your OS isn't in the list, you can build it yourself following the instruction in the next section.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Compile from sources ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
From the terminal, change to the <code>"extensions/Math/math"</code> sub-directory of your MediaWiki install, and make sure the math directory is writable:
</div>

:<code>sudo chown your-username .</code>

<span lang="en" dir="ltr" class="mw-content-ltr">Then, run <code>make</code> (or <code>gmake</code> if GNU make is not your default make).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This should produce the <code>texvc</code> executable.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
By default, MediaWiki will search in this directory for texvc; if you moved it elsewhere, you'll have to modify $wgTexvc and set it to the path of the texvc executable.
</div>

<span id="Windows"></span>
=== Windows ===
<span lang="en" dir="ltr" class="mw-content-ltr">Getting it up and running on Windows can be somewhat troublesome, as it was developed on and for linux, so it is recommended to use one of the other options found below.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The first alternative solution has the highest success rate, assuming you have the correct software installed.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
:'''Note''': Maths support is strictly optional. Your wiki will run fine without it, although you'll need it if you want to enter formulae which are more complicated than a simple subscript.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
What you'll need for all solutions:
* Latex and dvips (using the [http://www.miktex.org/Setup.aspx Miktex package] for Windows)
* [http://prdownloads.sourceforge.net/ghostscript/ GhostScript] for its Postscript libraries ([http://www.ghostscript.com/]) (Caution! in newer versions the gswin32c.exe has to be renamed or linked to gs.exe)
* [http://www.imagemagick.org/script/binary-releases.php#windows ImageMagick binaries] for windows
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">Install these packages to a short directory, preferably one which does not contain spaces.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">C:\texmf seems to be the most common.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">You may have to manually add these packages to the path.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Once you have these programs installed, check if the commands <code>gs</code>, <code>latex</code>, <code>dvips</code> and <code>convert</code> (not the built-in windows-tool!) are working by typing them at the cmd prompt.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">(Note that you may have to use ctrl-c to quit them as they take input from the console if no arguments are supplied).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If they're not found you'll have to modify your PATH variable and restart your operating system.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">(For some reason Apache or PHP doesn't update its PATH until reboot, a service stop-start does not work)</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Option A - Using texvc ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
<code>texvc</code> is the tool that is included with MediaWiki, but it is written for Linux / Unix.  Getting this to work in Windows can be challenging.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====Building texvc on Windows=====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
This is a quick and dirty hack to make texvc work under Windows.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
What you'll need:
* the <code>texvc</code> sources (included in the math directory of the MediaWiki distribution)
* a Make utility (for example mingw32-make, included in [http://www.mingw.org/download.shtml MinGW])
* an [http://caml.inria.fr/download.en.html OCaml compiler]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
If you use a pre-compiled binary you can skip this section, however you will still have to make the edits to Math.php and LocalSettings.php as described below.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Before we compile texvc, we need to modify some of the files to reflect certain differences between Windows and Unix/Linux (mainly filesystem differences).
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
'''Modify''' <code>math\render.ml</code> so it looks like the file found [[MWWRender.ml|here]] (updated).
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">If you have Visual C++ and MASM installed, make the optimized <code>texvc.exe</code> by running the make utility in the math directory.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If you do not have Visual C++ and MASM, make the bytecode version <code>texvc.bc</code> (by typing for example <code>mingw32-make texvc.bc</code> in the math directory) and rename it to <code>texvc.exe</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If an error occurs by do it via command line, restart your machine and try it again.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====Configuring MediaWiki to use texvc=====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
In <code>LocalSettings.php</code>, uncomment or insert:
</div>

<syntaxhighlight lang="php" style="overflow:auto;">$wgUseTeX = true;</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
to activate texvc functionality.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
If you are using MediaWiki with IIS then you should replace "REQUEST_URI" with "SCRIPT_NAME" in all files.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
And finally, set the <code>texvc</code> executable path to the root path of Wiki, by inserting this line in <code>LocalSettings.php</code>:
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
$wgTexvc = "texvc.exe"; # Location of the texvc binary
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Let me know how this works for you in the discussion page.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====Troubleshooting=====
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">I have experienced several problems with this method in connection with math.php as of MediaWiki version 1.10.0 (I have no experience with earlier versions) and the above texvc executable (1.4.7) by Fernando.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">I chose the latter one because it required neither cygwin nor ocaml runtimes.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Here's what I figured out:</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
# only the directory "$wgTmpDirectory" is passed to both the temp and the math directory that texvc expects on its command line. This somehow seems to cause unwanted deletion of the generated image.
# the math.php relies on the cygwin shell "sh" to be installed on the system, which is not the case on my system.
# "$wgTmpDirectory" and "$wgMathDirectory" contain some slashes instead of backslashes as is common for windows. This seems to mess something up for the texvc executable so the image file does not get generated. Surprisingly, if I copy the very same command-line from the MediaWiki debug logfile to a shell window, the file gets generated.
# after execution of texvc, the math.php looks for the image file in "$wgTmpDirectory" which is consistent with the call of texvc
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The following steps to change math.php were necessary for me to get it working.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The constructor:
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
function __construct( $tex, $params=array() ) {
    if ( wfIsWindows() ) {
        $tex = str_replace( "\n", ' ', $tex );
    }
    $this->tex = $tex;
    $this->params = $params;
}
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
In "<code>function render()</code>";
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Make "$wgMathDirectory" accessible by changing
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
function render() {
    global $wgTmpDirectory, $wgInputEncoding;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
into
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
function render() {
    global $wgTmpDirectory,$wgMathDirectory, $wgInputEncoding;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Then change the target directory for the texvc call into wgMathDirectory by replacing
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
$cmd = $wgTexvc . ' ' .
    escapeshellarg( $wgTmpDirectory ).' '.
    escapeshellarg( $wgTmpDirectory ).' '.
    escapeshellarg( $this->tex ).' '.
    escapeshellarg( $wgInputEncoding );
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
with
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
$cmd = $wgTexvc . ' ' .
    escapeshellarg( $wgTmpDirectory ).' '.
    escapeshellarg( $wgMathDirectory ).' '.
    escapeshellarg( $this->tex ).' '.
    escapeshellarg( $wgInputEncoding );
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Now comment out the lines that try to use cygwin shell, if your system happens to be devoid of cygwin. Cmd.exe seems to be perfect for this anyway.
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
/*if ( wfIsWindows() ) {
    # Invoke it within cygwin sh, because texvc expects sh features in its default shell
    $cmd = 'sh -c ' . wfEscapeShellArg( $cmd );
}*/
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
To solve the slash problem (if not already done) replace the line
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
wfDebug( "TeX: $cmd\n" );
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
with the lines
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
 $cmd=str_replace("'","\"",$cmd); # replace single quotes by double quotes
 $cmd=str_replace("/","\\",$cmd); # replace slash by backslash for windows so texvc can work with it
 wfDebug( "TeX: $cmd\n" );
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Finally replace
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
if( !file_exists( "$wgTmpDirectory/{$this->hash}.png" ) ) {
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
by
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
if( !file_exists( "$wgMathDirectory/{$this->hash}.png" ) ) {
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
and
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
if( filesize( "$wgTmpDirectory/{$this->hash}.png" ) == 0 ) {
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
by
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
if( filesize( "$wgMathDirectory/{$this->hash}.png" ) == 0 ) {
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
and
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
if( !rename( "$wgTmpDirectory/{$this->hash}.png", "$hashpath/{$this->hash}.png" ) ) {
    return $this->_error( 'math_output_error' );
}
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
by
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
if (!file_exists("$hashpath/{$this->hash}.png")) {
    if( !rename( "$wgMathDirectory/{$this->hash}.png", "$hashpath/{$this->hash}.png" ) ) {
        return $this->_error( 'math_output_error' );
    }
}
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
so the generated file will be found where it has been saved. And if the image already exists at the final destination don't error when calling <code>rename()</code>.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The suggested solution is obviously a workaround for problems located in the specific texvc executable (except for the probably missing cygwin shell). Perhaps it would be a cleaner solution to compile a texvc that does not have these problems, but personally I did not want to delve into the rather involved procedure of fixing and building texvc.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====Permissions=====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
If the math still is not working, turn on the debug log and find the command string that calls <code>texvc</code>.  For example:
</div>

<pre style="overflow:auto;">TeX: C:\inetpub\wwwroot\w\math\texvc "C:\inetpub\wwwroot\w\images\tmp" "C:\inetpub\wwwroot\w\images\math" "\begin{align} y = & \frac{1}{2} + \frac{1}{3}x^2 + \\ & \frac{1}{4}x^3\end{align}" "utf-8"</pre>

<div lang="en" dir="ltr" class="mw-content-ltr">
Try the command in the console.  If it works, you may have a permission problem.  Try:
# Setting the images directory to Everyone; and
# Setting the internet user to a local profile (Application pools in IIS).
# Run [http://technet.microsoft.com/en-nz/sysinternals/bb896645(en-us).aspx Process Monitor] on the server, look for "ACCESS DENIED" status errors.  The path and user of the event will show which user needs permissions and what directories they need permission on.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Option B - Using LatexRender ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You may find compiling texvc to be very complicated or simply not working. Here is another solution (Using LatexRender, thanks to Benjamin Zeiss, completed by [http://www.metasharp.net/ MetaSharp]). The directories given here are examples, use your owns. This method has been successfully tested up to MediaWiki 1.10.0, 1.13.1 and on MediaWiki 1.15.1.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====Installation=====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
#install the complete [http://www.miktex.org/Setup.aspx MikTeX] (not the basic one, use the network installer) in <span color=green>D:\wikitex\miktex</span>
#install the static (to be sure dependencies are embed) binary of [http://www.imagemagick.org/script/binary-releases.php#windows ImageMagick] in <span color=green>D:\wikitex\imagick</span> (ensure there are no spaces in the path you choose)
#install [http://prdownloads.sourceforge.net/ghostscript/ AFPL GhostScript] in <span color=green>D:\wikitex\ghostscript</span>
#copy <span color=green>D:\wikitex\ghostscript\gs8.54\bin\gswin32c.exe</span> to <span color=green>D:\wikitex\ghostscript\gs8.54\bin\gs.exe</span>
#:(8.54 can be different depending on version you install)
#add to the windows PATH environment variable this path: <span color=green>D:\wikitex\ghostscript\gs8.54\bin</span>
#:(again, 8.54 can be different depending on version you install)
#If you installed MiKTeX for all users and are running IIS, you may also need to create MiKTeX folders under "C:\Documents and Settings\Default User\Application Data" and "C:\Documents and Settings\Default User\Local Settings\Application Data".  Make sure the IIS working process account running PHP (IUSR_[whoever]) has both read ''and write'' permissions to these directories!
#open a command line (start -> execute -> cmd.exe)
#verify that the following commands are working:
 latex
 dvips
 convert (not the Microsoft convert)
 gs
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====Settings=====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
(your wiki directory = $)
*replace the file <span color=green>$/includes/Math.php</span> with '''[[Manual:Running MediaWiki on Windows/math.php|this one]]'''. Later, if you see error message '' '''Strict standards:''' Non-static method MathRenderer::renderMath() should not be called statically'' on the wiki page then change this line:
</div>
<syntaxhighlight lang="php" style="overflow:auto;">function renderMath($latex_formula) {</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
To this
</div>
<syntaxhighlight lang="php" style="overflow:auto;">static function renderMath($latex_formula) {</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
*uncomment or insert in <span color=green>$/LocalSettings.php</span>:
</div>
<syntaxhighlight lang="php" style="overflow:auto;">$wgUseTeX= true;</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
*insert in <span color=green>$/LocalSettings.php</span>:
</div>
<syntaxhighlight lang="php" style="overflow:auto;">
#ImageMagick
$wgImageMagickConvertCommand    = 'D:\wikitex\imagick\convert.exe';
$wgImageMagickIdentifyCommand   = 'D:\wikitex\imagick\identify.exe';
#Tex
$wgLaTexCommand                 = 'D:\wikitex\miktex\miktex\bin\latex.exe';
$wgDvipsCommand                 = 'D:\wikitex\miktex\miktex\bin\dvips.exe';
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
*reboot if needed so that paths variables are updated for your services too
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====Verifications=====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
*and voilà ;) Now you can try in the sandbox to see whether it works. Enter something like this and hit preview to see if it works:
</div>

<syntaxhighlight lang=html>
<math>\sqrt{2}</math>
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
*the folders "math" and "tmp" should have been created in the "images" folder automatically.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====How to get the latex "picture" package to work=====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Just put something like this into your wiki page:
</div>

<syntaxhighlight lang=html>
<math>\setlength{\unitlength}{1cm}
\begin{picture}(4,2)
\put(1,1){\circle{3}}
\put(3,1){\circle*{5}}
\end{picture}
</math>
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
[http://www.semibyte.de/wp/informatics/latex/picture_umgebung#kreise Here] is the result (modified orders of magnitude!).
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=====Troubleshooting=====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You might experience some problems with formulas not being displayed if you are not logged in. In such a case comment out the 3 following lines in <span color=green>$/LocalSettings.php</span>
</div>:

<syntaxhighlight lang="php" style="overflow:auto;">
$wgMathPath         = "{$wgUploadPath}/math";
$wgMathDirectory    = "{$wgUploadDirectory}/math";
$wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
like this:
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
 #$wgMathPath         = "{$wgUploadPath}/math";
 #$wgMathDirectory    = "{$wgUploadDirectory}/math";
 #$wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
or just suppress them. Everything should be working fine now.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You have to give permissions to the webserver to all the folders that need to access. Not just the ones in the wiki image and temporary folders, but also where you installed latex and the other software.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Option C - Using MathLatexRender based on LatexRender of option B ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Option C was tested on Windows Server 2008 with MW 1.23 LTS and extension Math REL1-23, because option B does not work in newer MediaWiki versions with the Math extension but only in older versions with the file Math.php in the includes directory.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Requirements:
</div>

* GhostScript
* ImageMagick
* MikTex
* <span lang="en" dir="ltr" class="mw-content-ltr">MediaWiki extension Math</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">File [[Special:MyLanguage/Manual:Running MediaWiki on Windows/math.php|Math.php with class LatexRender]] from Benjamin Zeiss, 2003</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Files to modify:
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* Math.php with class LatexRender, after modification renaming to MathLatexRender.php
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* Math.php from extension Math (add $wgAutoloadClasses['MathLatexRender'] = $dir . 'MathLatexRender.php';)
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* MathRenderer.php from extension Math (function getRenderer(...) $mode default: $renderer = new MathLatexRender($tex, $params) instead of new Texvc($tex, $params))
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
* LocalSettings.php (settings for Math, ImageMagick, MikTeX and <syntaxhighlight lang=php inline>$wgUseTeX = true; $wgMathDisableTexFilter = true;</syntaxhighlight>)
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
For more information like modification of MathLatexRender.php see https://www.mediawiki.org/wiki/Extension_talk:Math#Math_REL-1_23_with_MW1.23LTS_on_Windows_with_ImageMagick.2C_MikTeX.2C_GhostScript_and_class_LatexRender.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Simplified solution with dvipng ====
</div>

https://bitbucket.org/FrigoCoder/script/src/tip/MediaWiki

<span lang="en" dir="ltr" class="mw-content-ltr">This is a greatly simplified solution of the above, removing all code and comments unrelated to MediaWiki.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It uses only LaTeX and dvipng compiled with FreeType, it does not require GhostScript or ImageMagick.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">MikTeX 2.9 contains these, 2.8 lacks FreeType to my knowledge.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Since dvipng wraps the formulas, it does not check for correct image dimensions, though it could be implemented, dvipng can return the image dimensions somehow.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It uses \displaystyle for all inline math.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">You can escape the inline math, but are still subject to the blacklist, so it is not recommended to write entire LaTeX books in it.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Very, very verbose error messages revealing your paths and latex version, modify the last return line if you don't like them; I might make a $debug setting, though at the moment I don't see any possibility of exploits.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">It does not change the current directory, and does not clean up temporary files if some error occurred during rendering, so you can check whether someone tried to feed it something suspicious.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">[[User:Frigo|Frigo]] 18:29, 11 April 2011 (UTC)</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
0) Make sure you have LaTeX and dvipng with FreeType support (e.g. MikTeX 2.9)
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
1) Copy the file to includes/Math.php
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
2) Add the following to LocalSettings.php (executable names will suffice if you have them in PATH)
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
$wgUseTeX = true;
$wgLaTexCommand = "insert\path\here\latex.exe";
$wgDvipngCommand = "insert\path\here\dvipng.exe";
</syntaxhighlight>

<span lang="en" dir="ltr" class="mw-content-ltr">3) Try it. My test is usually</span> <syntaxhighlight lang=html inline><math>E=mc^2</math></syntaxhighlight> :)
<span lang="en" dir="ltr" class="mw-content-ltr">Comments for the [[meta:Help:Running_MediaWiki_on_Windows/math-dvipng.php|previous, messy version]]:</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
:Comment: This works for me in MediaWiki 1.11.0 except \begin{align}...\end{align} causes the image not to be rendered at all. This causes LaTeX to generate a blank DVI file and complain, "Package amsmath Error: \begin{align} allowed only in paragraph mode". If you comment out the usepackage{ams...} lines in Benjamin Zeiss's Math.php (function wrap_formula), the problem goes away. [[User:Maiden taiwan|Maiden taiwan]] 20:21, 26 October 2007 (UTC)
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
:Comment: This works for right out of the box for MediaWiki 1.10.0. The MikTeX installer sets everything up and the basic MikTeK package was enough. Only thing I needed to do, was a reboot after the install was finished. Good stuff. [[User:florihupf]] 16:30, 7/July/2007
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
:Comment: Very easy and works great for MediaWiki 1.10.0. Why is there no MediaWiki Package with this for Installing MediaWiki with TeX on Windows?, 18.11.2007
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
:Comment: This works with MediaWiki 1.11.0. I used texvc 1.4.7, MiKTeX 2.7 (full package), ImageMagick and Ghostscript 8.60. My only gripe is the size of MiKTeX when installed... more than 1 Gigabyte!!!
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Another simple solution which extends the MathTexvc Class, and works with portable versions of LaTex ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The extension of the MathTexvc class was made based on the code for {{ll|Extension:MathLaTeX}}.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The changes made to the MathRenderer.php and extension.json (V1.27), as well as the additional file MathLatexRender.php can be found in the following commit in [https://github.com/judios/mediawiki-extensions-Math/commit/13d0b4bc6b9e5d6201df28b4667bd6ba39862622 GitHub]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The lines added to the LocalSettings.php file are:
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
wfLoadExtension( 'Math' );
$wgUseTeX= true; 
$wgLatexOnWindows = true;
$wgPdfLaTexCommand = "D:\\texlive\bin\win32\pdflatex.exe"; 
$wgDvipngCommand = "D:\\texlive\bin\win32\dvipng.exe"; 
$wgMathDisableTexFilter = true;
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Alternative Solution with Texvc for experienced users (MediaWiki 1.16.0)====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
'''install this'''
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
* wamp (included apache, php5, mysql)
* a Make utility (for example mingw32-make, included in [http://www.mingw.org/download.shtml MinGW])
* an [http://caml.inria.fr/download.en.html OCaml compiler]
* Latex and dvips (using the [http://www.miktex.org/Setup.aspx Miktex package] for Windows)
* [http://prdownloads.sourceforge.net/ghostscript/ GhostScript] for its Postscript libraries ([http://www.ghostscript.com/]) (Caution! in newer versions the gswin32c.exe has to be renamed or linked to gs.exe)
* [http://www.imagemagick.org/script/binary-releases.php#windows ImageMagick binaries] for windows
*<del> maybe cygwin ''i got it''</del>
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
''in upper manual is written how to install this ''
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
'''try somehow build texvc'''
''Attention!!!!!!! not needed edit render.ml''
* the <code>texvc</code> sources (included in the math directory of the MediaWiki distribution)
*C:\wamp\www\wiki\math> mingw32-make texvc.bc & mv texvc.bc to texvc.exe
''in upper manual is written how to build this ''
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
'''Edit localconfig'''
</div>
<pre style="overflow:auto;">
$wgUseTeX           = true;
$wgTexvc = "c:/wamp/www/wiki/math/texvc.exe";
</pre>

<div lang="en" dir="ltr" class="mw-content-ltr">
'''Edit include/math.php'''
This must be commented /* ... */
</div>

<syntaxhighlight lang="php" style="overflow:auto;">
/*  if ( wfIsWindows() ) {
	# Invoke it within cygwin sh, because texvc expects sh features in its default shell
	$cmd = 'sh -c ' . wfEscapeShellArg( $cmd );
	}
*/
</syntaxhighlight>

'''déboguez'''

<pre style="overflow:auto;">
c:/wamp/www/wiki/math/texvc.exe "C:\wamp\www\wiki/images/tmp" "C:\wamp\www\wiki/images/tmp" "B^{X^{c + v}}_Y + 121\!\," "UTF-8" "transparent"
or
c:\wamp\www\wiki\math\texvc.exe "C:\wamp\www\wiki\images\tmp" "C:\wamp\www\wiki\images\tmp" "B^{X^{c + v}}_Y + 121\!\," "UTF-8" "transparent"
</pre>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Usage ==
</div>
Normally texvc is called from MediaWiki's Math.php modules and everything
Just Works. It can be run manually for testing or for use in another app.

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Command-line parameters ===
</div>
    texvc &lt;temp directory> &lt;output directory> &lt;TeX code> &lt;encoding> &lt;color>

Be sure to properly quote the TeX code!

Example:

    texvc /home/wiki/tmp /home/wiki/math "y=x+2" iso-8859-1 "rgb 1.0 1.0 1.0"

<div lang="en" dir="ltr" class="mw-content-ltr">
=== LaTeX syntax ===
</div>
The syntax is documented at [[Extension:Math/Syntax]].

In addition to standard AMS LaTeX, texvc interprets additional syntax such as <code>\codes</code> for HTML math character entities (for example, <code>&amp;Sigma;</code> → <code>\Sigma</code>) which have different names in LaTeX.

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Output modes ===
</div>
The HTML-code generated by texvc may be in one of three modes:
# Conservative: the code should look good and work well in most browsers.
# Moderate: the code should work and look good in reasonably modern browsers.
# Liberal: the code is HTML, but it is designed for very recent browsers, such as newer versions of [[w:Mozilla Firefox]]. While it should be legible, it might not look very good.

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Output format ===
</div>
Status codes and HTML/MathML transformations are returned on stdout.
A rasterized PNG file will be written to the output directory, named for the MD5 hash code.

texvc output format is like this:

    +%5         ok, but not html or mathml
    c%5%h       ok, conservative html, no mathml
    m%5%h       ok, moderate html, no mathml
    l%5%h       ok, liberal html, no mathml
    C%5%h\0%m   ok, conservative html, with mathml
    M%5%h\0%m   ok, moderate html, with mathml
    L%5%h\0%m   ok, liberal html, with mathml
    X%5%m       ok, no html, with mathml
    S           syntax error
    E           lexing error
    F%s         unknown function %s
    -           other error

 \0 - null character
 %5 - md5, 32 hex characters
 %h - html code, without \0 characters
 %m - mathml code, without \0 characters

<div lang="en" dir="ltr" class="mw-content-ltr">
== Troubleshooting ==
</div>
Unfortunately, many error conditions with rasterization are not well reported.
texvc will return as though everything is successful, and the only obvious sign of problems for the user is a big X on a wiki page where an equation should be.

Try running texvc from the command line to ensure that the software it relies upon is all set up.

Ensure that the temporary and math directories exist and can be written to by the user account the web server runs under; if you don't control the server, you may have to make them world-writable.

If some equations render correctly while others don't, you probably don't have AMS* packages for LaTeX installed. Most distributions of TeX come with AMS*.
In Debian/Ubuntu AMS* is in tetex-extra package.
To check if that is the problem you can try those two equations:

    x + y
    x \implies y

The first uses only standard LaTeX, while the second uses symbol \implies from AMS*.
If the first renders, but the second doesn't, you need to install AMS*.

<div lang="en" dir="ltr" class="mw-content-ltr">
== Hacking ==
</div>
Before you start hacking on the math package it's good to know the workflow,
which is basically:

# texvc gets called by extensions/Math/Math.body.php (check out the line beginning with "$cmd")
# texvc does its magic, which is basically to check for invalid latex code.
# texvc takes the user input if valid and creates a latex file containing it, see get_preface in texutil.ml
# dvipng(1) gets called to create a .png file. See render.ml for this process (commenting out the removal of the temporary file is useful for debugging).

=== Adding support for [[w:Commutative_diagram|commutative diagrams]] ===
To be able to generate [[w:Commutative_diagram|commutative diagrams]] via the LaTeX package [http://tex.loria.fr/graph-pack/doc-xypic/xyguide-html/xyguide-html.html xy-pic], just modify the wrap_formula function in your math.php:
 
*your function <span color=green>$/includes/Math.php</span> before the change:
    function wrap_formula($latex_formula) {
        $string  = "\documentclass{".$this->_latexclass."}\n";
        $string .= "\usepackage{amsmath}\n";
        $string .= "\usepackage{amsfonts}\n";
        $string .= "\usepackage{amssymb}\n";
        $string .= "\pagestyle{empty}\n";
        $string .= "\begin{document}\n";
        $string .= "$".$latex_formula."$\n";
        $string .= "\end{document}\n";
        return $string;
    }

*and afterwards:
    function wrap_formula($latex_formula) {
        $string  = "\documentclass{".$this->_latexclass."}\n";
        $string .= "\usepackage{amsmath}\n";
        $string .= "\usepackage{amsfonts}\n";
        $string .= "\usepackage{amssymb}\n";
        $string .= "\pagestyle{empty}\n";
        $string .= "\input xy\n";
        $string .= "\xyoption{all}\n";
        $string .= "\begin{document}\n";
        $string .= "$".$latex_formula."$\n";
        $string .= "\end{document}\n";
        return $string;
    }

Formulas will still work normally as before, as xy-pic is enabled by the \xymatrix{} command. Try this for fun:

<syntaxhighlight lang=html>
<math>\xymatrix{U \ar@/_/[ddr]_y \ar@/^/[drr]^x \ar@{.>}[dr]|-{(x,y)}            \\
& X \times_Z Y \ar[d]^q \ar[r]_p & X \ar[d]_f       \\
& Y \ar[r]^g   & Z                }</math>
</syntaxhighlight>

==end of file README==
also, that directory contains files 
$IP/extensions/Math/math/texvc_test.ml and $IP/extensions/Math/math/texvc_tex.ml that are also necessary.

The file texvc is not the only file required for the support of mathematical typing. There are many other files necessary; they are mentioned in the [[Manual:Enable TeX]].

The installing of the support of typing mathematics in MediaWiki with texvc requires certain programming in a language, pretty different from that used to type the MediaWiki documents. This process is not always successful; some problems seem to be not resolved at least for the beginning of year 2011.

[[Category:TeX{{#translation:}}]]