Chirun LaTeX Package

When compiling LaTeX documents in Chirun, the chirun LaTeX package provides some supporting functionality.

Using Chirun LaTeX Package

Use the chirun LaTeX package in your documents by adding the following line to you preamble:

\usepackage{chirun}

Interaction with the Hyperref Package

Chirun requires and loads the hyperref package automatically. If the hyperref package is loaded for a second time it can lead to an error of the form,

! LaTeX Error: Option clash for package hyperref.

One solution is to ensure that the hyperref package is loaded first:

\usepackage[colorlinks,linkcolor={blue}]{hyperref}
\usepackage{chirun}

An alternative solution is to load only the chirun package and pass any required options for hyperref via the chirun package options:

\usepackage[hyperref={colorlinks,linkcolor={blue}}]{chirun}

Features

Embed HTML

\begin{HTML}
    <div>
        <p>This raw HTML will be produced in the output directly</p>
    </div>
\end{HTML}

The raw HTML will not appear in the LaTeX PDF output.

Embed a Numbas Test

\numbas[Test Yourself:]{https://numbas.mathcentre.ac.uk/[...]}

The Numbas test will appear embedded in the HTML web page.

In the LaTeX PDF output, a link to the content will be shown.

Embed Youtube/Vimeo

\youtube[YouTube:]{EdyociU35u8}
\vimeo[Vimeo:]{8169375}

The video will appear embedded in the HTML web page. In the LaTeX PDF output, a link to the content will be shown.

Image Alt Text

All images should have accompanying alt text, describing the content of the image for users who can’t see it.

Use the \alttext command inside a figure block to add alt text:

\begin{figure}
    \includegraphics[width=0.8\textwidth]{images/hist.pdf}
    \caption{A histogram originally provided in .pdf format}
    \alttext{A plot titled "A histogram". The x axis is labelled "x-axis".
            The y axis is labelled "Frequency". The histogram shows a peak at
            a value of approximately 70.}
\end{figure}

The content of the \altext{} command will be attached to the figure image as alt text in the HTML web page. The to the contentLaTeX PDF output is unaffected.