Command line options

In the following notes some typical usage-scenario are reported.

It is assumed the you have already installed MaTiSSe.py and you have written your_presentation.md source.

Specifying a custom output directory

MaTiSse.py -i your_presentation.md -o your_output_dir

This will generate the html presentation into your_output_dir that will be created if it does not already exist. Note that into the output path some other sub-directories are created, besides the main html presentation (index.html): as an example the css and js directories which contains the css style files and the javascripts, respectively. Moreover, all other directories you have specified into the presentation source are copied inside the root output directory. Before copy such a directories they are removed from the output if already existing thus if you manually modify the contents of output path your modification will be lost after a presentation (re)compilation. Be very careful with MaTiSSe.py -o .: if you use subdirectories for other contents (e.g. images, videos) these will be definitely lost!

Specifying a custom highligth.js style

MaTiSse.py -i your_presentation.md -hs zenburn.css

This will set the style for code highlighting to zenburn.css instead of using the default one github.css. To list all the available style type:

MaTiSse.py --print-highlight-styles

Inserting Table of Contents slide at the beginning of each section and/or subsection

For long presentation it could be useful to structuring your presentation in sections and/or subsections and insert a slide summarizing the Table of Contents at the beginning of each section and/or subsection for highlighting the current slide position with respect the whole presentation (and avoid your listeners to go away before an interesting argument). To this aim there are two helper switches --toc-at-sec-beginning and --toc-at-subsec-beginning, as an example:

MaTiSse.py -i your_presentation.md  --toc-at-sec-beginning 2

will insert a slide with TOC (and highligthed the current slide position) at the beginning of each section. The number after the switch indicates the depth of the TOC:

• depth=1, the TOC is limited to the sections list;
• depth=2, the TOC is limited to the sections/subsections list;
• depth=3, the TOC contains sections/subsections/slides list;

Print presentation informations/options

MaTiSSe.py has a long list of options/usage thus it is often useful listing the informations of the current presentation and/or listing other available options.

Print presentation informations

MaTiSse.py -i your_presentation.md --print-preamble 

This will print the metadata (authors, title, emails, etc...) and the theme styles (slide dimension, background color, slides transitions, etc...) you have specified into your source.

Print available options

MaTiSse.py --print-options

This will print the available options for the metadata and theme styles of each element (canvas, slide headers, slide footers, etc...). It could also be useful to print the css theme built up by MaTiSSe.py. To see the default theme type:

MaTiSse.py --print-css

while to print the css theme of your actual presentation (that is built up according to the options specified into your source) type:

MaTiSse.py -i your_presentation.md --print-css

Indenting the html output

The default behaviour is to produce the html without indentation. This has two advantages:

1. a smaller size index.html;
2. a safe rendering (without any unwanted white spaces...).

However, if you want to manually modify or inspect the html the indentation is necessary. In such a case type:

MaTiSse.py -i your_presentation.md --indented

The rendering of such a html output is unsafe especially if you have defined containers where the white spaces are important (e.g. code listings) because unwanted white spaces could be added.

Using Online MathJax service

By default MaTiSSe.py uses a local (simplified) copy of MathJax engine. However, even if the local copy has been strongly compressed it still occupy about 1.8MB. In case you prefer to use the full engine of MathJax by means of the online service type:

MaTiSse.py -i your_presentation.md --online-MathJax

In this case the local copy of MathJax is avoided and you can save about 1.8MB of your space.