diff options
author | gbrandl <devnull@localhost> | 2007-02-14 21:10:31 +0100 |
---|---|---|
committer | gbrandl <devnull@localhost> | 2007-02-14 21:10:31 +0100 |
commit | f61861dc4ce7303a6a768b262135134c3051b50e (patch) | |
tree | c58eb8c8993a9eb4a8827e522c561e635f6ddef7 /docs/src | |
parent | 5742a7850bc59d4e9e5a47a06c90b2321c389c63 (diff) | |
download | pygments-f61861dc4ce7303a6a768b262135134c3051b50e.tar.gz |
[svn] Improve Moin parser and add docs.
Diffstat (limited to 'docs/src')
-rw-r--r-- | docs/src/index.txt | 2 | ||||
-rw-r--r-- | docs/src/moinmoin.txt | 38 |
2 files changed, 40 insertions, 0 deletions
diff --git a/docs/src/index.txt b/docs/src/index.txt index 97438d95..3676f6c7 100644 --- a/docs/src/index.txt +++ b/docs/src/index.txt @@ -46,6 +46,8 @@ Welcome to the Pygments documentation. - `Using Pygments in ReST documents <rstdirective.txt>`_ + - `Using Pygments with MoinMoin <moinmoin.txt>`_ + - About Pygments - `Changelog <changelog.txt>`_ diff --git a/docs/src/moinmoin.txt b/docs/src/moinmoin.txt new file mode 100644 index 00000000..783c7f4d --- /dev/null +++ b/docs/src/moinmoin.txt @@ -0,0 +1,38 @@ +.. -*- 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 and give the file 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/ |