MathematicaTeXUtilities

KO | EN

gitlite — search

#javascript #python #go #golang #android #machine-learning #rust #deep-learning #windows #awesome #kubernetes #vue #pytorch #openai

MathematicaTeXUtilities

(★ 11)

Tools useful for customizing TeX output of Mathematica.

MathematicaTeXUtilities Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TeX Utilities

[![releases](https://img.shields.io/github/release/jkuczm/MathematicaTeXUtilities.svg)](https://github.com/jkuczm/MathematicaTeXUtilities/releases)
[![SemVer 2.0.0](https://img.shields.io/badge/SemVer-2.0.0-brightgreen.svg)](https://semver.org/spec/v2.0.0.html)
[![license MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jkuczm/MathematicaTeXUtilities/blob/master/LICENSE)
[![Mathematica 8.0 - 11.0](https://img.shields.io/badge/Mathematica-8.0%20--%2011.0-brightgreen.svg)](https://raw.githubusercontent.com/jkuczm/MathematicaTeXUtilities/master/)

Set of tools useful for customizing TeX output of *Mathematica*.

Contains also patch fixing behavior of `TeXForm` for expressions with custom
formatting defined using `Format[expr, TeXForm]`.

* [Usage example](#usage-example)
* [Installation](#installation)
    * [Automatic installation](#automatic-installation)
    * [Manual installation](#manual-installation)
    * [No installation](#no-installation)
* [Documentation](#documentation)
* [Compatibility](#compatibility)
* [Bugs and requests](#bugs-and-requests)
* [Contributing](#contributing)
* [License](#license)
* [Versioning](#versioning)

## Usage example

Define custom TeX formatting for some symbols:

```Mathematica
Format[something, TeXForm] = TeXVerbatim["\\macro $1+1$ \\command[a=b]{c}"];

Format[f[x__], TeXForm] := TeXDelimited["\\left(", x, "\\right)", "DelimSeparator" -> ""]

Format[g[x__], TeXForm] := TeXCommand["g", {{a -> b}, x}]

Format[h[x__], TeXForm] := TeXEnvironment["myEnv", x]
```

Use `TeXForm` as usual:

```Mathematica
TeXForm[
    h[
        f[1 + alpha],
        5 - g[3, g[2]],
        something
    ]
]
```

Output is:
```TeX
\begin{myEnv}
    \left(\alpha +1\right)
    5-\g[a=b]{3}{\g[a=b]{2}}
    \macro $1+1$ \command[a=b]{c}
\end{myEnv}
```

You can find more usage examples in
[package documentation](https://jkuczm.github.io/MathematicaTeXUtilities/reference/guide/TeXUtilities.html).

## Installation

### Automatic installation

To install TeXUtilities package evaluate:
```Mathematica
Import["https://raw.githubusercontent.com/jkuczm/MathematicaTeXUtilities/master/BootstrapInstall.m"]
```

Note that this will also install
[ProjectInstaller](https://github.com/lshifr/ProjectInstaller) package, if you
don't have it already installed.

To load TeXUtilities package evaluate: ``Needs["TeXUtilities`"]``.

### Manual installation

1. Download latest released
   [TeXUtilities.zip](https://github.com/jkuczm/MathematicaTeXUtilities/releases/download/v1.0.1/TeXUtilities.zip)
   file.

2. Extract downloaded `TeXUtilities.zip` to any directory which is on
   *Mathematica* `$Path`, e.g. to one obtained by evaluating
   `FileNameJoin[{$UserBaseDirectory,"Applications"}]`.

3. To load the package evaluate: ``Needs["TeXUtilities`"]``.

### No installation

To use package directly from the Web, without installation, evaluate:
```Mathematica
Import["https://raw.githubusercontent.com/jkuczm/MathematicaTeXUtilities/master/NoInstall.m"]
```

Note that, with this method of initialization,
package documentation will not be available in *Mathematica* Documentation Center,
but you can use
[online version of documentation](https://jkuczm.github.io/MathematicaTeXUtilities/reference/guide/TeXUtilities.html).

## Documentation

This application comes with documentation integrated with *Mathematica*
Documentation Center. To use it search for "TeXUtilities" in documentation
center or press `F1` key with cursor on name of any of symbols introduced by
this application.

There's also
[online version of documentation](https://jkuczm.github.io/MathematicaTeXUtilities/reference/guide/TeXUtilities.html).

## Compatibility

This package contains extensive
[automatic test suite](https://github.com/jkuczm/MathematicaTeXUtilities/tree/master/TeXUtilities/Tests).
Package is tested with all *Mathematica* major and minor versions from 8.0 to
11.0 on Linux. Since it doesn't contain any OS specific code it should work
with above versions on all operating systems.

There's also no obvious reason for package not to work on older (6.0+) and
newer (11.1+) versions of *Mathematica*, but it was not tested with these
versions.

If you want to test TeXUtilities in your setup, you can, in *Mathematica*
versions 10.0+, run test suite by evaluating:
```Mathematica
Needs["MUnit`"]
TestRun@FileNameJoin[{$UserBaseDirectory, "Applications/TeXUtilities/Tests/suite.mt"}]
```
if you installed TeXUtilities in non-standard location, above path to test
suite file should be adapted.

## Bugs and requests

If you find any bugs or have feature request please create an
[issue on GitHub](https://github.com/jkuczm/MathematicaTeXUtilities/issues).

## Contributing

Feel free to fork and send pull requests.

If you want to use Ant scripts from this repository you will also need to
install [WWBCommon](https://github.com/jkuczm/WWBCommon) project.

All contributions are welcome!

## License

This package is released under
[The MIT License](https://github.com/jkuczm/MathematicaTeXUtilities/blob/master/LICENSE).

## Versioning

Releases of this package will be numbered using
[Semantic Versioning guidelines](http://semver.org/).

MathematicaTeXUtilities

MathematicaTeXUtilities Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

MathematicaTeXUtilities

MathematicaTeXUtilities Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README