pandoc-latex-tip 1.5.0

pandoc-latex-tip
================

`Build
Status <https://travis-ci.org/chdemko/pandoc-latex-tip/branches>`__
`Coveralls <https://coveralls.io/github/chdemko/pandoc-latex-tip?branch=1.5.0>`__
`Scrutinizer <https://scrutinizer-ci.com/g/chdemko/pandoc-latex-tip/>`__
`PyPI version <https://pypi.org/project/pandoc-latex-tip/>`__ `PyPI
format <https://pypi.org/project/pandoc-latex-tip/1.5.0/>`__
`License <https://raw.githubusercontent.com/chdemko/pandoc-latex-tip/1.5.0/LICENSE>`__
`Python version <https://pypi.org/project/pandoc-latex-tip/>`__
`Development Status <https://pypi.org/project/pandoc-latex-tip/>`__

*pandoc-latex-tip* is a `pandoc <http://pandoc.org/>`__ filter for
adding icon tooltips in the margin using popular icon collections:

+----------+------+----------------------------------------------+----+
| Collecti | Vers | Author | Li |
| on | ions | | ce |
| name | | | ns |
| | | | e |
+==========+======+==============================================+====+
| Font-Awe | 4.7, | `Dave Gandy - | `S |
| some | 5.0 | https://fontawesome.com/ <https://fontawesom | IL |
| | | e.com/>`__ | OF |
| | | | L |
| | | | 1. |
| | | | 1 |
| | | | <h |
| | | | tt |
| | | | ps |
| | | | :/ |
| | | | /f |
| | | | on |
| | | | ta |
| | | | we |
| | | | so |
| | | | me |
| | | | .c |
| | | | om |
| | | | /l |
| | | | ic |
| | | | en |
| | | | se |
| | | | /> |
| | | | `_ |
| | | | _ |
+----------+------+----------------------------------------------+----+
| Glyphico | 3.3 | `Jan Kovarik - | `M |
| ns | | https://glyphicons.com/ <https://glyphicons. | IT |
| | | com/>`__ | < |
| | | | ht |
| | | | tp |
| | | | s: |
| | | | // |
| | | | gi |
| | | | th |
| | | | ub |
| | | | .c |
| | | | om |
| | | | /t |
| | | | wb |
| | | | s/ |
| | | | bo |
| | | | ot |
| | | | st |
| | | | ra |
| | | | p/ |
| | | | bl |
| | | | ob |
| | | | /v |
| | | | 3. |
| | | | 3. |
| | | | 7/ |
| | | | LI |
| | | | CE |
| | | | NS |
| | | | E> |
| | | | `_ |
| | | | _ |
+----------+------+----------------------------------------------+----+
| Material | 2.4 | `Austin Andrews & Google - | `S |
| Design | | https://materialdesignicons.com/ <https://ma | IL |
| | | terialdesignicons.com/>`__ | OF |
| | | | L |
| | | | 1. |
| | | | 1 |
| | | | <h |
| | | | tt |
| | | | ps |
| | | | :/ |
| | | | /g |
| | | | it |
| | | | hu |
| | | | b. |
| | | | co |
| | | | m/ |
| | | | Te |
| | | | mp |
| | | | la |
| | | | ri |
| | | | an |
| | | | /M |
| | | | at |
| | | | er |
| | | | ia |
| | | | lD |
| | | | es |
| | | | ig |
| | | | n/ |
| | | | bl |
| | | | ob |
| | | | /m |
| | | | as |
| | | | te |
| | | | r/ |
| | | | LI |
| | | | CE |
| | | | NS |
| | | | E> |
| | | | `_ |
| | | | _ |
+----------+------+----------------------------------------------+----+

It uses the *icon_font_to_png* package to generate on-fly images.

Documentation
-------------

See the `wiki
pages <https://github.com/chdemko/pandoc-latex-tip/wiki>`__.

Usage
-----

To apply the filter, use the following option with pandoc:

::

--filter pandoc-latex-tip

Installation
------------

*pandoc-latex-tip* requires `python <https://www.python.org>`__, a
programming language that comes pre-installed on linux and Mac OS X, and
which is easily installed `on
Windows <https://www.python.org/downloads/windows>`__. Either python 2.7
or 3.x will do.

Install *pandoc-latex-tip* as root using the bash command

::

pip install pandoc-latex-tip

To upgrade to the most recent release, use

::

pip install --upgrade pandoc-latex-tip

To upgrade the icon collections add the ``--force`` and ``--no-cache``
flags

::

pip install --upgrade --force --no-cache pandoc-latex-tip

To upgrade to the current code, use

::

pip install --upgrade --force --no-cache git+https://github.com/chdemko/pandoc-latex-tip

``pip`` is a script that downloads and installs modules from the Python
Package Index, `PyPI <https://pypi.org>`__. It should come installed
with your python distribution. If you are running linux, ``pip`` may be
bundled separately. On a Debian-based system (including Ubuntu), you can
install it as root using

::

apt-get update
apt-get install python-pip

Make sure you have required packages for `Pillow
installation <https://pillow.readthedocs.org/en/3.1.x/installation.html>`__.
On linux you have to install some extra libraries **before**
*pandoc-latex-tip*. On a Debian-based system (including Ubuntu), you can
install it as root using

::

apt-get build-dep python-imaging
apt-get install libjpeg8 libjpeg62-dev libfreetype6 libfreetype6-dev

Getting Help
------------

If you have any difficulties with pandoc-latex-tip, please feel welcome
to `file an
issue <https://github.com/chdemko/pandoc-latex-tip/issues>`__ on github
so that we can help.