Home
build details

# Using LaTeX constructs in documentation

Modified 2018-06-02 by Andrea Censi

Working knowledge of LaTeX.

## LaTeX equations

Modified 2018-06-02 by Andrea Censi

We can refer to equations, such as \eqref{eq:one}:

$$2a = a + a \label{eq:one}\tag{1}$$

This uses align and contains \eqref{eq:two} and \eqref{eq:three}.

\begin{align} a &= b \label{eq:two}\tag{2} \\ &= c \label{eq:three}\tag{3} \end{align}

We can refer to equations, such as \eqref{eq:one}:

\begin{equation}
2a = a + a          \label{eq:one}
\end{equation}

This uses align and contains  \eqref{eq:two} and \eqref{eq:three}.

\begin{align}
a &= b       \label{eq:two} \\
&= c       \label{eq:three}
\end{align}

Note that referring to the equations is done using the syntax \eqref{eq:name}, rather than [](#eq:name).

## Bibliography support

Modified 2018-06-02 by Andrea Censi

You need to have installed bibtex2html.

The system supports Bibtex files.

Place *.bib files anywhere in the directory.

Then you can refer to them using the syntax:

[](#bib:bibtex ID)


For example:

Please see [](#bib:siciliano07handbook).


Will result in:

Please see [1].

## Embedding Latex in Figures through SVG

Modified 2018-06-04 by Andrea Censi

In order to compile the figures into PDFs you need to have Inkscape installed. Instructions to download and install Inkscape are here.

To embed latex in your figures, you can add it directly to a file and save it as filename.svg file and save in the /docs directory in a subfolder called assets/svg2pdf.

You can then run:

\$ make process-svg-figs


And the SVG file will be compiled into a PDF figure with the LaTeX commands properly interpreted.

You can then include the PDF file in a normal way (Section 1.5 - Figures) using filename.pdf as the filename in the <img> tag.

It can take a bit of work to get the positioning of the code to appear properly on the figure.

No questions found. You can ask a question on the website.