MarTeX-Cpp

MarTeX-Cpp is a flexable, extendable and fast TeX-to-HTML converter by fully tokenizing-lexing-parsing-interpreting the TeX source. It can be compiled to serve as a module for different languages, like PHP or JavaScript. It's goal is to provide a way to allow users to write TeX they are familiar with to produce nice looking pages like this one, but without allowing code injection.

Styling

• Headings
  • \title{Title}

    Make a big fancy title.

  • \chapter{Title}

    Make a chapter title.

  • \section{Title}

    Make a section title.

  • \subsection{Title}

    Make a subsection title.

  • \subsubsection{Title}

    Make a subsubsection title.

• Markup
  • \textbf{Text} or \bold{Text}

    Render Text in bold.

  • \textit{Text} or \italic{Text}

    Render Text in italics.

  • \textul{Text} or \underline{Text}

    Render Text underlined.

  • \textsc{Text} or \smallcaps{Text}

    Render Text .

  • \textms{Text} or \mono{Text}

    Render Text monospaced.

• Elements
  • \hline

    Make a horizontal line.

  • \newline

    Line break, equivalent to a double backslash.

  • \ref{label}

    Reference a label (from an image, for example). Works with both forward and backwards declaration (The label can be both above and below the ref command). Outputs a question mark when the label is undefined.

  • \define{Variable}{Value}

    Set the global Variable to Value. Often used to change module behaviour.

  • \href{URL}{Text}

    Make a hyperlink to URL with text Text

  • \colo(u)r{type}{definition}{text}

    Change the colour of a piece of text. \colour{ff00ff}{text}

Special Characters

Images

Images are pretty. Normally the images try to fill the page width, you can control this behaviour with the provided sizing options. If you add a caption to an image it will put "Figure 1: caption" under it. You can change "Figure" to , for example, "Picture" by setting the header with a \define{header}{Picture }.

• \includegraphics{url}

  Use to display an image.

• \caption{caption text}

  Use to display text under your image.

• \label{label text}

  Use to give your image a label, so you can use \ref{label} to reference it.

• \width{Width}

  Set the width of your image. Width can have the following formats: 10 (this is a percentage), 10px, 10cm, 10em.

• \height{Height}

  Set the height of your image. Height can have the following formats: 10 (this is a percentage), 10px, 10cm, 10em.

• \alttext{alt text}

  Set the alt text, also called hovertext, of your image.

\begin{figure}
    \includegraphics{test.png}
    \caption{This is a test image}
    \label{testimage}
    \width{120px}
    \height{30}
    \alttext{A mouse!}
\end{figure}

Lists

Note that there are two different list environments: enumerate and itemize with a different default markers, respectively numbers and bullets.

• \item

  Mark the start of the next item in the list.

• \setmarker{type}

  Set the marker type. Valid types are: square, bullet, circle, none, numbers, letters, LETTERS, roman, ROMAN.

\begin{itemize}
    \setmarker{square}
    \item Apple
    \item Banana
    \item Kiwi 
    \item Pear
\end{itemize}

Tables

Tables are a good way to represent content in a neat way. In MarTeX they behave pretty similar to the LaTeX tabulars. The tabular format accepts '|' for vertical lines, 'l' for left aligned column, 'c' for a centered column and 'r' for a right aligned column.

• \hline

  Add a horizontal line at this position in the table. Maximum of two lines per row.

• \multicolumn{N}{format}{text}

  Make a cell span over N columns. You can add special formatting to this cell (so just like your table formatting).

• \multirow{N}{text}

  Make a cell span over N rows

\begin{tabular}[|| l | c | r ||]
    \hline \hline
    1 & 2 & 3 \\\hline
    4 & 5 & 6 \\\hline
    7 & 8 & 9 \\\hline
    \multicolumn{3}{| c |}{0} \\
    \hline
\end{tabular}

Contributing

Please feel free to submit anything! The only thing I ask is that you include at least one test that verifies the behaviour of your change.

Bug Bounty Program

If you find a way insert arbitrary html tags and/or get javascript execution from a certain input string then first I'd like to congratualate you on a job well done! Please contact me privately with said input and we'll work on pushing out a fix as quickly as possible. Because I'm still a student there is unfortunately no hard cash to be made here, but certainly there is coffee and cake in it for you!

links

• Live MarTeX interpreter
• Development Guide

Authors

• Thijs Miedema - Initial work - thijsmie

Acknowledgments

Thanks to my committee for their endless patience and enthusiasm while listening to me whining on about this.
Thanks to Diego Perini for writing a nifty regex-based URL validator.

License

This project is licensed under the MIT License - see the LICENSE.md file for details