This is the README file for the file muse-tikz2png.el.

Synopsis
========

This file can be used within Emacs-Muse for those who want to draw
graphics using the pgf package (which provides the tikz
command). Graphics will be inserted in LaTeX, ConText and html/xhtml/xml
documents.


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

The file muse-tikz2png.el should be put in the muse directory, where all
the other muse files lie, or to any place in the path of your
(x)emacs, and to use it just load it.

The mechanism for html/xhtml/xml relies on ImageMagick, a software
which is freely available for all major platform, so you should have
it installed if it's not already on your machine.  To use with
LaTeX-derived styles, you have to add this line to your header
(customize muse-latex-header):

\usepackage{tikz}

(It can be done with the "preamble" argument also).

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

To include a tikz picture in a muse file, just open a tikz tag:

<tikz caption="THE CAPTION YOU WANT DISPLAYED">
YOUR TIKZ CODE	
</tikz>

The caption is optional and will be displayed only if there are 6 or
more whitespaces (and nothing other) between beginning of line and
<tikz>; in this case the graphic will be a float in LaTeX and ConText
(it will be numbered). In html this mechanism allows prints the
caption at the bottom but not so nicely.

I have tested this file extensively but it certainly has defects;
please let me know when you find one.

Have fun

jean@bornier.net