# LaTeXStrings.jl

**Repository Path**: Julialang/LaTeXStrings.jl

## Basic Information

- **Project Name**: LaTeXStrings.jl
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-03-12
- **Last Updated**: 2022-03-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/stevengj/LaTeXStrings.jl.svg?branch=master)](https://travis-ci.org/stevengj/LaTeXStrings.jl)
[![LaTeXStrings](http://pkg.julialang.org/badges/LaTeXStrings_0.3.svg)](http://pkg.julialang.org/?pkg=LaTeXStrings&ver=0.3)
[![LaTeXStrings](http://pkg.julialang.org/badges/LaTeXStrings_0.4.svg)](http://pkg.julialang.org/?pkg=LaTeXStrings&ver=0.4)

# LaTeXStrings

This is a small package to make it easier to type LaTeX equations in
string literals in the [Julia language](http://julialang.org/), 
written by [Steven G. Johnson](http://math.mit.edu/~stevenj).

With ordinary strings in Julia, to enter a string literal with
embedded LaTeX equations you need to manually escape all backslashes
and dollar signs: for example, `$\alpha^2$` is written
`\$\\alpha^2\$`.  Also, even though
[IJulia](https://github.com/JuliaLang/IJulia.jl) is capable of
displaying formatted LaTeX equations (via
[MathJax](http://www.mathjax.org/)), an ordinary string will not
exploit this.  Therefore, the LaTeXStrings package defines:

* A `LaTeXString` class (a subtype of `String`), which works like
  a string (for indexing, conversion, etcetera), but automatically displays
  as `text/latex` in IJulia.

* `L"..."` and `L"""..."""` string macros which allow you to enter
  LaTeX equations without escaping backslashes and dollar signs
  (and which add the dollar signs for you if you omit them).

## Usage

After installing LaTeXStrings with `Pkg.add("LaTeXStrings")` in Julia, run

```
using LaTeXStrings
```

to load the package.  At this point, you can construct `LaTeXString`
literals with the constructor `L"..."` (and `L"""..."""` for multi-line
strings); for example `L"1 + \alpha^2"` or `L"an equation: $1 +
\alpha^2$"`.  (Note that `$` is added automatically around your
string, i.e. the string is interpreted as an equation, if you do not
include `$` yourself.)

You can also use the lower-level constructor `latexstring(args...)`,
which works much like `string(args...)` except that it produces a
`LaTeXString` result and automatically puts `$` at the beginning and
end of the string if an unescaped `$` is not already present.  Note
that with `latexstring(...)` you *do* have to escape `$` and `\`: for
example, `latexstring("an equation: \$1 + \\alpha^2\$")`.  One reason
you might want to use `latexstring` instead of `L"..."` is that only
the former supports [string
interpolation](http://docs.julialang.org/en/latest/manual/strings/#interpolation)
(inserting the values of other variables into your string).

Finally, you can use the lowest-level constructor
`LaTeXString(s)`.  The only advantage of this is that it
does *not* automatically put `$` at the beginning and end of the
string.  So, if for some reason you want to use `text/latex` display
of ordinary text (with no equations or formatting), you can use this
constructor.  (Note that IJulia *only* formats LaTeX equations; other
LaTeX text-formatting commands like `\emph` are ignored.)

## Author

This package was written by [Steven
G. Johnson](http://math.mit.edu/~stevenj/), and is distributed under
the MIT/expat license (see the [LICENSE.md](LICENSE.md) file).