summaryrefslogtreecommitdiff
path: root/doc/docs/moinmoin.rst
diff options
context:
space:
mode:
authorTim Hatch <tim@timhatch.com>2014-04-23 16:48:10 -0400
committerTim Hatch <tim@timhatch.com>2014-04-23 16:48:10 -0400
commit690a2bdfa924f76fd374e25bd9772c2090cf6414 (patch)
tree576991298817f1055da24857df6982dc2bd37d5a /doc/docs/moinmoin.rst
parent1d9f7f4f19c49a22ecd119f58580f9bc5ccd5080 (diff)
parentb69477dc22e228cde4c1d39bf11b292b88d95fe1 (diff)
downloadpygments-690a2bdfa924f76fd374e25bd9772c2090cf6414.tar.gz
Merged in lefticus/pygments-main (pull request #24)
Conflicts: pygments/lexers/_mapping.py pygments/lexers/agile.py
Diffstat (limited to 'doc/docs/moinmoin.rst')
-rw-r--r--doc/docs/moinmoin.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/docs/moinmoin.rst b/doc/docs/moinmoin.rst
new file mode 100644
index 00000000..8b2216b3
--- /dev/null
+++ b/doc/docs/moinmoin.rst
@@ -0,0 +1,39 @@
+.. -*- mode: rst -*-
+
+============================
+Using Pygments with MoinMoin
+============================
+
+From Pygments 0.7, the source distribution ships a `Moin`_ parser plugin that
+can be used to get Pygments highlighting in Moin wiki pages.
+
+To use it, copy the file `external/moin-parser.py` from the Pygments
+distribution to the `data/plugin/parser` subdirectory of your Moin instance.
+Edit the options at the top of the file (currently ``ATTACHMENTS`` and
+``INLINESTYLES``) and rename the file to the name that the parser directive
+should have. For example, if you name the file ``code.py``, you can get a
+highlighted Python code sample with this Wiki markup::
+
+ {{{
+ #!code python
+ [...]
+ }}}
+
+where ``python`` is the Pygments name of the lexer to use.
+
+Additionally, if you set the ``ATTACHMENTS`` option to True, Pygments will also
+be called for all attachments for whose filenames there is no other parser
+registered.
+
+You are responsible for including CSS rules that will map the Pygments CSS
+classes to colors. You can output a stylesheet file with `pygmentize`, put it
+into the `htdocs` directory of your Moin instance and then include it in the
+`stylesheets` configuration option in the Moin config, e.g.::
+
+ stylesheets = [('screen', '/htdocs/pygments.css')]
+
+If you do not want to do that and are willing to accept larger HTML output, you
+can set the ``INLINESTYLES`` option to True.
+
+
+.. _Moin: http://moinmoin.wikiwikiweb.de/