From: JinWang An Date: Tue, 5 Jan 2021 03:15:41 +0000 (+0900) Subject: Imported Upstream version 2.0rc1 X-Git-Tag: upstream/2.0rc1^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=7935db78092dd7eb1c37a994959f59304fbff05d;p=platform%2Fupstream%2Fpython3-pygments.git Imported Upstream version 2.0rc1 --- diff --git a/AUTHORS b/AUTHORS index 9447bd0..0611923 100644 --- a/AUTHORS +++ b/AUTHORS @@ -6,15 +6,19 @@ Major developers are Tim Hatch and Armin Ronacher Other contributors, listed alphabetically, are: * Sam Aaron -- Ioke lexer -* Kumar Appaiah -- Debian control lexer * Ali Afshar -- image formatter +* Thomas Aglassinger -- Rexx lexer +* Kumar Appaiah -- Debian control lexer * Andreas Amann -- AppleScript lexer * Timothy Armstrong -- Dart lexer fixes * Jeffrey Arnold -- R/S, Rd, BUGS, Jags, and Stan lexers * Jeremy Ashkenas -- CoffeeScript lexer * Stefan Matthias Aust -- Smalltalk lexer +* Lucas Bajolet -- Nit lexer * Ben Bangert -- Mako lexers * Max Battcher -- Darcs patch lexer +* Thomas Baruchel -- APL lexer +* Tim Baumann -- (Literate) Agda lexer * Paul Baumgart, 280 North, Inc. -- Objective-J lexer * Michael Bayer -- Myghty lexers * John Benediktsson -- Factor lexer @@ -25,24 +29,31 @@ Other contributors, listed alphabetically, are: * Pierre Bourdon -- bugfixes * Hiram Chirino -- Scaml and Jade lexers * Ian Cooper -- VGL lexer +* David Corbett -- Inform, Jasmin, and TADS 3 lexers * Leaf Corcoran -- MoonScript lexer -* Christian Jann -- ShellSession lexer * Christopher Creutzig -- MuPAD lexer +* Daniël W. Crompton - Pike lexer * Pete Curry -- bugfixes -* Owen Durni -- haXe lexer +* Bryan Davis -- EBNF lexer +* Owen Durni -- Haxe lexer +* Alexander Dutton, Oxford University Computing Services -- SPARQL lexer * Nick Efford -- Python 3 lexer * Sven Efftinge -- Xtend lexer * Artem Egorkine -- terminal256 formatter * James H. Fisher -- PostScript lexer +* William S. Fulton -- SWIG lexer * Carlos Galdino -- Elixir and Elixir Console lexers * Michael Galloy -- IDL lexer * Naveen Garg -- Autohotkey lexer * Laurent Gautier -- R/S lexer * Alex Gaynor -- PyPy log lexer +* Richard Gerkin -- Igor Pro lexer * Alain Gilbert -- TypeScript lexer +* Alex Gilding -- BlitzBasic lexer * Bertrand Goetzmann -- Groovy lexer * Krzysiek Goj -- Scala lexer * Matt Good -- Genshi, Cheetah lexers +* Michał Górny -- vim modeline support * Patrick Gotthardt -- PHP namespaces support * Olivier Guibe -- Asymptote lexer * Jordi Gutiérrez Hermoso -- Octave lexer @@ -53,19 +64,27 @@ Other contributors, listed alphabetically, are: * Greg Hendershott -- Racket lexer * David Hess, Fish Software, Inc. -- Objective-J lexer * Varun Hiremath -- Debian control lexer +* Rob Hoelz -- Perl 6 lexer * Doug Hogan -- Mscgen lexer * Ben Hollis -- Mason lexer +* Max Horn -- GAP lexer * Dustin Howett -- Logos lexer * Alastair Houghton -- Lexer inheritance facility * Tim Howard -- BlitzMax lexer * Ivan Inozemtsev -- Fantom lexer * Brian R. Jackson -- Tea lexer +* Christian Jann -- ShellSession lexer * Dennis Kaarsemaker -- sources.list lexer +* Dmitri Kabak - Inferno Limbo lexer * Igor Kalnitsky -- vhdl lexer +* Alexander Kit -- MaskJS lexer * Pekka Klärck -- Robot Framework lexer +* Gerwin Klein -- Isabelle lexer * Eric Knibbe -- Lasso lexer +* Stepan Koltsov -- Clay lexer * Adam Koprowski -- Opa lexer * Benjamin Kowarsch -- Modula-2 lexer +* Domen Kožar -- Nix lexer * Alexander Kriegisch -- Kconfig and AspectJ lexers * Marek Kubica -- Scheme lexer * Jochen Kupperschmidt -- Markdown processor @@ -76,6 +95,7 @@ Other contributors, listed alphabetically, are: * Mark Lee -- Vala lexer * Ben Mabey -- Gherkin lexer * Angus MacArthur -- QML lexer +* Louis Marchand -- Eiffel lexer * Simone Margaritelli -- Hybris lexer * Kirk McDonald -- D lexer * Gordon McGregor -- SystemVerilog lexer @@ -83,6 +103,7 @@ Other contributors, listed alphabetically, are: * Brian McKenna -- F# lexer * Charles McLaughlin -- Puppet lexer * Lukas Meuser -- BBCode formatter, Lua lexer +* Cat Miller -- Pig lexer * Paul Miller -- LiveScript lexer * Hong Minhee -- HTTP lexer * Michael Mior -- Awk lexer @@ -96,15 +117,20 @@ Other contributors, listed alphabetically, are: * Jesper Noehr -- HTML formatter "anchorlinenos" * Mike Nolta -- Julia lexer * Jonas Obrist -- BBCode lexer +* Edward O'Callaghan -- Cryptol lexer * David Oliva -- Rebol lexer +* Pat Pannuto -- nesC lexer * Jon Parise -- Protocol buffers lexer * Ronny Pfannschmidt -- BBCode lexer * Benjamin Peterson -- Test suite refactoring * Dominik Picheta -- Nimrod lexer +* Andrew Pinkham -- RTF Formatter Refactoring * Clément Prévost -- UrbiScript lexer +* raichoo -- Idris lexer * Kashif Rasul -- CUDA lexer * Justin Reidy -- MXML lexer * Norman Richards -- JSON lexer +* Corey Richardson -- Rust lexer updates * Lubomir Rintel -- GoodData MAQL and CL lexers * Andre Roberge -- Tango style * Konrad Rudolph -- LaTeX formatter enhancements @@ -126,12 +152,16 @@ Other contributors, listed alphabetically, are: * Tiberius Teng -- default style overhaul * Jeremy Thurgood -- Erlang, Squid config lexers * Brian Tiffin -- OpenCOBOL lexer +* Bob Tolbert -- Hy lexer * Erick Tryzelaar -- Felix lexer +* Alexander Udalov -- Kotlin lexer improvements +* Thomas Van Doren -- Chapel lexer * Daniele Varrazzo -- PostgreSQL lexers * Abe Voelker -- OpenEdge ABL lexer * Pepijn de Vos -- HTML formatter CTags support * Whitney Young -- ObjectiveC lexer * Matthias Vallentin -- Bro lexer +* Linh Vu Hong -- RSL lexer * Nathan Weizenbaum -- Haml and Sass lexers * Dietmar Winkler -- Modelica lexer * Nils Winter -- Smalltalk lexer @@ -139,5 +169,6 @@ Other contributors, listed alphabetically, are: * Diego Zamboni -- CFengine3 lexer * Enrique Zamudio -- Ceylon lexer * Alex Zimin -- Nemerle lexer +* Rob Zimmerman -- Kal lexer Many thanks for all contributions! diff --git a/CHANGES b/CHANGES index c2a3528..95f975a 100644 --- a/CHANGES +++ b/CHANGES @@ -6,6 +6,159 @@ Issue numbers refer to the tracker at pull request numbers to the requests at . +Version 2.0rc1 +-------------- +(released Oct 16, 2014) + +- Dropped Python 2.4 and 2.5 compatibility. This is in favor of single-source + compatibility between Python 2.6, 2.7 and 3.3+. + +- New website and documentation based on Sphinx (finally!) + +- Lexers added: + + * APL (#969) + * Agda and Literate Agda (PR#203) + * Alloy (PR#355) + * AmbientTalk + * BlitzBasic (PR#197) + * ChaiScript (PR#24) + * Chapel (PR#256) + * Cirru (PR#275) + * Clay (PR#184) + * ColdFusion CFC (PR#283) + * Cryptol and Literate Cryptol (PR#344) + * Cypher (PR#257) + * Docker config files + * EBNF (PR#193) + * Eiffel (PR#273) + * GAP (PR#311) + * Golo (PR#309) + * Handlebars (PR#186) + * Hy (PR#238) + * Idris and Literate Idris (PR#210) + * Igor Pro (PR#172) + * Inform 6/7 (PR#281) + * Intel objdump (PR#279) + * Isabelle (PR#386) + * Jasmin (PR#349) + * JSON-LD (PR#289) + * Kal (PR#233) + * Lean (PR#399) + * LSL (PR#296) + * Limbo (PR#291) + * Liquid (#977) + * MQL (PR#285) + * MaskJS (PR#280) + * Mozilla preprocessors + * Mathematica (PR#245) + * NesC (PR#166) + * Nit (PR#375) + * Nix (PR#267) + * Pan + * Pawn (PR#211) + * Perl 6 (PR#181) + * Pig (PR#304) + * Pike (PR#237) + * QBasic (PR#182) + * Red (PR#341) + * ResourceBundle (#1038) + * Rexx (PR#199) + * Rql (PR#251) + * Rsl + * SPARQL (PR#78) + * Slim (PR#366) + * Swift (PR#371) + * Swig (PR#168) + * TADS 3 (PR#407) + * Todo.txt todo lists + * Twig (PR#404) + +- Added a helper to "optimize" regular expressions that match one of many + literal words; this can save 20% and more lexing time with lexers that + highlight many keywords or builtins. + +- New styles: "xcode" and "igor", similar to the default highlighting of + the respective IDEs. + +- The command-line "pygmentize" tool now tries a little harder to find the + correct encoding for files and the terminal (#979). + +- Added "inencoding" option for lexers to override "encoding" analogous + to "outencoding" (#800). + +- Added line-by-line "streaming" mode for pygmentize with the "-s" option. + (PR#165) Only fully works for lexers that have no constructs spanning + lines! + +- Added an "envname" option to the LaTeX formatter to select a replacement + verbatim environment (PR#235). + +- Updated the Makefile lexer to yield a little more useful highlighting. + +- Lexer aliases passed to ``get_lexer_by_name()`` are now case-insensitive. + +- File name matching in lexers and formatters will now use a regex cache + for speed (PR#205). + +- Pygments will now recognize "vim" modelines when guessing the lexer for + a file based on content (PR#118). + +- The NameHighlightFilter now works with any Name.* token type (#790). + +- Python 3 lexer: add new exceptions from PEP 3151. + +- Opa lexer: add new keywords (PR#170). + +- Julia lexer: add keywords and underscore-separated number + literals (PR#176). + +- Lasso lexer: fix method highlighting, update builtins. Fix + guessing so that plain XML isn't always taken as Lasso (PR#163). + +- Objective C/C++ lexers: allow "@" prefixing any expression (#871). + +- Ruby lexer: fix lexing of Name::Space tokens (#860) and of symbols + in hashes (#873). + +- Stan lexer: update for version 2.4.0 of the language (PR#162, PR#255, PR#377). + +- JavaScript lexer: add the "yield" keyword (PR#196). + +- HTTP lexer: support for PATCH method (PR#190). + +- Koka lexer: update to newest language spec (PR#201). + +- Haxe lexer: rewrite and support for Haxe 3 (PR#174). + +- Prolog lexer: add different kinds of numeric literals (#864). + +- F# lexer: rewrite with newest spec for F# 3.0 (#842), fix a bug with + dotted chains (#948). + +- Kotlin lexer: general update (PR#271). + +- Rebol lexer: fix comment detection and analyse_text (PR#261). + +- LLVM lexer: update keywords to v3.4 (PR#258). + +- PHP lexer: add new keywords and binary literals (PR#222). + +- external/markdown-processor.py updated to newest python-markdown (PR#221). + +- CSS lexer: some highlighting order fixes (PR#231). + +- Ceylon lexer: fix parsing of nested multiline comments (#915). + +- C family lexers: fix parsing of indented preprocessor directives (#944). + +- Rust lexer: update to 0.9 language version (PR#270, PR#388). + +- Elixir lexer: update to 0.15 language version (PR#392). + +- Fix swallowing incomplete tracebacks in Python console lexer (#874). + + Version 1.6 ----------- (released Feb 3, 2013) @@ -259,7 +412,7 @@ Version 1.3 * Ada * Coldfusion * Modula-2 - * haXe + * Haxe * R console * Objective-J * Haml and Sass @@ -318,7 +471,7 @@ Version 1.2 * CMake * Ooc * Coldfusion - * haXe + * Haxe * R console - Added options for rendering LaTeX in source code comments in the diff --git a/LICENSE b/LICENSE index 1e09119..641c8e8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2006-2013 by the respective authors (see AUTHORS file). +Copyright (c) 2006-2014 by the respective authors (see AUTHORS file). All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/MANIFEST.in b/MANIFEST.in index 312c150..cfec4e9 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,5 +2,5 @@ include pygmentize include external/* include Makefile CHANGES LICENSE AUTHORS TODO ez_setup.py recursive-include tests * -recursive-include docs * +recursive-include doc * recursive-include scripts * diff --git a/Makefile b/Makefile index f24dd08..020f6ac 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ # # Combines scripts for common tasks. # -# :copyright: Copyright 2006-2013 by the Pygments team, see AUTHORS. +# :copyright: Copyright 2006-2014 by the Pygments team, see AUTHORS. # :license: BSD, see LICENSE for details. # @@ -19,9 +19,9 @@ all: clean-pyc check test check: @$(PYTHON) scripts/detect_missing_analyse_text.py || true + @pyflakes pygments | grep -v 'but unused' || true @$(PYTHON) scripts/check_sources.py -i build -i dist -i pygments/lexers/_mapping.py \ - -i docs/build -i pygments/formatters/_mapping.py -i pygments/unistring.py \ - -i pygments/lexers/_vimbuiltins.py + -i docs/build -i pygments/formatters/_mapping.py -i pygments/unistring.py clean: clean-pyc -rm -rf build @@ -36,15 +36,12 @@ codetags: @$(PYTHON) scripts/find_codetags.py -i tests/examplefiles -i scripts/pylintrc \ -i scripts/find_codetags.py -o codetags.html . -docs: docs/build - -docs/build: docs/src/*.txt - $(PYTHON) docs/generate.py html docs/build $? - touch docs/build +docs: + make -C doc html mapfiles: - (cd pygments/lexers; $(PYTHON) _mapping.py) (cd pygments/formatters; $(PYTHON) _mapping.py) + (cd pygments/lexers; $(PYTHON) _mapping.py) pylint: @pylint --rcfile scripts/pylintrc pygments @@ -53,7 +50,7 @@ reindent: @$(PYTHON) scripts/reindent.py -r -B . test: - @$(PYTHON) tests/run.py $(TESTS) + @$(PYTHON) tests/run.py $(TEST) test-coverage: - @$(PYTHON) tests/run.py -C $(TESTS) + @$(PYTHON) tests/run.py -C $(TEST) diff --git a/PKG-INFO b/PKG-INFO index 6e9739d..5575d60 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,34 +1,27 @@ Metadata-Version: 1.1 Name: Pygments -Version: 1.6 +Version: 2.0rc1 Summary: Pygments is a syntax highlighting package written in Python. Home-page: http://pygments.org/ Author: Georg Brandl Author-email: georg@python.org License: BSD License -Description: - Pygments +Description: Pygments ~~~~~~~~ Pygments is a syntax highlighting package written in Python. - It is a generic syntax highlighter for general use in all kinds of software - such as forum systems, wikis or other applications that need to prettify - source code. Highlights are: + It is a generic syntax highlighter suitable for use in code hosting, forums, + wikis or other applications that need to prettify source code. Highlights + are: - * a wide range of common languages and markup formats is supported + * a wide range of over 300 languages and other text formats is supported * special attention is paid to details, increasing quality by a fair amount * support for new languages and formats are added easily * a number of output formats, presently HTML, LaTeX, RTF, SVG, all image formats that PIL supports and ANSI sequences * it is usable as a command-line tool and as a library - * ... and it highlights even Brainfuck! - The `Pygments tip`_ is installable with ``easy_install Pygments==dev``. - - .. _Pygments tip: - http://bitbucket.org/birkenfeld/pygments-main/get/default.zip#egg=Pygments-dev - - :copyright: Copyright 2006-2013 by the Pygments team, see AUTHORS. + :copyright: Copyright 2006-2014 by the Pygments team, see AUTHORS. :license: BSD, see LICENSE for details. Keywords: syntax highlighting diff --git a/Pygments.egg-info/PKG-INFO b/Pygments.egg-info/PKG-INFO index 6e9739d..5575d60 100644 --- a/Pygments.egg-info/PKG-INFO +++ b/Pygments.egg-info/PKG-INFO @@ -1,34 +1,27 @@ Metadata-Version: 1.1 Name: Pygments -Version: 1.6 +Version: 2.0rc1 Summary: Pygments is a syntax highlighting package written in Python. Home-page: http://pygments.org/ Author: Georg Brandl Author-email: georg@python.org License: BSD License -Description: - Pygments +Description: Pygments ~~~~~~~~ Pygments is a syntax highlighting package written in Python. - It is a generic syntax highlighter for general use in all kinds of software - such as forum systems, wikis or other applications that need to prettify - source code. Highlights are: + It is a generic syntax highlighter suitable for use in code hosting, forums, + wikis or other applications that need to prettify source code. Highlights + are: - * a wide range of common languages and markup formats is supported + * a wide range of over 300 languages and other text formats is supported * special attention is paid to details, increasing quality by a fair amount * support for new languages and formats are added easily * a number of output formats, presently HTML, LaTeX, RTF, SVG, all image formats that PIL supports and ANSI sequences * it is usable as a command-line tool and as a library - * ... and it highlights even Brainfuck! - The `Pygments tip`_ is installable with ``easy_install Pygments==dev``. - - .. _Pygments tip: - http://bitbucket.org/birkenfeld/pygments-main/get/default.zip#egg=Pygments-dev - - :copyright: Copyright 2006-2013 by the Pygments team, see AUTHORS. + :copyright: Copyright 2006-2014 by the Pygments team, see AUTHORS. :license: BSD, see LICENSE for details. Keywords: syntax highlighting diff --git a/Pygments.egg-info/SOURCES.txt b/Pygments.egg-info/SOURCES.txt index dd49c40..e1a295e 100644 --- a/Pygments.egg-info/SOURCES.txt +++ b/Pygments.egg-info/SOURCES.txt @@ -3,6 +3,7 @@ CHANGES LICENSE MANIFEST.in Makefile +README.rst TODO ez_setup.py pygmentize @@ -14,56 +15,52 @@ Pygments.egg-info/dependency_links.txt Pygments.egg-info/entry_points.txt Pygments.egg-info/not-zip-safe Pygments.egg-info/top_level.txt -docs/generate.py -docs/pygmentize.1 -docs/build/api.html -docs/build/authors.html -docs/build/changelog.html -docs/build/cmdline.html -docs/build/filterdevelopment.html -docs/build/filters.html -docs/build/formatterdevelopment.html -docs/build/formatters.html -docs/build/index.html -docs/build/installation.html -docs/build/integrate.html -docs/build/java.html -docs/build/lexerdevelopment.html -docs/build/lexers.html -docs/build/moinmoin.html -docs/build/plugins.html -docs/build/quickstart.html -docs/build/rstdirective.html -docs/build/styles.html -docs/build/tokens.html -docs/build/unicode.html -docs/src/api.txt -docs/src/authors.txt -docs/src/changelog.txt -docs/src/cmdline.txt -docs/src/filterdevelopment.txt -docs/src/filters.txt -docs/src/formatterdevelopment.txt -docs/src/formatters.txt -docs/src/index.txt -docs/src/installation.txt -docs/src/integrate.txt -docs/src/java.txt -docs/src/lexerdevelopment.txt -docs/src/lexers.txt -docs/src/moinmoin.txt -docs/src/plugins.txt -docs/src/quickstart.txt -docs/src/rstdirective.txt -docs/src/styles.txt -docs/src/tokens.txt -docs/src/unicode.txt +doc/Makefile +doc/conf.py +doc/download.rst +doc/faq.rst +doc/index.rst +doc/languages.rst +doc/make.bat +doc/pygmentize.1 +doc/_static/favicon.ico +doc/_static/logo_new.png +doc/_static/logo_only.png +doc/_templates/docssidebar.html +doc/_templates/indexsidebar.html +doc/_themes/pygments14/layout.html +doc/_themes/pygments14/theme.conf +doc/_themes/pygments14/static/bodybg.png +doc/_themes/pygments14/static/docbg.png +doc/_themes/pygments14/static/listitem.png +doc/_themes/pygments14/static/logo.png +doc/_themes/pygments14/static/pocoo.png +doc/_themes/pygments14/static/pygments14.css_t +doc/docs/api.rst +doc/docs/authors.rst +doc/docs/changelog.rst +doc/docs/cmdline.rst +doc/docs/filterdevelopment.rst +doc/docs/filters.rst +doc/docs/formatterdevelopment.rst +doc/docs/formatters.rst +doc/docs/index.rst +doc/docs/integrate.rst +doc/docs/java.rst +doc/docs/lexerdevelopment.rst +doc/docs/lexers.rst +doc/docs/moinmoin.rst +doc/docs/plugins.rst +doc/docs/quickstart.rst +doc/docs/rstdirective.rst +doc/docs/styles.rst +doc/docs/tokens.rst +doc/docs/unicode.rst external/autopygmentize external/lasso-builtins-generator-9.lasso external/markdown-processor.py external/moin-parser.py external/pygments.bashcomp -external/rst-directive-old.py external/rst-directive.py pygments/__init__.py pygments/cmdline.py @@ -71,8 +68,11 @@ pygments/console.py pygments/filter.py pygments/formatter.py pygments/lexer.py +pygments/modeline.py pygments/plugin.py +pygments/regexopt.py pygments/scanner.py +pygments/sphinxext.py pygments/style.py pygments/token.py pygments/unistring.py @@ -90,37 +90,111 @@ pygments/formatters/svg.py pygments/formatters/terminal.py pygments/formatters/terminal256.py pygments/lexers/__init__.py -pygments/lexers/_asybuiltins.py -pygments/lexers/_clbuiltins.py -pygments/lexers/_lassobuiltins.py -pygments/lexers/_luabuiltins.py +pygments/lexers/_asy_builtins.py +pygments/lexers/_cl_builtins.py +pygments/lexers/_cocoa_builtins.py +pygments/lexers/_lasso_builtins.py +pygments/lexers/_lua_builtins.py pygments/lexers/_mapping.py -pygments/lexers/_openedgebuiltins.py -pygments/lexers/_phpbuiltins.py +pygments/lexers/_openedge_builtins.py +pygments/lexers/_php_builtins.py pygments/lexers/_postgres_builtins.py -pygments/lexers/_robotframeworklexer.py pygments/lexers/_scilab_builtins.py -pygments/lexers/_sourcemodbuiltins.py +pygments/lexers/_sourcemod_builtins.py pygments/lexers/_stan_builtins.py -pygments/lexers/_vimbuiltins.py +pygments/lexers/_vim_builtins.py +pygments/lexers/actionscript.py pygments/lexers/agile.py +pygments/lexers/algebra.py +pygments/lexers/ambient.py +pygments/lexers/apl.py pygments/lexers/asm.py +pygments/lexers/automation.py +pygments/lexers/basic.py +pygments/lexers/business.py +pygments/lexers/c_cpp.py +pygments/lexers/c_like.py +pygments/lexers/chapel.py pygments/lexers/compiled.py +pygments/lexers/configs.py +pygments/lexers/console.py +pygments/lexers/css.py +pygments/lexers/d.py pygments/lexers/dalvik.py +pygments/lexers/data.py +pygments/lexers/diff.py pygments/lexers/dotnet.py +pygments/lexers/dsls.py +pygments/lexers/dylan.py +pygments/lexers/ecl.py +pygments/lexers/eiffel.py +pygments/lexers/erlang.py +pygments/lexers/esoteric.py +pygments/lexers/factor.py +pygments/lexers/fantom.py +pygments/lexers/felix.py +pygments/lexers/fortran.py pygments/lexers/foxpro.py pygments/lexers/functional.py +pygments/lexers/go.py +pygments/lexers/graph.py +pygments/lexers/graphics.py +pygments/lexers/haskell.py +pygments/lexers/haxe.py pygments/lexers/hdl.py +pygments/lexers/html.py +pygments/lexers/idl.py +pygments/lexers/igor.py +pygments/lexers/inferno.py +pygments/lexers/installers.py +pygments/lexers/int_fiction.py +pygments/lexers/iolang.py +pygments/lexers/javascript.py +pygments/lexers/julia.py pygments/lexers/jvm.py +pygments/lexers/lisp.py +pygments/lexers/make.py +pygments/lexers/markup.py pygments/lexers/math.py +pygments/lexers/matlab.py +pygments/lexers/ml.py +pygments/lexers/modeling.py +pygments/lexers/nimrod.py +pygments/lexers/nit.py +pygments/lexers/nix.py +pygments/lexers/objective.py +pygments/lexers/ooc.py pygments/lexers/other.py pygments/lexers/parsers.py +pygments/lexers/pascal.py +pygments/lexers/pawn.py +pygments/lexers/perl.py +pygments/lexers/php.py +pygments/lexers/prolog.py +pygments/lexers/python.py +pygments/lexers/r.py +pygments/lexers/rdf.py +pygments/lexers/rebol.py +pygments/lexers/resource.py +pygments/lexers/robotframework.py +pygments/lexers/ruby.py +pygments/lexers/rust.py +pygments/lexers/scripting.py pygments/lexers/shell.py +pygments/lexers/smalltalk.py +pygments/lexers/snobol.py pygments/lexers/special.py pygments/lexers/sql.py +pygments/lexers/tcl.py pygments/lexers/templates.py +pygments/lexers/testing.py pygments/lexers/text.py +pygments/lexers/textedit.py +pygments/lexers/textfmts.py +pygments/lexers/theorem.py +pygments/lexers/urbi.py pygments/lexers/web.py +pygments/lexers/webmisc.py pygments/styles/__init__.py pygments/styles/autumn.py pygments/styles/borland.py @@ -130,10 +204,13 @@ pygments/styles/default.py pygments/styles/emacs.py pygments/styles/friendly.py pygments/styles/fruity.py +pygments/styles/igor.py pygments/styles/manni.py pygments/styles/monokai.py pygments/styles/murphy.py pygments/styles/native.py +pygments/styles/paraiso_dark.py +pygments/styles/paraiso_light.py pygments/styles/pastie.py pygments/styles/perldoc.py pygments/styles/rrt.py @@ -141,27 +218,41 @@ pygments/styles/tango.py pygments/styles/trac.py pygments/styles/vim.py pygments/styles/vs.py +pygments/styles/xcode.py scripts/check_sources.py +scripts/debug_lexer.py scripts/detect_missing_analyse_text.py scripts/epydoc.css scripts/find_codetags.py scripts/find_error.py scripts/get_vimkw.py scripts/pylintrc -scripts/reindent.py scripts/vim2pygments.py -tests/old_run.py tests/run.py +tests/string_asserts.py tests/support.py tests/test_basic_api.py +tests/test_cfm.py tests/test_clexer.py tests/test_cmdline.py tests/test_examplefiles.py tests/test_html_formatter.py +tests/test_java.py tests/test_latex_formatter.py +tests/test_lexers_other.py +tests/test_objectiveclexer.py tests/test_perllexer.py +tests/test_qbasiclexer.py tests/test_regexlexer.py +tests/test_regexopt.py +tests/test_rtf_formatter.py +tests/test_ruby.py +tests/test_shell.py +tests/test_smarty.py +tests/test_string_asserts.py +tests/test_textfmts.py tests/test_token.py +tests/test_unistring.py tests/test_using_api.py tests/test_util.py tests/dtds/HTML4-f.dtd @@ -172,7 +263,7 @@ tests/dtds/HTML4.soc tests/dtds/HTMLlat1.ent tests/dtds/HTMLspec.ent tests/dtds/HTMLsym.ent -tests/examplefiles/ANTLRv3.g +tests/examplefiles/99_bottles_of_beer.chpl tests/examplefiles/AcidStateAdvanced.hs tests/examplefiles/AlternatingGroup.mu tests/examplefiles/BOM.js @@ -180,16 +271,24 @@ tests/examplefiles/CPDictionary.j tests/examplefiles/Config.in.cache tests/examplefiles/Constants.mo tests/examplefiles/DancingSudoku.lhs +tests/examplefiles/Deflate.fs +tests/examplefiles/Error.pmod tests/examplefiles/Errors.scala -tests/examplefiles/File.hy +tests/examplefiles/FakeFile.pike +tests/examplefiles/Get-CommandDefinitionHtml.ps1 +tests/examplefiles/IPDispatchC.nc +tests/examplefiles/IPDispatchP.nc tests/examplefiles/Intro.java tests/examplefiles/Makefile tests/examplefiles/Object.st tests/examplefiles/OrderedMap.hx +tests/examplefiles/RoleQ.pm6 tests/examplefiles/SmallCheck.hs tests/examplefiles/Sorting.mod tests/examplefiles/Sudoku.lhs tests/examplefiles/addressbook.proto +tests/examplefiles/all.nit +tests/examplefiles/antlr_ANTLRv3.g tests/examplefiles/antlr_throws tests/examplefiles/apache2.conf tests/examplefiles/as3_test.as @@ -197,6 +296,7 @@ tests/examplefiles/as3_test2.as tests/examplefiles/as3_test3.as tests/examplefiles/aspx-cs_example tests/examplefiles/autoit_submit.au3 +tests/examplefiles/automake.mk tests/examplefiles/badcase.java tests/examplefiles/batchfile.bat tests/examplefiles/bigtest.nsi @@ -207,49 +307,92 @@ tests/examplefiles/cells.ps tests/examplefiles/ceval.c tests/examplefiles/cheetah_example.html tests/examplefiles/classes.dylan +tests/examplefiles/clojure-weird-keywords.clj tests/examplefiles/condensed_ruby.rb tests/examplefiles/coq_RelationClasses +tests/examplefiles/core.cljs tests/examplefiles/database.pytb tests/examplefiles/de.MoinMoin.po tests/examplefiles/demo.ahk tests/examplefiles/demo.cfm +tests/examplefiles/demo.css.in +tests/examplefiles/demo.hbs +tests/examplefiles/demo.js.in +tests/examplefiles/demo.xul.in tests/examplefiles/django_sample.html+django +tests/examplefiles/docker.docker tests/examplefiles/dwarf.cw +tests/examplefiles/ember.handlebars tests/examplefiles/erl_session tests/examplefiles/escape_semicolon.clj tests/examplefiles/evil_regex.js tests/examplefiles/example.Rd +tests/examplefiles/example.als tests/examplefiles/example.bug tests/examplefiles/example.c tests/examplefiles/example.ceylon +tests/examplefiles/example.chai +tests/examplefiles/example.clay tests/examplefiles/example.cls tests/examplefiles/example.cob +tests/examplefiles/example.coffee tests/examplefiles/example.cpp +tests/examplefiles/example.e +tests/examplefiles/example.f90 +tests/examplefiles/example.feature +tests/examplefiles/example.gd +tests/examplefiles/example.gi +tests/examplefiles/example.golo +tests/examplefiles/example.groovy tests/examplefiles/example.gs tests/examplefiles/example.gst +tests/examplefiles/example.hs +tests/examplefiles/example.hx +tests/examplefiles/example.i6t +tests/examplefiles/example.i7x +tests/examplefiles/example.inf +tests/examplefiles/example.j tests/examplefiles/example.jag +tests/examplefiles/example.java +tests/examplefiles/example.jsonld +tests/examplefiles/example.kal tests/examplefiles/example.kt +tests/examplefiles/example.lagda +tests/examplefiles/example.liquid tests/examplefiles/example.lua +tests/examplefiles/example.ma tests/examplefiles/example.monkey tests/examplefiles/example.moo tests/examplefiles/example.moon +tests/examplefiles/example.mq4 +tests/examplefiles/example.mqh tests/examplefiles/example.msc +tests/examplefiles/example.ni tests/examplefiles/example.nim +tests/examplefiles/example.nix tests/examplefiles/example.ns2 -tests/examplefiles/example.p tests/examplefiles/example.pas +tests/examplefiles/example.pp tests/examplefiles/example.prg tests/examplefiles/example.rb +tests/examplefiles/example.red +tests/examplefiles/example.reds tests/examplefiles/example.reg +tests/examplefiles/example.rexx tests/examplefiles/example.rhtml tests/examplefiles/example.rkt tests/examplefiles/example.rpf +tests/examplefiles/example.sh tests/examplefiles/example.sh-session tests/examplefiles/example.shell-session +tests/examplefiles/example.slim +tests/examplefiles/example.sls tests/examplefiles/example.sml tests/examplefiles/example.snobol tests/examplefiles/example.stan tests/examplefiles/example.tea +tests/examplefiles/example.thy +tests/examplefiles/example.todotxt tests/examplefiles/example.ts tests/examplefiles/example.u tests/examplefiles/example.weechatlog @@ -258,6 +401,9 @@ tests/examplefiles/example.xtend tests/examplefiles/example.yaml tests/examplefiles/example2.aspx tests/examplefiles/example2.msc +tests/examplefiles/exampleScript.cfc +tests/examplefiles/exampleTag.cfc +tests/examplefiles/example_coq.v tests/examplefiles/example_elixir.ex tests/examplefiles/example_file.fy tests/examplefiles/firefox.mak @@ -273,13 +419,21 @@ tests/examplefiles/genshi_example.xml+genshi tests/examplefiles/genshitext_example.genshitext tests/examplefiles/glsl.frag tests/examplefiles/glsl.vert +tests/examplefiles/grammar-test.p6 +tests/examplefiles/hash_syntax.rb +tests/examplefiles/hello.at +tests/examplefiles/hello.golo +tests/examplefiles/hello.lsl tests/examplefiles/hello.smali tests/examplefiles/hello.sp tests/examplefiles/html+php_faulty.php tests/examplefiles/http_request_example tests/examplefiles/http_response_example -tests/examplefiles/import.hs +tests/examplefiles/hybris_File.hy +tests/examplefiles/idl_sample.pro +tests/examplefiles/iex_example tests/examplefiles/inet_pton6.dg +tests/examplefiles/interp.scala tests/examplefiles/intro.ik tests/examplefiles/ints.php tests/examplefiles/intsyn.fun @@ -292,7 +446,9 @@ tests/examplefiles/jbst_example2.jbst tests/examplefiles/jinjadesignerdoc.rst tests/examplefiles/json.lasso tests/examplefiles/json.lasso9 +tests/examplefiles/language.hy tests/examplefiles/lighttpd_config.conf +tests/examplefiles/limbo.b tests/examplefiles/linecontinuation.py tests/examplefiles/livescript-demo.ls tests/examplefiles/logos_example.xm @@ -303,7 +459,6 @@ tests/examplefiles/matlab_noreturn tests/examplefiles/matlab_sample tests/examplefiles/matlabsession_sample.txt tests/examplefiles/metagrammar.treetop -tests/examplefiles/mg_sample.pro tests/examplefiles/minehunt.qml tests/examplefiles/minimal.ns2 tests/examplefiles/moin_SyntaxReference.txt @@ -315,7 +470,8 @@ tests/examplefiles/nemerle_sample.n tests/examplefiles/nginx_nginx.conf tests/examplefiles/numbers.c tests/examplefiles/objc_example.m -tests/examplefiles/objc_example2.m +tests/examplefiles/openedge_example +tests/examplefiles/pawn_example tests/examplefiles/perl_misc tests/examplefiles/perl_perl5db tests/examplefiles/perl_regex-delims @@ -327,46 +483,60 @@ tests/examplefiles/postgresql_test.txt tests/examplefiles/pppoe.applescript tests/examplefiles/psql_session.txt tests/examplefiles/py3_test.txt +tests/examplefiles/py3tb_test.py3tb tests/examplefiles/pycon_test.pycon tests/examplefiles/pytb_test2.pytb tests/examplefiles/pytb_test3.pytb tests/examplefiles/python25-bsd.mak +tests/examplefiles/qbasic_example tests/examplefiles/qsort.prolog tests/examplefiles/r-console-transcript.Rout +tests/examplefiles/r6rs-comments.scm tests/examplefiles/ragel-cpp_rlscan tests/examplefiles/ragel-cpp_snippet tests/examplefiles/regex.js +tests/examplefiles/resourcebundle_demo tests/examplefiles/reversi.lsp -tests/examplefiles/robotframework.txt +tests/examplefiles/robotframework_test.txt +tests/examplefiles/rql-queries.rql tests/examplefiles/ruby_func_def.rb tests/examplefiles/rust_example.rs tests/examplefiles/scilab.sci +tests/examplefiles/scope.cirru tests/examplefiles/session.dylan-console tests/examplefiles/sibling.prolog -tests/examplefiles/simple.md +tests/examplefiles/simple.croc tests/examplefiles/smarty_example.html tests/examplefiles/source.lgt tests/examplefiles/sources.list +tests/examplefiles/sparql.rq tests/examplefiles/sphere.pov tests/examplefiles/sqlite3.sqlite3-console tests/examplefiles/squid.conf tests/examplefiles/string.jl tests/examplefiles/string_delimiters.d tests/examplefiles/stripheredoc.sh +tests/examplefiles/swig_java.swg +tests/examplefiles/swig_std_vector.i +tests/examplefiles/tads3_example.t tests/examplefiles/test.R tests/examplefiles/test.adb +tests/examplefiles/test.agda +tests/examplefiles/test.apl tests/examplefiles/test.asy tests/examplefiles/test.awk -tests/examplefiles/test.bas +tests/examplefiles/test.bb tests/examplefiles/test.bmx tests/examplefiles/test.boo tests/examplefiles/test.bro tests/examplefiles/test.cs tests/examplefiles/test.css tests/examplefiles/test.cu +tests/examplefiles/test.cyp tests/examplefiles/test.d tests/examplefiles/test.dart tests/examplefiles/test.dtd +tests/examplefiles/test.ebnf tests/examplefiles/test.ec tests/examplefiles/test.ecl tests/examplefiles/test.eh @@ -377,37 +547,54 @@ tests/examplefiles/test.flx tests/examplefiles/test.gdc tests/examplefiles/test.groovy tests/examplefiles/test.html +tests/examplefiles/test.idr tests/examplefiles/test.ini tests/examplefiles/test.java tests/examplefiles/test.jsp +tests/examplefiles/test.lean tests/examplefiles/test.maql +tests/examplefiles/test.mask tests/examplefiles/test.mod tests/examplefiles/test.moo tests/examplefiles/test.myt tests/examplefiles/test.nim tests/examplefiles/test.opa +tests/examplefiles/test.p6 +tests/examplefiles/test.pan tests/examplefiles/test.pas tests/examplefiles/test.php +tests/examplefiles/test.pig tests/examplefiles/test.plot tests/examplefiles/test.ps1 +tests/examplefiles/test.pwn tests/examplefiles/test.pypylog tests/examplefiles/test.r3 tests/examplefiles/test.rb tests/examplefiles/test.rhtml +tests/examplefiles/test.rsl tests/examplefiles/test.scaml tests/examplefiles/test.ssp +tests/examplefiles/test.swift tests/examplefiles/test.tcsh tests/examplefiles/test.vb tests/examplefiles/test.vhdl tests/examplefiles/test.xqy tests/examplefiles/test.xsl +tests/examplefiles/test.zep tests/examplefiles/test2.pypylog tests/examplefiles/truncated.pytb +tests/examplefiles/twig_test tests/examplefiles/type.lisp tests/examplefiles/underscore.coffee tests/examplefiles/unicode.applescript +tests/examplefiles/unicode.go +tests/examplefiles/unicode.js tests/examplefiles/unicodedoc.py tests/examplefiles/unix-io.lid +tests/examplefiles/vbnet_test.bas +tests/examplefiles/vctreestatus_hg +tests/examplefiles/vimrc +tests/examplefiles/vpath.mk tests/examplefiles/webkit-transition.css tests/examplefiles/while.pov tests/examplefiles/wiki.factor diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..e6c0392 --- /dev/null +++ b/README.rst @@ -0,0 +1,39 @@ +README for Pygments +=================== + +This is the source of Pygments. It is a generic syntax highlighter that +supports over 300 languages and text formats, for use in code hosting, forums, +wikis or other applications that need to prettify source code. + +Installing +---------- + +... works as usual, use ``python setup.py install``. + +Documentation +------------- + +... can be found online at http://pygments.org/ or created by :: + + cd doc + make html + +Development +----------- + +... takes place on `Bitbucket +`_, where the Mercurial +repository, tickets and pull requests can be viewed. + +Continuous testing runs on drone.io: + +.. image:: https://drone.io/bitbucket.org/birkenfeld/pygments-main/status.png + :target: https://drone.io/bitbucket.org/birkenfeld/pygments-main/ + +The authors +----------- + +Pygments is maintained by **Georg Brandl**, e-mail address *georg*\ *@*\ *python.org*. + +Many lexers and fixes have been contributed by **Armin Ronacher**, the rest of +the `Pocoo `_ team and **Tim Hatch**. diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..7fb7541 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = PYTHONPATH=.. sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Pygments.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Pygments.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Pygments" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Pygments" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/_static/favicon.ico b/doc/_static/favicon.ico new file mode 100644 index 0000000..777f617 Binary files /dev/null and b/doc/_static/favicon.ico differ diff --git a/doc/_static/logo_new.png b/doc/_static/logo_new.png new file mode 100644 index 0000000..0ae4b20 Binary files /dev/null and b/doc/_static/logo_new.png differ diff --git a/doc/_static/logo_only.png b/doc/_static/logo_only.png new file mode 100644 index 0000000..fdebcc4 Binary files /dev/null and b/doc/_static/logo_only.png differ diff --git a/doc/_templates/docssidebar.html b/doc/_templates/docssidebar.html new file mode 100644 index 0000000..913acaa --- /dev/null +++ b/doc/_templates/docssidebar.html @@ -0,0 +1,3 @@ +{% if pagename != 'docs/index' %} +« Back to docs index +{% endif %} diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html new file mode 100644 index 0000000..2995455 --- /dev/null +++ b/doc/_templates/indexsidebar.html @@ -0,0 +1,25 @@ +

Download

+{% if version.endswith('(hg)') %} +

This documentation is for version {{ version }}, which is + not released yet.

+

You can use it from the + Mercurial repo or look for + released versions in the Python + Package Index.

+{% else %} +

Current version: {{ version }}

+

Get Pygments from the Python Package +Index, or install it with:

+
pip install Pygments
+{% endif %} + +

Questions? Suggestions?

+ +

Clone at Bitbucket +or come to the #pocoo channel on FreeNode.

+

You can also open an issue at the + tracker.

+ + + diff --git a/doc/_themes/pygments14/layout.html b/doc/_themes/pygments14/layout.html new file mode 100644 index 0000000..93a3119 --- /dev/null +++ b/doc/_themes/pygments14/layout.html @@ -0,0 +1,98 @@ +{# + sphinxdoc/layout.html + ~~~~~~~~~~~~~~~~~~~~~ + + Sphinx layout template for the sphinxdoc theme. + + :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- extends "basic/layout.html" %} + +{# put the sidebar before the body #} +{% block sidebar1 %}{{ sidebar() }}{% endblock %} +{% block sidebar2 %}{% endblock %} + +{% block relbar1 %}{% endblock %} +{% block relbar2 %}{% endblock %} + +{% block extrahead %} + +{{ super() }} +{%- if not embedded %} + + +{%- endif %} +{% endblock %} + +{% block header %} +
+
+ +
+ + Pygments logo + +
+
+{% endblock %} + +{% block footer %} + +
{# closes "outerwrapper" div #} +{% endblock %} + +{% block sidebarrel %} +{% endblock %} + +{% block sidebarsourcelink %} +{% endblock %} diff --git a/doc/_themes/pygments14/static/bodybg.png b/doc/_themes/pygments14/static/bodybg.png new file mode 100644 index 0000000..46892b8 Binary files /dev/null and b/doc/_themes/pygments14/static/bodybg.png differ diff --git a/doc/_themes/pygments14/static/docbg.png b/doc/_themes/pygments14/static/docbg.png new file mode 100644 index 0000000..13e61f3 Binary files /dev/null and b/doc/_themes/pygments14/static/docbg.png differ diff --git a/doc/_themes/pygments14/static/listitem.png b/doc/_themes/pygments14/static/listitem.png new file mode 100644 index 0000000..e45715f Binary files /dev/null and b/doc/_themes/pygments14/static/listitem.png differ diff --git a/doc/_themes/pygments14/static/logo.png b/doc/_themes/pygments14/static/logo.png new file mode 100644 index 0000000..2c1a24d Binary files /dev/null and b/doc/_themes/pygments14/static/logo.png differ diff --git a/doc/_themes/pygments14/static/pocoo.png b/doc/_themes/pygments14/static/pocoo.png new file mode 100644 index 0000000..4174149 Binary files /dev/null and b/doc/_themes/pygments14/static/pocoo.png differ diff --git a/doc/_themes/pygments14/static/pygments14.css_t b/doc/_themes/pygments14/static/pygments14.css_t new file mode 100644 index 0000000..838782b --- /dev/null +++ b/doc/_themes/pygments14/static/pygments14.css_t @@ -0,0 +1,401 @@ +/* + * pygments14.css + * ~~~~~~~~~~~~~~ + * + * Sphinx stylesheet -- pygments14 theme. Heavily copied from sphinx13. + * + * :copyright: Copyright 2006-2014 by the Pygments team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: {{ theme_font }}, 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 14px; + text-align: center; + background-image: url(bodybg.png); + background-color: {{ theme_background }}; + color: black; + padding: 0; + /* + border-right: 1px solid {{ theme_border }}; + border-left: 1px solid {{ theme_border }}; + */ + + margin: 0 auto; + min-width: 780px; + max-width: 1080px; +} + +.outerwrapper { + background-image: url(docbg.png); + background-attachment: fixed; +} + +.pageheader { + text-align: left; + padding: 10px 15px; +} + +.pageheader ul { + float: right; + color: white; + list-style-type: none; + padding-left: 0; + margin-top: 40px; + margin-right: 10px; +} + +.pageheader li { + float: left; + margin: 0 0 0 10px; +} + +.pageheader li a { + border-radius: 3px; + padding: 8px 12px; + color: {{ theme_darkgray }}; + text-shadow: 0 0 5px rgba(0, 0, 0, 0.2); +} + +.pageheader li a:hover { + background-color: {{ theme_yellow }}; + color: black; + text-shadow: none; +} + +div.document { + text-align: left; + /*border-left: 1em solid {{ theme_lightyellow }};*/ +} + +div.bodywrapper { + margin: 0 12px 0 240px; + background-color: white; +/* border-right: 1px solid {{ theme_border }}; */ +} + +div.body { + margin: 0; + padding: 0.5em 20px 20px 20px; +} + +div.related { + font-size: 1em; + color: {{ theme_darkgray }}; +} + +div.related ul { + background-image: url(relbg.png); + background-repeat: repeat-y; + background-color: {{ theme_yellow }}; + height: 1.9em; + /* + border-top: 1px solid {{ theme_border }}; + border-bottom: 1px solid {{ theme_border }}; + */ +} + +div.related ul li { + margin: 0 5px 0 0; + padding: 0; + float: left; +} + +div.related ul li.right { + float: right; + margin-right: 5px; +} + +div.related ul li a { + margin: 0; + padding: 0 5px 0 5px; + line-height: 1.75em; + color: {{ theme_darkgray }}; + /*text-shadow: 0px 0px 1px rgba(0, 0, 0, 0.5);*/ +} + +div.related ul li a:hover { + text-decoration: underline; + text-shadow: 0px 0px 1px rgba(255, 255, 255, 0.5); +} + +div.sphinxsidebarwrapper { + position: relative; + top: 0px; + padding: 0; +} + +div.sphinxsidebar { + margin: 0; + padding: 0 0px 15px 15px; + width: 210px; + float: left; + font-size: 1em; + text-align: left; +} + +div.sphinxsidebar .logo { + font-size: 1.8em; + color: #666; + font-weight: 300; + text-align: center; +} + +div.sphinxsidebar .logo img { + vertical-align: middle; +} + +div.sphinxsidebar input { + border: 1px solid #aaa; + font-family: {{ theme_font }}, 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 1em; +} + +div.sphinxsidebar h3 { + font-size: 1.5em; + /* border-top: 1px solid {{ theme_border }}; */ + margin-top: 1em; + margin-bottom: 0.5em; + padding-top: 0.5em; +} + +div.sphinxsidebar h4 { + font-size: 1.2em; + margin-bottom: 0; +} + +div.sphinxsidebar h3, div.sphinxsidebar h4 { + margin-right: -15px; + margin-left: -15px; + padding-right: 14px; + padding-left: 14px; + color: #333; + font-weight: 300; + /*text-shadow: 0px 0px 0.5px rgba(0, 0, 0, 0.4);*/ +} + +div.sphinxsidebarwrapper > h3:first-child { + margin-top: 0.5em; + border: none; +} + +div.sphinxsidebar h3 a { + color: #333; +} + +div.sphinxsidebar ul { + color: #444; + margin-top: 7px; + padding: 0; + line-height: 130%; +} + +div.sphinxsidebar ul ul { + margin-left: 20px; + list-style-image: url(listitem.png); +} + +div.footer { + color: {{ theme_darkgray }}; + text-shadow: 0 0 .2px rgba(255, 255, 255, 0.8); + padding: 2em; + text-align: center; + clear: both; + font-size: 0.8em; +} + +/* -- body styles ----------------------------------------------------------- */ + +p { + margin: 0.8em 0 0.5em 0; +} + +a { + color: {{ theme_darkgreen }}; + text-decoration: none; +} + +a:hover { + color: {{ theme_darkyellow }}; +} + +div.body a { + text-decoration: underline; +} + +h1 { + margin: 10px 0 0 0; + font-size: 2.4em; + color: {{ theme_darkgray }}; + font-weight: 300; +} + +h2 { + margin: 1.em 0 0.2em 0; + font-size: 1.5em; + font-weight: 300; + padding: 0; + color: {{ theme_darkgreen }}; +} + +h3 { + margin: 1em 0 -0.3em 0; + font-size: 1.3em; + font-weight: 300; +} + +div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a { + text-decoration: none; +} + +div.body h1 a tt, div.body h2 a tt, div.body h3 a tt, div.body h4 a tt, div.body h5 a tt, div.body h6 a tt { + color: {{ theme_darkgreen }} !important; + font-size: inherit !important; +} + +a.headerlink { + color: {{ theme_green }} !important; + font-size: 12px; + margin-left: 6px; + padding: 0 4px 0 4px; + text-decoration: none !important; + float: right; +} + +a.headerlink:hover { + background-color: #ccc; + color: white!important; +} + +cite, code, tt { + font-family: 'Consolas', 'DejaVu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 14px; + letter-spacing: -0.02em; +} + +tt { + background-color: #f2f2f2; + border: 1px solid #ddd; + border-radius: 2px; + color: #333; + padding: 1px; +} + +tt.descname, tt.descclassname, tt.xref { + border: 0; +} + +hr { + border: 1px solid #abc; + margin: 2em; +} + +a tt { + border: 0; + color: {{ theme_darkgreen }}; +} + +a tt:hover { + color: {{ theme_darkyellow }}; +} + +pre { + font-family: 'Consolas', 'DejaVu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 13px; + letter-spacing: 0.015em; + line-height: 120%; + padding: 0.5em; + border: 1px solid #ccc; + border-radius: 2px; + background-color: #f8f8f8; +} + +pre a { + color: inherit; + text-decoration: underline; +} + +td.linenos pre { + padding: 0.5em 0; +} + +div.quotebar { + background-color: #f8f8f8; + max-width: 250px; + float: right; + padding: 0px 7px; + border: 1px solid #ccc; + margin-left: 1em; +} + +div.topic { + background-color: #f8f8f8; +} + +table { + border-collapse: collapse; + margin: 0 -0.5em 0 -0.5em; +} + +table td, table th { + padding: 0.2em 0.5em 0.2em 0.5em; +} + +div.admonition, div.warning { + font-size: 0.9em; + margin: 1em 0 1em 0; + border: 1px solid #86989B; + border-radius: 2px; + background-color: #f7f7f7; + padding: 0; +} + +div.admonition p, div.warning p { + margin: 0.5em 1em 0.5em 1em; + padding: 0; +} + +div.admonition pre, div.warning pre { + margin: 0.4em 1em 0.4em 1em; +} + +div.admonition p.admonition-title, +div.warning p.admonition-title { + margin-top: 1em; + padding-top: 0.5em; + font-weight: bold; +} + +div.warning { + border: 1px solid #940000; +/* background-color: #FFCCCF;*/ +} + +div.warning p.admonition-title { +} + +div.admonition ul, div.admonition ol, +div.warning ul, div.warning ol { + margin: 0.1em 0.5em 0.5em 3em; + padding: 0; +} + +.viewcode-back { + font-family: {{ theme_font }}, 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} diff --git a/doc/_themes/pygments14/theme.conf b/doc/_themes/pygments14/theme.conf new file mode 100644 index 0000000..fffe66d --- /dev/null +++ b/doc/_themes/pygments14/theme.conf @@ -0,0 +1,15 @@ +[theme] +inherit = basic +stylesheet = pygments14.css +pygments_style = friendly + +[options] +green = #66b55e +darkgreen = #36852e +darkgray = #666666 +border = #66b55e +yellow = #f4cd00 +darkyellow = #d4ad00 +lightyellow = #fffbe3 +background = #f9f9f9 +font = PT Sans diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..4ac487f --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,249 @@ +# -*- coding: utf-8 -*- +# +# Pygments documentation build configuration file, created by +# sphinx-quickstart on Sat Jan 18 17:07:37 2014. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('..')) + +import pygments + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'pygments.sphinxext'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Pygments' +copyright = u'2014, Georg Brandl' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = pygments.__version__ +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +#pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'pygments14' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = ['_themes'] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = '_static/favicon.ico' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +html_sidebars = {'index': 'indexsidebar.html', + 'docs/*': 'docssidebar.html'} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Pygmentsdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Pygments.tex', u'Pygments Documentation', + u'Georg Brandl', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'pygments', u'Pygments Documentation', + [u'Georg Brandl'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Pygments', u'Pygments Documentation', + u'Georg Brandl', 'Pygments', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# Example configuration for intersphinx: refer to the Python standard library. +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/docs/api.rst b/doc/docs/api.rst new file mode 100644 index 0000000..123a464 --- /dev/null +++ b/doc/docs/api.rst @@ -0,0 +1,316 @@ +.. -*- mode: rst -*- + +===================== +The full Pygments API +===================== + +This page describes the Pygments API. + +High-level API +============== + +.. module:: pygments + +Functions from the :mod:`pygments` module: + +.. function:: lex(code, lexer) + + Lex `code` with the `lexer` (must be a `Lexer` instance) + and return an iterable of tokens. Currently, this only calls + `lexer.get_tokens()`. + +.. function:: format(tokens, formatter, outfile=None) + + Format a token stream (iterable of tokens) `tokens` with the + `formatter` (must be a `Formatter` instance). The result is + written to `outfile`, or if that is ``None``, returned as a + string. + +.. function:: highlight(code, lexer, formatter, outfile=None) + + This is the most high-level highlighting function. + It combines `lex` and `format` in one function. + + +.. module:: pygments.lexers + +Functions from :mod:`pygments.lexers`: + +.. function:: get_lexer_by_name(alias, **options) + + Return an instance of a `Lexer` subclass that has `alias` in its + aliases list. The lexer is given the `options` at its + instantiation. + + Will raise :exc:`pygments.util.ClassNotFound` if no lexer with that alias is + found. + +.. function:: get_lexer_for_filename(fn, **options) + + Return a `Lexer` subclass instance that has a filename pattern + matching `fn`. The lexer is given the `options` at its + instantiation. + + Will raise :exc:`pygments.util.ClassNotFound` if no lexer for that filename + is found. + +.. function:: get_lexer_for_mimetype(mime, **options) + + Return a `Lexer` subclass instance that has `mime` in its mimetype + list. The lexer is given the `options` at its instantiation. + + Will raise :exc:`pygments.util.ClassNotFound` if not lexer for that mimetype + is found. + +.. function:: guess_lexer(text, **options) + + Return a `Lexer` subclass instance that's guessed from the text in + `text`. For that, the :meth:`.analyse_text()` method of every known lexer + class is called with the text as argument, and the lexer which returned the + highest value will be instantiated and returned. + + :exc:`pygments.util.ClassNotFound` is raised if no lexer thinks it can + handle the content. + +.. function:: guess_lexer_for_filename(filename, text, **options) + + As :func:`guess_lexer()`, but only lexers which have a pattern in `filenames` + or `alias_filenames` that matches `filename` are taken into consideration. + + :exc:`pygments.util.ClassNotFound` is raised if no lexer thinks it can + handle the content. + +.. function:: get_all_lexers() + + Return an iterable over all registered lexers, yielding tuples in the + format:: + + (longname, tuple of aliases, tuple of filename patterns, tuple of mimetypes) + + .. versionadded:: 0.6 + + +.. module:: pygments.formatters + +Functions from :mod:`pygments.formatters`: + +.. function:: get_formatter_by_name(alias, **options) + + Return an instance of a :class:`.Formatter` subclass that has `alias` in its + aliases list. The formatter is given the `options` at its instantiation. + + Will raise :exc:`pygments.util.ClassNotFound` if no formatter with that + alias is found. + +.. function:: get_formatter_for_filename(fn, **options) + + Return a :class:`.Formatter` subclass instance that has a filename pattern + matching `fn`. The formatter is given the `options` at its instantiation. + + Will raise :exc:`pygments.util.ClassNotFound` if no formatter for that filename + is found. + + +.. module:: pygments.styles + +Functions from :mod:`pygments.styles`: + +.. function:: get_style_by_name(name) + + Return a style class by its short name. The names of the builtin styles + are listed in :data:`pygments.styles.STYLE_MAP`. + + Will raise :exc:`pygments.util.ClassNotFound` if no style of that name is + found. + +.. function:: get_all_styles() + + Return an iterable over all registered styles, yielding their names. + + .. versionadded:: 0.6 + + +.. module:: pygments.lexer + +Lexers +====== + +The base lexer class from which all lexers are derived is: + +.. class:: Lexer(**options) + + The constructor takes a \*\*keywords dictionary of options. + Every subclass must first process its own options and then call + the `Lexer` constructor, since it processes the `stripnl`, + `stripall` and `tabsize` options. + + An example looks like this: + + .. sourcecode:: python + + def __init__(self, **options): + self.compress = options.get('compress', '') + Lexer.__init__(self, **options) + + As these options must all be specifiable as strings (due to the + command line usage), there are various utility functions + available to help with that, see `Option processing`_. + + .. method:: get_tokens(text) + + This method is the basic interface of a lexer. It is called by + the `highlight()` function. It must process the text and return an + iterable of ``(tokentype, value)`` pairs from `text`. + + Normally, you don't need to override this method. The default + implementation processes the `stripnl`, `stripall` and `tabsize` + options and then yields all tokens from `get_tokens_unprocessed()`, + with the ``index`` dropped. + + .. method:: get_tokens_unprocessed(text) + + This method should process the text and return an iterable of + ``(index, tokentype, value)`` tuples where ``index`` is the starting + position of the token within the input text. + + This method must be overridden by subclasses. + + .. staticmethod:: analyse_text(text) + + A static method which is called for lexer guessing. It should analyse + the text and return a float in the range from ``0.0`` to ``1.0``. + If it returns ``0.0``, the lexer will not be selected as the most + probable one, if it returns ``1.0``, it will be selected immediately. + + .. note:: You don't have to add ``@staticmethod`` to the definition of + this method, this will be taken care of by the Lexer's metaclass. + + For a list of known tokens have a look at the :doc:`tokens` page. + + A lexer also can have the following attributes (in fact, they are mandatory + except `alias_filenames`) that are used by the builtin lookup mechanism. + + .. attribute:: name + + Full name for the lexer, in human-readable form. + + .. attribute:: aliases + + A list of short, unique identifiers that can be used to lookup + the lexer from a list, e.g. using `get_lexer_by_name()`. + + .. attribute:: filenames + + A list of `fnmatch` patterns that match filenames which contain + content for this lexer. The patterns in this list should be unique among + all lexers. + + .. attribute:: alias_filenames + + A list of `fnmatch` patterns that match filenames which may or may not + contain content for this lexer. This list is used by the + :func:`.guess_lexer_for_filename()` function, to determine which lexers + are then included in guessing the correct one. That means that + e.g. every lexer for HTML and a template language should include + ``\*.html`` in this list. + + .. attribute:: mimetypes + + A list of MIME types for content that can be lexed with this + lexer. + + +.. module:: pygments.formatter + +Formatters +========== + +A formatter is derived from this class: + + +.. class:: Formatter(**options) + + As with lexers, this constructor processes options and then must call the + base class :meth:`__init__`. + + The :class:`Formatter` class recognizes the options `style`, `full` and + `title`. It is up to the formatter class whether it uses them. + + .. method:: get_style_defs(arg='') + + This method must return statements or declarations suitable to define + the current style for subsequent highlighted text (e.g. CSS classes + in the `HTMLFormatter`). + + The optional argument `arg` can be used to modify the generation and + is formatter dependent (it is standardized because it can be given on + the command line). + + This method is called by the ``-S`` :doc:`command-line option `, + the `arg` is then given by the ``-a`` option. + + .. method:: format(tokensource, outfile) + + This method must format the tokens from the `tokensource` iterable and + write the formatted version to the file object `outfile`. + + Formatter options can control how exactly the tokens are converted. + + .. versionadded:: 0.7 + A formatter must have the following attributes that are used by the + builtin lookup mechanism. + + .. attribute:: name + + Full name for the formatter, in human-readable form. + + .. attribute:: aliases + + A list of short, unique identifiers that can be used to lookup + the formatter from a list, e.g. using :func:`.get_formatter_by_name()`. + + .. attribute:: filenames + + A list of :mod:`fnmatch` patterns that match filenames for which this + formatter can produce output. The patterns in this list should be unique + among all formatters. + + +.. module:: pygments.util + +Option processing +================= + +The :mod:`pygments.util` module has some utility functions usable for option +processing: + +.. exception:: OptionError + + This exception will be raised by all option processing functions if + the type or value of the argument is not correct. + +.. function:: get_bool_opt(options, optname, default=None) + + Interpret the key `optname` from the dictionary `options` as a boolean and + return it. Return `default` if `optname` is not in `options`. + + The valid string values for ``True`` are ``1``, ``yes``, ``true`` and + ``on``, the ones for ``False`` are ``0``, ``no``, ``false`` and ``off`` + (matched case-insensitively). + +.. function:: get_int_opt(options, optname, default=None) + + As :func:`get_bool_opt`, but interpret the value as an integer. + +.. function:: get_list_opt(options, optname, default=None) + + If the key `optname` from the dictionary `options` is a string, + split it at whitespace and return it. If it is already a list + or a tuple, it is returned as a list. + +.. function:: get_choice_opt(options, optname, allowed, default=None) + + If the key `optname` from the dictionary is not in the sequence + `allowed`, raise an error, otherwise return it. + + .. versionadded:: 0.8 diff --git a/doc/docs/authors.rst b/doc/docs/authors.rst new file mode 100644 index 0000000..f8373f0 --- /dev/null +++ b/doc/docs/authors.rst @@ -0,0 +1,4 @@ +Full contributor list +===================== + +.. include:: ../../AUTHORS diff --git a/doc/docs/changelog.rst b/doc/docs/changelog.rst new file mode 100644 index 0000000..f264cab --- /dev/null +++ b/doc/docs/changelog.rst @@ -0,0 +1 @@ +.. include:: ../../CHANGES diff --git a/doc/docs/cmdline.rst b/doc/docs/cmdline.rst new file mode 100644 index 0000000..bf0177a --- /dev/null +++ b/doc/docs/cmdline.rst @@ -0,0 +1,145 @@ +.. -*- mode: rst -*- + +====================== +Command Line Interface +====================== + +You can use Pygments from the shell, provided you installed the +:program:`pygmentize` script:: + + $ pygmentize test.py + print "Hello World" + +will print the file test.py to standard output, using the Python lexer +(inferred from the file name extension) and the terminal formatter (because +you didn't give an explicit formatter name). + +If you want HTML output:: + + $ pygmentize -f html -l python -o test.html test.py + +As you can see, the -l option explicitly selects a lexer. As seen above, if you +give an input file name and it has an extension that Pygments recognizes, you can +omit this option. + +The ``-o`` option gives an output file name. If it is not given, output is +written to stdout. + +The ``-f`` option selects a formatter (as with ``-l``, it can also be omitted +if an output file name is given and has a supported extension). +If no output file name is given and ``-f`` is omitted, the +:class:`.TerminalFormatter` is used. + +The above command could therefore also be given as:: + + $ pygmentize -o test.html test.py + +To create a full HTML document, including line numbers and stylesheet (using the +"emacs" style), highlighting the Python file ``test.py`` to ``test.html``:: + + $ pygmentize -O full,style=emacs -o test.html test.py + + +Options and filters +------------------- + +Lexer and formatter options can be given using the ``-O`` option:: + + $ pygmentize -f html -O style=colorful,linenos=1 -l python test.py + +Be sure to enclose the option string in quotes if it contains any special shell +characters, such as spaces or expansion wildcards like ``*``. If an option +expects a list value, separate the list entries with spaces (you'll have to +quote the option value in this case too, so that the shell doesn't split it). + +Since the ``-O`` option argument is split at commas and expects the split values +to be of the form ``name=value``, you can't give an option value that contains +commas or equals signs. Therefore, an option ``-P`` is provided (as of Pygments +0.9) that works like ``-O`` but can only pass one option per ``-P``. Its value +can then contain all characters:: + + $ pygmentize -P "heading=Pygments, the Python highlighter" ... + +Filters are added to the token stream using the ``-F`` option:: + + $ pygmentize -f html -l pascal -F keywordcase:case=upper main.pas + +As you see, options for the filter are given after a colon. As for ``-O``, the +filter name and options must be one shell word, so there may not be any spaces +around the colon. + + +Generating styles +----------------- + +Formatters normally don't output full style information. For example, the HTML +formatter by default only outputs ```` tags with ``class`` attributes. +Therefore, there's a special ``-S`` option for generating style definitions. +Usage is as follows:: + + $ pygmentize -f html -S colorful -a .syntax + +generates a CSS style sheet (because you selected the HTML formatter) for +the "colorful" style prepending a ".syntax" selector to all style rules. + +For an explanation what ``-a`` means for :doc:`a particular formatter +`, look for the `arg` argument for the formatter's +:meth:`.get_style_defs()` method. + + +Getting lexer names +------------------- + +.. versionadded:: 1.0 + +The ``-N`` option guesses a lexer name for a given filename, so that :: + + $ pygmentize -N setup.py + +will print out ``python``. It won't highlight anything yet. If no specific +lexer is known for that filename, ``text`` is printed. + + +Getting help +------------ + +The ``-L`` option lists lexers, formatters, along with their short +names and supported file name extensions, styles and filters. If you want to see +only one category, give it as an argument:: + + $ pygmentize -L filters + +will list only all installed filters. + +The ``-H`` option will give you detailed information (the same that can be found +in this documentation) about a lexer, formatter or filter. Usage is as follows:: + + $ pygmentize -H formatter html + +will print the help for the HTML formatter, while :: + + $ pygmentize -H lexer python + +will print the help for the Python lexer, etc. + + +A note on encodings +------------------- + +.. versionadded:: 0.9 + +Pygments tries to be smart regarding encodings in the formatting process: + +* If you give an ``encoding`` option, it will be used as the input and + output encoding. + +* If you give an ``outencoding`` option, it will override ``encoding`` + as the output encoding. + +* If you don't give an encoding and have given an output file, the default + encoding for lexer and formatter is ``latin1`` (which will pass through + all non-ASCII characters). + +* If you don't give an encoding and haven't given an output file (that means + output is written to the console), the default encoding for lexer and + formatter is the terminal encoding (``sys.stdout.encoding``). diff --git a/doc/docs/filterdevelopment.rst b/doc/docs/filterdevelopment.rst new file mode 100644 index 0000000..bc399a6 --- /dev/null +++ b/doc/docs/filterdevelopment.rst @@ -0,0 +1,70 @@ +.. -*- mode: rst -*- + +===================== +Write your own filter +===================== + +.. versionadded:: 0.7 + +Writing own filters is very easy. All you have to do is to subclass +the `Filter` class and override the `filter` method. Additionally a +filter is instanciated with some keyword arguments you can use to +adjust the behavior of your filter. + + +Subclassing Filters +=================== + +As an example, we write a filter that converts all `Name.Function` tokens +to normal `Name` tokens to make the output less colorful. + +.. sourcecode:: python + + from pygments.util import get_bool_opt + from pygments.token import Name + from pygments.filter import Filter + + class UncolorFilter(Filter): + + def __init__(self, **options): + Filter.__init__(self, **options) + self.class_too = get_bool_opt(options, 'classtoo') + + def filter(self, lexer, stream): + for ttype, value in stream: + if ttype is Name.Function or (self.class_too and + ttype is Name.Class): + ttype = Name + yield ttype, value + +Some notes on the `lexer` argument: that can be quite confusing since it doesn't +need to be a lexer instance. If a filter was added by using the `add_filter()` +function of lexers, that lexer is registered for the filter. In that case +`lexer` will refer to the lexer that has registered the filter. It *can* be used +to access options passed to a lexer. Because it could be `None` you always have +to check for that case if you access it. + + +Using a decorator +================= + +You can also use the `simplefilter` decorator from the `pygments.filter` module: + +.. sourcecode:: python + + from pygments.util import get_bool_opt + from pygments.token import Name + from pygments.filter import simplefilter + + + @simplefilter + def uncolor(lexer, stream, options): + class_too = get_bool_opt(options, 'classtoo') + for ttype, value in stream: + if ttype is Name.Function or (class_too and + ttype is Name.Class): + ttype = Name + yield ttype, value + +The decorator automatically subclasses an internal filter class and uses the +decorated function for filtering. diff --git a/doc/docs/filters.rst b/doc/docs/filters.rst new file mode 100644 index 0000000..ff2519a --- /dev/null +++ b/doc/docs/filters.rst @@ -0,0 +1,41 @@ +.. -*- mode: rst -*- + +======= +Filters +======= + +.. versionadded:: 0.7 + +You can filter token streams coming from lexers to improve or annotate the +output. For example, you can highlight special words in comments, convert +keywords to upper or lowercase to enforce a style guide etc. + +To apply a filter, you can use the `add_filter()` method of a lexer: + +.. sourcecode:: pycon + + >>> from pygments.lexers import PythonLexer + >>> l = PythonLexer() + >>> # add a filter given by a string and options + >>> l.add_filter('codetagify', case='lower') + >>> l.filters + [] + >>> from pygments.filters import KeywordCaseFilter + >>> # or give an instance + >>> l.add_filter(KeywordCaseFilter(case='lower')) + +The `add_filter()` method takes keyword arguments which are forwarded to +the constructor of the filter. + +To get a list of all registered filters by name, you can use the +`get_all_filters()` function from the `pygments.filters` module that returns an +iterable for all known filters. + +If you want to write your own filter, have a look at :doc:`Write your own filter +`. + + +Builtin Filters +=============== + +.. pygmentsdoc:: filters diff --git a/doc/docs/formatterdevelopment.rst b/doc/docs/formatterdevelopment.rst new file mode 100644 index 0000000..2bfac05 --- /dev/null +++ b/doc/docs/formatterdevelopment.rst @@ -0,0 +1,169 @@ +.. -*- mode: rst -*- + +======================== +Write your own formatter +======================== + +As well as creating :doc:`your own lexer `, writing a new +formatter for Pygments is easy and straightforward. + +A formatter is a class that is initialized with some keyword arguments (the +formatter options) and that must provides a `format()` method. +Additionally a formatter should provide a `get_style_defs()` method that +returns the style definitions from the style in a form usable for the +formatter's output format. + + +Quickstart +========== + +The most basic formatter shipped with Pygments is the `NullFormatter`. It just +sends the value of a token to the output stream: + +.. sourcecode:: python + + from pygments.formatter import Formatter + + class NullFormatter(Formatter): + def format(self, tokensource, outfile): + for ttype, value in tokensource: + outfile.write(value) + +As you can see, the `format()` method is passed two parameters: `tokensource` +and `outfile`. The first is an iterable of ``(token_type, value)`` tuples, +the latter a file like object with a `write()` method. + +Because the formatter is that basic it doesn't overwrite the `get_style_defs()` +method. + + +Styles +====== + +Styles aren't instantiated but their metaclass provides some class functions +so that you can access the style definitions easily. + +Styles are iterable and yield tuples in the form ``(ttype, d)`` where `ttype` +is a token and `d` is a dict with the following keys: + +``'color'`` + Hexadecimal color value (eg: ``'ff0000'`` for red) or `None` if not + defined. + +``'bold'`` + `True` if the value should be bold + +``'italic'`` + `True` if the value should be italic + +``'underline'`` + `True` if the value should be underlined + +``'bgcolor'`` + Hexadecimal color value for the background (eg: ``'eeeeeee'`` for light + gray) or `None` if not defined. + +``'border'`` + Hexadecimal color value for the border (eg: ``'0000aa'`` for a dark + blue) or `None` for no border. + +Additional keys might appear in the future, formatters should ignore all keys +they don't support. + + +HTML 3.2 Formatter +================== + +For an more complex example, let's implement a HTML 3.2 Formatter. We don't +use CSS but inline markup (````, ````, etc). Because this isn't good +style this formatter isn't in the standard library ;-) + +.. sourcecode:: python + + from pygments.formatter import Formatter + + class OldHtmlFormatter(Formatter): + + def __init__(self, **options): + Formatter.__init__(self, **options) + + # create a dict of (start, end) tuples that wrap the + # value of a token so that we can use it in the format + # method later + self.styles = {} + + # we iterate over the `_styles` attribute of a style item + # that contains the parsed style values. + for token, style in self.style: + start = end = '' + # a style item is a tuple in the following form: + # colors are readily specified in hex: 'RRGGBB' + if style['color']: + start += '' % style['color'] + end = '' + end + if style['bold']: + start += '' + end = '' + end + if style['italic']: + start += '' + end = '' + end + if style['underline']: + start += '' + end = '' + end + self.styles[token] = (start, end) + + def format(self, tokensource, outfile): + # lastval is a string we use for caching + # because it's possible that an lexer yields a number + # of consecutive tokens with the same token type. + # to minimize the size of the generated html markup we + # try to join the values of same-type tokens here + lastval = '' + lasttype = None + + # wrap the whole output with 
+            outfile.write('
')
+
+            for ttype, value in tokensource:
+                # if the token type doesn't exist in the stylemap
+                # we try it with the parent of the token type
+                # eg: parent of Token.Literal.String.Double is
+                # Token.Literal.String
+                while ttype not in self.styles:
+                    ttype = ttype.parent
+                if ttype == lasttype:
+                    # the current token type is the same of the last
+                    # iteration. cache it
+                    lastval += value
+                else:
+                    # not the same token as last iteration, but we
+                    # have some data in the buffer. wrap it with the
+                    # defined style and write it to the output file
+                    if lastval:
+                        stylebegin, styleend = self.styles[lasttype]
+                        outfile.write(stylebegin + lastval + styleend)
+                    # set lastval/lasttype to current values
+                    lastval = value
+                    lasttype = ttype
+
+            # if something is left in the buffer, write it to the
+            # output file, then close the opened 
 tag
+            if lastval:
+                stylebegin, styleend = self.styles[lasttype]
+                outfile.write(stylebegin + lastval + styleend)
+            outfile.write('
\n')
+
+The comments should explain it. Again, this formatter doesn't override the
+`get_style_defs()` method. If we would have used CSS classes instead of
+inline HTML markup, we would need to generate the CSS first. For that
+purpose the `get_style_defs()` method exists:
+
+
+Generating Style Definitions
+============================
+
+Some formatters like the `LatexFormatter` and the `HtmlFormatter` don't
+output inline markup but reference either macros or css classes. Because
+the definitions of those are not part of the output, the `get_style_defs()`
+method exists. It is passed one parameter (if it's used and how it's used
+is up to the formatter) and has to return a string or ``None``.
diff --git a/doc/docs/formatters.rst b/doc/docs/formatters.rst
new file mode 100644
index 0000000..9e7074e
--- /dev/null
+++ b/doc/docs/formatters.rst
@@ -0,0 +1,48 @@
+.. -*- mode: rst -*-
+
+====================
+Available formatters
+====================
+
+This page lists all builtin formatters.
+
+Common options
+==============
+
+All formatters support these options:
+
+`encoding`
+    If given, must be an encoding name (such as ``"utf-8"``). This will
+    be used to convert the token strings (which are Unicode strings)
+    to byte strings in the output (default: ``None``).
+    It will also be written in an encoding declaration suitable for the
+    document format if the `full` option is given (e.g. a ``meta
+    content-type`` directive in HTML or an invocation of the `inputenc`
+    package in LaTeX).
+
+    If this is ``""`` or ``None``, Unicode strings will be written
+    to the output file, which most file-like objects do not support.
+    For example, `pygments.highlight()` will return a Unicode string if
+    called with no `outfile` argument and a formatter that has `encoding`
+    set to ``None`` because it uses a `StringIO.StringIO` object that
+    supports Unicode arguments to `write()`. Using a regular file object
+    wouldn't work.
+
+    .. versionadded:: 0.6
+
+`outencoding`
+    When using Pygments from the command line, any `encoding` option given is
+    passed to the lexer and the formatter. This is sometimes not desirable,
+    for example if you want to set the input encoding to ``"guess"``.
+    Therefore, `outencoding` has been introduced which overrides `encoding`
+    for the formatter if given.
+
+    .. versionadded:: 0.7
+
+
+Formatter classes
+=================
+
+All these classes are importable from :mod:`pygments.formatters`.
+
+.. pygmentsdoc:: formatters
diff --git a/doc/docs/index.rst b/doc/docs/index.rst
new file mode 100644
index 0000000..30d5c08
--- /dev/null
+++ b/doc/docs/index.rst
@@ -0,0 +1,66 @@
+Pygments documentation
+======================
+
+**Starting with Pygments**
+
+.. toctree::
+   :maxdepth: 1
+
+   ../download
+   quickstart
+   cmdline
+
+**Builtin components**
+
+.. toctree::
+   :maxdepth: 1
+
+   lexers
+   filters
+   formatters
+   styles
+
+**Reference**
+
+.. toctree::
+   :maxdepth: 1
+
+   unicode
+   tokens
+   api
+
+**Hacking for Pygments**
+
+.. toctree::
+   :maxdepth: 1
+
+   lexerdevelopment
+   formatterdevelopment
+   filterdevelopment
+   plugins
+
+**Hints and tricks**
+
+.. toctree::
+   :maxdepth: 1
+
+   rstdirective
+   moinmoin
+   java
+   integrate
+
+**About Pygments**
+              
+.. toctree::
+   :maxdepth: 1
+
+   changelog
+   authors
+
+
+If you find bugs or have suggestions for the documentation, please look
+:ref:`here ` for info on how to contact the team.
+
+.. XXX You can download an offline version of this documentation from the
+   :doc:`download page `.
+
diff --git a/doc/docs/integrate.rst b/doc/docs/integrate.rst
new file mode 100644
index 0000000..03fc268
--- /dev/null
+++ b/doc/docs/integrate.rst
@@ -0,0 +1,44 @@
+.. -*- mode: rst -*-
+
+===================================
+Using Pygments in various scenarios
+===================================
+
+PyGtk
+-----
+
+Armin has written a piece of sample code that shows how to create a Gtk
+`TextBuffer` object containing Pygments-highlighted text.
+
+See the article here: http://lucumr.pocoo.org/cogitations/2007/05/30/pygments-gtk-rendering/
+
+Wordpress
+---------
+
+He also has a snippet that shows how to use Pygments in WordPress:
+
+http://lucumr.pocoo.org/cogitations/2007/05/30/pygments-in-wordpress/
+
+Markdown
+--------
+
+Since Pygments 0.9, the distribution ships Markdown_ preprocessor sample code
+that uses Pygments to render source code in
+:file:`external/markdown-processor.py`.  You can copy and adapt it to your
+liking.
+
+.. _Markdown: http://www.freewisdom.org/projects/python-markdown/
+
+TextMate
+--------
+
+Antonio Cangiano has created a Pygments bundle for TextMate that allows to
+colorize code via a simple menu option.  It can be found here_.
+
+.. _here: http://antoniocangiano.com/2008/10/28/pygments-textmate-bundle/
+
+Bash completion
+---------------
+
+The source distribution contains a file ``external/pygments.bashcomp`` that
+sets up completion for the ``pygmentize`` command in bash.
diff --git a/doc/docs/java.rst b/doc/docs/java.rst
new file mode 100644
index 0000000..5eb6196
--- /dev/null
+++ b/doc/docs/java.rst
@@ -0,0 +1,70 @@
+=====================
+Use Pygments in Java
+=====================
+
+Thanks to `Jython `__ it is possible to use Pygments in
+Java.
+
+This page is a simple tutorial to get an idea of how this is working. You can
+then look at the `Jython documentation `__ for more
+advanced use.
+
+Since version 1.5, Pygments is deployed on `Maven Central
+`__ as a JAR so is Jython
+which makes it a lot easier to create the Java project.
+
+Here is an example of a `Maven `__ ``pom.xml`` file for a
+project running Pygments:
+
+.. sourcecode:: xml
+
+    
+
+    
+      4.0.0
+      example
+      example
+      1.0-SNAPSHOT
+      
+        
+          org.python
+          jython-standalone
+          2.5.3
+        
+        
+          org.pygments
+          pygments
+          1.5
+          runtime
+        
+      
+    
+
+The following Java example:
+
+.. sourcecode:: java
+
+    PythonInterpreter interpreter = new PythonInterpreter();
+
+    // Set a variable with the content you want to work with
+    interpreter.set("code", code);
+
+    // Simple use Pygments as you would in Python
+    interpreter.exec("from pygments import highlight\n"
+        + "from pygments.lexers import PythonLexer\n"
+        + "from pygments.formatters import HtmlFormatter\n"
+        + "\nresult = highlight(code, PythonLexer(), HtmlFormatter())");
+
+    // Get the result that has been set in a variable
+    System.out.println(interpreter.get("result", String.class));
+
+will print something like:
+
+.. sourcecode:: html
+
+    

+    
print "Hello World"

+    

diff --git a/doc/docs/lexerdevelopment.rst b/doc/docs/lexerdevelopment.rst
new file mode 100644
index 0000000..23bcb4f
--- /dev/null
+++ b/doc/docs/lexerdevelopment.rst
@@ -0,0 +1,682 @@
+.. -*- mode: rst -*-
+
+.. highlight:: python
+
+====================
+Write your own lexer
+====================
+
+If a lexer for your favorite language is missing in the Pygments package, you
+can easily write your own and extend Pygments.
+
+All you need can be found inside the :mod:`pygments.lexer` module.  As you can
+read in the :doc:`API documentation `, a lexer is a class that is
+initialized with some keyword arguments (the lexer options) and that provides a
+:meth:`.get_tokens_unprocessed()` method which is given a string or unicode
+object with the data to lex.
+
+The :meth:`.get_tokens_unprocessed()` method must return an iterator or iterable
+containing tuples in the form ``(index, token, value)``.  Normally you don't
+need to do this since there are base lexers that do most of the work and that
+you can subclass.
+
+
+RegexLexer
+==========
+
+The lexer base class used by almost all of Pygments' lexers is the
+:class:`RegexLexer`.  This class allows you to define lexing rules in terms of
+*regular expressions* for different *states*.
+
+States are groups of regular expressions that are matched against the input
+string at the *current position*.  If one of these expressions matches, a
+corresponding action is performed (such as yielding a token with a specific
+type, or changing state), the current position is set to where the last match
+ended and the matching process continues with the first regex of the current
+state.
+
+Lexer states are kept on a stack: each time a new state is entered, the new
+state is pushed onto the stack.  The most basic lexers (like the `DiffLexer`)
+just need one state.
+
+Each state is defined as a list of tuples in the form (`regex`, `action`,
+`new_state`) where the last item is optional.  In the most basic form, `action`
+is a token type (like `Name.Builtin`).  That means: When `regex` matches, emit a
+token with the match text and type `tokentype` and push `new_state` on the state
+stack.  If the new state is ``'#pop'``, the topmost state is popped from the
+stack instead.  To pop more than one state, use ``'#pop:2'`` and so on.
+``'#push'`` is a synonym for pushing the current state on the stack.
+
+The following example shows the `DiffLexer` from the builtin lexers.  Note that
+it contains some additional attributes `name`, `aliases` and `filenames` which
+aren't required for a lexer.  They are used by the builtin lexer lookup
+functions. ::
+
+    from pygments.lexer import RegexLexer
+    from pygments.token import *
+
+    class DiffLexer(RegexLexer):
+        name = 'Diff'
+        aliases = ['diff']
+        filenames = ['*.diff']
+
+        tokens = {
+            'root': [
+                (r' .*\n', Text),
+                (r'\+.*\n', Generic.Inserted),
+                (r'-.*\n', Generic.Deleted),
+                (r'@.*\n', Generic.Subheading),
+                (r'Index.*\n', Generic.Heading),
+                (r'=.*\n', Generic.Heading),
+                (r'.*\n', Text),
+            ]
+        }
+
+As you can see this lexer only uses one state.  When the lexer starts scanning
+the text, it first checks if the current character is a space.  If this is true
+it scans everything until newline and returns the data as a `Text` token (which
+is the "no special highlighting" token).
+
+If this rule doesn't match, it checks if the current char is a plus sign.  And
+so on.
+
+If no rule matches at the current position, the current char is emitted as an
+`Error` token that indicates a lexing error, and the position is increased by
+one.
+
+
+Adding and testing a new lexer
+==============================
+
+To make pygments aware of your new lexer, you have to perform the following
+steps:
+
+First, change to the current directory containing the pygments source code:
+
+.. code-block:: console
+
+    $ cd .../pygments-main
+
+Select a matching module under ``pygments/lexers``, or create a new module for
+your lexer class.
+
+Next, make sure the lexer is known from outside of the module.  All modules in
+the ``pygments.lexers`` specify ``__all__``. For example, ``esoteric.py`` sets::
+
+    __all__ = ['BrainfuckLexer', 'BefungeLexer', ...]
+
+Simply add the name of your lexer class to this list.
+
+Finally the lexer can be made publicly known by rebuilding the lexer mapping:
+
+.. code-block:: console
+
+    $ make mapfiles
+
+To test the new lexer, store an example file with the proper extension in
+``tests/examplefiles``.  For example, to test your ``DiffLexer``, add a
+``tests/examplefiles/example.diff`` containing a sample diff output.
+
+Now you can use pygmentize to render your example to HTML:
+
+.. code-block:: console
+
+    $ ./pygmentize -O full -f html -o /tmp/example.html tests/examplefiles/example.diff
+
+Note that this explicitely calls the ``pygmentize`` in the current directory
+by preceding it with ``./``. This ensures your modifications are used.
+Otherwise a possibly already installed, unmodified version without your new
+lexer would have been called from the system search path (``$PATH``).
+
+To view the result, open ``/tmp/example.html`` in your browser.
+
+Once the example renders as expected, you should run the complete test suite:
+
+.. code-block:: console
+
+    $ make test
+
+It also tests that your lexer fulfills the lexer API and certain invariants,
+such as that the concatenation of all token text is the same as the input text.
+
+
+Regex Flags
+===========
+
+You can either define regex flags locally in the regex (``r'(?x)foo bar'``) or
+globally by adding a `flags` attribute to your lexer class.  If no attribute is
+defined, it defaults to `re.MULTILINE`.  For more informations about regular
+expression flags see the page about `regular expressions`_ in the Python
+documentation.
+
+.. _regular expressions: http://docs.python.org/library/re.html#regular-expression-syntax
+
+
+Scanning multiple tokens at once
+================================
+
+So far, the `action` element in the rule tuple of regex, action and state has
+been a single token type.  Now we look at the first of several other possible
+values.
+
+Here is a more complex lexer that highlights INI files.  INI files consist of
+sections, comments and ``key = value`` pairs::
+
+    from pygments.lexer import RegexLexer, bygroups
+    from pygments.token import *
+
+    class IniLexer(RegexLexer):
+        name = 'INI'
+        aliases = ['ini', 'cfg']
+        filenames = ['*.ini', '*.cfg']
+
+        tokens = {
+            'root': [
+                (r'\s+', Text),
+                (r';.*?$', Comment),
+                (r'\[.*?\]$', Keyword),
+                (r'(.*?)(\s*)(=)(\s*)(.*?)$',
+                 bygroups(Name.Attribute, Text, Operator, Text, String))
+            ]
+        }
+
+The lexer first looks for whitespace, comments and section names.  Later it
+looks for a line that looks like a key, value pair, separated by an ``'='``
+sign, and optional whitespace.
+
+The `bygroups` helper yields each capturing group in the regex with a different
+token type.  First the `Name.Attribute` token, then a `Text` token for the
+optional whitespace, after that a `Operator` token for the equals sign. Then a
+`Text` token for the whitespace again.  The rest of the line is returned as
+`String`.
+
+Note that for this to work, every part of the match must be inside a capturing
+group (a ``(...)``), and there must not be any nested capturing groups.  If you
+nevertheless need a group, use a non-capturing group defined using this syntax:
+``(?:some|words|here)`` (note the ``?:`` after the beginning parenthesis).
+
+If you find yourself needing a capturing group inside the regex which shouldn't
+be part of the output but is used in the regular expressions for backreferencing
+(eg: ``r'(<(foo|bar)>)(.*?)()'``), you can pass `None` to the bygroups
+function and that group will be skipped in the output.
+
+
+Changing states
+===============
+
+Many lexers need multiple states to work as expected.  For example, some
+languages allow multiline comments to be nested.  Since this is a recursive
+pattern it's impossible to lex just using regular expressions.
+
+Here is a lexer that recognizes C++ style comments (multi-line with ``/* */``
+and single-line with ``//`` until end of line)::
+
+    from pygments.lexer import RegexLexer
+    from pygments.token import *
+
+    class CppCommentLexer(RegexLexer):
+        name = 'Example Lexer with states'
+
+        tokens = {
+            'root': [
+                (r'[^/]+', Text),
+                (r'/\*', Comment.Multiline, 'comment'),
+                (r'//.*?$', Comment.Singleline),
+                (r'/', Text)
+            ],
+            'comment': [
+                (r'[^*/]', Comment.Multiline),
+                (r'/\*', Comment.Multiline, '#push'),
+                (r'\*/', Comment.Multiline, '#pop'),
+                (r'[*/]', Comment.Multiline)
+            ]
+        }
+
+This lexer starts lexing in the ``'root'`` state. It tries to match as much as
+possible until it finds a slash (``'/'``).  If the next character after the slash
+is an asterisk (``'*'``) the `RegexLexer` sends those two characters to the
+output stream marked as `Comment.Multiline` and continues lexing with the rules
+defined in the ``'comment'`` state.
+
+If there wasn't an asterisk after the slash, the `RegexLexer` checks if it's a
+singleline comment (i.e. followed by a second slash).  If this also wasn't the
+case it must be a single slash, which is not a comment starter (the separate
+regex for a single slash must also be given, else the slash would be marked as
+an error token).
+
+Inside the ``'comment'`` state, we do the same thing again.  Scan until the
+lexer finds a star or slash.  If it's the opening of a multiline comment, push
+the ``'comment'`` state on the stack and continue scanning, again in the
+``'comment'`` state.  Else, check if it's the end of the multiline comment.  If
+yes, pop one state from the stack.
+
+Note: If you pop from an empty stack you'll get an `IndexError`.  (There is an
+easy way to prevent this from happening: don't ``'#pop'`` in the root state).
+
+If the `RegexLexer` encounters a newline that is flagged as an error token, the
+stack is emptied and the lexer continues scanning in the ``'root'`` state.  This
+can help producing error-tolerant highlighting for erroneous input, e.g. when a
+single-line string is not closed.
+
+
+Advanced state tricks
+=====================
+
+There are a few more things you can do with states:
+
+- You can push multiple states onto the stack if you give a tuple instead of a
+  simple string as the third item in a rule tuple.  For example, if you want to
+  match a comment containing a directive, something like:
+
+  .. code-block:: text
+
+      /*     rest of comment */
+
+  you can use this rule::
+
+      tokens = {
+          'root': [
+              (r'/\* <', Comment, ('comment', 'directive')),
+              ...
+          ],
+          'directive': [
+              (r'[^>]*', Comment.Directive),
+              (r'>', Comment, '#pop'),
+          ],
+          'comment': [
+              (r'[^*]+', Comment),
+              (r'\*/', Comment, '#pop'),
+              (r'\*', Comment),
+          ]
+      }
+
+  When this encounters the above sample, first ``'comment'`` and ``'directive'``
+  are pushed onto the stack, then the lexer continues in the directive state
+  until it finds the closing ``>``, then it continues in the comment state until
+  the closing ``*/``.  Then, both states are popped from the stack again and
+  lexing continues in the root state.
+
+  .. versionadded:: 0.9
+     The tuple can contain the special ``'#push'`` and ``'#pop'`` (but not
+     ``'#pop:n'``) directives.
+
+
+- You can include the rules of a state in the definition of another.  This is
+  done by using `include` from `pygments.lexer`::
+
+      from pygments.lexer import RegexLexer, bygroups, include
+      from pygments.token import *
+
+      class ExampleLexer(RegexLexer):
+          tokens = {
+              'comments': [
+                  (r'/\*.*?\*/', Comment),
+                  (r'//.*?\n', Comment),
+              ],
+              'root': [
+                  include('comments'),
+                  (r'(function )(\w+)( {)',
+                   bygroups(Keyword, Name, Keyword), 'function'),
+                  (r'.', Text),
+              ],
+              'function': [
+                  (r'[^}/]+', Text),
+                  include('comments'),
+                  (r'/', Text),
+                  (r'\}', Keyword, '#pop'),
+              ]
+          }
+
+  This is a hypothetical lexer for a language that consist of functions and
+  comments.  Because comments can occur at toplevel and in functions, we need
+  rules for comments in both states.  As you can see, the `include` helper saves
+  repeating rules that occur more than once (in this example, the state
+  ``'comment'`` will never be entered by the lexer, as it's only there to be
+  included in ``'root'`` and ``'function'``).
+
+- Sometimes, you may want to "combine" a state from existing ones.  This is
+  possible with the `combined` helper from `pygments.lexer`.
+
+  If you, instead of a new state, write ``combined('state1', 'state2')`` as the
+  third item of a rule tuple, a new anonymous state will be formed from state1
+  and state2 and if the rule matches, the lexer will enter this state.
+
+  This is not used very often, but can be helpful in some cases, such as the
+  `PythonLexer`'s string literal processing.
+
+- If you want your lexer to start lexing in a different state you can modify the
+  stack by overloading the `get_tokens_unprocessed()` method::
+
+      from pygments.lexer import RegexLexer
+
+      class ExampleLexer(RegexLexer):
+          tokens = {...}
+
+          def get_tokens_unprocessed(self, text):
+              stack = ['root', 'otherstate']
+              for item in RegexLexer.get_tokens_unprocessed(text, stack):
+                  yield item
+
+  Some lexers like the `PhpLexer` use this to make the leading ``', Name.Tag),
+            ],
+            'script-content': [
+                (r'(.+?)(<\s*/\s*script\s*>)',
+                 bygroups(using(JavascriptLexer), Name.Tag),
+                 '#pop'),
+            ]
+        }
+
+Here the content of a ```` end tag is processed by the `JavascriptLexer`,
+while the end tag is yielded as a normal token with the `Name.Tag` type.
+
+Also note the ``(r'<\s*script\s*', Name.Tag, ('script-content', 'tag'))`` rule.
+Here, two states are pushed onto the state stack, ``'script-content'`` and
+``'tag'``.  That means that first ``'tag'`` is processed, which will lex
+attributes and the closing ``>``, then the ``'tag'`` state is popped and the
+next state on top of the stack will be ``'script-content'``.
+
+Since you cannot refer to the class currently being defined, use `this`
+(imported from `pygments.lexer`) to refer to the current lexer class, i.e.
+``using(this)``.  This construct may seem unnecessary, but this is often the
+most obvious way of lexing arbitrary syntax between fixed delimiters without
+introducing deeply nested states.
+
+The `using()` helper has a special keyword argument, `state`, which works as
+follows: if given, the lexer to use initially is not in the ``"root"`` state,
+but in the state given by this argument.  This does not work with advanced
+`RegexLexer` subclasses such as `ExtendedRegexLexer` (see below).
+
+Any other keywords arguments passed to `using()` are added to the keyword
+arguments used to create the lexer.
+
+
+Delegating Lexer
+================
+
+Another approach for nested lexers is the `DelegatingLexer` which is for example
+used for the template engine lexers.  It takes two lexers as arguments on
+initialisation: a `root_lexer` and a `language_lexer`.
+
+The input is processed as follows: First, the whole text is lexed with the
+`language_lexer`.  All tokens yielded with the special type of ``Other`` are
+then concatenated and given to the `root_lexer`.  The language tokens of the
+`language_lexer` are then inserted into the `root_lexer`'s token stream at the
+appropriate positions. ::
+
+    from pygments.lexer import DelegatingLexer
+    from pygments.lexers.web import HtmlLexer, PhpLexer
+
+    class HtmlPhpLexer(DelegatingLexer):
+        def __init__(self, **options):
+            super(HtmlPhpLexer, self).__init__(HtmlLexer, PhpLexer, **options)
+
+This procedure ensures that e.g. HTML with template tags in it is highlighted
+correctly even if the template tags are put into HTML tags or attributes.
+
+If you want to change the needle token ``Other`` to something else, you can give
+the lexer another token type as the third parameter::
+
+    DelegatingLexer.__init__(MyLexer, OtherLexer, Text, **options)
+
+
+Callbacks
+=========
+
+Sometimes the grammar of a language is so complex that a lexer would be unable
+to process it just by using regular expressions and stacks.
+
+For this, the `RegexLexer` allows callbacks to be given in rule tuples, instead
+of token types (`bygroups` and `using` are nothing else but preimplemented
+callbacks).  The callback must be a function taking two arguments:
+
+* the lexer itself
+* the match object for the last matched rule
+
+The callback must then return an iterable of (or simply yield) ``(index,
+tokentype, value)`` tuples, which are then just passed through by
+`get_tokens_unprocessed()`.  The ``index`` here is the position of the token in
+the input string, ``tokentype`` is the normal token type (like `Name.Builtin`),
+and ``value`` the associated part of the input string.
+
+You can see an example here::
+
+    from pygments.lexer import RegexLexer
+    from pygments.token import Generic
+
+    class HypotheticLexer(RegexLexer):
+
+        def headline_callback(lexer, match):
+            equal_signs = match.group(1)
+            text = match.group(2)
+            yield match.start(), Generic.Headline, equal_signs + text + equal_signs
+
+        tokens = {
+            'root': [
+                (r'(=+)(.*?)(\1)', headline_callback)
+            ]
+        }
+
+If the regex for the `headline_callback` matches, the function is called with
+the match object.  Note that after the callback is done, processing continues
+normally, that is, after the end of the previous match.  The callback has no
+possibility to influence the position.
+
+There are not really any simple examples for lexer callbacks, but you can see
+them in action e.g. in the `SMLLexer` class in `ml.py`_.
+
+.. _ml.py: http://bitbucket.org/birkenfeld/pygments-main/src/tip/pygments/lexers/ml.py
+
+
+The ExtendedRegexLexer class
+============================
+
+The `RegexLexer`, even with callbacks, unfortunately isn't powerful enough for
+the funky syntax rules of languages such as Ruby.
+
+But fear not; even then you don't have to abandon the regular expression
+approach: Pygments has a subclass of `RegexLexer`, the `ExtendedRegexLexer`.
+All features known from RegexLexers are available here too, and the tokens are
+specified in exactly the same way, *except* for one detail:
+
+The `get_tokens_unprocessed()` method holds its internal state data not as local
+variables, but in an instance of the `pygments.lexer.LexerContext` class, and
+that instance is passed to callbacks as a third argument. This means that you
+can modify the lexer state in callbacks.
+
+The `LexerContext` class has the following members:
+
+* `text` -- the input text
+* `pos` -- the current starting position that is used for matching regexes
+* `stack` -- a list containing the state stack
+* `end` -- the maximum position to which regexes are matched, this defaults to
+  the length of `text`
+
+Additionally, the `get_tokens_unprocessed()` method can be given a
+`LexerContext` instead of a string and will then process this context instead of
+creating a new one for the string argument.
+
+Note that because you can set the current position to anything in the callback,
+it won't be automatically be set by the caller after the callback is finished.
+For example, this is how the hypothetical lexer above would be written with the
+`ExtendedRegexLexer`::
+
+    from pygments.lexer import ExtendedRegexLexer
+    from pygments.token import Generic
+
+    class ExHypotheticLexer(ExtendedRegexLexer):
+
+        def headline_callback(lexer, match, ctx):
+            equal_signs = match.group(1)
+            text = match.group(2)
+            yield match.start(), Generic.Headline, equal_signs + text + equal_signs
+            ctx.pos = match.end()
+
+        tokens = {
+            'root': [
+                (r'(=+)(.*?)(\1)', headline_callback)
+            ]
+        }
+
+This might sound confusing (and it can really be). But it is needed, and for an
+example look at the Ruby lexer in `ruby.py`_.
+
+.. _ruby.py: https://bitbucket.org/birkenfeld/pygments-main/src/tip/pygments/lexers/ruby.py
+
+
+Handling Lists of Keywords
+==========================
+
+For a relatively short list (hundreds) you can construct an optimized regular
+expression directly using ``words()`` (longer lists, see next section).  This
+function handles a few things for you automatically, including escaping
+metacharacters and Python's first-match rather than longest-match in
+alternations.  Feel free to put the lists themselves in
+``pygments/lexers/_$lang_builtins.py`` (see examples there), and generated by
+code if possible.
+
+An example of using ``words()`` is something like::
+
+    from pygments.lexer import RegexLexer, words, Name
+
+    class MyLexer(RegexLexer):
+
+        tokens = {
+            'root': [
+                (words(('else', 'elseif'), suffix=r'\b'), Name.Builtin),
+                (r'\w+', Name),
+            ],
+        }
+
+As you can see, you can add ``prefix`` and ``suffix`` parts to the constructed
+regex.
+
+
+Modifying Token Streams
+=======================
+
+Some languages ship a lot of builtin functions (for example PHP).  The total
+amount of those functions differs from system to system because not everybody
+has every extension installed.  In the case of PHP there are over 3000 builtin
+functions.  That's an incredibly huge amount of functions, much more than you
+want to put into a regular expression.
+
+But because only `Name` tokens can be function names this is solvable by
+overriding the ``get_tokens_unprocessed()`` method.  The following lexer
+subclasses the `PythonLexer` so that it highlights some additional names as
+pseudo keywords::
+
+    from pygments.lexers.python import PythonLexer
+    from pygments.token import Name, Keyword
+
+    class MyPythonLexer(PythonLexer):
+        EXTRA_KEYWORDS = set(('foo', 'bar', 'foobar', 'barfoo', 'spam', 'eggs'))
+
+        def get_tokens_unprocessed(self, text):
+            for index, token, value in PythonLexer.get_tokens_unprocessed(self, text):
+                if token is Name and value in self.EXTRA_KEYWORDS:
+                    yield index, Keyword.Pseudo, value
+                else:
+                    yield index, token, value
+
+The `PhpLexer` and `LuaLexer` use this method to resolve builtin functions.
diff --git a/doc/docs/lexers.rst b/doc/docs/lexers.rst
new file mode 100644
index 0000000..914b53e
--- /dev/null
+++ b/doc/docs/lexers.rst
@@ -0,0 +1,69 @@
+.. -*- mode: rst -*-
+
+================
+Available lexers
+================
+
+This page lists all available builtin lexers and the options they take.
+
+Currently, **all lexers** support these options:
+
+`stripnl`
+    Strip leading and trailing newlines from the input (default: ``True``)
+
+`stripall`
+    Strip all leading and trailing whitespace from the input (default:
+    ``False``).
+
+`ensurenl`
+    Make sure that the input ends with a newline (default: ``True``).  This
+    is required for some lexers that consume input linewise.
+
+    .. versionadded:: 1.3
+
+`tabsize`
+    If given and greater than 0, expand tabs in the input (default: ``0``).
+
+`encoding`
+    If given, must be an encoding name (such as ``"utf-8"``). This encoding
+    will be used to convert the input string to Unicode (if it is not already
+    a Unicode string). The default is ``"latin1"``.
+
+    If this option is set to ``"guess"``, a simple UTF-8 vs. Latin-1
+    detection is used, if it is set to ``"chardet"``, the
+    `chardet library `__ is used to
+    guess the encoding of the input.
+
+    .. versionadded:: 0.6
+
+
+The "Short Names" field lists the identifiers that can be used with the
+`get_lexer_by_name()` function.
+
+These lexers are builtin and can be imported from `pygments.lexers`:
+
+.. pygmentsdoc:: lexers
+
+
+Iterating over all lexers
+-------------------------
+
+.. versionadded:: 0.6
+
+To get all lexers (both the builtin and the plugin ones), you can
+use the `get_all_lexers()` function from the `pygments.lexers`
+module:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.lexers import get_all_lexers
+    >>> i = get_all_lexers()
+    >>> i.next()
+    ('Diff', ('diff',), ('*.diff', '*.patch'), ('text/x-diff', 'text/x-patch'))
+    >>> i.next()
+    ('Delphi', ('delphi', 'objectpascal', 'pas', 'pascal'), ('*.pas',), ('text/x-pascal',))
+    >>> i.next()
+    ('XML+Ruby', ('xml+erb', 'xml+ruby'), (), ())
+
+As you can see, the return value is an iterator which yields tuples
+in the form ``(name, aliases, filetypes, mimetypes)``.
diff --git a/doc/docs/moinmoin.rst b/doc/docs/moinmoin.rst
new file mode 100644
index 0000000..8b2216b
--- /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/
diff --git a/doc/docs/plugins.rst b/doc/docs/plugins.rst
new file mode 100644
index 0000000..a6f8d7b
--- /dev/null
+++ b/doc/docs/plugins.rst
@@ -0,0 +1,93 @@
+================
+Register Plugins
+================
+
+If you want to extend Pygments without hacking the sources, but want to
+use the lexer/formatter/style/filter lookup functions (`lexers.get_lexer_by_name`
+et al.), you can use `setuptools`_ entrypoints to add new lexers, formatters
+or styles as if they were in the Pygments core.
+
+.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
+
+That means you can use your highlighter modules with the `pygmentize` script,
+which relies on the mentioned functions.
+
+
+Entrypoints
+===========
+
+Here is a list of setuptools entrypoints that Pygments understands:
+
+`pygments.lexers`
+
+    This entrypoint is used for adding new lexers to the Pygments core.
+    The name of the entrypoint values doesn't really matter, Pygments extracts
+    required metadata from the class definition:
+
+    .. sourcecode:: ini
+
+        [pygments.lexers]
+        yourlexer = yourmodule:YourLexer
+
+    Note that you have to define ``name``, ``aliases`` and ``filename``
+    attributes so that you can use the highlighter from the command line:
+
+    .. sourcecode:: python
+
+        class YourLexer(...):
+            name = 'Name Of Your Lexer'
+            aliases = ['alias']
+            filenames = ['*.ext']
+
+
+`pygments.formatters`
+
+    You can use this entrypoint to add new formatters to Pygments. The
+    name of an entrypoint item is the name of the formatter. If you
+    prefix the name with a slash it's used as a filename pattern:
+
+    .. sourcecode:: ini
+
+        [pygments.formatters]
+        yourformatter = yourmodule:YourFormatter
+        /.ext = yourmodule:YourFormatter
+
+
+`pygments.styles`
+
+    To add a new style you can use this entrypoint. The name of the entrypoint
+    is the name of the style:
+
+    .. sourcecode:: ini
+
+        [pygments.styles]
+        yourstyle = yourmodule:YourStyle
+
+
+`pygments.filters`
+
+    Use this entrypoint to register a new filter. The name of the
+    entrypoint is the name of the filter:
+
+    .. sourcecode:: ini
+
+        [pygments.filters]
+        yourfilter = yourmodule:YourFilter
+
+
+How To Use Entrypoints
+======================
+
+This documentation doesn't explain how to use those entrypoints because this is
+covered in the `setuptools documentation`_. That page should cover everything
+you need to write a plugin.
+
+.. _setuptools documentation: http://peak.telecommunity.com/DevCenter/setuptools
+
+
+Extending The Core
+==================
+
+If you have written a Pygments plugin that is open source, please inform us
+about that. There is a high chance that we'll add it to the Pygments
+distribution.
diff --git a/doc/docs/quickstart.rst b/doc/docs/quickstart.rst
new file mode 100644
index 0000000..dba7698
--- /dev/null
+++ b/doc/docs/quickstart.rst
@@ -0,0 +1,205 @@
+.. -*- mode: rst -*-
+
+===========================
+Introduction and Quickstart
+===========================
+
+
+Welcome to Pygments! This document explains the basic concepts and terms and
+gives a few examples of how to use the library.
+
+
+Architecture
+============
+
+There are four types of components that work together highlighting a piece of
+code:
+
+* A **lexer** splits the source into tokens, fragments of the source that
+  have a token type that determines what the text represents semantically
+  (e.g., keyword, string, or comment). There is a lexer for every language
+  or markup format that Pygments supports.
+* The token stream can be piped through **filters**, which usually modify
+  the token types or text fragments, e.g. uppercasing all keywords.
+* A **formatter** then takes the token stream and writes it to an output
+  file, in a format such as HTML, LaTeX or RTF.
+* While writing the output, a **style** determines how to highlight all the
+  different token types. It maps them to attributes like "red and bold".
+
+
+Example
+=======
+
+Here is a small example for highlighting Python code:
+
+.. sourcecode:: python
+
+    from pygments import highlight
+    from pygments.lexers import PythonLexer
+    from pygments.formatters import HtmlFormatter
+
+    code = 'print "Hello World"'
+    print highlight(code, PythonLexer(), HtmlFormatter())
+
+which prints something like this:
+
+.. sourcecode:: html
+
+    

+    
print "Hello World"

+    

+
+As you can see, Pygments uses CSS classes (by default, but you can change that)
+instead of inline styles in order to avoid outputting redundant style information over
+and over. A CSS stylesheet that contains all CSS classes possibly used in the output
+can be produced by:
+
+.. sourcecode:: python
+
+    print HtmlFormatter().get_style_defs('.highlight')
+
+The argument to :func:`get_style_defs` is used as an additional CSS selector:
+the output may look like this:
+
+.. sourcecode:: css
+
+    .highlight .k { color: #AA22FF; font-weight: bold }
+    .highlight .s { color: #BB4444 }
+    ...
+
+
+Options
+=======
+
+The :func:`highlight()` function supports a fourth argument called *outfile*, it
+must be a file object if given. The formatted output will then be written to
+this file instead of being returned as a string.
+
+Lexers and formatters both support options. They are given to them as keyword
+arguments either to the class or to the lookup method:
+
+.. sourcecode:: python
+
+    from pygments import highlight
+    from pygments.lexers import get_lexer_by_name
+    from pygments.formatters import HtmlFormatter
+
+    lexer = get_lexer_by_name("python", stripall=True)
+    formatter = HtmlFormatter(linenos=True, cssclass="source")
+    result = highlight(code, lexer, formatter)
+
+This makes the lexer strip all leading and trailing whitespace from the input
+(`stripall` option), lets the formatter output line numbers (`linenos` option),
+and sets the wrapping ``
``'s class to ``source`` (instead of
+``highlight``).
+
+Important options include:
+
+`encoding` : for lexers and formatters
+   Since Pygments uses Unicode strings internally, this determines which
+   encoding will be used to convert to or from byte strings.
+`style` : for formatters
+   The name of the style to use when writing the output.
+
+
+For an overview of builtin lexers and formatters and their options, visit the
+:doc:`lexer ` and :doc:`formatters ` lists.
+
+For a documentation on filters, see :doc:`this page `.
+
+
+Lexer and formatter lookup
+==========================
+
+If you want to lookup a built-in lexer by its alias or a filename, you can use
+one of the following methods:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.lexers import (get_lexer_by_name,
+    ...     get_lexer_for_filename, get_lexer_for_mimetype)
+
+    >>> get_lexer_by_name('python')
+    
+
+    >>> get_lexer_for_filename('spam.rb')
+    
+
+    >>> get_lexer_for_mimetype('text/x-perl')
+    
+
+All these functions accept keyword arguments; they will be passed to the lexer
+as options.
+
+A similar API is available for formatters: use :func:`.get_formatter_by_name()`
+and :func:`.get_formatter_for_filename()` from the :mod:`pygments.formatters`
+module for this purpose.
+
+
+Guessing lexers
+===============
+
+If you don't know the content of the file, or you want to highlight a file
+whose extension is ambiguous, such as ``.html`` (which could contain plain HTML
+or some template tags), use these functions:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.lexers import guess_lexer, guess_lexer_for_filename
+
+    >>> guess_lexer('#!/usr/bin/python\nprint "Hello World!"')
+    
+
+    >>> guess_lexer_for_filename('test.py', 'print "Hello World!"')
+    
+
+:func:`.guess_lexer()` passes the given content to the lexer classes'
+:meth:`analyse_text()` method and returns the one for which it returns the
+highest number.
+
+All lexers have two different filename pattern lists: the primary and the
+secondary one. The :func:`.get_lexer_for_filename()` function only uses the
+primary list, whose entries are supposed to be unique among all lexers.
+:func:`.guess_lexer_for_filename()`, however, will first loop through all lexers
+and look at the primary and secondary filename patterns if the filename matches.
+If only one lexer matches, it is returned, else the guessing mechanism of
+:func:`.guess_lexer()` is used with the matching lexers.
+
+As usual, keyword arguments to these functions are given to the created lexer
+as options.    
+
+
+Command line usage
+==================
+
+You can use Pygments from the command line, using the :program:`pygmentize`
+script::
+
+    $ pygmentize test.py
+
+will highlight the Python file test.py using ANSI escape sequences
+(a.k.a. terminal colors) and print the result to standard output.
+
+To output HTML, use the ``-f`` option::
+
+    $ pygmentize -f html -o test.html test.py
+
+to write an HTML-highlighted version of test.py to the file test.html.
+Note that it will only be a snippet of HTML, if you want a full HTML document,
+use the "full" option::
+
+    $ pygmentize -f html -O full -o test.html test.py
+
+This will produce a full HTML document with included stylesheet.
+
+A style can be selected with ``-O style=``.
+
+If you need a stylesheet for an existing HTML file using Pygments CSS classes,
+it can be created with::
+
+    $ pygmentize -S default -f html > style.css
+
+where ``default`` is the style name.
+
+More options and tricks and be found in the :doc:`command line reference
+`.
diff --git a/doc/docs/rstdirective.rst b/doc/docs/rstdirective.rst
new file mode 100644
index 0000000..c0d503b
--- /dev/null
+++ b/doc/docs/rstdirective.rst
@@ -0,0 +1,22 @@
+.. -*- mode: rst -*-
+
+================================
+Using Pygments in ReST documents
+================================
+
+Many Python people use `ReST`_ for documentation their sourcecode, programs,
+scripts et cetera. This also means that documentation often includes sourcecode
+samples or snippets.
+
+You can easily enable Pygments support for your ReST texts using a custom
+directive -- this is also how this documentation displays source code.
+
+From Pygments 0.9, the directive is shipped in the distribution as
+`external/rst-directive.py`.  You can copy and adapt this code to your liking.
+
+.. removed -- too confusing
+   *Loosely related note:* The ReST lexer now recognizes ``.. sourcecode::`` and
+   ``.. code::`` directives and highlights the contents in the specified language
+   if the `handlecodeblocks` option is true.
+
+.. _ReST: http://docutils.sf.net/rst.html
diff --git a/doc/docs/styles.rst b/doc/docs/styles.rst
new file mode 100644
index 0000000..d56db0d
--- /dev/null
+++ b/doc/docs/styles.rst
@@ -0,0 +1,145 @@
+.. -*- mode: rst -*-
+
+======
+Styles
+======
+
+Pygments comes with some builtin styles that work for both the HTML and
+LaTeX formatter.
+
+The builtin styles can be looked up with the `get_style_by_name` function:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.styles import get_style_by_name
+    >>> get_style_by_name('colorful')
+    
+
+You can pass a instance of a `Style` class to a formatter as the `style`
+option in form of a string:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.styles import get_style_by_name
+    >>> from pygments.formatters import HtmlFormatter
+    >>> HtmlFormatter(style='colorful').style
+    
+
+Or you can also import your own style (which must be a subclass of
+`pygments.style.Style`) and pass it to the formatter:
+
+.. sourcecode:: pycon
+
+    >>> from yourapp.yourmodule import YourStyle
+    >>> from pygments.formatters import HtmlFormatter
+    >>> HtmlFormatter(style=YourStyle).style
+    
+
+
+Creating Own Styles
+===================
+
+So, how to create a style? All you have to do is to subclass `Style` and
+define some styles:
+
+.. sourcecode:: python
+
+    from pygments.style import Style
+    from pygments.token import Keyword, Name, Comment, String, Error, \
+         Number, Operator, Generic
+
+    class YourStyle(Style):
+        default_style = ""
+        styles = {
+            Comment:                'italic #888',
+            Keyword:                'bold #005',
+            Name:                   '#f00',
+            Name.Function:          '#0f0',
+            Name.Class:             'bold #0f0',
+            String:                 'bg:#eee #111'
+        }
+
+That's it. There are just a few rules. When you define a style for `Name`
+the style automatically also affects `Name.Function` and so on. If you
+defined ``'bold'`` and you don't want boldface for a subtoken use ``'nobold'``.
+
+(Philosophy: the styles aren't written in CSS syntax since this way
+they can be used for a variety of formatters.)
+
+`default_style` is the style inherited by all token types.
+
+To make the style usable for Pygments, you must
+
+* either register it as a plugin (see :doc:`the plugin docs `)
+* or drop it into the `styles` subpackage of your Pygments distribution one style
+  class per style, where the file name is the style name and the class name is
+  `StylenameClass`. For example, if your style should be called
+  ``"mondrian"``, name the class `MondrianStyle`, put it into the file
+  ``mondrian.py`` and this file into the ``pygments.styles`` subpackage
+  directory.
+
+
+Style Rules
+===========
+
+Here a small overview of all allowed styles:
+
+``bold``
+    render text as bold
+``nobold``
+    don't render text as bold (to prevent subtokens being highlighted bold)
+``italic``
+    render text italic
+``noitalic``
+    don't render text as italic
+``underline``
+    render text underlined
+``nounderline``
+    don't render text underlined
+``bg:``
+    transparent background
+``bg:#000000``
+    background color (black)
+``border:``
+    no border
+``border:#ffffff``
+    border color (white)
+``#ff0000``
+    text color (red)
+``noinherit``
+    don't inherit styles from supertoken
+
+Note that there may not be a space between ``bg:`` and the color value
+since the style definition string is split at whitespace.
+Also, using named colors is not allowed since the supported color names
+vary for different formatters.
+
+Furthermore, not all lexers might support every style.
+
+
+Builtin Styles
+==============
+
+Pygments ships some builtin styles which are maintained by the Pygments team.
+
+To get a list of known styles you can use this snippet:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.styles import STYLE_MAP
+    >>> STYLE_MAP.keys()
+    ['default', 'emacs', 'friendly', 'colorful']
+
+
+Getting a list of available styles
+==================================
+
+.. versionadded:: 0.6
+
+Because it could be that a plugin registered a style, there is
+a way to iterate over all styles:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.styles import get_all_styles
+    >>> styles = list(get_all_styles())
diff --git a/doc/docs/tokens.rst b/doc/docs/tokens.rst
new file mode 100644
index 0000000..9193d5f
--- /dev/null
+++ b/doc/docs/tokens.rst
@@ -0,0 +1,352 @@
+.. -*- mode: rst -*-
+
+==============
+Builtin Tokens
+==============
+
+.. module:: pygments.token
+
+In the :mod:`pygments.token` module, there is a special object called `Token`
+that is used to create token types.
+
+You can create a new token type by accessing an attribute of `Token`:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.token import Token
+    >>> Token.String
+    Token.String
+    >>> Token.String is Token.String
+    True
+
+Note that tokens are singletons so you can use the ``is`` operator for comparing
+token types.
+
+As of Pygments 0.7 you can also use the ``in`` operator to perform set tests:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.token import Comment
+    >>> Comment.Single in Comment
+    True
+    >>> Comment in Comment.Multi
+    False
+
+This can be useful in :doc:`filters ` and if you write lexers on your
+own without using the base lexers.
+
+You can also split a token type into a hierarchy, and get the parent of it:
+
+.. sourcecode:: pycon
+
+    >>> String.split()
+    [Token, Token.Literal, Token.Literal.String]
+    >>> String.parent
+    Token.Literal
+
+In principle, you can create an unlimited number of token types but nobody can
+guarantee that a style would define style rules for a token type. Because of
+that, Pygments proposes some global token types defined in the
+`pygments.token.STANDARD_TYPES` dict.
+
+For some tokens aliases are already defined:
+
+.. sourcecode:: pycon
+
+    >>> from pygments.token import String
+    >>> String
+    Token.Literal.String
+
+Inside the :mod:`pygments.token` module the following aliases are defined:
+
+============= ============================ ====================================
+`Text`        `Token.Text`                 for any type of text data
+`Whitespace`  `Token.Text.Whitespace`      for specially highlighted whitespace
+`Error`       `Token.Error`                represents lexer errors
+`Other`       `Token.Other`                special token for data not
+                                           matched by a parser (e.g. HTML
+                                           markup in PHP code)
+`Keyword`     `Token.Keyword`              any kind of keywords
+`Name`        `Token.Name`                 variable/function names
+`Literal`     `Token.Literal`              Any literals
+`String`      `Token.Literal.String`       string literals
+`Number`      `Token.Literal.Number`       number literals
+`Operator`    `Token.Operator`             operators (``+``, ``not``...)
+`Punctuation` `Token.Punctuation`          punctuation (``[``, ``(``...)
+`Comment`     `Token.Comment`              any kind of comments
+`Generic`     `Token.Generic`              generic tokens (have a look at
+                                           the explanation below)
+============= ============================ ====================================
+
+The `Whitespace` token type is new in Pygments 0.8. It is used only by the
+`VisibleWhitespaceFilter` currently.
+
+Normally you just create token types using the already defined aliases. For each
+of those token aliases, a number of subtypes exists (excluding the special tokens
+`Token.Text`, `Token.Error` and `Token.Other`)
+
+The `is_token_subtype()` function in the `pygments.token` module can be used to
+test if a token type is a subtype of another (such as `Name.Tag` and `Name`).
+(This is the same as ``Name.Tag in Name``. The overloaded `in` operator was newly
+introduced in Pygments 0.7, the function still exists for backwards
+compatiblity.)
+
+With Pygments 0.7, it's also possible to convert strings to token types (for example
+if you want to supply a token from the command line):
+
+.. sourcecode:: pycon
+
+    >>> from pygments.token import String, string_to_tokentype
+    >>> string_to_tokentype("String")
+    Token.Literal.String
+    >>> string_to_tokentype("Token.Literal.String")
+    Token.Literal.String
+    >>> string_to_tokentype(String)
+    Token.Literal.String
+
+
+Keyword Tokens
+==============
+
+`Keyword`
+    For any kind of keyword (especially if it doesn't match any of the
+    subtypes of course).
+
+`Keyword.Constant`
+    For keywords that are constants (e.g. ``None`` in future Python versions).
+
+`Keyword.Declaration`
+    For keywords used for variable declaration (e.g. ``var`` in some programming
+    languages like JavaScript).
+
+`Keyword.Namespace`
+    For keywords used for namespace declarations (e.g. ``import`` in Python and
+    Java and ``package`` in Java).
+
+`Keyword.Pseudo`
+    For keywords that aren't really keywords (e.g. ``None`` in old Python
+    versions).
+
+`Keyword.Reserved`
+    For reserved keywords.
+
+`Keyword.Type`
+    For builtin types that can't be used as identifiers (e.g. ``int``,
+    ``char`` etc. in C).
+
+
+Name Tokens
+===========
+
+`Name`
+    For any name (variable names, function names, classes).
+
+`Name.Attribute`
+    For all attributes (e.g. in HTML tags).
+
+`Name.Builtin`
+    Builtin names; names that are available in the global namespace.
+
+`Name.Builtin.Pseudo`
+    Builtin names that are implicit (e.g. ``self`` in Ruby, ``this`` in Java).
+
+`Name.Class`
+    Class names. Because no lexer can know if a name is a class or a function
+    or something else this token is meant for class declarations.
+
+`Name.Constant`
+    Token type for constants. In some languages you can recognise a token by the
+    way it's defined (the value after a ``const`` keyword for example). In
+    other languages constants are uppercase by definition (Ruby).
+
+`Name.Decorator`
+    Token type for decorators. Decorators are synatic elements in the Python
+    language. Similar syntax elements exist in C# and Java.
+
+`Name.Entity`
+    Token type for special entities. (e.g. `` `` in HTML).
+
+`Name.Exception`
+    Token type for exception names (e.g. ``RuntimeError`` in Python). Some languages
+    define exceptions in the function signature (Java). You can highlight
+    the name of that exception using this token then.
+
+`Name.Function`
+    Token type for function names.
+
+`Name.Label`
+    Token type for label names (e.g. in languages that support ``goto``).
+
+`Name.Namespace`
+    Token type for namespaces. (e.g. import paths in Java/Python), names following
+    the ``module``/``namespace`` keyword in other languages.
+
+`Name.Other`
+    Other names. Normally unused.
+
+`Name.Tag`
+    Tag names (in HTML/XML markup or configuration files).
+
+`Name.Variable`
+    Token type for variables. Some languages have prefixes for variable names
+    (PHP, Ruby, Perl). You can highlight them using this token.
+
+`Name.Variable.Class`
+    same as `Name.Variable` but for class variables (also static variables).
+
+`Name.Variable.Global`
+    same as `Name.Variable` but for global variables (used in Ruby, for
+    example).
+
+`Name.Variable.Instance`
+    same as `Name.Variable` but for instance variables.
+
+
+Literals
+========
+
+`Literal`
+    For any literal (if not further defined).
+
+`Literal.Date`
+    for date literals (e.g. ``42d`` in Boo).
+
+
+`String`
+    For any string literal.
+
+`String.Backtick`
+    Token type for strings enclosed in backticks.
+
+`String.Char`
+    Token type for single characters (e.g. Java, C).
+
+`String.Doc`
+    Token type for documentation strings (for example Python).
+
+`String.Double`
+    Double quoted strings.
+
+`String.Escape`
+    Token type for escape sequences in strings.
+
+`String.Heredoc`
+    Token type for "heredoc" strings (e.g. in Ruby or Perl).
+
+`String.Interpol`
+    Token type for interpolated parts in strings (e.g. ``#{foo}`` in Ruby).
+
+`String.Other`
+    Token type for any other strings (for example ``%q{foo}`` string constructs
+    in Ruby).
+
+`String.Regex`
+    Token type for regular expression literals (e.g. ``/foo/`` in JavaScript).
+
+`String.Single`
+    Token type for single quoted strings.
+
+`String.Symbol`
+    Token type for symbols (e.g. ``:foo`` in LISP or Ruby).
+
+
+`Number`
+    Token type for any number literal.
+
+`Number.Bin`
+    Token type for binary literals (e.g. ``0b101010``).
+
+`Number.Float`
+    Token type for float literals (e.g. ``42.0``).
+
+`Number.Hex`
+    Token type for hexadecimal number literals (e.g. ``0xdeadbeef``).
+
+`Number.Integer`
+    Token type for integer literals (e.g. ``42``).
+
+`Number.Integer.Long`
+    Token type for long integer literals (e.g. ``42L`` in Python).
+
+`Number.Oct`
+    Token type for octal literals.
+
+
+Operators
+=========
+
+`Operator`
+    For any punctuation operator (e.g. ``+``, ``-``).
+
+`Operator.Word`
+    For any operator that is a word (e.g. ``not``).
+
+
+Punctuation
+===========
+
+.. versionadded:: 0.7
+
+`Punctuation`
+    For any punctuation which is not an operator (e.g. ``[``, ``(``...)
+
+
+Comments
+========
+
+`Comment`
+    Token type for any comment.
+
+`Comment.Multiline`
+    Token type for multiline comments.
+
+`Comment.Preproc`
+    Token type for preprocessor comments (also ```.
+
+.. versionadded:: 0.7
+   The formatters now also accept an `outencoding` option which will override
+   the `encoding` option if given. This makes it possible to use a single
+   options dict with lexers and formatters, and still have different input and
+   output encodings.
+
+.. _chardet: http://chardet.feedparser.org/
diff --git a/doc/download.rst b/doc/download.rst
new file mode 100644
index 0000000..cf32f48
--- /dev/null
+++ b/doc/download.rst
@@ -0,0 +1,41 @@
+Download and installation
+=========================
+
+The current release is version |version|.
+
+Packaged versions
+-----------------
+
+You can download it `from the Python Package Index
+`_.  For installation of packages from
+PyPI, we recommend `Pip `_, which works on all
+major platforms.
+
+Under Linux, most distributions include a package for Pygments, usually called
+``pygments`` or ``python-pygments``.  You can install it with the package
+manager as usual.
+
+Development sources
+-------------------
+
+We're using the `Mercurial `_ version control
+system.  You can get the development source using this command::
+
+    hg clone http://bitbucket.org/birkenfeld/pygments-main pygments
+
+Development takes place at `Bitbucket
+`_, you can browse the source
+online `here `_.
+
+The latest changes in the development source code are listed in the `changelog
+`_.
+
+.. Documentation
+   -------------
+
+.. XXX todo
+
+   You can download the documentation either as
+      a bunch of rst files from the Mercurial repository, see above, or
+      as a tar.gz containing rendered HTML files:

+      
pygmentsdocs.tar.gz

diff --git a/doc/faq.rst b/doc/faq.rst
new file mode 100644
index 0000000..f040e05
--- /dev/null
+++ b/doc/faq.rst
@@ -0,0 +1,143 @@
+:orphan:
+
+Pygments FAQ
+=============
+
+What is Pygments?
+-----------------
+
+Pygments is a syntax highlighting engine written in Python. That means, it will
+take source code (or other markup) in a supported language and output a
+processed version (in different formats) containing syntax highlighting markup.
+
+Its features include:
+
+* a wide range of common languages and markup formats is supported (look here
+  for a list)
+* new languages and formats are added easily
+* a number of output formats is available, including:
+
+  - HTML
+  - ANSI sequences (console output)
+  - LaTeX
+  - RTF
+
+* it is usable as a command-line tool and as a library
+* parsing and formatting is fast
+
+Pygments is licensed under the BSD license.
+
+Where does the name Pygments come from?
+---------------------------------------
+
+*Py* of course stands for Python, while *pigments* are used for coloring paint,
+and in this case, source code!
+
+What are the system requirements?
+---------------------------------
+
+Pygments only needs a standard Python install, version 2.6 or higher or version
+3.3 or higher for Python 3. No additional libraries are needed.
+
+How can I use Pygments?
+-----------------------
+
+Pygments is usable as a command-line tool as well as a library.
+
+From the command-line, usage looks like this (assuming the pygmentize script is
+properly installed)::
+
+    pygmentize -f html /path/to/file.py
+
+This will print a HTML-highlighted version of /path/to/file.py to standard output.
+
+For a complete help, please run ``pygmentize -h``.
+
+Usage as a library is thoroughly demonstrated in the Documentation section.
+
+How do I make a new style?
+--------------------------
+
+Please see the :doc:`documentation on styles `.
+
+How can I report a bug or suggest a feature?
+--------------------------------------------
+
+Please report bugs and feature wishes in the tracker at Bitbucket.
+
+You can also e-mail the author or use IRC, see the contact details.
+
+I want this support for this language!
+--------------------------------------
+
+Instead of waiting for others to include language support, why not write it
+yourself? All you have to know is :doc:`outlined in the docs
+`.
+
+Can I use Pygments for programming language processing?
+-------------------------------------------------------
+
+The Pygments lexing machinery is quite powerful can be used to build lexers for
+basically all languages. However, parsing them is not possible, though some
+lexers go some steps in this direction in order to e.g. highlight function names
+differently.
+
+Also, error reporting is not the scope of Pygments. It focuses on correctly
+highlighting syntactically valid documents, not finding and compensating errors.
+
+Who uses Pygments?
+------------------
+
+This is an (incomplete) list of projects and sites known to use the Pygments highlighter.
+
+* `Pygments API `_, a HTTP POST interface to Pygments
+* `The Sphinx documentation builder `_, for embedded source examples
+* `rst2pdf `_, a reStructuredText to PDF converter
+* `Zine `_, a Python blogging system
+* `Trac `_, the universal project management tool
+* `Bruce `_, a reStructuredText presentation tool
+* `AsciiDoc `_, a text-based documentation generator
+* `ActiveState Code `_, the Python Cookbook successor
+* `ViewVC `_, a web-based version control repository browser
+* `BzrFruit `_, a Bazaar branch viewer
+* `QBzr `_, a cross-platform Qt-based GUI front end for Bazaar
+* `BitBucket `_, a Mercurial and Git hosting site
+* `GitHub `_, a site offering secure Git hosting and collaborative development
+* `Review Board `_, a collaborative code reviewing tool
+* `skeletonz `_, a Python powered content management system
+* `Diamanda `_, a Django powered wiki system with support for Pygments
+* `Progopedia `_ (`English `_),
+  an encyclopedia of programming languages
+* `Postmarkup `_, a BBCode to XHTML generator
+* `Language Comparison `_, a site that compares different programming languages
+* `BPython `_, a curses-based intelligent Python shell
+* `Challenge-You! `_, a site offering programming challenges
+* `PIDA `_, a universal IDE written in Python
+* `PuDB `_, a console Python debugger
+* `XWiki `_, a wiki-based development framework in Java, using Jython
+* `roux `_, a script for running R scripts
+  and creating beautiful output including graphs
+* `hurl `_, a web service for making HTTP requests
+* `wxHTMLPygmentizer `_ is
+  a GUI utility, used to make code-colorization easier
+* `WpPygments `_, a highlighter plugin for WordPress
+* `LodgeIt `_, a pastebin with XMLRPC support and diffs
+* `SpammCan `_, a pastebin (demo see
+  `here `_)
+* `WowAce.com pastes `_, a pastebin
+* `Siafoo `_, a tool for sharing and storing useful code and programming experience
+* `D source `_, a community for the D programming language
+* `dumpz.org `_, a pastebin
+* `dpaste.com `_, another Django pastebin
+* `PylonsHQ Pasties `_, a pastebin
+* `Django snippets `_, a pastebin for Django code
+* `Fayaa `_, a Chinese pastebin
+* `Incollo.com `_, a free collaborative debugging tool
+* `PasteBox `_, a pastebin focused on privacy
+* `xinotes.org `_, a site to share notes, code snippets etc.
+* `hilite.me `_, a site to highlight code snippets
+* `patx.me `_, a pastebin
+
+If you have a project or web site using Pygments, drop me a line, and I'll add a
+link here.
+
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..2611404
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,54 @@
+Welcome!
+========
+
+This is the home of Pygments.  It is a generic syntax highlighter suitable for
+use in code hosting, forums, wikis or other applications that need to prettify
+source code.  Highlights are:
+
+* a wide range of over 300 languages and other text formats is supported
+* special attention is paid to details that increase highlighting quality
+* support for new languages and formats are added easily; most languages use a
+  simple regex-based lexing mechanism
+* a number of output formats is available, among them HTML, RTF, LaTeX and ANSI
+  sequences
+* it is usable as a command-line tool and as a library
+* ... and it highlights even Perl 6!
+
+Read more in the :doc:`FAQ list ` or the :doc:`documentation `,
+or `download the latest release `_.
+
+.. _contribute:
+
+Contribute
+----------
+
+Like every open-source project, we are always looking for volunteers to help us
+with programming. Python knowledge is required, but don't fear: Python is a very
+clear and easy to learn language.
+
+Development takes place on `Bitbucket
+`_, where the Mercurial
+repository, tickets and pull requests can be viewed.
+
+Our primary communication instrument is the IRC channel **#pocoo** on the
+Freenode network. To join it, let your IRC client connect to
+``irc.freenode.net`` and do ``/join #pocoo``.
+
+If you found a bug, just open a ticket in the Bitbucket tracker. Be sure to log
+in to be notified when the issue is fixed -- development is not fast-paced as
+the library is quite stable.  You can also send an e-mail to the developers, see
+below.
+
+The authors
+-----------
+
+Pygments is maintained by **Georg Brandl**, e-mail address *georg*\ *@*\ *python.org*.
+
+Many lexers and fixes have been contributed by **Armin Ronacher**, the rest of
+the `Pocoo `_ team and **Tim Hatch**.
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   docs/index
diff --git a/doc/languages.rst b/doc/languages.rst
new file mode 100644
index 0000000..0f98c58
--- /dev/null
+++ b/doc/languages.rst
@@ -0,0 +1,151 @@
+:orphan:
+
+Supported languages
+===================
+
+Pygments supports an ever-growing range of languages. Watch this space...
+
+Programming languages
+---------------------
+
+* ActionScript
+* Ada
+* ANTLR
+* AppleScript
+* Assembly (various)
+* Asymptote
+* Awk
+* Befunge
+* Boo
+* BrainFuck
+* C, C++
+* C#
+* Clojure
+* CoffeeScript
+* ColdFusion
+* Common Lisp
+* Coq
+* Cryptol (incl. Literate Cryptol)
+* `Cython `_
+* `D `_
+* Dart
+* Delphi
+* Dylan
+* Erlang
+* Factor
+* Fancy
+* Fortran
+* F#
+* GAP
+* Gherkin (Cucumber)
+* GL shaders
+* Groovy
+* `Haskell `_ (incl. Literate Haskell)
+* IDL
+* Io
+* Java
+* JavaScript
+* LLVM
+* Logtalk
+* `Lua `_
+* Matlab
+* MiniD
+* Modelica
+* Modula-2
+* MuPad
+* Nemerle
+* Nimrod
+* Objective-C
+* Objective-J
+* Octave
+* OCaml
+* PHP
+* `Perl `_
+* PovRay
+* PostScript
+* PowerShell
+* Prolog
+* `Python `_ 2.x and 3.x (incl. console sessions and tracebacks)
+* `REBOL `_
+* `Red `_
+* Redcode
+* `Ruby `_ (incl. irb sessions)
+* Rust
+* S, S-Plus, R
+* Scala
+* Scheme
+* Scilab
+* Smalltalk
+* SNOBOL
+* Tcl
+* Vala
+* Verilog
+* VHDL
+* Visual Basic.NET
+* Visual FoxPro
+* XQuery
+* Zephir
+  
+
+Template languages
+------------------
+
+* Cheetah templates
+* `Django `_ / `Jinja
+  `_ templates
+* ERB (Ruby templating)
+* `Genshi `_ (the Trac template language)
+* JSP (Java Server Pages)
+* `Myghty `_ (the HTML::Mason based framework)
+* `Mako `_ (the Myghty successor)
+* `Smarty `_ templates (PHP templating)
+* Tea
+
+Other markup
+------------
+
+* Apache config files
+* Bash shell scripts
+* BBCode
+* CMake
+* CSS
+* Debian control files
+* Diff files
+* DTD
+* Gettext catalogs
+* Gnuplot script
+* Groff markup
+* HTML
+* HTTP sessions
+* INI-style config files
+* IRC logs (irssi style)
+* Lighttpd config files
+* Makefiles
+* MoinMoin/Trac Wiki markup
+* MySQL
+* Nginx config files
+* POV-Ray scenes
+* Ragel
+* Redcode
+* ReST
+* Robot Framework
+* RPM spec files
+* SQL, also MySQL, SQLite
+* Squid configuration
+* TeX
+* tcsh
+* Vim Script
+* Windows batch files
+* XML
+* XSLT
+* YAML
+
+... that's all?
+---------------
+
+Well, why not write your own? Contributing to Pygments is easy and fun.  Look
+:doc:`here ` for the docs on lexer development and
+:ref:`here ` for contact details.
+
+Note: the languages listed here are supported in the development version. The
+latest release may lack a few of them.
diff --git a/doc/make.bat b/doc/make.bat
new file mode 100644
index 0000000..8803c98
--- /dev/null
+++ b/doc/make.bat
@@ -0,0 +1,190 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^` where ^ is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Pygments.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Pygments.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end
diff --git a/doc/pygmentize.1 b/doc/pygmentize.1
new file mode 100644
index 0000000..71bb6f9
--- /dev/null
+++ b/doc/pygmentize.1
@@ -0,0 +1,94 @@
+.TH PYGMENTIZE 1 "February 15, 2007"
+
+.SH NAME
+pygmentize \- highlights the input file
+
+.SH SYNOPSIS
+.B \fBpygmentize\fP
+.RI  [-l\ \fI\fP]\ [-F\ \fI\fP[:\fI\fP]]\ [-f\ \fI\fP]
+.RI  [-O\ \fI\fP]\ [-P\ \fI\fP]\ [-o\ \fI\fP]\ [\fI\fP]
+.br
+.B \fBpygmentize\fP
+.RI -S\ \fI
-
-
-  

-    
Pygments

-    
The full Pygments API

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
This page describes the Pygments API.

-

-
High-level API

-
Functions from the pygments module:

-

-
def lex(code, lexer):

-
Lex code with the lexer (must be a Lexer instance)
-and return an iterable of tokens. Currently, this only calls
-lexer.get_tokens().

-
def format(tokens, formatter, outfile=None):

-
Format a token stream (iterable of tokens) tokens with the
-formatter (must be a Formatter instance). The result is
-written to outfile, or if that is None, returned as a
-string.

-
def highlight(code, lexer, formatter, outfile=None):

-
This is the most high-level highlighting function.
-It combines lex and format in one function.

-

-
Functions from pygments.lexers:

-

-
def get_lexer_by_name(alias, **options):

-
Return an instance of a Lexer subclass that has alias in its
-aliases list. The lexer is given the options at its
-instantiation.

-
Will raise pygments.util.ClassNotFound if no lexer with that alias is
-found.

-

-
def get_lexer_for_filename(fn, **options):

-
Return a Lexer subclass instance that has a filename pattern
-matching fn. The lexer is given the options at its
-instantiation.

-
Will raise pygments.util.ClassNotFound if no lexer for that filename is
-found.

-

-
def get_lexer_for_mimetype(mime, **options):

-
Return a Lexer subclass instance that has mime in its mimetype
-list. The lexer is given the options at its instantiation.

-
Will raise pygments.util.ClassNotFound if not lexer for that mimetype is
-found.

-

-
def guess_lexer(text, **options):

-
Return a Lexer subclass instance that's guessed from the text
-in text. For that, the analyse_text() method of every known
-lexer class is called with the text as argument, and the lexer
-which returned the highest value will be instantiated and returned.

-
pygments.util.ClassNotFound is raised if no lexer thinks it can handle the
-content.

-

-
def guess_lexer_for_filename(filename, text, **options):

-
As guess_lexer(), but only lexers which have a pattern in filenames
-or alias_filenames that matches filename are taken into consideration.

-
pygments.util.ClassNotFound is raised if no lexer thinks it can handle the
-content.

-

-
def get_all_lexers():

-
Return an iterable over all registered lexers, yielding tuples in the
-format:

-
-(longname, tuple of aliases, tuple of filename patterns, tuple of mimetypes)
-

-
New in Pygments 0.6.

-

-

-
Functions from pygments.formatters:

-

-
def get_formatter_by_name(alias, **options):

-
Return an instance of a Formatter subclass that has alias in its
-aliases list. The formatter is given the options at its
-instantiation.

-
Will raise pygments.util.ClassNotFound if no formatter with that alias is
-found.

-

-
def get_formatter_for_filename(fn, **options):

-
Return a Formatter subclass instance that has a filename pattern
-matching fn. The formatter is given the options at its
-instantiation.

-
Will raise pygments.util.ClassNotFound if no formatter for that filename
-is found.

-

-

-
Functions from pygments.styles:

-

-
def get_style_by_name(name):

-
Return a style class by its short name. The names of the builtin styles
-are listed in pygments.styles.STYLE_MAP.

-
Will raise pygments.util.ClassNotFound if no style of that name is found.

-

-
def get_all_styles():

-
Return an iterable over all registered styles, yielding their names.

-
New in Pygments 0.6.

-

-

-

-

-
Lexers

-
A lexer (derived from pygments.lexer.Lexer) has the following functions:

-

-
def __init__(self, **options):

-
The constructor. Takes a **keywords dictionary of options.
-Every subclass must first process its own options and then call
-the Lexer constructor, since it processes the stripnl,
-stripall and tabsize options.

-
An example looks like this:

-
def __init__(self, **options):
-    self.compress = options.get('compress', '')
-    Lexer.__init__(self, **options)
-

-
As these options must all be specifiable as strings (due to the
-command line usage), there are various utility functions
-available to help with that, see Option processing.

-

-
def get_tokens(self, text):

-
This method is the basic interface of a lexer. It is called by
-the highlight() function. It must process the text and return an
-iterable of (tokentype, value) pairs from text.

-
Normally, you don't need to override this method. The default
-implementation processes the stripnl, stripall and tabsize
-options and then yields all tokens from get_tokens_unprocessed(),
-with the index dropped.

-

-
def get_tokens_unprocessed(self, text):

-
This method should process the text and return an iterable of
-(index, tokentype, value) tuples where index is the starting
-position of the token within the input text.

-
This method must be overridden by subclasses.

-

-
def analyse_text(text):

-
A static method which is called for lexer guessing. It should analyse
-the text and return a float in the range from 0.0 to 1.0.
-If it returns 0.0, the lexer will not be selected as the most
-probable one, if it returns 1.0, it will be selected immediately.

-

-
For a list of known tokens have a look at the Tokens page.

-
A lexer also can have the following attributes (in fact, they are mandatory
-except alias_filenames) that are used by the builtin lookup mechanism.

-

-
name

-
Full name for the lexer, in human-readable form.

-
aliases

-
A list of short, unique identifiers that can be used to lookup
-the lexer from a list, e.g. using get_lexer_by_name().

-
filenames

-
A list of fnmatch patterns that match filenames which contain
-content for this lexer. The patterns in this list should be unique among
-all lexers.

-
alias_filenames

-
A list of fnmatch patterns that match filenames which may or may not
-contain content for this lexer. This list is used by the
-guess_lexer_for_filename() function, to determine which lexers are
-then included in guessing the correct one. That means that e.g. every
-lexer for HTML and a template language should include \*.html in
-this list.

-
mimetypes

-
A list of MIME types for content that can be lexed with this
-lexer.

-

-

-

-
Formatters

-
A formatter (derived from pygments.formatter.Formatter) has the following
-functions:

-

-
def __init__(self, **options):

-
As with lexers, this constructor processes options and then must call
-the base class __init__.

-
The Formatter class recognizes the options style, full and
-title. It is up to the formatter class whether it uses them.

-

-
def get_style_defs(self, arg=''):

-
This method must return statements or declarations suitable to define
-the current style for subsequent highlighted text (e.g. CSS classes
-in the HTMLFormatter).

-
The optional argument arg can be used to modify the generation and
-is formatter dependent (it is standardized because it can be given on
-the command line).

-
This method is called by the -S command-line option, the arg
-is then given by the -a option.

-

-
def format(self, tokensource, outfile):

-
This method must format the tokens from the tokensource iterable and
-write the formatted version to the file object outfile.

-
Formatter options can control how exactly the tokens are converted.

-

-

-
A formatter must have the following attributes that are used by the
-builtin lookup mechanism. (New in Pygments 0.7.)

-

-
name

-
Full name for the formatter, in human-readable form.

-
aliases

-
A list of short, unique identifiers that can be used to lookup
-the formatter from a list, e.g. using get_formatter_by_name().

-
filenames

-
A list of fnmatch patterns that match filenames for which this formatter
-can produce output. The patterns in this list should be unique among
-all formatters.

-

-

-

-
Option processing

-
The pygments.util module has some utility functions usable for option
-processing:

-

-
class OptionError

-
This exception will be raised by all option processing functions if
-the type or value of the argument is not correct.

-
def get_bool_opt(options, optname, default=None):

-
Interpret the key optname from the dictionary options
-as a boolean and return it. Return default if optname
-is not in options.

-
The valid string values for True are 1, yes,
-true and on, the ones for False are 0,
-no, false and off (matched case-insensitively).

-

-
def get_int_opt(options, optname, default=None):

-
As get_bool_opt, but interpret the value as an integer.

-
def get_list_opt(options, optname, default=None):

-
If the key optname from the dictionary options is a string,
-split it at whitespace and return it. If it is already a list
-or a tuple, it is returned as a list.

-
def get_choice_opt(options, optname, allowed, default=None):

-
If the key optname from the dictionary is not in the sequence
-allowed, raise an error, otherwise return it. New in Pygments 0.8.

-

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/authors.html b/docs/build/authors.html
deleted file mode 100644
index 98190b7..0000000
--- a/docs/build/authors.html
+++ /dev/null
@@ -1,355 +0,0 @@
-
-
-
-  Authors — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Authors

-    
-      « Back To Index
-    
-    
-    
Pygments is written and maintained by Georg Brandl <georg@python.org>.

-
Major developers are Tim Hatch <tim@timhatch.com> and Armin Ronacher
-<armin.ronacher@active-4.com>.

-
Other contributors, listed alphabetically, are:

-
    
-
  • Sam Aaron -- Ioke lexer
    • 
-
  • Kumar Appaiah -- Debian control lexer
    • 
-
  • Ali Afshar -- image formatter
    • 
-
  • Andreas Amann -- AppleScript lexer
    • 
-
  • Jeffrey Arnold -- R/S, Rd, BUGS, Jags, and Stan lexers
    • 
-
  • Jeremy Ashkenas -- CoffeeScript lexer
    • 
-
  • Stefan Matthias Aust -- Smalltalk lexer
    • 
-
  • Ben Bangert -- Mako lexers
    • 
-
  • Max Battcher -- Darcs patch lexer
    • 
-
  • Paul Baumgart, 280 North, Inc. -- Objective-J lexer
    • 
-
  • Michael Bayer -- Myghty lexers
    • 
-
  • John Benediktsson -- Factor lexer
    • 
-
  • Christopher Bertels -- Fancy lexer
    • 
-
  • Jarrett Billingsley -- MiniD lexer
    • 
-
  • Adam Blinkinsop -- Haskell, Redcode lexers
    • 
-
  • Frits van Bommel -- assembler lexers
    • 
-
  • Pierre Bourdon -- bugfixes
    • 
-
  • Hiram Chirino -- Scaml and Jade lexers
    • 
-
  • Ian Cooper -- VGL lexer
    • 
-
  • Leaf Corcoran -- MoonScript lexer
    • 
-
  • Christopher Creutzig -- MuPAD lexer
    • 
-
  • Pete Curry -- bugfixes
    • 
-
  • Owen Durni -- haXe lexer
    • 
-
  • Nick Efford -- Python 3 lexer
    • 
-
  • Sven Efftinge -- Xtend lexer
    • 
-
  • Artem Egorkine -- terminal256 formatter
    • 
-
  • James H. Fisher -- PostScript lexer
    • 
-
  • Carlos Galdino -- Elixir and Elixir Console lexers
    • 
-
  • Michael Galloy -- IDL lexer
    • 
-
  • Naveen Garg -- Autohotkey lexer
    • 
-
  • Laurent Gautier -- R/S lexer
    • 
-
  • Alex Gaynor -- PyPy log lexer
    • 
-
  • Alain Gilbert -- TypeScript lexer
    • 
-
  • Bertrand Goetzmann -- Groovy lexer
    • 
-
  • Krzysiek Goj -- Scala lexer
    • 
-
  • Matt Good -- Genshi, Cheetah lexers
    • 
-
  • Patrick Gotthardt -- PHP namespaces support
    • 
-
  • Olivier Guibe -- Asymptote lexer
    • 
-
  • Jordi Gutiérrez Hermoso -- Octave lexer
    • 
-
  • Martin Harriman -- SNOBOL lexer
    • 
-
  • Matthew Harrison -- SVG formatter
    • 
-
  • Steven Hazel -- Tcl lexer
    • 
-
  • Aslak Hellesøy -- Gherkin lexer
    • 
-
  • Greg Hendershott -- Racket lexer
    • 
-
  • David Hess, Fish Software, Inc. -- Objective-J lexer
    • 
-
  • Varun Hiremath -- Debian control lexer
    • 
-
  • Doug Hogan -- Mscgen lexer
    • 
-
  • Ben Hollis -- Mason lexer
    • 
-
  • Alastair Houghton -- Lexer inheritance facility
    • 
-
  • Tim Howard -- BlitzMax lexer
    • 
-
  • Ivan Inozemtsev -- Fantom lexer
    • 
-
  • Brian R. Jackson -- Tea lexer
    • 
-
  • Dennis Kaarsemaker -- sources.list lexer
    • 
-
  • Igor Kalnitsky -- vhdl lexer
    • 
-
  • Pekka Klärck -- Robot Framework lexer
    • 
-
  • Eric Knibbe -- Lasso lexer
    • 
-
  • Adam Koprowski -- Opa lexer
    • 
-
  • Benjamin Kowarsch -- Modula-2 lexer
    • 
-
  • Alexander Kriegisch -- Kconfig and AspectJ lexers
    • 
-
  • Marek Kubica -- Scheme lexer
    • 
-
  • Jochen Kupperschmidt -- Markdown processor
    • 
-
  • Gerd Kurzbach -- Modelica lexer
    • 
-
  • Jon Larimer, Google Inc. -- Smali lexer
    • 
-
  • Olov Lassus -- Dart lexer
    • 
-
  • Sylvestre Ledru -- Scilab lexer
    • 
-
  • Mark Lee -- Vala lexer
    • 
-
  • Ben Mabey -- Gherkin lexer
    • 
-
  • Angus MacArthur -- QML lexer
    • 
-
  • Simone Margaritelli -- Hybris lexer
    • 
-
  • Kirk McDonald -- D lexer
    • 
-
  • Gordon McGregor -- SystemVerilog lexer
    • 
-
  • Stephen McKamey -- Duel/JBST lexer
    • 
-
  • Brian McKenna -- F# lexer
    • 
-
  • Charles McLaughlin -- Puppet lexer
    • 
-
  • Lukas Meuser -- BBCode formatter, Lua lexer
    • 
-
  • Paul Miller -- LiveScript lexer
    • 
-
  • Hong Minhee -- HTTP lexer
    • 
-
  • Michael Mior -- Awk lexer
    • 
-
  • Bruce Mitchener -- Dylan lexer rewrite
    • 
-
  • Reuben Morais -- SourcePawn lexer
    • 
-
  • Jon Morton -- Rust lexer
    • 
-
  • Paulo Moura -- Logtalk lexer
    • 
-
  • Mher Movsisyan -- DTD lexer
    • 
-
  • Ana Nelson -- Ragel, ANTLR, R console lexers
    • 
-
  • Nam T. Nguyen -- Monokai style
    • 
-
  • Jesper Noehr -- HTML formatter "anchorlinenos"
    • 
-
  • Mike Nolta -- Julia lexer
    • 
-
  • Jonas Obrist -- BBCode lexer
    • 
-
  • David Oliva -- Rebol lexer
    • 
-
  • Jon Parise -- Protocol buffers lexer
    • 
-
  • Ronny Pfannschmidt -- BBCode lexer
    • 
-
  • Benjamin Peterson -- Test suite refactoring
    • 
-
  • Dominik Picheta -- Nimrod lexer
    • 
-
  • Clément Prévost -- UrbiScript lexer
    • 
-
  • Kashif Rasul -- CUDA lexer
    • 
-
  • Justin Reidy -- MXML lexer
    • 
-
  • Norman Richards -- JSON lexer
    • 
-
  • Lubomir Rintel -- GoodData MAQL and CL lexers
    • 
-
  • Andre Roberge -- Tango style
    • 
-
  • Konrad Rudolph -- LaTeX formatter enhancements
    • 
-
  • Mario Ruggier -- Evoque lexers
    • 
-
  • Stou Sandalski -- NumPy, FORTRAN, tcsh and XSLT lexers
    • 
-
  • Matteo Sasso -- Common Lisp lexer
    • 
-
  • Joe Schafer -- Ada lexer
    • 
-
  • Ken Schutte -- Matlab lexers
    • 
-
  • Tassilo Schweyer -- Io, MOOCode lexers
    • 
-
  • Ted Shaw -- AutoIt lexer
    • 
-
  • Joerg Sieker -- ABAP lexer
    • 
-
  • Robert Simmons -- Standard ML lexer
    • 
-
  • Kirill Simonov -- YAML lexer
    • 
-
  • Alexander Smishlajev -- Visual FoxPro lexer
    • 
-
  • Steve Spigarelli -- XQuery lexer
    • 
-
  • Jerome St-Louis -- eC lexer
    • 
-
  • James Strachan -- Kotlin lexer
    • 
-
  • Tom Stuart -- Treetop lexer
    • 
-
  • Tiberius Teng -- default style overhaul
    • 
-
  • Jeremy Thurgood -- Erlang, Squid config lexers
    • 
-
  • Brian Tiffin -- OpenCOBOL lexer
    • 
-
  • Erick Tryzelaar -- Felix lexer
    • 
-
  • Daniele Varrazzo -- PostgreSQL lexers
    • 
-
  • Abe Voelker -- OpenEdge ABL lexer
    • 
-
  • Pepijn de Vos -- HTML formatter CTags support
    • 
-
  • Whitney Young -- ObjectiveC lexer
    • 
-
  • Matthias Vallentin -- Bro lexer
    • 
-
  • Nathan Weizenbaum -- Haml and Sass lexers
    • 
-
  • Dietmar Winkler -- Modelica lexer
    • 
-
  • Nils Winter -- Smalltalk lexer
    • 
-
  • Davy Wybiral -- Clojure lexer
    • 
-
  • Diego Zamboni -- CFengine3 lexer
    • 
-
  • Enrique Zamudio -- Ceylon lexer
    • 
-
  • Alex Zimin -- Nemerle lexer
    • 
-

-
Many thanks for all contributions!

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/changelog.html b/docs/build/changelog.html
deleted file mode 100644
index 0f8f603..0000000
--- a/docs/build/changelog.html
+++ /dev/null
@@ -1,930 +0,0 @@
-
-
-
-  Changelog — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Changelog

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
Issue numbers refer to the tracker at
-<http://bitbucket.org/birkenfeld/pygments-main/issues>,
-pull request numbers to the requests at
-<http://bitbucket.org/birkenfeld/pygments-main/pull-requests/merged>.

-

-
Version 1.6rc1

-
(released Jan 9, 2013)

-
    
-
  • Lexers added:
      
-
    • AspectJ (PR#90)
      • 
-
    • AutoIt (PR#122)
      • 
-
    • BUGS-like languages (PR#89)
      • 
-
    • Ceylon (PR#86)
      • 
-
    • Croc (new name for MiniD)
      • 
-
    • CUDA (PR#75)
      • 
-
    • Dg (PR#116)
      • 
-
    • IDL (PR#115)
      • 
-
    • Jags (PR#89)
      • 
-
    • Julia (PR#61)
      • 
-
    • Kconfig (#711)
      • 
-
    • Lasso (PR#95, PR#113)
      • 
-
    • LiveScript (PR#84)
      • 
-
    • Monkey (PR#117)
      • 
-
    • Mscgen (PR#80)
      • 
-
    • NSIS scripts (PR#136)
      • 
-
    • OpenCOBOL (PR#72)
      • 
-
    • QML (PR#123)
      • 
-
    • Puppet (PR#133)
      • 
-
    • Racket (PR#94)
      • 
-
    • Rdoc (PR#99)
      • 
-
    • Robot Framework (PR#137)
      • 
-
    • RPM spec files (PR#124)
      • 
-
    • Rust (PR#67)
      • 
-
    • Smali (Dalvik assembly)
      • 
-
    • SourcePawn (PR#39)
      • 
-
    • Stan (PR#89)
      • 
-
    • Treetop (PR#125)
      • 
-
    • TypeScript (PR#114)
      • 
-
    • VGL (PR#12)
      • 
-
    • Visual FoxPro (#762)
      • 
-
    • Windows Registry (#819)
      • 
-
    • Xtend (PR#68)
      • 
-
    
-
    • 
-
  • The HTML formatter now supports linking to tags using CTags files, when the
-python-ctags package is installed (PR#87).
    • 
-
  • The HTML formatter now has a "linespans" option that wraps every line in a
-<span> tag with a specific id (PR#82).
    • 
-
  • When deriving a lexer from another lexer with token definitions, definitions
-for states not in the child lexer are now inherited.  If you override a state
-in the child lexer, an "inherit" keyword has been added to insert the base
-state at that position (PR#141).
    • 
-
  • The C family lexers now inherit token definitions from a common base class,
-removing code duplication (PR#141).
    • 
-
  • Use "colorama" on Windows for console color output (PR#142).
    • 
-
  • Fix Template Haskell highlighting (PR#63).
    • 
-
  • Fix some S/R lexer errors (PR#91).
    • 
-
  • Fix a bug in the Prolog lexer with names that start with 'is' (#810).
    • 
-
  • Rewrite Dylan lexer, add Dylan LID lexer (PR#147).
    • 
-
  • Add a Java quickstart document (PR#146).
    • 
-
  • Add a "external/autopygmentize" file that can be used as .lessfilter (#802).
    • 
-

-

-

-
Version 1.5

-
(codename Zeitdilatation, released Mar 10, 2012)

-
    
-
  • Lexers added:
      
-
    • Awk (#630)
      • 
-
    • Fancy (#633)
      • 
-
    • PyPy Log
      • 
-
    • eC
      • 
-
    • Nimrod
      • 
-
    • Nemerle (#667)
      • 
-
    • F# (#353)
      • 
-
    • Groovy (#501)
      • 
-
    • PostgreSQL (#660)
      • 
-
    • DTD
      • 
-
    • Gosu (#634)
      • 
-
    • Octave (PR#22)
      • 
-
    • Standard ML (PR#14)
      • 
-
    • CFengine3 (#601)
      • 
-
    • Opa (PR#37)
      • 
-
    • HTTP sessions (PR#42)
      • 
-
    • JSON (PR#31)
      • 
-
    • SNOBOL (PR#30)
      • 
-
    • MoonScript (PR#43)
      • 
-
    • ECL (PR#29)
      • 
-
    • Urbiscript (PR#17)
      • 
-
    • OpenEdge ABL (PR#27)
      • 
-
    • SystemVerilog (PR#35)
      • 
-
    • Coq (#734)
      • 
-
    • PowerShell (#654)
      • 
-
    • Dart (#715)
      • 
-
    • Fantom (PR#36)
      • 
-
    • Bro (PR#5)
      • 
-
    • NewLISP (PR#26)
      • 
-
    • VHDL (PR#45)
      • 
-
    • Scilab (#740)
      • 
-
    • Elixir (PR#57)
      • 
-
    • Tea (PR#56)
      • 
-
    • Kotlin (PR#58)
      • 
-
    
-
    • 
-
  • Fix Python 3 terminal highlighting with pygmentize (#691).
    • 
-
  • In the LaTeX formatter, escape special &, < and > chars (#648).
    • 
-
  • In the LaTeX formatter, fix display problems for styles with token
-background colors (#670).
    • 
-
  • Enhancements to the Squid conf lexer (#664).
    • 
-
  • Several fixes to the reStructuredText lexer (#636).
    • 
-
  • Recognize methods in the ObjC lexer (#638).
    • 
-
  • Fix Lua "class" highlighting: it does not have classes (#665).
    • 
-
  • Fix degenerate regex in Scala lexer (#671) and highlighting bugs (#713, 708).
    • 
-
  • Fix number pattern order in Ocaml lexer (#647).
    • 
-
  • Fix generic type highlighting in ActionScript 3 (#666).
    • 
-
  • Fixes to the Clojure lexer (PR#9).
    • 
-
  • Fix degenerate regex in Nemerle lexer (#706).
    • 
-
  • Fix infinite looping in CoffeeScript lexer (#729).
    • 
-
  • Fix crashes and analysis with ObjectiveC lexer (#693, #696).
    • 
-
  • Add some Fortran 2003 keywords.
    • 
-
  • Fix Boo string regexes (#679).
    • 
-
  • Add "rrt" style (#727).
    • 
-
  • Fix infinite looping in Darcs Patch lexer.
    • 
-
  • Lots of misc fixes to character-eating bugs and ordering problems in many
-different lexers.
    • 
-

-

-

-
Version 1.4

-
(codename Unschärfe, released Jan 03, 2011)

-
    
-
  • Lexers added:
      
-
    • Factor (#520)
      • 
-
    • PostScript (#486)
      • 
-
    • Verilog (#491)
      • 
-
    • BlitzMax Basic (#478)
      • 
-
    • Ioke (#465)
      • 
-
    • Java properties, split out of the INI lexer (#445)
      • 
-
    • Scss (#509)
      • 
-
    • Duel/JBST
      • 
-
    • XQuery (#617)
      • 
-
    • Mason (#615)
      • 
-
    • GoodData (#609)
      • 
-
    • SSP (#473)
      • 
-
    • Autohotkey (#417)
      • 
-
    • Google Protocol Buffers
      • 
-
    • Hybris (#506)
      • 
-
    
-
    • 
-
  • Do not fail in analyse_text methods (#618).
    • 
-
  • Performance improvements in the HTML formatter (#523).
    • 
-
  • With the noclasses option in the HTML formatter, some styles
-present in the stylesheet were not added as inline styles.
    • 
-
  • Four fixes to the Lua lexer (#480, #481, #482, #497).
    • 
-
  • More context-sensitive Gherkin lexer with support for more i18n translations.
    • 
-
  • Support new OO keywords in Matlab lexer (#521).
    • 
-
  • Small fix in the CoffeeScript lexer (#519).
    • 
-
  • A bugfix for backslashes in ocaml strings (#499).
    • 
-
  • Fix unicode/raw docstrings in the Python lexer (#489).
    • 
-
  • Allow PIL to work without PIL.pth (#502).
    • 
-
  • Allow seconds as a unit in CSS (#496).
    • 
-
  • Support application/javascript as a JavaScript mime type (#504).
    • 
-
  • Support Offload C++ Extensions as
-keywords in the C++ lexer (#484).
    • 
-
  • Escape more characters in LaTeX output (#505).
    • 
-
  • Update Haml/Sass lexers to version 3 (#509).
    • 
-
  • Small PHP lexer string escaping fix (#515).
    • 
-
  • Support comments before preprocessor directives, and unsigned/
-long long literals in C/C++ (#613, #616).
    • 
-
  • Support line continuations in the INI lexer (#494).
    • 
-
  • Fix lexing of Dylan string and char literals (#628).
    • 
-
  • Fix class/procedure name highlighting in VB.NET lexer (#624).
    • 
-

-

-

-
Version 1.3.1

-
(bugfix release, released Mar 05, 2010)

-
    
-
  • The pygmentize script was missing from the distribution.
    • 
-

-

-

-
Version 1.3

-
(codename Schneeglöckchen, released Mar 01, 2010)

-
    
-
  • Added the ensurenl lexer option, which can be used to suppress the
-automatic addition of a newline to the lexer input.
    • 
-
  • Lexers added:
      
-
    • Ada
      • 
-
    • Coldfusion
      • 
-
    • Modula-2
      • 
-
    • haXe
      • 
-
    • R console
      • 
-
    • Objective-J
      • 
-
    • Haml and Sass
      • 
-
    • CoffeeScript
      • 
-
    
-
    • 
-
  • Enhanced reStructuredText highlighting.
    • 
-
  • Added support for PHP 5.3 namespaces in the PHP lexer.
    • 
-
  • Added a bash completion script for pygmentize, to the external/
-directory (#466).
    • 
-
  • Fixed a bug in do_insertions() used for multi-lexer languages.
    • 
-
  • Fixed a Ruby regex highlighting bug (#476).
    • 
-
  • Fixed regex highlighting bugs in Perl lexer (#258).
    • 
-
  • Add small enhancements to the C lexer (#467) and Bash lexer (#469).
    • 
-
  • Small fixes for the Tcl, Debian control file, Nginx config,
-Smalltalk, Objective-C, Clojure, Lua lexers.
    • 
-
  • Gherkin lexer: Fixed single apostrophe bug and added new i18n keywords.
    • 
-

-

-

-
Version 1.2.2

-
(bugfix release, released Jan 02, 2010)

-
    
-
  • Removed a backwards incompatibility in the LaTeX formatter that caused
-Sphinx to produce invalid commands when writing LaTeX output (#463).
    • 
-
  • Fixed a forever-backtracking regex in the BashLexer (#462).
    • 
-

-

-

-
Version 1.2.1

-
(bugfix release, released Jan 02, 2010)

-
    
-
  • Fixed mishandling of an ellipsis in place of the frames in a Python
-console traceback, resulting in clobbered output.
    • 
-

-

-

-
Version 1.2

-
(codename Neujahr, released Jan 01, 2010)

-
    
-
  • Dropped Python 2.3 compatibility.
    • 
-
  • Lexers added:
      
-
    • Asymptote
      • 
-
    • Go
      • 
-
    • Gherkin (Cucumber)
      • 
-
    • CMake
      • 
-
    • Ooc
      • 
-
    • Coldfusion
      • 
-
    • haXe
      • 
-
    • R console
      • 
-
    
-
    • 
-
  • Added options for rendering LaTeX in source code comments in the
-LaTeX formatter (#461).
    • 
-
  • Updated the Logtalk lexer.
    • 
-
  • Added line_number_start option to image formatter (#456).
    • 
-
  • Added hl_lines and hl_color options to image formatter (#457).
    • 
-
  • Fixed the HtmlFormatter's handling of noclasses=True to not output any
-classes (#427).
    • 
-
  • Added the Monokai style (#453).
    • 
-
  • Fixed LLVM lexer identifier syntax and added new keywords (#442).
    • 
-
  • Fixed the PythonTracebackLexer to handle non-traceback data in header or
-trailer, and support more partial tracebacks that start on line 2 (#437).
    • 
-
  • Fixed the CLexer to not highlight ternary statements as labels.
    • 
-
  • Fixed lexing of some Ruby quoting peculiarities (#460).
    • 
-
  • A few ASM lexer fixes (#450).
    • 
-

-

-

-
Version 1.1.1

-
(bugfix release, released Sep 15, 2009)

-
    
-
  • Fixed the BBCode lexer (#435).
    • 
-
  • Added support for new Jinja2 keywords.
    • 
-
  • Fixed test suite failures.
    • 
-
  • Added Gentoo-specific suffixes to Bash lexer.
    • 
-

-

-

-
Version 1.1

-
(codename Brillouin, released Sep 11, 2009)

-
    
-
  • Ported Pygments to Python 3.  This needed a few changes in the way
-encodings are handled; they may affect corner cases when used with
-Python 2 as well.
    • 
-
  • Lexers added:
      
-
    • Antlr/Ragel, thanks to Ana Nelson
      • 
-
    • (Ba)sh shell
      • 
-
    • Erlang shell
      • 
-
    • GLSL
      • 
-
    • Prolog
      • 
-
    • Evoque
      • 
-
    • Modelica
      • 
-
    • Rebol
      • 
-
    • MXML
      • 
-
    • Cython
      • 
-
    • ABAP
      • 
-
    • ASP.net (VB/C#)
      • 
-
    • Vala
      • 
-
    • Newspeak
      • 
-
    
-
    • 
-
  • Fixed the LaTeX formatter's output so that output generated for one style
-can be used with the style definitions of another (#384).
    • 
-
  • Added "anchorlinenos" and "noclobber_cssfile" (#396) options to HTML
-formatter.
    • 
-
  • Support multiline strings in Lua lexer.
    • 
-
  • Rewrite of the JavaScript lexer by Pumbaa80 to better support regular
-expression literals (#403).
    • 
-
  • When pygmentize is asked to highlight a file for which multiple lexers
-match the filename, use the analyse_text guessing engine to determine the
-winner (#355).
    • 
-
  • Fixed minor bugs in the JavaScript lexer (#383), the Matlab lexer (#378),
-the Scala lexer (#392), the INI lexer (#391), the Clojure lexer (#387)
-and the AS3 lexer (#389).
    • 
-
  • Fixed three Perl heredoc lexing bugs (#379, #400, #422).
    • 
-
  • Fixed a bug in the image formatter which misdetected lines (#380).
    • 
-
  • Fixed bugs lexing extended Ruby strings and regexes.
    • 
-
  • Fixed a bug when lexing git diffs.
    • 
-
  • Fixed a bug lexing the empty commit in the PHP lexer (#405).
    • 
-
  • Fixed a bug causing Python numbers to be mishighlighted as floats (#397).
    • 
-
  • Fixed a bug when backslashes are used in odd locations in Python (#395).
    • 
-
  • Fixed various bugs in Matlab and S-Plus lexers, thanks to Winston Chang (#410,
-#411, #413, #414) and fmarc (#419).
    • 
-
  • Fixed a bug in Haskell single-line comment detection (#426).
    • 
-
  • Added new-style reStructuredText directive for docutils 0.5+ (#428).
    • 
-

-

-

-
Version 1.0

-
(codename Dreiundzwanzig, released Nov 23, 2008)

-
    
-
  • Don't use join(splitlines()) when converting newlines to \n,
-because that doesn't keep all newlines at the end when the
-stripnl lexer option is False.
    
-
    • 
-
  • Added -N option to command-line interface to get a lexer name
-for a given filename.
    
-
    • 
-
  • Added Tango style, written by Andre Roberge for the Crunchy project.
    
-
    • 
-
  • Added Python3TracebackLexer and python3 option to
-PythonConsoleLexer.
    
-
    • 
-
  • Fixed a few bugs in the Haskell lexer.
    
-
    • 
-
  • Fixed PythonTracebackLexer to be able to recognize SyntaxError and
-KeyboardInterrupt (#360).
    
-
    • 
-
  • Provide one formatter class per image format, so that surprises like:
    
-
    -pygmentize -f gif -o foo.gif foo.py
-
    
-
    creating a PNG file are avoided.
    
-
    • 
-
  • Actually use the font_size option of the image formatter.
    
-
    • 
-
  • Fixed numpy lexer that it doesn't listen for *.py any longer.
    
-
    • 
-
  • Fixed HTML formatter so that text options can be Unicode
-strings (#371).
    
-
    • 
-
  • Unified Diff lexer supports the "udiff" alias now.
    
-
    • 
-
  • Fixed a few issues in Scala lexer (#367).
    
-
    • 
-
  • RubyConsoleLexer now supports simple prompt mode (#363).
    
-
    • 
-
  • JavascriptLexer is smarter about what constitutes a regex (#356).
    
-
    • 
-
  • Add Applescript lexer, thanks to Andreas Amann (#330).
    
-
    • 
-
  • Make the codetags more strict about matching words (#368).
    
-
    • 
-
  • NginxConfLexer is a little more accurate on mimetypes and
-variables (#370).
    
-
    • 
-

-

-

-
Version 0.11.1

-
(released Aug 24, 2008)

-
    
-
  • Fixed a Jython compatibility issue in pygments.unistring (#358).
    • 
-

-

-

-
Version 0.11

-
(codename Straußenei, released Aug 23, 2008)

-
Many thanks go to Tim Hatch for writing or integrating most of the bug
-fixes and new features.

-
    
-
  • Lexers added:
      
-
    • Nasm-style assembly language, thanks to delroth
      • 
-
    • YAML, thanks to Kirill Simonov
      • 
-
    • ActionScript 3, thanks to Pierre Bourdon
      • 
-
    • Cheetah/Spitfire templates, thanks to Matt Good
      • 
-
    • Lighttpd config files
      • 
-
    • Nginx config files
      • 
-
    • Gnuplot plotting scripts
      • 
-
    • Clojure
      • 
-
    • POV-Ray scene files
      • 
-
    • Sqlite3 interactive console sessions
      • 
-
    • Scala source files, thanks to Krzysiek Goj
      • 
-
    
-
    • 
-
  • Lexers improved:
      
-
    • C lexer highlights standard library functions now and supports C99
-types.
      • 
-
    • Bash lexer now correctly highlights heredocs without preceding
-whitespace.
      • 
-
    • Vim lexer now highlights hex colors properly and knows a couple
-more keywords.
      • 
-
    • Irc logs lexer now handles xchat's default time format (#340) and
-correctly highlights lines ending in >.
      • 
-
    • Support more delimiters for perl regular expressions (#258).
      • 
-
    • ObjectiveC lexer now supports 2.0 features.
      • 
-
    
-
    • 
-
  • Added "Visual Studio" style.
    • 
-
  • Updated markdown processor to Markdown 1.7.
    • 
-
  • Support roman/sans/mono style defs and use them in the LaTeX
-formatter.
    • 
-
  • The RawTokenFormatter is no longer registered to *.raw and it's
-documented that tokenization with this lexer may raise exceptions.
    • 
-
  • New option hl_lines to HTML formatter, to highlight certain
-lines.
    • 
-
  • New option prestyles to HTML formatter.
    • 
-
  • New option -g to pygmentize, to allow lexer guessing based on
-filetext (can be slowish, so file extensions are still checked
-first).
    • 
-
  • guess_lexer() now makes its decision much faster due to a cache
-of whether data is xml-like (a check which is used in several
-versions of analyse_text().  Several lexers also have more
-accurate analyse_text() now.
    • 
-

-

-

-
Version 0.10

-
(codename Malzeug, released May 06, 2008)

-
    
-
  • Lexers added:
      
-
    • Io
      • 
-
    • Smalltalk
      • 
-
    • Darcs patches
      • 
-
    • Tcl
      • 
-
    • Matlab
      • 
-
    • Matlab sessions
      • 
-
    • FORTRAN
      • 
-
    • XSLT
      • 
-
    • tcsh
      • 
-
    • NumPy
      • 
-
    • Python 3
      • 
-
    • S, S-plus, R statistics languages
      • 
-
    • Logtalk
      • 
-
    
-
    • 
-
  • In the LatexFormatter, the commandprefix option is now by default
-'PY' instead of 'C', since the latter resulted in several collisions
-with other packages.  Also, the special meaning of the arg
-argument to get_style_defs() was removed.
    • 
-
  • Added ImageFormatter, to format code as PNG, JPG, GIF or BMP.
-(Needs the Python Imaging Library.)
    • 
-
  • Support doc comments in the PHP lexer.
    • 
-
  • Handle format specifications in the Perl lexer.
    • 
-
  • Fix comment handling in the Batch lexer.
    • 
-
  • Add more file name extensions for the C++, INI and XML lexers.
    • 
-
  • Fixes in the IRC and MuPad lexers.
    • 
-
  • Fix function and interface name highlighting in the Java lexer.
    • 
-
  • Fix at-rule handling in the CSS lexer.
    • 
-
  • Handle KeyboardInterrupts gracefully in pygmentize.
    • 
-
  • Added BlackWhiteStyle.
    • 
-
  • Bash lexer now correctly highlights math, does not require
-whitespace after semicolons, and correctly highlights boolean
-operators.
    • 
-
  • Makefile lexer is now capable of handling BSD and GNU make syntax.
    • 
-

-

-

-
Version 0.9

-
(codename Herbstzeitlose, released Oct 14, 2007)

-
    
-
  • Lexers added:
      
-
    • Erlang
      • 
-
    • ActionScript
      • 
-
    • Literate Haskell
      • 
-
    • Common Lisp
      • 
-
    • Various assembly languages
      • 
-
    • Gettext catalogs
      • 
-
    • Squid configuration
      • 
-
    • Debian control files
      • 
-
    • MySQL-style SQL
      • 
-
    • MOOCode
      • 
-
    
-
    • 
-
  • Lexers improved:
      
-
    • Greatly improved the Haskell and OCaml lexers.
      • 
-
    • Improved the Bash lexer's handling of nested constructs.
      • 
-
    • The C# and Java lexers exhibited abysmal performance with some
-input code; this should now be fixed.
      • 
-
    • The IRC logs lexer is now able to colorize weechat logs too.
      • 
-
    • The Lua lexer now recognizes multi-line comments.
      • 
-
    • Fixed bugs in the D and MiniD lexer.
      • 
-
    
-
    • 
-
  • The encoding handling of the command line mode (pygmentize) was
-enhanced. You shouldn't get UnicodeErrors from it anymore if you
-don't give an encoding option.
    • 
-
  • Added a -P option to the command line mode which can be used to
-give options whose values contain commas or equals signs.
    • 
-
  • Added 256-color terminal formatter.
    • 
-
  • Added an experimental SVG formatter.
    • 
-
  • Added the lineanchors option to the HTML formatter, thanks to
-Ian Charnas for the idea.
    • 
-
  • Gave the line numbers table a CSS class in the HTML formatter.
    • 
-
  • Added a Vim 7-like style.
    • 
-

-

-

-
Version 0.8.1

-
(released Jun 27, 2007)

-
    
-
  • Fixed POD highlighting in the Ruby lexer.
    • 
-
  • Fixed Unicode class and namespace name highlighting in the C# lexer.
    • 
-
  • Fixed Unicode string prefix highlighting in the Python lexer.
    • 
-
  • Fixed a bug in the D and MiniD lexers.
    • 
-
  • Fixed the included MoinMoin parser.
    • 
-

-

-

-
Version 0.8

-
(codename Maikäfer, released May 30, 2007)

-
    
-
  • Lexers added:
      
-
    • Haskell, thanks to Adam Blinkinsop
      • 
-
    • Redcode, thanks to Adam Blinkinsop
      • 
-
    • D, thanks to Kirk McDonald
      • 
-
    • MuPad, thanks to Christopher Creutzig
      • 
-
    • MiniD, thanks to Jarrett Billingsley
      • 
-
    • Vim Script, by Tim Hatch
      • 
-
    
-
    • 
-
  • The HTML formatter now has a second line-numbers mode in which it
-will just integrate the numbers in the same <pre> tag as the
-code.
    • 
-
  • The CSharpLexer now is Unicode-aware, which means that it has an
-option that can be set so that it correctly lexes Unicode
-identifiers allowed by the C# specs.
    • 
-
  • Added a RaiseOnErrorTokenFilter that raises an exception when the
-lexer generates an error token, and a VisibleWhitespaceFilter that
-converts whitespace (spaces, tabs, newlines) into visible
-characters.
    • 
-
  • Fixed the do_insertions() helper function to yield correct
-indices.
    • 
-
  • The ReST lexer now automatically highlights source code blocks in
-".. sourcecode:: language" and ".. code:: language" directive
-blocks.
    • 
-
  • Improved the default style (thanks to Tiberius Teng). The old
-default is still available as the "emacs" style (which was an alias
-before).
    • 
-
  • The get_style_defs method of HTML formatters now uses the
-cssclass option as the default selector if it was given.
    • 
-
  • Improved the ReST and Bash lexers a bit.
    • 
-
  • Fixed a few bugs in the Makefile and Bash lexers, thanks to Tim
-Hatch.
    • 
-
  • Fixed a bug in the command line code that disallowed -O options
-when using the -S option.
    • 
-
  • Fixed a bug in the RawTokenFormatter.
    • 
-

-

-

-
Version 0.7.1

-
(released Feb 15, 2007)

-
    
-
  • Fixed little highlighting bugs in the Python, Java, Scheme and
-Apache Config lexers.
    • 
-
  • Updated the included manpage.
    • 
-
  • Included a built version of the documentation in the source tarball.
    • 
-

-

-

-
Version 0.7

-
(codename Faschingskrapfn, released Feb 14, 2007)

-
    
-
  • Added a MoinMoin parser that uses Pygments. With it, you get
-Pygments highlighting in Moin Wiki pages.
    • 
-
  • Changed the exception raised if no suitable lexer, formatter etc. is
-found in one of the get_*_by_* functions to a custom exception,
-pygments.util.ClassNotFound. It is, however, a subclass of
-ValueError in order to retain backwards compatibility.
    • 
-
  • Added a -H command line option which can be used to get the
-docstring of a lexer, formatter or filter.
    • 
-
  • Made the handling of lexers and formatters more consistent. The
-aliases and filename patterns of formatters are now attributes on
-them.
    • 
-
  • Added an OCaml lexer, thanks to Adam Blinkinsop.
    • 
-
  • Made the HTML formatter more flexible, and easily subclassable in
-order to make it easy to implement custom wrappers, e.g. alternate
-line number markup. See the documentation.
    • 
-
  • Added an outencoding option to all formatters, making it possible
-to override the encoding (which is used by lexers and formatters)
-when using the command line interface. Also, if using the terminal
-formatter and the output file is a terminal and has an encoding
-attribute, use it if no encoding is given.
    • 
-
  • Made it possible to just drop style modules into the styles
-subpackage of the Pygments installation.
    • 
-
  • Added a "state" keyword argument to the using helper.
    • 
-
  • Added a commandprefix option to the LatexFormatter which allows
-to control how the command names are constructed.
    • 
-
  • Added quite a few new lexers, thanks to Tim Hatch:
      
-
    • Java Server Pages
      • 
-
    • Windows batch files
      • 
-
    • Trac Wiki markup
      • 
-
    • Python tracebacks
      • 
-
    • ReStructuredText
      • 
-
    • Dylan
      • 
-
    • and the Befunge esoteric programming language (yay!)
      • 
-
    
-
    • 
-
  • Added Mako lexers by Ben Bangert.
    • 
-
  • Added "fruity" style, another dark background originally vim-based
-theme.
    • 
-
  • Added sources.list lexer by Dennis Kaarsemaker.
    • 
-
  • Added token stream filters, and a pygmentize option to use them.
    • 
-
  • Changed behavior of in Operator for tokens.
    • 
-
  • Added mimetypes for all lexers.
    • 
-
  • Fixed some problems lexing Python strings.
    • 
-
  • Fixed tickets: #167, #178, #179, #180, #185, #201.
    • 
-

-

-

-
Version 0.6

-
(codename Zimtstern, released Dec 20, 2006)

-
    
-
  • Added option for the HTML formatter to write the CSS to an external
-file in "full document" mode.
    • 
-
  • Added RTF formatter.
    • 
-
  • Added Bash and Apache configuration lexers (thanks to Tim Hatch).
    • 
-
  • Improved guessing methods for various lexers.
    • 
-
  • Added @media support to CSS lexer (thanks to Tim Hatch).
    • 
-
  • Added a Groff lexer (thanks to Tim Hatch).
    • 
-
  • License change to BSD.
    • 
-
  • Added lexers for the Myghty template language.
    • 
-
  • Added a Scheme lexer (thanks to Marek Kubica).
    • 
-
  • Added some functions to iterate over existing lexers, formatters and
-lexers.
    • 
-
  • The HtmlFormatter's get_style_defs() can now take a list as an
-argument to generate CSS with multiple prefixes.
    • 
-
  • Support for guessing input encoding added.
    • 
-
  • Encoding support added: all processing is now done with Unicode
-strings, input and output are converted from and optionally to byte
-strings (see the encoding option of lexers and formatters).
    • 
-
  • Some improvements in the C(++) lexers handling comments and line
-continuations.
    • 
-

-

-

-
Version 0.5.1

-
(released Oct 30, 2006)

-
    
-
  • Fixed traceback in pygmentize -L (thanks to Piotr Ozarowski).
    • 
-

-

-

-
Version 0.5

-
(codename PyKleur, released Oct 30, 2006)

-
    
-
  • Initial public release.
    • 
-

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/cmdline.html b/docs/build/cmdline.html
deleted file mode 100644
index 51eeed5..0000000
--- a/docs/build/cmdline.html
+++ /dev/null
@@ -1,353 +0,0 @@
-
-
-
-  Command Line Interface — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Command Line Interface

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
You can use Pygments from the shell, provided you installed the pygmentize
-script:

-
-$ pygmentize test.py
-print "Hello World"
-

-
will print the file test.py to standard output, using the Python lexer
-(inferred from the file name extension) and the terminal formatter (because
-you didn't give an explicit formatter name).

-
If you want HTML output:

-
-$ pygmentize -f html -l python -o test.html test.py
-

-
As you can see, the -l option explicitly selects a lexer. As seen above, if you
-give an input file name and it has an extension that Pygments recognizes, you can
-omit this option.

-
The -o option gives an output file name. If it is not given, output is
-written to stdout.

-
The -f option selects a formatter (as with -l, it can also be omitted
-if an output file name is given and has a supported extension).
-If no output file name is given and -f is omitted, the
-TerminalFormatter is used.

-
The above command could therefore also be given as:

-
-$ pygmentize -o test.html test.py
-

-
To create a full HTML document, including line numbers and stylesheet (using the
-"emacs" style), highlighting the Python file test.py to test.html:

-
-$ pygmentize -O full,style=emacs -o test.html test.py
-

-

-
Options and filters

-
Lexer and formatter options can be given using the -O option:

-
-$ pygmentize -f html -O style=colorful,linenos=1 -l python test.py
-

-
Be sure to enclose the option string in quotes if it contains any special shell
-characters, such as spaces or expansion wildcards like *. If an option
-expects a list value, separate the list entries with spaces (you'll have to
-quote the option value in this case too, so that the shell doesn't split it).

-
Since the -O option argument is split at commas and expects the split values
-to be of the form name=value, you can't give an option value that contains
-commas or equals signs.  Therefore, an option -P is provided (as of Pygments
-0.9) that works like -O but can only pass one option per -P. Its value
-can then contain all characters:

-
-$ pygmentize -P "heading=Pygments, the Python highlighter" ...
-

-
Filters are added to the token stream using the -F option:

-
-$ pygmentize -f html -l pascal -F keywordcase:case=upper main.pas
-

-
As you see, options for the filter are given after a colon. As for -O, the
-filter name and options must be one shell word, so there may not be any spaces
-around the colon.

-

-

-
Generating styles

-
Formatters normally don't output full style information.  For example, the HTML
-formatter by default only outputs <span> tags with class attributes.
-Therefore, there's a special -S option for generating style definitions.
-Usage is as follows:

-
-$ pygmentize -f html -S colorful -a .syntax
-

-
generates a CSS style sheet (because you selected the HTML formatter) for
-the "colorful" style prepending a ".syntax" selector to all style rules.

-
For an explanation what -a means for a particular formatter, look for
-the arg argument for the formatter's get_style_defs() method.

-

-

-
Getting lexer names

-
New in Pygments 1.0.

-
The -N option guesses a lexer name for a given filename, so that

-
-$ pygmentize -N setup.py
-

-
will print out python.  It won't highlight anything yet.  If no specific
-lexer is known for that filename, text is printed.

-

-

-
Getting help

-
The -L option lists lexers, formatters, along with their short
-names and supported file name extensions, styles and filters. If you want to see
-only one category, give it as an argument:

-
-$ pygmentize -L filters
-

-
will list only all installed filters.

-
The -H option will give you detailed information (the same that can be found
-in this documentation) about a lexer, formatter or filter. Usage is as follows:

-
-$ pygmentize -H formatter html
-

-
will print the help for the HTML formatter, while

-
-$ pygmentize -H lexer python
-

-
will print the help for the Python lexer, etc.

-

-

-
A note on encodings

-
New in Pygments 0.9.

-
Pygments tries to be smart regarding encodings in the formatting process:

-
    
-
  • If you give an encoding option, it will be used as the input and
-output encoding.
    • 
-
  • If you give an outencoding option, it will override encoding
-as the output encoding.
    • 
-
  • If you don't give an encoding and have given an output file, the default
-encoding for lexer and formatter is latin1 (which will pass through
-all non-ASCII characters).
    • 
-
  • If you don't give an encoding and haven't given an output file (that means
-output is written to the console), the default encoding for lexer and
-formatter is the terminal encoding (sys.stdout.encoding).
    • 
-

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/filterdevelopment.html b/docs/build/filterdevelopment.html
deleted file mode 100644
index 25ffa59..0000000
--- a/docs/build/filterdevelopment.html
+++ /dev/null
@@ -1,282 +0,0 @@
-
-
-
-  Write your own filter — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Write your own filter

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
New in Pygments 0.7.

-
Writing own filters is very easy. All you have to do is to subclass
-the Filter class and override the filter method. Additionally a
-filter is instanciated with some keyword arguments you can use to
-adjust the behavior of your filter.

-

-
Subclassing Filters

-
As an example, we write a filter that converts all Name.Function tokens
-to normal Name tokens to make the output less colorful.

-
from pygments.util import get_bool_opt
-from pygments.token import Name
-from pygments.filter import Filter
-
-class UncolorFilter(Filter):
-
-    def __init__(self, **options):
-        Filter.__init__(self, **options)
-        self.class_too = get_bool_opt(options, 'classtoo')
-
-    def filter(self, lexer, stream):
-        for ttype, value in stream:
-            if ttype is Name.Function or (self.class_too and
-                                          ttype is Name.Class):
-                ttype = Name
-            yield ttype, value
-

-
Some notes on the lexer argument: that can be quite confusing since it doesn't
-need to be a lexer instance. If a filter was added by using the add_filter()
-function of lexers, that lexer is registered for the filter. In that case
-lexer will refer to the lexer that has registered the filter. It can be used
-to access options passed to a lexer. Because it could be None you always have
-to check for that case if you access it.

-

-

-
Using a decorator

-
You can also use the simplefilter decorator from the pygments.filter module:

-
from pygments.util import get_bool_opt
-from pygments.token import Name
-from pygments.filter import simplefilter
-
-
-@simplefilter
-def uncolor(lexer, stream, options):
-    class_too = get_bool_opt(options, 'classtoo')
-    for ttype, value in stream:
-        if ttype is Name.Function or (class_too and
-                                      ttype is Name.Class):
-            ttype = Name
-        yield ttype, value
-

-
The decorator automatically subclasses an internal filter class and uses the
-decorated function for filtering.

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/filters.html b/docs/build/filters.html
deleted file mode 100644
index bf1c9f5..0000000
--- a/docs/build/filters.html
+++ /dev/null
@@ -1,412 +0,0 @@
-
-
-
-  Filters — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Filters

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
New in Pygments 0.7.

-
You can filter token streams coming from lexers to improve or annotate the
-output. For example, you can highlight special words in comments, convert
-keywords to upper or lowercase to enforce a style guide etc.

-
To apply a filter, you can use the add_filter() method of a lexer:

-
>>> from pygments.lexers import PythonLexer
->>> l = PythonLexer()
->>> # add a filter given by a string and options
->>> l.add_filter('codetagify', case='lower')
->>> l.filters
-[<pygments.filters.CodeTagFilter object at 0xb785decc>]
->>> from pygments.filters import KeywordCaseFilter
->>> # or give an instance
->>> l.add_filter(KeywordCaseFilter(case='lower'))
-

-
The add_filter() method takes keyword arguments which are forwarded to
-the constructor of the filter.

-
To get a list of all registered filters by name, you can use the
-get_all_filters() function from the pygments.filters module that returns an
-iterable for all known filters.

-
If you want to write your own filter, have a look at Write your own filter.

-

-
Builtin Filters

-
RaiseOnErrorTokenFilter

-

-
Raise an exception when the lexer generates an error token.

-
Options accepted:

-

-
excclass : Exception class

-
The exception class to raise.
-The default is pygments.filters.ErrorToken.

-

-
New in Pygments 0.8.

-
---
-
-
-
-



Name:raiseonerror

-

-
VisibleWhitespaceFilter

-

-
Convert tabs, newlines and/or spaces to visible characters.

-
Options accepted:

-

-
spaces : string or bool

-
If this is a one-character string, spaces will be replaces by this string.
-If it is another true value, spaces will be replaced by · (unicode
-MIDDLE DOT).  If it is a false value, spaces will not be replaced.  The
-default is False.

-
tabs : string or bool

-
The same as for spaces, but the default replacement character is »
-(unicode RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK).  The default value
-is False.  Note: this will not work if the tabsize option for the
-lexer is nonzero, as tabs will already have been expanded then.

-
tabsize : int

-
If tabs are to be replaced by this filter (see the tabs option), this
-is the total number of characters that a tab should be expanded to.
-The default is 8.

-
newlines : string or bool

-
The same as for spaces, but the default replacement character is ¶
-(unicode PILCROW SIGN).  The default value is False.

-
wstokentype : bool

-
If true, give whitespace the special Whitespace token type.  This allows
-styling the visible whitespace differently (e.g. greyed out), but it can
-disrupt background colors.  The default is True.

-

-
New in Pygments 0.8.

-
---
-
-
-
-



Name:whitespace

-

-
TokenMergeFilter

-

-
Merges consecutive tokens with the same token type in the output stream of a
-lexer.

-
New in Pygments 1.2.

-
---
-
-
-
-



Name:tokenmerge

-

-
NameHighlightFilter

-

-
Highlight a normal Name token with a different token type.

-
Example:

-
-filter = NameHighlightFilter(
-    names=['foo', 'bar', 'baz'],
-    tokentype=Name.Function,
-)
-

-
This would highlight the names "foo", "bar" and "baz"
-as functions. Name.Function is the default token type.

-
Options accepted:

-

-
names : list of strings

-
A list of names that should be given the different token type.
-There is no default.

-
tokentype : TokenType or string

-
A token type or a string containing a token type name that is
-used for highlighting the strings in names.  The default is
-Name.Function.

-

-
---
-
-
-
-



Name:highlight

-

-
GobbleFilter

-

-
Gobbles source code lines (eats initial characters).

-
This filter drops the first n characters off every line of code.  This
-may be useful when the source code fed to the lexer is indented by a fixed
-amount of space that isn't desired in the output.

-
Options accepted:

-

-
n : int

-
The number of characters to gobble.

-

-
New in Pygments 1.2.

-
---
-
-
-
-



Name:gobble

-

-
CodeTagFilter

-

-
Highlight special code tags in comments and docstrings.

-
Options accepted:

-

-
codetags : list of strings

-
A list of strings that are flagged as code tags.  The default is to
-highlight XXX, TODO, BUG and NOTE.

-

-
---
-
-
-
-



Name:codetagify

-

-
KeywordCaseFilter

-

-
Convert keywords to lowercase or uppercase or capitalize them, which
-means first letter uppercase, rest lowercase.

-
This can be useful e.g. if you highlight Pascal code and want to adapt the
-code to your styleguide.

-
Options accepted:

-

-
case : string

-
The casing to convert keywords to. Must be one of 'lower',
-'upper' or 'capitalize'.  The default is 'lower'.

-

-
---
-
-
-
-



Name:keywordcase

-

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/formatterdevelopment.html b/docs/build/formatterdevelopment.html
deleted file mode 100644
index 1485dd1..0000000
--- a/docs/build/formatterdevelopment.html
+++ /dev/null
@@ -1,374 +0,0 @@
-
-
-
-  Write your own formatter — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Write your own formatter

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
As well as creating your own lexer, writing a new
-formatter for Pygments is easy and straightforward.

-
A formatter is a class that is initialized with some keyword arguments (the
-formatter options) and that must provides a format() method.
-Additionally a formatter should provide a get_style_defs() method that
-returns the style definitions from the style in a form usable for the
-formatter's output format.

-

-
Quickstart

-
The most basic formatter shipped with Pygments is the NullFormatter. It just
-sends the value of a token to the output stream:

-
from pygments.formatter import Formatter
-
-class NullFormatter(Formatter):
-    def format(self, tokensource, outfile):
-        for ttype, value in tokensource:
-            outfile.write(value)
-

-
As you can see, the format() method is passed two parameters: tokensource
-and outfile. The first is an iterable of (token_type, value) tuples,
-the latter a file like object with a write() method.

-
Because the formatter is that basic it doesn't overwrite the get_style_defs()
-method.

-

-

-
Styles

-
Styles aren't instantiated but their metaclass provides some class functions
-so that you can access the style definitions easily.

-
Styles are iterable and yield tuples in the form (ttype, d) where ttype
-is a token and d is a dict with the following keys:

-

-
'color'

-
Hexadecimal color value (eg: 'ff0000' for red) or None if not
-defined.

-
'bold'

-
True if the value should be bold

-
'italic'

-
True if the value should be italic

-
'underline'

-
True if the value should be underlined

-
'bgcolor'

-
Hexadecimal color value for the background (eg: 'eeeeeee' for light
-gray) or None if not defined.

-
'border'

-
Hexadecimal color value for the border (eg: '0000aa' for a dark
-blue) or None for no border.

-

-
Additional keys might appear in the future, formatters should ignore all keys
-they don't support.

-

-

-
HTML 3.2 Formatter

-
For an more complex example, let's implement a HTML 3.2 Formatter. We don't
-use CSS but inline markup (<u>, <font>, etc). Because this isn't good
-style this formatter isn't in the standard library ;-)

-
from pygments.formatter import Formatter
-
-class OldHtmlFormatter(Formatter):
-
-    def __init__(self, **options):
-        Formatter.__init__(self, **options)
-
-        # create a dict of (start, end) tuples that wrap the
-        # value of a token so that we can use it in the format
-        # method later
-        self.styles = {}
-
-        # we iterate over the `_styles` attribute of a style item
-        # that contains the parsed style values.
-        for token, style in self.style:
-            start = end = ''
-            # a style item is a tuple in the following form:
-            # colors are readily specified in hex: 'RRGGBB'
-            if style['color']:
-                start += '<font color="#%s">' % style['color']
-                end = '</font>' + end
-            if style['bold']:
-                start += '<b>'
-                end = '</b>' + end
-            if style['italic']:
-                start += '<i>'
-                end = '</i>' + end
-            if style['underline']:
-                start += '<u>'
-                end = '</u>' + end
-            self.styles[token] = (start, end)
-
-    def format(self, tokensource, outfile):
-        # lastval is a string we use for caching
-        # because it's possible that an lexer yields a number
-        # of consecutive tokens with the same token type.
-        # to minimize the size of the generated html markup we
-        # try to join the values of same-type tokens here
-        lastval = ''
-        lasttype = None
-
-        # wrap the whole output with <pre>
-        outfile.write('<pre>')
-
-        for ttype, value in tokensource:
-            # if the token type doesn't exist in the stylemap
-            # we try it with the parent of the token type
-            # eg: parent of Token.Literal.String.Double is
-            # Token.Literal.String
-            while ttype not in self.styles:
-                ttype = ttype.parent
-            if ttype == lasttype:
-                # the current token type is the same of the last
-                # iteration. cache it
-                lastval += value
-            else:
-                # not the same token as last iteration, but we
-                # have some data in the buffer. wrap it with the
-                # defined style and write it to the output file
-                if lastval:
-                    stylebegin, styleend = self.styles[lasttype]
-                    outfile.write(stylebegin + lastval + styleend)
-                # set lastval/lasttype to current values
-                lastval = value
-                lasttype = ttype
-
-        # if something is left in the buffer, write it to the
-        # output file, then close the opened <pre> tag
-        if lastval:
-            stylebegin, styleend = self.styles[lasttype]
-            outfile.write(stylebegin + lastval + styleend)
-        outfile.write('</pre>\n')
-

-
The comments should explain it. Again, this formatter doesn't override the
-get_style_defs() method. If we would have used CSS classes instead of
-inline HTML markup, we would need to generate the CSS first. For that
-purpose the get_style_defs() method exists:

-

-

-
Generating Style Definitions

-
Some formatters like the LatexFormatter and the HtmlFormatter don't
-output inline markup but reference either macros or css classes. Because
-the definitions of those are not part of the output, the get_style_defs()
-method exists. It is passed one parameter (if it's used and how it's used
-is up to the formatter) and has to return a string or None.

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/formatters.html b/docs/build/formatters.html
deleted file mode 100644
index 02bfa5c..0000000
--- a/docs/build/formatters.html
+++ /dev/null
@@ -1,927 +0,0 @@
-
-
-
-  Available formatters — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Available formatters

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
This page lists all builtin formatters.

-

-
Common options

-
All formatters support these options:

-

-
encoding

-
New in Pygments 0.6.

-
If given, must be an encoding name (such as "utf-8"). This will
-be used to convert the token strings (which are Unicode strings)
-to byte strings in the output (default: None).
-It will also be written in an encoding declaration suitable for the
-document format if the full option is given (e.g. a meta
-content-type directive in HTML or an invocation of the inputenc
-package in LaTeX).

-
If this is "" or None, Unicode strings will be written
-to the output file, which most file-like objects do not support.
-For example, pygments.highlight() will return a Unicode string if
-called with no outfile argument and a formatter that has encoding
-set to None because it uses a StringIO.StringIO object that
-supports Unicode arguments to write(). Using a regular file object
-wouldn't work.

-

-
outencoding

-
New in Pygments 0.7.

-
When using Pygments from the command line, any encoding option given is
-passed to the lexer and the formatter. This is sometimes not desirable,
-for example if you want to set the input encoding to "guess".
-Therefore, outencoding has been introduced which overrides encoding
-for the formatter if given.

-

-

-

-

-
Formatter classes

-
All these classes are importable from pygments.formatters.

-

-
BBCodeFormatter

-

-
Format tokens with BBcodes. These formatting codes are used by many
-bulletin boards, so you can highlight your sourcecode with pygments before
-posting it there.

-
This formatter has no support for background colors and borders, as there
-are no common BBcode tags for that.

-
Some board systems (e.g. phpBB) don't support colors in their [code] tag,
-so you can't use the highlighting together with that tag.
-Text in a [code] tag usually is shown with a monospace font (which this
-formatter can do with the monofont option) and no spaces (which you
-need for indentation) are removed.

-
Additional options accepted:

-

-
style

-
The style to use, can be a string or a Style subclass (default:
-'default').

-
codetag

-
If set to true, put the output into [code] tags (default:
-false)

-
monofont

-
If set to true, add a tag to show the code with a monospace font
-(default: false).

-

-
---
-
-
-
-
-
-



Short names:bbcode, bb
Filename patterns:None

-

-

-

-
BmpImageFormatter

-

-
Create a bitmap image from source code. This uses the Python Imaging Library to
-generate a pixmap from the source code.

-
New in Pygments 1.0. (You could create bitmap images before by passing a
-suitable image_format option to the ImageFormatter.)

-
---
-
-
-
-
-
-



Short names:bmp, bitmap
Filename patterns:*.bmp

-

-

-

-
GifImageFormatter

-

-
Create a GIF image from source code. This uses the Python Imaging Library to
-generate a pixmap from the source code.

-
New in Pygments 1.0. (You could create GIF images before by passing a
-suitable image_format option to the ImageFormatter.)

-
---
-
-
-
-
-
-



Short names:gif
Filename patterns:*.gif

-

-

-

-
HtmlFormatter

-

-
Format tokens as HTML 4 <span> tags within a <pre> tag, wrapped
-in a <div> tag. The <div>'s CSS class can be set by the cssclass
-option.

-
If the linenos option is set to "table", the <pre> is
-additionally wrapped inside a <table> which has one row and two
-cells: one containing the line numbers and one containing the code.
-Example:

-
<div class="highlight" >
-<table><tr>
-  <td class="linenos" title="click to toggle"
-    onclick="with (this.firstChild.style)
-             { display = (display == '') ? 'none' : '' }">
-    <pre>1
-    2</pre>
-  </td>
-  <td class="code">
-    <pre><span class="Ke">def </span><span class="NaFu">foo</span>(bar):
-      <span class="Ke">pass</span>
-    </pre>
-  </td>
-</tr></table></div>
-

-
(whitespace added to improve clarity).

-
Wrapping can be disabled using the nowrap option.

-
A list of lines can be specified using the hl_lines option to make these
-lines highlighted (as of Pygments 0.11).

-
With the full option, a complete HTML 4 document is output, including
-the style definitions inside a <style> tag, or in a separate file if
-the cssfile option is given.

-
When tagsfile is set to the path of a ctags index file, it is used to
-generate hyperlinks from names to their definition.  You must enable
-anchorlines and run ctags with the -n option for this to work.  The
-python-ctags module from PyPI must be installed to use this feature;
-otherwise a RuntimeError will be raised.

-
The get_style_defs(arg='') method of a HtmlFormatter returns a string
-containing CSS rules for the CSS classes used by the formatter. The
-argument arg can be used to specify additional CSS selectors that
-are prepended to the classes. A call fmter.get_style_defs('td .code')
-would result in the following CSS classes:

-
td .code .kw { font-weight: bold; color: #00FF00 }
-td .code .cm { color: #999999 }
-...
-

-
If you have Pygments 0.6 or higher, you can also pass a list or tuple to the
-get_style_defs() method to request multiple prefixes for the tokens:

-
formatter.get_style_defs(['div.syntax pre', 'pre.syntax'])
-

-
The output would then look like this:

-
div.syntax pre .kw,
-pre.syntax .kw { font-weight: bold; color: #00FF00 }
-div.syntax pre .cm,
-pre.syntax .cm { color: #999999 }
-...
-

-
Additional options accepted:

-

-
nowrap

-
If set to True, don't wrap the tokens at all, not even inside a <pre>
-tag. This disables most other options (default: False).

-
full

-
Tells the formatter to output a "full" document, i.e. a complete
-self-contained document (default: False).

-
title

-
If full is true, the title that should be used to caption the
-document (default: '').

-
style

-
The style to use, can be a string or a Style subclass (default:
-'default'). This option has no effect if the cssfile
-and noclobber_cssfile option are given and the file specified in
-cssfile exists.

-
noclasses

-
If set to true, token <span> tags will not use CSS classes, but
-inline styles. This is not recommended for larger pieces of code since
-it increases output size by quite a bit (default: False).

-
classprefix

-
Since the token types use relatively short class names, they may clash
-with some of your own class names. In this case you can use the
-classprefix option to give a string to prepend to all Pygments-generated
-CSS class names for token types.
-Note that this option also affects the output of get_style_defs().

-
cssclass

-
CSS class for the wrapping <div> tag (default: 'highlight').
-If you set this option, the default selector for get_style_defs()
-will be this class.

-
New in Pygments 0.9: If you select the 'table' line numbers, the
-wrapping table will have a CSS class of this string plus 'table',
-the default is accordingly 'highlighttable'.

-

-
cssstyles

-
Inline CSS styles for the wrapping <div> tag (default: '').

-
prestyles

-
Inline CSS styles for the <pre> tag (default: '').  New in
-Pygments 0.11.

-
cssfile

-
If the full option is true and this option is given, it must be the
-name of an external file. If the filename does not include an absolute
-path, the file's path will be assumed to be relative to the main output
-file's path, if the latter can be found. The stylesheet is then written
-to this file instead of the HTML file. New in Pygments 0.6.

-
noclobber_cssfile

-
If cssfile is given and the specified file exists, the css file will
-not be overwritten. This allows the use of the full option in
-combination with a user specified css file. Default is False.
-New in Pygments 1.1.

-
linenos

-
If set to 'table', output line numbers as a table with two cells,
-one containing the line numbers, the other the whole code.  This is
-copy-and-paste-friendly, but may cause alignment problems with some
-browsers or fonts.  If set to 'inline', the line numbers will be
-integrated in the <pre> tag that contains the code (that setting
-is new in Pygments 0.8).

-
For compatibility with Pygments 0.7 and earlier, every true value
-except 'inline' means the same as 'table' (in particular, that
-means also True).

-
The default value is False, which means no line numbers at all.

-
Note: with the default ("table") line number mechanism, the line
-numbers and code can have different line heights in Internet Explorer
-unless you give the enclosing <pre> tags an explicit line-height
-CSS property (you get the default line spacing with line-height:
-125%).

-

-
hl_lines

-
Specify a list of lines to be highlighted.  New in Pygments 0.11.

-
linenostart

-
The line number for the first line (default: 1).

-
linenostep

-
If set to a number n > 1, only every nth line number is printed.

-
linenospecial

-
If set to a number n > 0, every nth line number is given the CSS
-class "special" (default: 0).

-
nobackground

-
If set to True, the formatter won't output the background color
-for the wrapping element (this automatically defaults to False
-when there is no wrapping element [eg: no argument for the
-get_syntax_defs method given]) (default: False). New in
-Pygments 0.6.

-
lineseparator

-
This string is output between lines of code. It defaults to "\n",
-which is enough to break a line inside <pre> tags, but you can
-e.g. set it to "<br>" to get HTML line breaks. New in Pygments
-0.7.

-
lineanchors

-
If set to a nonempty string, e.g. foo, the formatter will wrap each
-output line in an anchor tag with a name of foo-linenumber.
-This allows easy linking to certain lines. New in Pygments 0.9.

-
linespans

-
If set to a nonempty string, e.g. foo, the formatter will wrap each
-output line in a span tag with an id of foo-linenumber.
-This allows easy access to lines via javascript. New in Pygments 1.6.

-
anchorlinenos

-
If set to True, will wrap line numbers in <a> tags. Used in
-combination with linenos and lineanchors.

-
tagsfile

-
If set to the path of a ctags file, wrap names in anchor tags that
-link to their definitions. lineanchors should be used, and the
-tags file should specify line numbers (see the -n option to ctags).
-New in Pygments 1.6.

-
tagurlformat

-
A string formatting pattern used to generate links to ctags definitions.
-Avaliabe variable are %(path)s, %(fname)s and %(fext)s.
-Defaults to an empty string, resulting in just #prefix-number links.
-New in Pygments 1.6.

-

-
Subclassing the HTML formatter

-
New in Pygments 0.7.

-
The HTML formatter is now built in a way that allows easy subclassing, thus
-customizing the output HTML code. The format() method calls
-self._format_lines() which returns a generator that yields tuples of (1,
-line), where the 1 indicates that the line is a line of the
-formatted source code.

-
If the nowrap option is set, the generator is the iterated over and the
-resulting HTML is output.

-
Otherwise, format() calls self.wrap(), which wraps the generator with
-other generators. These may add some HTML code to the one generated by
-_format_lines(), either by modifying the lines generated by the latter,
-then yielding them again with (1, line), and/or by yielding other HTML
-code before or after the lines, with (0, html). The distinction between
-source lines and other code makes it possible to wrap the generator multiple
-times.

-
The default wrap() implementation adds a <div> and a <pre> tag.

-
A custom HtmlFormatter subclass could look like this:

-
class CodeHtmlFormatter(HtmlFormatter):
-
-    def wrap(self, source, outfile):
-        return self._wrap_code(source)
-
-    def _wrap_code(self, source):
-        yield 0, '<code>'
-        for i, t in source:
-            if i == 1:
-                # it's a line of formatted code
-                t += '<br>'
-            yield i, t
-        yield 0, '</code>'
-

-
This results in wrapping the formatted lines with a <code> tag, where the
-source lines are broken using <br> tags.

-
After calling wrap(), the format() method also adds the "line numbers"
-and/or "full document" wrappers if the respective options are set. Then, all
-HTML yielded by the wrapped generator is output.

-
---
-
-
-
-
-
-



Short names:html
Filename patterns:*.html, *.htm

-

-

-

-
ImageFormatter

-

-
Create a PNG image from source code. This uses the Python Imaging Library to
-generate a pixmap from the source code.

-
New in Pygments 0.10.

-
Additional options accepted:

-

-
image_format

-
An image format to output to that is recognised by PIL, these include:

-
    
-
  • "PNG" (default)
    • 
-
  • "JPEG"
    • 
-
  • "BMP"
    • 
-
  • "GIF"
    • 
-

-

-
line_pad

-
The extra spacing (in pixels) between each line of text.

-
Default: 2

-

-
font_name

-
The font name to be used as the base font from which others, such as
-bold and italic fonts will be generated.  This really should be a
-monospace font to look sane.

-
Default: "Bitstream Vera Sans Mono"

-

-
font_size

-
The font size in points to be used.

-
Default: 14

-

-
image_pad

-
The padding, in pixels to be used at each edge of the resulting image.

-
Default: 10

-

-
line_numbers

-
Whether line numbers should be shown: True/False

-
Default: True

-

-
line_number_start

-
The line number of the first line.

-
Default: 1

-

-
line_number_step

-
The step used when printing line numbers.

-
Default: 1

-

-
line_number_bg

-
The background colour (in "#123456" format) of the line number bar, or
-None to use the style background color.

-
Default: "#eed"

-

-
line_number_fg

-
The text color of the line numbers (in "#123456"-like format).

-
Default: "#886"

-

-
line_number_chars

-
The number of columns of line numbers allowable in the line number
-margin.

-
Default: 2

-

-
line_number_bold

-
Whether line numbers will be bold: True/False

-
Default: False

-

-
line_number_italic

-
Whether line numbers will be italicized: True/False

-
Default: False

-

-
line_number_separator

-
Whether a line will be drawn between the line number area and the
-source code area: True/False

-
Default: True

-

-
line_number_pad

-
The horizontal padding (in pixels) between the line number margin, and
-the source code area.

-
Default: 6

-

-
hl_lines

-
Specify a list of lines to be highlighted.  New in Pygments 1.2.

-
Default: empty list

-

-
hl_color

-
Specify the color for highlighting lines.  New in Pygments 1.2.

-
Default: highlight color of the selected style

-

-

-
---
-
-
-
-
-
-



Short names:img, IMG, png
Filename patterns:*.png

-

-

-

-
JpgImageFormatter

-

-
Create a JPEG image from source code. This uses the Python Imaging Library to
-generate a pixmap from the source code.

-
New in Pygments 1.0. (You could create JPEG images before by passing a
-suitable image_format option to the ImageFormatter.)

-
---
-
-
-
-
-
-



Short names:jpg, jpeg
Filename patterns:*.jpg

-

-

-

-
LatexFormatter

-

-
Format tokens as LaTeX code. This needs the fancyvrb and color
-standard packages.

-
Without the full option, code is formatted as one Verbatim
-environment, like this:

-
\begin{Verbatim}[commandchars=\\{\}]
-\PY{k}{def }\PY{n+nf}{foo}(\PY{n}{bar}):
-    \PY{k}{pass}
-\end{Verbatim}
-

-
The special command used here (\PY) and all the other macros it needs
-are output by the get_style_defs method.

-
With the full option, a complete LaTeX document is output, including
-the command definitions in the preamble.

-
The get_style_defs() method of a LatexFormatter returns a string
-containing \def commands defining the macros needed inside the
-Verbatim environments.

-
Additional options accepted:

-

-
style

-
The style to use, can be a string or a Style subclass (default:
-'default').

-
full

-
Tells the formatter to output a "full" document, i.e. a complete
-self-contained document (default: False).

-
title

-
If full is true, the title that should be used to caption the
-document (default: '').

-
docclass

-
If the full option is enabled, this is the document class to use
-(default: 'article').

-
preamble

-
If the full option is enabled, this can be further preamble commands,
-e.g. \usepackage (default: '').

-
linenos

-
If set to True, output line numbers (default: False).

-
linenostart

-
The line number for the first line (default: 1).

-
linenostep

-
If set to a number n > 1, only every nth line number is printed.

-
verboptions

-
Additional options given to the Verbatim environment (see the fancyvrb
-docs for possible values) (default: '').

-
commandprefix

-
The LaTeX commands used to produce colored output are constructed
-using this prefix and some letters (default: 'PY').
-New in Pygments 0.7.

-
New in Pygments 0.10: the default is now 'PY' instead of 'C'.

-

-
texcomments

-
If set to True, enables LaTeX comment lines.  That is, LaTex markup
-in comment tokens is not escaped so that LaTeX can render it (default:
-False).  New in Pygments 1.2.

-
mathescape

-
If set to True, enables LaTeX math mode escape in comments. That
-is, '$...$' inside a comment will trigger math mode (default:
-False).  New in Pygments 1.2.

-

-
---
-
-
-
-
-
-



Short names:latex, tex
Filename patterns:*.tex

-

-

-

-
NullFormatter

-

-
Output the text unchanged without any formatting.

-
---
-
-
-
-
-
-



Short names:text, null
Filename patterns:*.txt

-

-

-

-
RawTokenFormatter

-

-
Format tokens as a raw representation for storing token streams.

-
The format is tokentype<TAB>repr(tokenstring)\n. The output can later
-be converted to a token stream with the RawTokenLexer, described in the
-lexer list.

-
Only two options are accepted:

-

-
compress

-
If set to 'gz' or 'bz2', compress the output with the given
-compression algorithm after encoding (default: '').

-
error_color

-
If set to a color name, highlight error tokens using that color.  If
-set but with no value, defaults to 'red'.
-New in Pygments 0.11.

-

-
---
-
-
-
-
-
-



Short names:raw, tokens
Filename patterns:*.raw

-

-

-

-
RtfFormatter

-

-
Format tokens as RTF markup. This formatter automatically outputs full RTF
-documents with color information and other useful stuff. Perfect for Copy and
-Paste into Microsoft® Word® documents.

-
New in Pygments 0.6.

-
Additional options accepted:

-

-
style

-
The style to use, can be a string or a Style subclass (default:
-'default').

-
fontface

-
The used font famliy, for example Bitstream Vera Sans. Defaults to
-some generic font which is supposed to have fixed width.

-

-
---
-
-
-
-
-
-



Short names:rtf
Filename patterns:*.rtf

-

-

-

-
SvgFormatter

-

-
Format tokens as an SVG graphics file.  This formatter is still experimental.
-Each line of code is a <text> element with explicit x and y
-coordinates containing <tspan> elements with the individual token styles.

-
By default, this formatter outputs a full SVG document including doctype
-declaration and the <svg> root element.

-
New in Pygments 0.9.

-
Additional options accepted:

-

-
nowrap

-
Don't wrap the SVG <text> elements in <svg><g> elements and
-don't add a XML declaration and a doctype.  If true, the fontfamily
-and fontsize options are ignored.  Defaults to False.

-
fontfamily

-
The value to give the wrapping <g> element's font-family
-attribute, defaults to "monospace".

-
fontsize

-
The value to give the wrapping <g> element's font-size
-attribute, defaults to "14px".

-
xoffset

-
Starting offset in X direction, defaults to 0.

-
yoffset

-
Starting offset in Y direction, defaults to the font size if it is given
-in pixels, or 20 else.  (This is necessary since text coordinates
-refer to the text baseline, not the top edge.)

-
ystep

-
Offset to add to the Y coordinate for each subsequent line.  This should
-roughly be the text size plus 5.  It defaults to that value if the text
-size is given in pixels, or 25 else.

-
spacehack

-
Convert spaces in the source to &#160;, which are non-breaking
-spaces.  SVG provides the xml:space attribute to control how
-whitespace inside tags is handled, in theory, the preserve value
-could be used to keep all whitespace as-is.  However, many current SVG
-viewers don't obey that rule, so this option is provided as a workaround
-and defaults to True.

-

-
---
-
-
-
-
-
-



Short names:svg
Filename patterns:*.svg

-

-

-

-
Terminal256Formatter

-

-
Format tokens with ANSI color sequences, for output in a 256-color
-terminal or console. Like in TerminalFormatter color sequences
-are terminated at newlines, so that paging the output works correctly.

-
The formatter takes colors from a style defined by the style option
-and converts them to nearest ANSI 256-color escape sequences. Bold and
-underline attributes from the style are preserved (and displayed).

-
New in Pygments 0.9.

-
Options accepted:

-

-
style

-
The style to use, can be a string or a Style subclass (default:
-'default').

-

-
---
-
-
-
-
-
-



Short names:terminal256, console256, 256
Filename patterns:None

-

-

-

-
TerminalFormatter

-

-
Format tokens with ANSI color sequences, for output in a text console.
-Color sequences are terminated at newlines, so that paging the output
-works correctly.

-
The get_style_defs() method doesn't do anything special since there is
-no support for common styles.

-
Options accepted:

-

-
bg

-
Set to "light" or "dark" depending on the terminal's background
-(default: "light").

-
colorscheme

-
A dictionary mapping token types to (lightbg, darkbg) color names or
-None (default: None = use builtin colorscheme).

-

-
---
-
-
-
-
-
-



Short names:terminal, console
Filename patterns:None

-

-

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/index.html b/docs/build/index.html
deleted file mode 100644
index 6ab5fd9..0000000
--- a/docs/build/index.html
+++ /dev/null
@@ -1,261 +0,0 @@
-
-
-
-  Overview — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Overview

-    
-    
-    
-
Welcome to the Pygments documentation.

-
-

-
If you find bugs or have suggestions for the documentation, please
-look here for info on how to contact the team.

-
You can download an offline version of this documentation from the
-download page.

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/installation.html b/docs/build/installation.html
deleted file mode 100644
index 6c32f77..0000000
--- a/docs/build/installation.html
+++ /dev/null
@@ -1,281 +0,0 @@
-
-
-
-  Installation — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Installation

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
Pygments requires at least Python 2.4 to work correctly. Just to clarify:
-there won't ever be support for Python versions below 2.4. However, there
-are no other dependencies.

-

-
Installing a released version

-

-
As a Python egg (via easy_install)

-
You can install the most recent Pygments version using easy_install:

-
-sudo easy_install Pygments
-

-
This will install a Pygments egg in your Python installation's site-packages
-directory.

-

-

-
From the tarball release

-
    
-
  1. Download the most recent tarball from the download page
    2. 
-
  2. Unpack the tarball
    3. 
-
  3. sudo python setup.py install
    4. 
-

-
Note that the last command will automatically download and install
-setuptools if you don't already have it installed. This requires a working
-internet connection.

-
This will install Pygments into your Python installation's site-packages directory.

-

-

-

-
Installing the development version

-

-
If you want to play around with the code

-
    
-
  1. Install Mercurial
    2. 
-
  2. hg clone http://bitbucket.org/birkenfeld/pygments-main pygments
    3. 
-
  3. cd pygments
    4. 
-
  4. ln -s pygments /usr/lib/python2.X/site-packages
    5. 
-
  5. ln -s pygmentize /usr/local/bin
    6. 
-

-
As an alternative to steps 4 and 5 you can also do python setup.py develop
-which will install the package via setuptools in development mode.

-
-

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/integrate.html b/docs/build/integrate.html
deleted file mode 100644
index 3b7ddc7..0000000
--- a/docs/build/integrate.html
+++ /dev/null
@@ -1,268 +0,0 @@
-
-
-
-  Using Pygments in various scenarios — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Using Pygments in various scenarios

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-

-
PyGtk

-
Armin has written a piece of sample code that shows how to create a Gtk
-TextBuffer object containing Pygments-highlighted text.

-
See the article here: http://lucumr.pocoo.org/cogitations/2007/05/30/pygments-gtk-rendering/

-

-

-
Wordpress

-
He also has a snippet that shows how to use Pygments in WordPress:

-
http://lucumr.pocoo.org/cogitations/2007/05/30/pygments-in-wordpress/

-

-

-
Markdown

-
Since Pygments 0.9, the distribution ships Markdown preprocessor sample code
-that uses Pygments to render source code in external/markdown-processor.py.
-You can copy and adapt it to your liking.

-

-

-
TextMate

-
Antonio Cangiano has created a Pygments bundle for TextMate that allows to
-colorize code via a simple menu option.  It can be found here.

-

-

-
Bash completion

-
The source distribution contains a file external/pygments.bashcomp that
-sets up completion for the pygmentize command in bash.

-

-

-
Java

-
See the Java quickstart document.

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/java.html b/docs/build/java.html
deleted file mode 100644
index af0b6e1..0000000
--- a/docs/build/java.html
+++ /dev/null
@@ -1,271 +0,0 @@
-
-
-
-  Use Pygments in Java — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Use Pygments in Java

-    
-      « Back To Index
-    
-    
-    
Thanks to Jython it is possible to use Pygments in
-Java.

-
This page is a simple tutorial to get an idea of how this is working. You can
-then look at the Jython documentation for more
-advanced use.

-
Since version 1.5, Pygments is deployed on Maven Central as a JAR so is Jython
-which makes it a lot easier to create the Java project.

-
Here is an example of a Maven pom.xml file for a
-project running Pygments:

-
<?xml version="1.0" encoding="UTF-8"?>
-
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
-                             http://maven.apache.org/maven-v4_0_0.xsd">
-  <modelVersion>4.0.0</modelVersion>
-  <groupId>example</groupId>
-  <artifactId>example</artifactId>
-  <version>1.0-SNAPSHOT</version>
-  <dependencies>
-    <dependency>
-      <groupId>org.python</groupId>
-      <artifactId>jython-standalone</artifactId>
-      <version>2.5.3</version>
-    </dependency>
-    <dependency>
-      <groupId>org.pygments</groupId>
-      <artifactId>pygments</artifactId>
-      <version>1.5</version>
-      <scope>runtime</scope>
-    </dependency>
-  </dependencies>
-</project>
-

-
The following Java example:

-
PythonInterpreter interpreter = new PythonInterpreter();
-
-// Set a variable with the content you want to work with
-interpreter.set("code", code);
-
-// Simple use Pygments as you would in Python
-interpreter.exec("from pygments import highlight\n"
-    + "from pygments.lexers import PythonLexer\n"
-    + "from pygments.formatters import HtmlFormatter\n"
-    + "\nresult = highlight(code, PythonLexer(), HtmlFormatter())");
-
-// Get the result that has been set in a variable
-System.out.println(interpreter.get("result", String.class));
-

-
will print something like:

-
<div class="highlight">
-<pre><span class="k">print</span> <span class="s">&quot;Hello World&quot;</span></pre>
-</div>
-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/lexerdevelopment.html b/docs/build/lexerdevelopment.html
deleted file mode 100644
index 3352d48..0000000
--- a/docs/build/lexerdevelopment.html
+++ /dev/null
@@ -1,691 +0,0 @@
-
-
-
-  Write your own lexer — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Write your own lexer

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
If a lexer for your favorite language is missing in the Pygments package, you can
-easily write your own and extend Pygments.

-
All you need can be found inside the pygments.lexer module. As you can read in
-the API documentation, a lexer is a class that is initialized with
-some keyword arguments (the lexer options) and that provides a
-get_tokens_unprocessed() method which is given a string or unicode object with
-the data to parse.

-
The get_tokens_unprocessed() method must return an iterator or iterable
-containing tuples in the form (index, token, value). Normally you don't need
-to do this since there are numerous base lexers you can subclass.

-

-
RegexLexer

-
A very powerful (but quite easy to use) lexer is the RegexLexer. This lexer
-base class allows you to define lexing rules in terms of regular expressions
-for different states.

-
States are groups of regular expressions that are matched against the input
-string at the current position. If one of these expressions matches, a
-corresponding action is performed (normally yielding a token with a specific
-type), the current position is set to where the last match ended and the
-matching process continues with the first regex of the current state.

-
Lexer states are kept in a state stack: each time a new state is entered, the
-new state is pushed onto the stack.  The most basic lexers (like the
-DiffLexer) just need one state.

-
Each state is defined as a list of tuples in the form (regex, action,
-new_state) where the last item is optional.  In the most basic form, action
-is a token type (like Name.Builtin).  That means: When regex matches, emit a
-token with the match text and type tokentype and push new_state on the state
-stack.  If the new state is '#pop', the topmost state is popped from the
-stack instead. (To pop more than one state, use '#pop:2' and so on.)
-'#push' is a synonym for pushing the current state on the
-stack.

-
The following example shows the DiffLexer from the builtin lexers. Note that
-it contains some additional attributes name, aliases and filenames which
-aren't required for a lexer. They are used by the builtin lexer lookup
-functions.

-
from pygments.lexer import RegexLexer
-from pygments.token import *
-
-class DiffLexer(RegexLexer):
-    name = 'Diff'
-    aliases = ['diff']
-    filenames = ['*.diff']
-
-    tokens = {
-        'root': [
-            (r' .*\n', Text),
-            (r'\+.*\n', Generic.Inserted),
-            (r'-.*\n', Generic.Deleted),
-            (r'@.*\n', Generic.Subheading),
-            (r'Index.*\n', Generic.Heading),
-            (r'=.*\n', Generic.Heading),
-            (r'.*\n', Text),
-        ]
-    }
-

-
As you can see this lexer only uses one state.  When the lexer starts scanning
-the text, it first checks if the current character is a space. If this is true
-it scans everything until newline and returns the parsed data as Text token.

-
If this rule doesn't match, it checks if the current char is a plus sign.  And
-so on.

-
If no rule matches at the current position, the current char is emitted as an
-Error token that indicates a parsing error, and the position is increased by
-1.

-

-

-
Regex Flags

-
You can either define regex flags in the regex (r'(?x)foo bar') or by adding
-a flags attribute to your lexer class. If no attribute is defined, it defaults
-to re.MULTILINE. For more informations about regular expression flags see the
-regular expressions help page in the python documentation.

-

-

-
Scanning multiple tokens at once

-
Here is a more complex lexer that highlights INI files. INI files consist of
-sections, comments and key = value pairs:

-
from pygments.lexer import RegexLexer, bygroups
-from pygments.token import *
-
-class IniLexer(RegexLexer):
-    name = 'INI'
-    aliases = ['ini', 'cfg']
-    filenames = ['*.ini', '*.cfg']
-
-    tokens = {
-        'root': [
-            (r'\s+', Text),
-            (r';.*?$', Comment),
-            (r'\[.*?\]$', Keyword),
-            (r'(.*?)(\s*)(=)(\s*)(.*?)$',
-             bygroups(Name.Attribute, Text, Operator, Text, String))
-        ]
-    }
-

-
The lexer first looks for whitespace, comments and section names. And later it
-looks for a line that looks like a key, value pair, separated by an '='
-sign, and optional whitespace.

-
The bygroups helper makes sure that each group is yielded with a different
-token type. First the Name.Attribute token, then a Text token for the
-optional whitespace, after that a Operator token for the equals sign. Then a
-Text token for the whitespace again. The rest of the line is returned as
-String.

-
Note that for this to work, every part of the match must be inside a capturing
-group (a (...)), and there must not be any nested capturing groups.  If you
-nevertheless need a group, use a non-capturing group defined using this syntax:
-r'(?:some|words|here)' (note the ?: after the beginning parenthesis).

-
If you find yourself needing a capturing group inside the regex which
-shouldn't be part of the output but is used in the regular expressions for
-backreferencing (eg: r'(<(foo|bar)>)(.*?)(</\2>)'), you can pass None
-to the bygroups function and it will skip that group will be skipped in the
-output.

-

-

-
Changing states

-
Many lexers need multiple states to work as expected. For example, some
-languages allow multiline comments to be nested. Since this is a recursive
-pattern it's impossible to lex just using regular expressions.

-
Here is the solution:

-
from pygments.lexer import RegexLexer
-from pygments.token import *
-
-class ExampleLexer(RegexLexer):
-    name = 'Example Lexer with states'
-
-    tokens = {
-        'root': [
-            (r'[^/]+', Text),
-            (r'/\*', Comment.Multiline, 'comment'),
-            (r'//.*?$', Comment.Singleline),
-            (r'/', Text)
-        ],
-        'comment': [
-            (r'[^*/]', Comment.Multiline),
-            (r'/\*', Comment.Multiline, '#push'),
-            (r'\*/', Comment.Multiline, '#pop'),
-            (r'[*/]', Comment.Multiline)
-        ]
-    }
-

-
This lexer starts lexing in the 'root' state. It tries to match as much as
-possible until it finds a slash ('/'). If the next character after the slash
-is a star ('*') the RegexLexer sends those two characters to the output
-stream marked as Comment.Multiline and continues parsing with the rules
-defined in the 'comment' state.

-
If there wasn't a star after the slash, the RegexLexer checks if it's a
-singleline comment (eg: followed by a second slash). If this also wasn't the
-case it must be a single slash (the separate regex for a single slash must also
-be given, else the slash would be marked as an error token).

-
Inside the 'comment' state, we do the same thing again. Scan until the lexer
-finds a star or slash. If it's the opening of a multiline comment, push the
-'comment' state on the stack and continue scanning, again in the
-'comment' state.  Else, check if it's the end of the multiline comment. If
-yes, pop one state from the stack.

-
Note: If you pop from an empty stack you'll get an IndexError. (There is an
-easy way to prevent this from happening: don't '#pop' in the root state).

-
If the RegexLexer encounters a newline that is flagged as an error token, the
-stack is emptied and the lexer continues scanning in the 'root' state. This
-helps producing error-tolerant highlighting for erroneous input, e.g. when a
-single-line string is not closed.

-

-

-
Advanced state tricks

-
There are a few more things you can do with states:

-
    
-
  • You can push multiple states onto the stack if you give a tuple instead of a
-simple string as the third item in a rule tuple. For example, if you want to
-match a comment containing a directive, something like:
    
-
    -/* <processing directive>    rest of comment */
-
    
-
    you can use this rule:
    
-
    tokens = {
-    'root': [
-        (r'/\* <', Comment, ('comment', 'directive')),
-        ...
-    ],
-    'directive': [
-        (r'[^>]*', Comment.Directive),
-        (r'>', Comment, '#pop'),
-    ],
-    'comment': [
-        (r'[^*]+', Comment),
-        (r'\*/', Comment, '#pop'),
-        (r'\*', Comment),
-    ]
-}
-
    
-
    When this encounters the above sample, first 'comment' and 'directive'
-are pushed onto the stack, then the lexer continues in the directive state
-until it finds the closing >, then it continues in the comment state until
-the closing */. Then, both states are popped from the stack again and
-lexing continues in the root state.
    
-
    New in Pygments 0.9: The tuple can contain the special '#push' and
-'#pop' (but not '#pop:n') directives.
    
-
    • 
-
  • You can include the rules of a state in the definition of another.  This is
-done by using include from pygments.lexer:
    
-
    from pygments.lexer import RegexLexer, bygroups, include
-from pygments.token import *
-
-class ExampleLexer(RegexLexer):
-    tokens = {
-        'comments': [
-            (r'/\*.*?\*/', Comment),
-            (r'//.*?\n', Comment),
-        ],
-        'root': [
-            include('comments'),
-            (r'(function )(\w+)( {)',
-             bygroups(Keyword, Name, Keyword), 'function'),
-            (r'.', Text),
-        ],
-        'function': [
-            (r'[^}/]+', Text),
-            include('comments'),
-            (r'/', Text),
-            (r'}', Keyword, '#pop'),
-        ]
-    }
-
    
-
    This is a hypothetical lexer for a language that consist of functions and
-comments. Because comments can occur at toplevel and in functions, we need
-rules for comments in both states. As you can see, the include helper saves
-repeating rules that occur more than once (in this example, the state
-'comment' will never be entered by the lexer, as it's only there to be
-included in 'root' and 'function').
    
-
    • 
-
  • Sometimes, you may want to "combine" a state from existing ones.  This is
-possible with the combine helper from pygments.lexer.
    
-
    If you, instead of a new state, write combined('state1', 'state2') as the
-third item of a rule tuple, a new anonymous state will be formed from state1
-and state2 and if the rule matches, the lexer will enter this state.
    
-
    This is not used very often, but can be helpful in some cases, such as the
-PythonLexer's string literal processing.
    
-
    • 
-
  • If you want your lexer to start lexing in a different state you can modify
-the stack by overloading the get_tokens_unprocessed() method:
    
-
    from pygments.lexer import RegexLexer
-
-class MyLexer(RegexLexer):
-    tokens = {...}
-
-    def get_tokens_unprocessed(self, text):
-        stack = ['root', 'otherstate']
-        for item in RegexLexer.get_tokens_unprocessed(text, stack):
-            yield item
-
    
-
    Some lexers like the PhpLexer use this to make the leading <?php
-preprocessor comments optional. Note that you can crash the lexer easily
-by putting values into the stack that don't exist in the token map. Also
-removing 'root' from the stack can result in strange errors!
    
-
    • 
-
  • An empty regex at the end of a state list, combined with '#pop', can
-act as a return point from a state that doesn't have a clear end marker.
    
-
    • 
-

-

-

-
Using multiple lexers

-
Using multiple lexers for the same input can be tricky. One of the easiest
-combination techniques is shown here: You can replace the token type entry in a
-rule tuple (the second item) with a lexer class. The matched text will then be
-lexed with that lexer, and the resulting tokens will be yielded.

-
For example, look at this stripped-down HTML lexer:

-
from pygments.lexer import RegexLexer, bygroups, using
-from pygments.token import *
-from pygments.lexers.web import JavascriptLexer
-
-class HtmlLexer(RegexLexer):
-    name = 'HTML'
-    aliases = ['html']
-    filenames = ['*.html', '*.htm']
-
-    flags = re.IGNORECASE | re.DOTALL
-    tokens = {
-        'root': [
-            ('[^<&]+', Text),
-            ('&.*?;', Name.Entity),
-            (r'<\s*script\s*', Name.Tag, ('script-content', 'tag')),
-            (r'<\s*[a-zA-Z0-9:]+', Name.Tag, 'tag'),
-            (r'<\s*/\s*[a-zA-Z0-9:]+\s*>', Name.Tag),
-        ],
-        'script-content': [
-            (r'(.+?)(<\s*/\s*script\s*>)',
-             bygroups(using(JavascriptLexer), Name.Tag),
-             '#pop'),
-        ]
-    }
-

-
Here the content of a <script> tag is passed to a newly created instance of
-a JavascriptLexer and not processed by the HtmlLexer. This is done using the
-using helper that takes the other lexer class as its parameter.

-
Note the combination of bygroups and using. This makes sure that the content
-up to the </script> end tag is processed by the JavascriptLexer, while the
-end tag is yielded as a normal token with the Name.Tag type.

-
As an additional goodie, if the lexer class is replaced by this (imported from
-pygments.lexer), the "other" lexer will be the current one (because you cannot
-refer to the current class within the code that runs at class definition time).

-
Also note the (r'<\s*script\s*', Name.Tag, ('script-content', 'tag')) rule.
-Here, two states are pushed onto the state stack, 'script-content' and
-'tag'.  That means that first 'tag' is processed, which will parse
-attributes and the closing >, then the 'tag' state is popped and the
-next state on top of the stack will be 'script-content'.

-
The using() helper has a special keyword argument, state, which works as
-follows: if given, the lexer to use initially is not in the "root" state,
-but in the state given by this argument. This only works with a RegexLexer.

-
Any other keywords arguments passed to using() are added to the keyword
-arguments used to create the lexer.

-

-

-
Delegating Lexer

-
Another approach for nested lexers is the DelegatingLexer which is for
-example used for the template engine lexers. It takes two lexers as
-arguments on initialisation: a root_lexer and a language_lexer.

-
The input is processed as follows: First, the whole text is lexed with the
-language_lexer. All tokens yielded with a type of Other are then
-concatenated and given to the root_lexer. The language tokens of the
-language_lexer are then inserted into the root_lexer's token stream
-at the appropriate positions.

-
from pygments.lexer import DelegatingLexer
-from pygments.lexers.web import HtmlLexer, PhpLexer
-
-class HtmlPhpLexer(DelegatingLexer):
-    def __init__(self, **options):
-        super(HtmlPhpLexer, self).__init__(HtmlLexer, PhpLexer, **options)
-

-
This procedure ensures that e.g. HTML with template tags in it is highlighted
-correctly even if the template tags are put into HTML tags or attributes.

-
If you want to change the needle token Other to something else, you can
-give the lexer another token type as the third parameter:

-
DelegatingLexer.__init__(MyLexer, OtherLexer, Text, **options)
-

-

-

-
Callbacks

-
Sometimes the grammar of a language is so complex that a lexer would be unable
-to parse it just by using regular expressions and stacks.

-
For this, the RegexLexer allows callbacks to be given in rule tuples, instead
-of token types (bygroups and using are nothing else but preimplemented
-callbacks). The callback must be a function taking two arguments:

-
    
-
  • the lexer itself
    • 
-
  • the match object for the last matched rule
    • 
-

-
The callback must then return an iterable of (or simply yield) (index,
-tokentype, value) tuples, which are then just passed through by
-get_tokens_unprocessed(). The index here is the position of the token in
-the input string, tokentype is the normal token type (like Name.Builtin),
-and value the associated part of the input string.

-
You can see an example here:

-
from pygments.lexer import RegexLexer
-from pygments.token import Generic
-
-class HypotheticLexer(RegexLexer):
-
-    def headline_callback(lexer, match):
-        equal_signs = match.group(1)
-        text = match.group(2)
-        yield match.start(), Generic.Headline, equal_signs + text + equal_signs
-
-    tokens = {
-        'root': [
-            (r'(=+)(.*?)(\1)', headline_callback)
-        ]
-    }
-

-
If the regex for the headline_callback matches, the function is called with the
-match object. Note that after the callback is done, processing continues
-normally, that is, after the end of the previous match. The callback has no
-possibility to influence the position.

-
There are not really any simple examples for lexer callbacks, but you can see
-them in action e.g. in the compiled.py source code in the CLexer and
-JavaLexer classes.

-

-

-
The ExtendedRegexLexer class

-
The RegexLexer, even with callbacks, unfortunately isn't powerful enough for
-the funky syntax rules of some languages that will go unnamed, such as Ruby.

-
But fear not; even then you don't have to abandon the regular expression
-approach. For Pygments has a subclass of RegexLexer, the ExtendedRegexLexer.
-All features known from RegexLexers are available here too, and the tokens are
-specified in exactly the same way, except for one detail:

-
The get_tokens_unprocessed() method holds its internal state data not as local
-variables, but in an instance of the pygments.lexer.LexerContext class, and
-that instance is passed to callbacks as a third argument. This means that you
-can modify the lexer state in callbacks.

-
The LexerContext class has the following members:

-
    
-
  • text -- the input text
    • 
-
  • pos -- the current starting position that is used for matching regexes
    • 
-
  • stack -- a list containing the state stack
    • 
-
  • end -- the maximum position to which regexes are matched, this defaults to
-the length of text
    • 
-

-
Additionally, the get_tokens_unprocessed() method can be given a
-LexerContext instead of a string and will then process this context instead of
-creating a new one for the string argument.

-
Note that because you can set the current position to anything in the callback,
-it won't be automatically be set by the caller after the callback is finished.
-For example, this is how the hypothetical lexer above would be written with the
-ExtendedRegexLexer:

-
from pygments.lexer import ExtendedRegexLexer
-from pygments.token import Generic
-
-class ExHypotheticLexer(ExtendedRegexLexer):
-
-    def headline_callback(lexer, match, ctx):
-        equal_signs = match.group(1)
-        text = match.group(2)
-        yield match.start(), Generic.Headline, equal_signs + text + equal_signs
-        ctx.pos = match.end()
-
-    tokens = {
-        'root': [
-            (r'(=+)(.*?)(\1)', headline_callback)
-        ]
-    }
-

-
This might sound confusing (and it can really be). But it is needed, and for an
-example look at the Ruby lexer in agile.py.

-

-

-
Filtering Token Streams

-
Some languages ship a lot of builtin functions (for example PHP). The total
-amount of those functions differs from system to system because not everybody
-has every extension installed. In the case of PHP there are over 3000 builtin
-functions. That's an incredible huge amount of functions, much more than you
-can put into a regular expression.

-
But because only Name tokens can be function names it's solvable by overriding
-the get_tokens_unprocessed() method. The following lexer subclasses the
-PythonLexer so that it highlights some additional names as pseudo keywords:

-
from pygments.lexers.agile import PythonLexer
-from pygments.token import Name, Keyword
-
-class MyPythonLexer(PythonLexer):
-    EXTRA_KEYWORDS = ['foo', 'bar', 'foobar', 'barfoo', 'spam', 'eggs']
-
-    def get_tokens_unprocessed(self, text):
-        for index, token, value in PythonLexer.get_tokens_unprocessed(self, text):
-            if token is Name and value in self.EXTRA_KEYWORDS:
-                yield index, Keyword.Pseudo, value
-            else:
-                yield index, token, value
-

-
The PhpLexer and LuaLexer use this method to resolve builtin functions.

-
Note Do not confuse this with the filter system.

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/lexers.html b/docs/build/lexers.html
deleted file mode 100644
index f8813fb..0000000
--- a/docs/build/lexers.html
+++ /dev/null
@@ -1,5359 +0,0 @@
-
-
-
-  Available lexers — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Available lexers

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
This page lists all available builtin lexers and the options they take.

-
Currently, all lexers support these options:

-

-
stripnl

-
Strip leading and trailing newlines from the input (default: True)

-
stripall

-
Strip all leading and trailing whitespace from the input (default:
-False).

-
ensurenl

-
Make sure that the input ends with a newline (default: True).  This
-is required for some lexers that consume input linewise.
-New in Pygments 1.3.

-
tabsize

-
If given and greater than 0, expand tabs in the input (default: 0).

-
encoding

-
New in Pygments 0.6.

-
If given, must be an encoding name (such as "utf-8"). This encoding
-will be used to convert the input string to Unicode (if it is not already
-a Unicode string). The default is "latin1".

-
If this option is set to "guess", a simple UTF-8 vs. Latin-1
-detection is used, if it is set to "chardet", the
-chardet library is used to
-guess the encoding of the input.

-

-

-
The "Short Names" field lists the identifiers that can be used with the
-get_lexer_by_name() function.

-
These lexers are builtin and can be imported from pygments.lexers:

-

-
Lexers for agile languages

-
CrocLexer

-

-
For Croc source.

-
---
-
-
-
-
-
-
-
-



Short names:croc
Filename patterns:*.croc
Mimetypes:text/x-crocsrc

-

-
DgLexer

-

-
Lexer for dg,
-a functional and object-oriented programming language
-running on the CPython 3 VM.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:dg
Filename patterns:*.dg
Mimetypes:text/x-dg

-

-
FactorLexer

-

-
Lexer for the Factor language.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:factor
Filename patterns:*.factor
Mimetypes:text/x-factor

-

-
FancyLexer

-

-
Pygments Lexer For Fancy.

-
Fancy is a self-hosted, pure object-oriented, dynamic,
-class-based, concurrent general-purpose programming language
-running on Rubinius, the Ruby VM.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:fancy, fy
Filename patterns:*.fy, *.fancypack
Mimetypes:text/x-fancysrc

-

-
IoLexer

-

-
For Io (a small, prototype-based
-programming language) source.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:io
Filename patterns:*.io
Mimetypes:text/x-iosrc

-

-
LuaLexer

-

-
For Lua source code.

-
Additional options accepted:

-

-
func_name_highlighting

-
If given and True, highlight builtin function names
-(default: True).

-
disabled_modules

-
If given, must be a list of module names whose function names
-should not be highlighted. By default all modules are highlighted.

-
To get a list of allowed modules have a look into the
-_luabuiltins module:

-
>>> from pygments.lexers._luabuiltins import MODULES
->>> MODULES.keys()
-['string', 'coroutine', 'modules', 'io', 'basic', ...]
-

-

-

-
---
-
-
-
-
-
-
-
-



Short names:lua
Filename patterns:*.lua, *.wlua
Mimetypes:text/x-lua, application/x-lua

-

-
MiniDLexer

-

-
For MiniD source. MiniD is now known as Croc.

-
---
-
-
-
-
-
-
-
-



Short names:minid
Filename patterns:*.md
Mimetypes:text/x-minidsrc

-

-
MoonScriptLexer

-

-
For MoonScript source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:moon, moonscript
Filename patterns:*.moon
Mimetypes:text/x-moonscript, application/x-moonscript

-

-
PerlLexer

-

-
For Perl source code.

-
---
-
-
-
-
-
-
-
-



Short names:perl, pl
Filename patterns:*.pl, *.pm
Mimetypes:text/x-perl, application/x-perl

-

-
Python3Lexer

-

-
For Python source code (version 3.0).

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:python3, py3
Filename patterns:None
Mimetypes:text/x-python3, application/x-python3

-

-
Python3TracebackLexer

-

-
For Python 3.0 tracebacks, with support for chained exceptions.

-
New in Pygments 1.0.

-
---
-
-
-
-
-
-
-
-



Short names:py3tb
Filename patterns:*.py3tb
Mimetypes:text/x-python3-traceback

-

-
PythonConsoleLexer

-

-
For Python console output or doctests, such as:

-
>>> a = 'foo'
->>> print a
-foo
->>> 1 / 0
-Traceback (most recent call last):
-  File "<stdin>", line 1, in <module>
-ZeroDivisionError: integer division or modulo by zero
-

-
Additional options:

-

-
python3

-
Use Python 3 lexer for code.  Default is False.
-New in Pygments 1.0.

-

-
---
-
-
-
-
-
-
-
-



Short names:pycon
Filename patterns:None
Mimetypes:text/x-python-doctest

-

-
PythonLexer

-

-
For Python source code.

-
---
-
-
-
-
-
-
-
-



Short names:python, py, sage
Filename patterns:*.py, *.pyw, *.sc, SConstruct, SConscript, *.tac, *.sage
Mimetypes:text/x-python, application/x-python

-

-
PythonTracebackLexer

-

-
For Python tracebacks.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:pytb
Filename patterns:*.pytb
Mimetypes:text/x-python-traceback

-

-
RubyConsoleLexer

-

-
For Ruby interactive console (irb) output like:

-
irb(main):001:0> a = 1
-=> 1
-irb(main):002:0> puts a
-1
-=> nil
-

-
---
-
-
-
-
-
-
-
-



Short names:rbcon, irb
Filename patterns:None
Mimetypes:text/x-ruby-shellsession

-

-
RubyLexer

-

-
For Ruby source code.

-
---
-
-
-
-
-
-
-
-



Short names:rb, ruby, duby
Filename patterns:*.rb, *.rbw, Rakefile, *.rake, *.gemspec, *.rbx, *.duby
Mimetypes:text/x-ruby, application/x-ruby

-

-
TclLexer

-

-
For Tcl source code.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:tcl
Filename patterns:*.tcl
Mimetypes:text/x-tcl, text/x-script.tcl, application/x-tcl

-

-

-

-
Lexers for assembly languages

-
CObjdumpLexer

-

-
For the output of 'objdump -Sr on compiled C files'

-
---
-
-
-
-
-
-
-
-



Short names:c-objdump
Filename patterns:*.c-objdump
Mimetypes:text/x-c-objdump

-

-
Ca65Lexer

-

-
For ca65 assembler sources.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:ca65
Filename patterns:*.s
Mimetypes:None

-

-
CppObjdumpLexer

-

-
For the output of 'objdump -Sr on compiled C++ files'

-
---
-
-
-
-
-
-
-
-



Short names:cpp-objdump, c++-objdumb, cxx-objdump
Filename patterns:*.cpp-objdump, *.c++-objdump, *.cxx-objdump
Mimetypes:text/x-cpp-objdump

-

-
DObjdumpLexer

-

-
For the output of 'objdump -Sr on compiled D files'

-
---
-
-
-
-
-
-
-
-



Short names:d-objdump
Filename patterns:*.d-objdump
Mimetypes:text/x-d-objdump

-

-
GasLexer

-

-
For Gas (AT&T) assembly code.

-
---
-
-
-
-
-
-
-
-



Short names:gas
Filename patterns:*.s, *.S
Mimetypes:text/x-gas

-

-
LlvmLexer

-

-
For LLVM assembly code.

-
---
-
-
-
-
-
-
-
-



Short names:llvm
Filename patterns:*.ll
Mimetypes:text/x-llvm

-

-
NasmLexer

-

-
For Nasm (Intel) assembly code.

-
---
-
-
-
-
-
-
-
-



Short names:nasm
Filename patterns:*.asm, *.ASM
Mimetypes:text/x-nasm

-

-
ObjdumpLexer

-

-
For the output of 'objdump -dr'

-
---
-
-
-
-
-
-
-
-



Short names:objdump
Filename patterns:*.objdump
Mimetypes:text/x-objdump

-

-

-

-
Lexers for compiled languages

-
AdaLexer

-

-
For Ada source code.

-
New in Pygments 1.3.

-
---
-
-
-
-
-
-
-
-



Short names:ada, ada95ada2005
Filename patterns:*.adb, *.ads, *.ada
Mimetypes:text/x-ada

-

-
BlitzMaxLexer

-

-
For BlitzMax source code.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:blitzmax, bmax
Filename patterns:*.bmx
Mimetypes:text/x-bmx

-

-
CLexer

-

-
For C source code with preprocessor directives.

-
---
-
-
-
-
-
-
-
-



Short names:c
Filename patterns:*.c, *.h, *.idc
Mimetypes:text/x-chdr, text/x-csrc

-

-
CobolFreeformatLexer

-

-
Lexer for Free format OpenCOBOL code.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:cobolfree
Filename patterns:*.cbl, *.CBL
Mimetypes:None

-

-
CobolLexer

-

-
Lexer for OpenCOBOL code.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:cobol
Filename patterns:*.cob, *.COB, *.cpy, *.CPY
Mimetypes:text/x-cobol

-

-
CppLexer

-

-
For C++ source code with preprocessor directives.

-
---
-
-
-
-
-
-
-
-



Short names:cpp, c++
Filename patterns:*.cpp, *.hpp, *.c++, *.h++, *.cc, *.hh, *.cxx, *.hxx, *.C, *.H, *.cp, *.CPP
Mimetypes:text/x-c++hdr, text/x-c++src

-

-
CudaLexer

-

-
For NVIDIA CUDA™
-source.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:cuda, cu
Filename patterns:*.cu, *.cuh
Mimetypes:text/x-cuda

-

-
CythonLexer

-

-
For Pyrex and Cython source code.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:cython, pyx
Filename patterns:*.pyx, *.pxd, *.pxi
Mimetypes:text/x-cython, application/x-cython

-

-
DLexer

-

-
For D source.

-
New in Pygments 1.2.

-
---
-
-
-
-
-
-
-
-



Short names:d
Filename patterns:*.d, *.di
Mimetypes:text/x-dsrc

-

-
DelphiLexer

-

-
For Delphi (Borland Object Pascal),
-Turbo Pascal and Free Pascal source code.

-
Additional options accepted:

-

-
turbopascal

-
Highlight Turbo Pascal specific keywords (default: True).

-
delphi

-
Highlight Borland Delphi specific keywords (default: True).

-
freepascal

-
Highlight Free Pascal specific keywords (default: True).

-
units

-
A list of units that should be considered builtin, supported are
-System, SysUtils, Classes and Math.
-Default is to consider all of them builtin.

-

-
---
-
-
-
-
-
-
-
-



Short names:delphi, pas, pascal, objectpascal
Filename patterns:*.pas
Mimetypes:text/x-pascal

-

-
DylanLexer

-

-
For the Dylan language.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:dylan
Filename patterns:*.dylan, *.dyl, *.intr
Mimetypes:text/x-dylan

-

-
DylanLidLexer

-

-
For Dylan LID (Library Interchange Definition) files.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:dylan-lid, lid
Filename patterns:*.lid, *.hdp
Mimetypes:text/x-dylan-lid

-

-
ECLexer

-

-
For eC source code with preprocessor directives.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:ec
Filename patterns:*.ec, *.eh
Mimetypes:text/x-echdr, text/x-ecsrc

-

-
FantomLexer

-

-
For Fantom source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:fan
Filename patterns:*.fan
Mimetypes:application/x-fantom

-

-
FelixLexer

-

-
For Felix source code.

-
New in Pygments 1.2.

-
---
-
-
-
-
-
-
-
-



Short names:felix, flx
Filename patterns:*.flx, *.flxh
Mimetypes:text/x-felix

-

-
FortranLexer

-

-
Lexer for FORTRAN 90 code.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:fortran
Filename patterns:*.f, *.f90, *.F, *.F90
Mimetypes:text/x-fortran

-

-
GLShaderLexer

-

-
GLSL (OpenGL Shader) lexer.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:glsl
Filename patterns:*.vert, *.frag, *.geo
Mimetypes:text/x-glslsrc

-

-
GoLexer

-

-
For Go source.

-
---
-
-
-
-
-
-
-
-



Short names:go
Filename patterns:*.go
Mimetypes:text/x-gosrc

-

-
Modula2Lexer

-

-
For Modula-2 source code.

-
Additional options that determine which keywords are highlighted:

-

-
pim

-
Select PIM Modula-2 dialect (default: True).

-
iso

-
Select ISO Modula-2 dialect (default: False).

-
objm2

-
Select Objective Modula-2 dialect (default: False).

-
gm2ext

-
Also highlight GNU extensions (default: False).

-

-
New in Pygments 1.3.

-
---
-
-
-
-
-
-
-
-



Short names:modula2, m2
Filename patterns:*.def, *.mod
Mimetypes:text/x-modula2

-

-
MonkeyLexer

-

-
For
-Monkey
-source code.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:monkey
Filename patterns:*.monkey
Mimetypes:text/x-monkey

-

-
NimrodLexer

-

-
For Nimrod source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:nimrod, nim
Filename patterns:*.nim, *.nimrod
Mimetypes:text/x-nimrod

-

-
ObjectiveCLexer

-

-
For Objective-C source code with preprocessor directives.

-
---
-
-
-
-
-
-
-
-



Short names:objective-c, objectivec, obj-c, objc
Filename patterns:*.m, *.h
Mimetypes:text/x-objective-c

-

-
ObjectiveCppLexer

-

-
For Objective-C++ source code with preprocessor directives.

-
---
-
-
-
-
-
-
-
-



Short names:objective-c++, objectivec++, obj-c++, objc++
Filename patterns:*.mm, *.hh
Mimetypes:text/x-objective-c++

-

-
OocLexer

-

-
For Ooc source code

-
New in Pygments 1.2.

-
---
-
-
-
-
-
-
-
-



Short names:ooc
Filename patterns:*.ooc
Mimetypes:text/x-ooc

-

-
PrologLexer

-

-
Lexer for Prolog files.

-
---
-
-
-
-
-
-
-
-



Short names:prolog
Filename patterns:*.prolog, *.pro, *.pl
Mimetypes:text/x-prolog

-

-
RustLexer

-

-
Lexer for Mozilla's Rust programming language.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:rust
Filename patterns:*.rs, *.rc
Mimetypes:text/x-rustsrc

-

-
ValaLexer

-

-
For Vala source code with preprocessor directives.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:vala, vapi
Filename patterns:*.vala, *.vapi
Mimetypes:text/x-vala

-

-

-
-

-
Lexers for .net languages

-
BooLexer

-

-
For Boo source code.

-
---
-
-
-
-
-
-
-
-



Short names:boo
Filename patterns:*.boo
Mimetypes:text/x-boo

-

-
CSharpAspxLexer

-

-
Lexer for highligting C# within ASP.NET pages.

-
---
-
-
-
-
-
-
-
-



Short names:aspx-cs
Filename patterns:*.aspx, *.asax, *.ascx, *.ashx, *.asmx, *.axd
Mimetypes:None

-

-
CSharpLexer

-

-
For C#
-source code.

-
Additional options accepted:

-

-
unicodelevel

-
Determines which Unicode characters this lexer allows for identifiers.
-The possible values are:

-
    
-
  • none -- only the ASCII letters and numbers are allowed. This
-is the fastest selection.
    • 
-
  • basic -- all Unicode characters from the specification except
-category Lo are allowed.
    • 
-
  • full -- all Unicode characters as specified in the C# specs
-are allowed.  Note that this means a considerable slowdown since the
-Lo category has more than 40,000 characters in it!
    • 
-

-
The default value is basic.

-
New in Pygments 0.8.

-

-

-
---
-
-
-
-
-
-
-
-



Short names:csharp, c#
Filename patterns:*.cs
Mimetypes:text/x-csharp

-

-
FSharpLexer

-

-
For the F# language.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:fsharp
Filename patterns:*.fs, *.fsi
Mimetypes:text/x-fsharp

-

-
NemerleLexer

-

-
For Nemerle source code.

-
Additional options accepted:

-

-
unicodelevel

-
Determines which Unicode characters this lexer allows for identifiers.
-The possible values are:

-
    
-
  • none -- only the ASCII letters and numbers are allowed. This
-is the fastest selection.
    • 
-
  • basic -- all Unicode characters from the specification except
-category Lo are allowed.
    • 
-
  • full -- all Unicode characters as specified in the C# specs
-are allowed.  Note that this means a considerable slowdown since the
-Lo category has more than 40,000 characters in it!
    • 
-

-
The default value is basic.

-

-

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:nemerle
Filename patterns:*.n
Mimetypes:text/x-nemerle

-

-
VbNetAspxLexer

-

-
Lexer for highligting Visual Basic.net within ASP.NET pages.

-
---
-
-
-
-
-
-
-
-



Short names:aspx-vb
Filename patterns:*.aspx, *.asax, *.ascx, *.ashx, *.asmx, *.axd
Mimetypes:None

-

-
VbNetLexer

-

-
For
-Visual Basic.NET
-source code.

-
---
-
-
-
-
-
-
-
-



Short names:vb.net, vbnet
Filename patterns:*.vb, *.bas
Mimetypes:text/x-vbnet, text/x-vba

-

-

-

-
Simple lexer for Microsoft Visual FoxPro source code

-
FoxProLexer
-Lexer for Microsoft Visual FoxPro language.

-

-
FoxPro syntax allows to shorten all keywords and function names
-to 4 characters.  Shortened forms are not recognized by this lexer.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:Clipper, XBase
Filename patterns:*.PRG, *.prg
Mimetypes:None

-

-

-

-
Lexers for functional languages

-
CommonLispLexer

-

-
A Common Lisp lexer.

-
New in Pygments 0.9.

-
---
-
-
-
-
-
-
-
-



Short names:common-lisp, cl
Filename patterns:*.cl, *.lisp, *.el
Mimetypes:text/x-common-lisp

-

-
CoqLexer

-

-
For the Coq theorem prover.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:coq
Filename patterns:*.v
Mimetypes:text/x-coq

-

-
ElixirConsoleLexer

-

-
For Elixir interactive console (iex) output like:

-
iex> [head | tail] = [1,2,3]
-[1,2,3]
-iex> head
-1
-iex> tail
-[2,3]
-iex> [head | tail]
-[1,2,3]
-iex> length [head | tail]
-3
-

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:iex
Filename patterns:None
Mimetypes:text/x-elixir-shellsession

-

-
ElixirLexer

-

-
For the Elixir language.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:elixir, ex, exs
Filename patterns:*.ex, *.exs
Mimetypes:text/x-elixir

-

-
ErlangLexer

-

-
For the Erlang functional programming language.

-
Blame Jeremy Thurgood (http://jerith.za.net/).

-
New in Pygments 0.9.

-
---
-
-
-
-
-
-
-
-



Short names:erlang
Filename patterns:*.erl, *.hrl, *.es, *.escript
Mimetypes:text/x-erlang

-

-
ErlangShellLexer

-

-
Shell sessions in erl (for Erlang code).

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:erl
Filename patterns:*.erl-sh
Mimetypes:text/x-erl-shellsession

-

-
HaskellLexer

-

-
A Haskell lexer based on the lexemes defined in the Haskell 98 Report.

-
New in Pygments 0.8.

-
---
-
-
-
-
-
-
-
-



Short names:haskell, hs
Filename patterns:*.hs
Mimetypes:text/x-haskell

-

-
KokaLexer

-

-
Lexer for the Koka
-language.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:koka
Filename patterns:*.kk, *.kki
Mimetypes:text/x-koka

-

-
LiterateHaskellLexer

-

-
For Literate Haskell (Bird-style or LaTeX) source.

-
Additional options accepted:

-

-
litstyle

-
If given, must be "bird" or "latex".  If not given, the style
-is autodetected: if the first non-whitespace character in the source
-is a backslash or percent character, LaTeX is assumed, else Bird.

-

-
New in Pygments 0.9.

-
---
-
-
-
-
-
-
-
-



Short names:lhs, literate-haskell
Filename patterns:*.lhs
Mimetypes:text/x-literate-haskell

-

-
NewLispLexer

-

-
For newLISP. source code (version 10.3.0).

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:newlisp
Filename patterns:*.lsp, *.nl
Mimetypes:text/x-newlisp, application/x-newlisp

-

-
OcamlLexer

-

-
For the OCaml language.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:ocaml
Filename patterns:*.ml, *.mli, *.mll, *.mly
Mimetypes:text/x-ocaml

-

-
OpaLexer

-

-
Lexer for the Opa language (http://opalang.org).

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:opa
Filename patterns:*.opa
Mimetypes:text/x-opa

-

-
RacketLexer

-

-
Lexer for Racket source code (formerly known as
-PLT Scheme).

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:racket, rkt
Filename patterns:*.rkt, *.rktl
Mimetypes:text/x-racket, application/x-racket

-

-
SMLLexer

-

-
For the Standard ML language.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:sml
Filename patterns:*.sml, *.sig, *.fun
Mimetypes:text/x-standardml, application/x-standardml

-

-
SchemeLexer

-

-
A Scheme lexer, parsing a stream and outputting the tokens
-needed to highlight scheme code.
-This lexer could be most probably easily subclassed to parse
-other LISP-Dialects like Common Lisp, Emacs Lisp or AutoLisp.

-
This parser is checked with pastes from the LISP pastebin
-at http://paste.lisp.org/ to cover as much syntax as possible.

-
It supports the full Scheme syntax as defined in R5RS.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:scheme, scm
Filename patterns:*.scm, *.ss
Mimetypes:text/x-scheme, application/x-scheme

-

-

-

-
Lexers for hardware descriptor languages

-
SystemVerilogLexer

-

-
Extends verilog lexer to recognise all SystemVerilog keywords from IEEE
-1800-2009 standard.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:sv
Filename patterns:*.sv, *.svh
Mimetypes:text/x-systemverilog

-

-
VerilogLexer

-

-
For verilog source code with preprocessor directives.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:v
Filename patterns:*.v
Mimetypes:text/x-verilog

-

-
VhdlLexer

-

-
For VHDL source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:vhdl
Filename patterns:*.vhdl, *.vhd
Mimetypes:text/x-vhdl

-

-

-

-
Pygments lexers for JVM languages

-
AspectJLexer

-

-
For AspectJ source code.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:aspectj
Filename patterns:*.aj
Mimetypes:text/x-aspectj

-

-
CeylonLexer

-

-
For Ceylon source code.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:ceylon
Filename patterns:*.ceylon
Mimetypes:text/x-ceylon

-

-
ClojureLexer

-

-
Lexer for Clojure source code.

-
New in Pygments 0.11.

-
---
-
-
-
-
-
-
-
-



Short names:clojure, clj
Filename patterns:*.clj
Mimetypes:text/x-clojure, application/x-clojure

-

-
GosuLexer

-

-
For Gosu source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:gosu
Filename patterns:*.gs, *.gsx, *.gsp, *.vark
Mimetypes:text/x-gosu

-

-
GosuTemplateLexer

-

-
For Gosu templates.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:gst
Filename patterns:*.gst
Mimetypes:text/x-gosu-template

-

-
GroovyLexer

-

-
For Groovy source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:groovy
Filename patterns:*.groovy
Mimetypes:text/x-groovy

-

-
IokeLexer

-

-
For Ioke (a strongly typed, dynamic,
-prototype based programming language) source.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:ioke, ik
Filename patterns:*.ik
Mimetypes:text/x-iokesrc

-

-
JavaLexer

-

-
For Java source code.

-
---
-
-
-
-
-
-
-
-



Short names:java
Filename patterns:*.java
Mimetypes:text/x-java

-

-
KotlinLexer

-

-
For Kotlin
-source code.

-
Additional options accepted:

-

-
unicodelevel

-
Determines which Unicode characters this lexer allows for identifiers.
-The possible values are:

-
    
-
  • none -- only the ASCII letters and numbers are allowed. This
-is the fastest selection.
    • 
-
  • basic -- all Unicode characters from the specification except
-category Lo are allowed.
    • 
-
  • full -- all Unicode characters as specified in the C# specs
-are allowed.  Note that this means a considerable slowdown since the
-Lo category has more than 40,000 characters in it!
    • 
-

-
The default value is basic.

-

-

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:kotlin
Filename patterns:*.kt
Mimetypes:text/x-kotlin

-

-
ScalaLexer

-

-
For Scala source code.

-
---
-
-
-
-
-
-
-
-



Short names:scala
Filename patterns:*.scala
Mimetypes:text/x-scala

-

-
XtendLexer

-

-
For Xtend source code.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:xtend
Filename patterns:*.xtend
Mimetypes:text/x-xtend

-

-

-

-
Lexers for math languages

-
BugsLexer

-

-
Pygments Lexer for OpenBugs and WinBugs
-models.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:bugs, winbugs, openbugs
Filename patterns:*.bug
Mimetypes:None

-

-
IDLLexer

-

-
Pygments Lexer for IDL (Interactive Data Language).

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:idl
Filename patterns:*.pro
Mimetypes:text/idl

-

-
JagsLexer

-

-
Pygments Lexer for JAGS.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:jags
Filename patterns:*.jag, *.bug
Mimetypes:None

-

-
JuliaConsoleLexer

-

-
For Julia console sessions. Modeled after MatlabSessionLexer.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:jlcon
Filename patterns:None
Mimetypes:None

-

-
JuliaLexer

-

-
For Julia source code.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:julia, jl
Filename patterns:*.jl
Mimetypes:text/x-julia, application/x-julia

-

-
MatlabLexer

-

-
For Matlab source code.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:matlab
Filename patterns:*.m
Mimetypes:text/matlab

-

-
MatlabSessionLexer

-

-
For Matlab sessions.  Modeled after PythonConsoleLexer.
-Contributed by Ken Schutte <kschutte@csail.mit.edu>.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:matlabsession
Filename patterns:None
Mimetypes:None

-

-
MuPADLexer

-

-
A MuPAD lexer.
-Contributed by Christopher Creutzig <christopher@creutzig.de>.

-
New in Pygments 0.8.

-
---
-
-
-
-
-
-
-
-



Short names:mupad
Filename patterns:*.mu
Mimetypes:None

-

-
NumPyLexer

-

-
A Python lexer recognizing Numerical Python builtins.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:numpy
Filename patterns:None
Mimetypes:None

-

-
OctaveLexer

-

-
For GNU Octave source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:octave
Filename patterns:*.m
Mimetypes:text/octave

-

-
RConsoleLexer

-

-
For R console transcripts or R CMD BATCH output files.

-
---
-
-
-
-
-
-
-
-



Short names:rconsole, rout
Filename patterns:*.Rout
Mimetypes:None

-

-
RdLexer

-

-
Pygments Lexer for R documentation (Rd) files

-
This is a very minimal implementation, highlighting little more
-than the macros. A description of Rd syntax is found in Writing R
-Extensions
-and Parsing Rd files.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:rd
Filename patterns:*.Rd
Mimetypes:text/x-r-doc

-

-
SLexer

-

-
For S, S-plus, and R source code.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:splus, s, r
Filename patterns:*.S, *.R, .Rhistory, .Rprofile
Mimetypes:text/S-plus, text/S, text/x-r-source, text/x-r, text/x-R, text/x-r-history, text/x-r-profile

-

-
ScilabLexer

-

-
For Scilab source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:scilab
Filename patterns:*.sci, *.sce, *.tst
Mimetypes:text/scilab

-

-
StanLexer

-

-
Pygments Lexer for Stan models.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:stan
Filename patterns:*.stan
Mimetypes:None

-

-

-

-
Lexers for other languages

-
ABAPLexer

-

-
Lexer for ABAP, SAP's integrated language.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:abap
Filename patterns:*.abap
Mimetypes:text/x-abap

-

-
AppleScriptLexer

-

-
For AppleScript source code,
-including AppleScript Studio.
-Contributed by Andreas Amann <aamann@mac.com>.

-
---
-
-
-
-
-
-
-
-



Short names:applescript
Filename patterns:*.applescript
Mimetypes:None

-

-
AsymptoteLexer

-

-
For Asymptote source code.

-
New in Pygments 1.2.

-
---
-
-
-
-
-
-
-
-



Short names:asy, asymptote
Filename patterns:*.asy
Mimetypes:text/x-asymptote

-

-
AutoItLexer

-

-
For AutoIt files.

-
AutoIt is a freeware BASIC-like scripting language
-designed for automating the Windows GUI and general scripting

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:autoit, Autoit
Filename patterns:*.au3
Mimetypes:text/x-autoit

-

-
AutohotkeyLexer

-

-
For autohotkey source code.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:ahk
Filename patterns:*.ahk, *.ahkl
Mimetypes:text/x-autohotkey

-

-
AwkLexer

-

-
For Awk scripts.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:awk, gawk, mawk, nawk
Filename patterns:*.awk
Mimetypes:application/x-awk

-

-
BefungeLexer

-

-
Lexer for the esoteric Befunge
-language.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:befunge
Filename patterns:*.befunge
Mimetypes:application/x-befunge

-

-
BrainfuckLexer

-

-
Lexer for the esoteric BrainFuck
-language.

-
---
-
-
-
-
-
-
-
-



Short names:brainfuck, bf
Filename patterns:*.bf, *.b
Mimetypes:application/x-brainfuck

-

-
BroLexer

-

-
For Bro scripts.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:bro
Filename patterns:*.bro
Mimetypes:None

-

-
CbmBasicV2Lexer

-

-
For CBM BASIC V2 sources.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:cbmbas
Filename patterns:*.bas
Mimetypes:None

-

-
Cfengine3Lexer

-

-
Lexer for CFEngine3 policy files.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:cfengine3, cf3
Filename patterns:*.cf
Mimetypes:None

-

-
ECLLexer

-

-
Lexer for the declarative big-data ECL
-language.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:ecl
Filename patterns:*.ecl
Mimetypes:application/x-ecl

-

-
GherkinLexer

-

-
For Gherkin <http://github.com/aslakhellesoy/gherkin/> syntax.

-
New in Pygments 1.2.

-
---
-
-
-
-
-
-
-
-



Short names:Cucumber, cucumber, Gherkin, gherkin
Filename patterns:*.feature
Mimetypes:text/x-gherkin

-

-
GnuplotLexer

-

-
For Gnuplot plotting scripts.

-
New in Pygments 0.11.

-
---
-
-
-
-
-
-
-
-



Short names:gnuplot
Filename patterns:*.plot, *.plt
Mimetypes:text/x-gnuplot

-

-
GoodDataCLLexer

-

-
Lexer for GoodData-CL
-script files.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:gooddata-cl
Filename patterns:*.gdc
Mimetypes:text/x-gooddata-cl

-

-
HybrisLexer

-

-
For Hybris source code.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:hybris, hy
Filename patterns:*.hy, *.hyb
Mimetypes:text/x-hybris, application/x-hybris

-

-
KconfigLexer

-

-
For Linux-style Kconfig files.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:kconfig, menuconfig, linux-config, kernel-config
Filename patterns:Kconfig, *Config.in*, external.in*, standard-modules.in
Mimetypes:text/x-kconfig

-

-
LogtalkLexer

-

-
For Logtalk source code.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:logtalk
Filename patterns:*.lgt
Mimetypes:text/x-logtalk

-

-
MOOCodeLexer

-

-
For MOOCode (the MOO scripting
-language).

-
New in Pygments 0.9.

-
---
-
-
-
-
-
-
-
-



Short names:moocode
Filename patterns:*.moo
Mimetypes:text/x-moocode

-

-
MaqlLexer

-

-
Lexer for GoodData MAQL
-scripts.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:maql
Filename patterns:*.maql
Mimetypes:text/x-gooddata-maql, application/x-gooddata-maql

-

-
ModelicaLexer

-

-
For Modelica source code.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:modelica
Filename patterns:*.mo
Mimetypes:text/x-modelica

-

-
MscgenLexer

-

-
For Mscgen files.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:mscgen, msc
Filename patterns:*.msc
Mimetypes:None

-

-
NSISLexer

-

-
For NSIS scripts.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:nsis, nsi, nsh
Filename patterns:*.nsi, *.nsh
Mimetypes:text/x-nsis

-

-
NewspeakLexer

-

-
For Newspeak <http://newspeaklanguage.org/> syntax.

-
---
-
-
-
-
-
-
-
-



Short names:newspeak
Filename patterns:*.ns2
Mimetypes:text/x-newspeak

-

-
OpenEdgeLexer

-

-
Lexer for OpenEdge ABL (formerly Progress) source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:openedge, abl, progress
Filename patterns:*.p, *.cls
Mimetypes:text/x-openedge, application/x-openedge

-

-
PostScriptLexer

-

-
Lexer for PostScript files.

-
The PostScript Language Reference published by Adobe at
-<http://partners.adobe.com/public/developer/en/ps/PLRM.pdf>
-is the authority for this.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:postscript
Filename patterns:*.ps, *.eps
Mimetypes:application/postscript

-

-
PovrayLexer

-

-
For Persistence of Vision Raytracer files.

-
New in Pygments 0.11.

-
---
-
-
-
-
-
-
-
-



Short names:pov
Filename patterns:*.pov, *.inc
Mimetypes:text/x-povray

-

-
ProtoBufLexer

-

-
Lexer for Protocol Buffer
-definition files.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:protobuf
Filename patterns:*.proto
Mimetypes:None

-

-
PuppetLexer

-

-
For Puppet configuration DSL.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:puppet
Filename patterns:*.pp
Mimetypes:None

-

-
RPMSpecLexer

-

-
For RPM *.spec files

-

-
System Message: WARNING/2 (<string>, line 1687); backlink

-Inline emphasis start-string without end-string.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:spec
Filename patterns:*.spec
Mimetypes:text/x-rpm-spec

-

-
RebolLexer

-

-
A REBOL lexer.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:rebol
Filename patterns:*.r, *.r3
Mimetypes:text/x-rebol

-

-
RedcodeLexer

-

-
A simple Redcode lexer based on ICWS'94.
-Contributed by Adam Blinkinsop <blinks@acm.org>.

-
New in Pygments 0.8.

-
---
-
-
-
-
-
-
-
-



Short names:redcode
Filename patterns:*.cw
Mimetypes:None

-

-
RobotFrameworkLexer

-

-
For Robot Framework test data.

-
Supports both space and pipe separated plain text formats.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:RobotFramework, robotframework
Filename patterns:*.txt
Mimetypes:text/x-robotframework

-

-
SmalltalkLexer

-

-
For Smalltalk syntax.
-Contributed by Stefan Matthias Aust.
-Rewritten by Nils Winter.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:smalltalk, squeak
Filename patterns:*.st
Mimetypes:text/x-smalltalk

-

-
SnobolLexer

-

-
Lexer for the SNOBOL4 programming language.

-
Recognizes the common ASCII equivalents of the original SNOBOL4 operators.
-Does not require spaces around binary operators.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:snobol
Filename patterns:*.snobol
Mimetypes:text/x-snobol

-

-
SourcePawnLexer

-

-
For SourcePawn source code with preprocessor directives.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:sp
Filename patterns:*.sp
Mimetypes:text/x-sourcepawn

-

-
UrbiscriptLexer

-

-
For UrbiScript source code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:urbiscript
Filename patterns:*.u
Mimetypes:application/x-urbiscript

-

-
VGLLexer

-

-
For SampleManager VGL
-source code.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:vgl
Filename patterns:*.rpf
Mimetypes:None

-

-

-

-
Lexers for parser generators

-
AntlrActionScriptLexer

-

-
ANTLR with ActionScript Target

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:antlr-as, antlr-actionscript
Filename patterns:*.G, *.g
Mimetypes:None

-

-
AntlrCSharpLexer

-

-
ANTLR with C# Target

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:antlr-csharp, antlr-c#
Filename patterns:*.G, *.g
Mimetypes:None

-

-
AntlrCppLexer

-

-
ANTLR with CPP Target

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:antlr-cpp
Filename patterns:*.G, *.g
Mimetypes:None

-

-
AntlrJavaLexer

-

-
ANTLR with Java Target

-
New in Pygments 1.1

-
---
-
-
-
-
-
-
-
-



Short names:antlr-java
Filename patterns:*.G, *.g
Mimetypes:None

-

-
AntlrLexer

-

-
Generic ANTLR Lexer.
-Should not be called directly, instead
-use DelegatingLexer for your target language.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:antlr
Filename patterns:None
Mimetypes:None

-

-
AntlrObjectiveCLexer

-

-
ANTLR with Objective-C Target

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:antlr-objc
Filename patterns:*.G, *.g
Mimetypes:None

-

-
AntlrPerlLexer

-

-
ANTLR with Perl Target

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:antlr-perl
Filename patterns:*.G, *.g
Mimetypes:None

-

-
AntlrPythonLexer

-

-
ANTLR with Python Target

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:antlr-python
Filename patterns:*.G, *.g
Mimetypes:None

-

-
AntlrRubyLexer

-

-
ANTLR with Ruby Target

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:antlr-ruby, antlr-rb
Filename patterns:*.G, *.g
Mimetypes:None

-

-
RagelCLexer

-

-
A lexer for Ragel in a C host file.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:ragel-c
Filename patterns:*.rl
Mimetypes:None

-

-
RagelCppLexer

-

-
A lexer for Ragel in a CPP host file.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:ragel-cpp
Filename patterns:*.rl
Mimetypes:None

-

-
RagelDLexer

-

-
A lexer for Ragel in a D host file.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:ragel-d
Filename patterns:*.rl
Mimetypes:None

-

-
RagelEmbeddedLexer

-

-
A lexer for Ragel embedded in a host language file.

-
This will only highlight Ragel statements. If you want host language
-highlighting then call the language-specific Ragel lexer.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:ragel-em
Filename patterns:*.rl
Mimetypes:None

-

-
RagelJavaLexer

-

-
A lexer for Ragel in a Java host file.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:ragel-java
Filename patterns:*.rl
Mimetypes:None

-

-
RagelLexer

-

-
A pure Ragel lexer.  Use this for
-fragments of Ragel.  For .rl files, use RagelEmbeddedLexer instead
-(or one of the language-specific subclasses).

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:ragel
Filename patterns:None
Mimetypes:None

-

-
RagelObjectiveCLexer

-

-
A lexer for Ragel in an Objective C host file.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:ragel-objc
Filename patterns:*.rl
Mimetypes:None

-

-
RagelRubyLexer

-

-
A lexer for Ragel in a Ruby host file.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:ragel-ruby, ragel-rb
Filename patterns:*.rl
Mimetypes:None

-

-
TreetopLexer

-

-
A lexer for Treetop grammars.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:treetop
Filename patterns:*.treetop, *.tt
Mimetypes:None

-

-

-

-
Lexers for various shells

-
BashLexer

-

-
Lexer for (ba|k|)sh shell scripts.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:bash, sh, ksh
Filename patterns:*.sh, *.ksh, *.bash, *.ebuild, *.eclass, .bashrc, bashrc, .bash\*, bash\*
Mimetypes:application/x-sh, application/x-shellscript

-

-
BashSessionLexer

-

-
Lexer for simplistic shell sessions.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:console
Filename patterns:*.sh-session
Mimetypes:application/x-shell-session

-

-
BatchLexer

-

-
Lexer for the DOS/Windows Batch file format.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:bat
Filename patterns:*.bat, *.cmd
Mimetypes:application/x-dos-batch

-

-
PowerShellLexer

-

-
For Windows PowerShell code.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:powershell, posh, ps1
Filename patterns:*.ps1
Mimetypes:text/x-powershell

-

-
TcshLexer

-

-
Lexer for tcsh scripts.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:tcsh, csh
Filename patterns:*.tcsh, *.csh
Mimetypes:application/x-csh

-

-

-

-
Special lexers

-
RawTokenLexer

-

-
Recreate a token stream formatted with the RawTokenFormatter.  This
-lexer raises exceptions during parsing if the token stream in the
-file is malformed.

-
Additional options accepted:

-

-
compress

-
If set to "gz" or "bz2", decompress the token stream with
-the given compression algorithm before lexing (default: "").

-

-
---
-
-
-
-
-
-
-
-



Short names:raw
Filename patterns:None
Mimetypes:application/x-pygments-tokens

-

-
TextLexer

-

-
"Null" lexer, doesn't highlight anything.

-
---
-
-
-
-
-
-
-
-



Short names:text
Filename patterns:*.txt
Mimetypes:text/plain

-

-

-
-

-
Lexers for various template engines' markup

-
CheetahHtmlLexer

-

-
Subclass of the CheetahLexer that highlights unlexer data
-with the HtmlLexer.

-
---
-
-
-
-
-
-
-
-



Short names:html+cheetah, html+spitfire
Filename patterns:None
Mimetypes:text/html+cheetah, text/html+spitfire

-

-
CheetahJavascriptLexer

-

-
Subclass of the CheetahLexer that highlights unlexer data
-with the JavascriptLexer.

-
---
-
-
-
-
-
-
-
-



Short names:js+cheetah, javascript+cheetah, js+spitfire, javascript+spitfire
Filename patterns:None
Mimetypes:application/x-javascript+cheetah, text/x-javascript+cheetah, text/javascript+cheetah, application/x-javascript+spitfire, text/x-javascript+spitfire, text/javascript+spitfire

-

-
CheetahLexer

-

-
Generic cheetah templates lexer. Code that isn't Cheetah
-markup is yielded as Token.Other.  This also works for
-spitfire templates which use the same syntax.

-
---
-
-
-
-
-
-
-
-



Short names:cheetah, spitfire
Filename patterns:*.tmpl, *.spt
Mimetypes:application/x-cheetah, application/x-spitfire

-

-
CheetahXmlLexer

-

-
Subclass of the CheetahLexer that highlights unlexer data
-with the XmlLexer.

-
---
-
-
-
-
-
-
-
-



Short names:xml+cheetah, xml+spitfire
Filename patterns:None
Mimetypes:application/xml+cheetah, application/xml+spitfire

-

-
ColdfusionHtmlLexer

-

-
Coldfusion markup in html

-
---
-
-
-
-
-
-
-
-



Short names:cfm
Filename patterns:*.cfm, *.cfml, *.cfc
Mimetypes:application/x-coldfusion

-

-
ColdfusionLexer

-

-
Coldfusion statements

-
---
-
-
-
-
-
-
-
-



Short names:cfs
Filename patterns:None
Mimetypes:None

-

-
CssDjangoLexer

-

-
Subclass of the DjangoLexer that highlights unlexed data with the
-CssLexer.

-
---
-
-
-
-
-
-
-
-



Short names:css+django, css+jinja
Filename patterns:None
Mimetypes:text/css+django, text/css+jinja

-

-
CssErbLexer

-

-
Subclass of ErbLexer which highlights unlexed data with the CssLexer.

-
---
-
-
-
-
-
-
-
-



Short names:css+erb, css+ruby
Filename patterns:None
Mimetypes:text/css+ruby

-

-
CssGenshiLexer

-

-
A lexer that highlights CSS definitions in genshi text templates.

-
---
-
-
-
-
-
-
-
-



Short names:css+genshitext, css+genshi
Filename patterns:None
Mimetypes:text/css+genshi

-

-
CssPhpLexer

-

-
Subclass of PhpLexer which highlights unmatched data with the CssLexer.

-
---
-
-
-
-
-
-
-
-



Short names:css+php
Filename patterns:None
Mimetypes:text/css+php

-

-
CssSmartyLexer

-

-
Subclass of the SmartyLexer that highlights unlexed data with the
-CssLexer.

-
---
-
-
-
-
-
-
-
-



Short names:css+smarty
Filename patterns:None
Mimetypes:text/css+smarty

-

-
DjangoLexer

-

-
Generic django
-and jinja template lexer.

-
It just highlights django/jinja code between the preprocessor directives,
-other data is left untouched by the lexer.

-
---
-
-
-
-
-
-
-
-



Short names:django, jinja
Filename patterns:None
Mimetypes:application/x-django-templating, application/x-jinja

-

-
ErbLexer

-

-
Generic ERB (Ruby Templating)
-lexer.

-
Just highlights ruby code between the preprocessor directives, other data
-is left untouched by the lexer.

-
All options are also forwarded to the RubyLexer.

-
---
-
-
-
-
-
-
-
-



Short names:erb
Filename patterns:None
Mimetypes:application/x-ruby-templating

-

-
EvoqueHtmlLexer

-

-
Subclass of the EvoqueLexer that highlights unlexed data with the
-HtmlLexer.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:html+evoque
Filename patterns:*.html
Mimetypes:text/html+evoque

-

-
EvoqueLexer

-

-
For files using the Evoque templating system.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:evoque
Filename patterns:*.evoque
Mimetypes:application/x-evoque

-

-
EvoqueXmlLexer

-

-
Subclass of the EvoqueLexer that highlights unlexed data with the
-XmlLexer.

-
New in Pygments 1.1.

-
---
-
-
-
-
-
-
-
-



Short names:xml+evoque
Filename patterns:*.xml
Mimetypes:application/xml+evoque

-

-
GenshiLexer

-

-
A lexer that highlights genshi and
-kid kid XML templates.

-
---
-
-
-
-
-
-
-
-



Short names:genshi, kid, xml+genshi, xml+kid
Filename patterns:*.kid
Mimetypes:application/x-genshi, application/x-kid

-

-
GenshiTextLexer

-

-
A lexer that highlights genshi text
-templates.

-
---
-
-
-
-
-
-
-
-



Short names:genshitext
Filename patterns:None
Mimetypes:application/x-genshi-text, text/x-genshi

-

-
HtmlDjangoLexer

-

-
Subclass of the DjangoLexer that highighlights unlexed data with the
-HtmlLexer.

-
Nested Javascript and CSS is highlighted too.

-
---
-
-
-
-
-
-
-
-



Short names:html+django, html+jinja
Filename patterns:None
Mimetypes:text/html+django, text/html+jinja

-

-
HtmlGenshiLexer

-

-
A lexer that highlights genshi and
-kid kid HTML templates.

-
---
-
-
-
-
-
-
-
-



Short names:html+genshi, html+kid
Filename patterns:None
Mimetypes:text/html+genshi

-

-
HtmlPhpLexer

-

-
Subclass of PhpLexer that highlights unhandled data with the HtmlLexer.

-
Nested Javascript and CSS is highlighted too.

-
---
-
-
-
-
-
-
-
-



Short names:html+php
Filename patterns:*.phtml
Mimetypes:application/x-php, application/x-httpd-php, application/x-httpd-php3, application/x-httpd-php4, application/x-httpd-php5

-

-
HtmlSmartyLexer

-

-
Subclass of the SmartyLexer that highighlights unlexed data with the
-HtmlLexer.

-
Nested Javascript and CSS is highlighted too.

-
---
-
-
-
-
-
-
-
-



Short names:html+smarty
Filename patterns:None
Mimetypes:text/html+smarty

-

-
JavascriptDjangoLexer

-

-
Subclass of the DjangoLexer that highlights unlexed data with the
-JavascriptLexer.

-
---
-
-
-
-
-
-
-
-



Short names:js+django, javascript+django, js+jinja, javascript+jinja
Filename patterns:None
Mimetypes:application/x-javascript+django, application/x-javascript+jinja, text/x-javascript+django, text/x-javascript+jinja, text/javascript+django, text/javascript+jinja

-

-
JavascriptErbLexer

-

-
Subclass of ErbLexer which highlights unlexed data with the
-JavascriptLexer.

-
---
-
-
-
-
-
-
-
-



Short names:js+erb, javascript+erb, js+ruby, javascript+ruby
Filename patterns:None
Mimetypes:application/x-javascript+ruby, text/x-javascript+ruby, text/javascript+ruby

-

-
JavascriptGenshiLexer

-

-
A lexer that highlights javascript code in genshi text templates.

-
---
-
-
-
-
-
-
-
-



Short names:js+genshitext, js+genshi, javascript+genshitext, javascript+genshi
Filename patterns:None
Mimetypes:application/x-javascript+genshi, text/x-javascript+genshi, text/javascript+genshi

-

-
JavascriptPhpLexer

-

-
Subclass of PhpLexer which highlights unmatched data with the
-JavascriptLexer.

-
---
-
-
-
-
-
-
-
-



Short names:js+php, javascript+php
Filename patterns:None
Mimetypes:application/x-javascript+php, text/x-javascript+php, text/javascript+php

-

-
JavascriptSmartyLexer

-

-
Subclass of the SmartyLexer that highlights unlexed data with the
-JavascriptLexer.

-
---
-
-
-
-
-
-
-
-



Short names:js+smarty, javascript+smarty
Filename patterns:None
Mimetypes:application/x-javascript+smarty, text/x-javascript+smarty, text/javascript+smarty

-

-
JspLexer

-

-
Lexer for Java Server Pages.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:jsp
Filename patterns:*.jsp
Mimetypes:application/x-jsp

-

-
LassoCssLexer

-

-
Subclass of the LassoLexer which highlights unhandled data with the
-CssLexer.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:css+lasso
Filename patterns:None
Mimetypes:text/css+lasso

-

-
LassoHtmlLexer

-

-
Subclass of the LassoLexer which highlights unhandled data with the
-HtmlLexer.

-
Nested JavaScript and CSS is also highlighted.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:html+lasso
Filename patterns:None
Mimetypes:text/html+lasso, application/x-httpd-lasso, application/x-httpd-lasso[89]

-

-
LassoJavascriptLexer

-

-
Subclass of the LassoLexer which highlights unhandled data with the
-JavascriptLexer.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:js+lasso, javascript+lasso
Filename patterns:None
Mimetypes:application/x-javascript+lasso, text/x-javascript+lasso, text/javascript+lasso

-

-
LassoXmlLexer

-

-
Subclass of the LassoLexer which highlights unhandled data with the
-XmlLexer.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:xml+lasso
Filename patterns:None
Mimetypes:application/xml+lasso

-

-
MakoCssLexer

-

-
Subclass of the MakoLexer that highlights unlexer data
-with the CssLexer.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:css+mako
Filename patterns:None
Mimetypes:text/css+mako

-

-
MakoHtmlLexer

-

-
Subclass of the MakoLexer that highlights unlexed data
-with the HtmlLexer.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:html+mako
Filename patterns:None
Mimetypes:text/html+mako

-

-
MakoJavascriptLexer

-

-
Subclass of the MakoLexer that highlights unlexer data
-with the JavascriptLexer.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:js+mako, javascript+mako
Filename patterns:None
Mimetypes:application/x-javascript+mako, text/x-javascript+mako, text/javascript+mako

-

-
MakoLexer

-

-
Generic mako templates lexer. Code that isn't Mako
-markup is yielded as Token.Other.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:mako
Filename patterns:*.mao
Mimetypes:application/x-mako

-

-
MakoXmlLexer

-

-
Subclass of the MakoLexer that highlights unlexer data
-with the XmlLexer.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:xml+mako
Filename patterns:None
Mimetypes:application/xml+mako

-

-
MasonLexer

-

-
Generic mason templates lexer. Stolen from Myghty lexer. Code that isn't
-Mason markup is HTML.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:mason
Filename patterns:*.m, *.mhtml, *.mc, *.mi, autohandler, dhandler
Mimetypes:application/x-mason

-

-
MyghtyCssLexer

-

-
Subclass of the MyghtyLexer that highlights unlexer data
-with the CssLexer.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:css+myghty
Filename patterns:None
Mimetypes:text/css+myghty

-

-
MyghtyHtmlLexer

-

-
Subclass of the MyghtyLexer that highlights unlexer data
-with the HtmlLexer.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:html+myghty
Filename patterns:None
Mimetypes:text/html+myghty

-

-
MyghtyJavascriptLexer

-

-
Subclass of the MyghtyLexer that highlights unlexer data
-with the JavascriptLexer.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:js+myghty, javascript+myghty
Filename patterns:None
Mimetypes:application/x-javascript+myghty, text/x-javascript+myghty, text/javascript+mygthy

-

-
MyghtyLexer

-

-
Generic myghty templates lexer. Code that isn't Myghty
-markup is yielded as Token.Other.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:myghty
Filename patterns:*.myt, autodelegate
Mimetypes:application/x-myghty

-

-
MyghtyXmlLexer

-

-
Subclass of the MyghtyLexer that highlights unlexer data
-with the XmlLexer.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:xml+myghty
Filename patterns:None
Mimetypes:application/xml+myghty

-

-
RhtmlLexer

-

-
Subclass of the ERB lexer that highlights the unlexed data with the
-html lexer.

-
Nested Javascript and CSS is highlighted too.

-
---
-
-
-
-
-
-
-
-



Short names:rhtml, html+erb, html+ruby
Filename patterns:*.rhtml
Mimetypes:text/html+ruby

-

-
SmartyLexer

-

-
Generic Smarty template lexer.

-
Just highlights smarty code between the preprocessor directives, other
-data is left untouched by the lexer.

-
---
-
-
-
-
-
-
-
-



Short names:smarty
Filename patterns:*.tpl
Mimetypes:application/x-smarty

-

-
SspLexer

-

-
Lexer for Scalate Server Pages.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:ssp
Filename patterns:*.ssp
Mimetypes:application/x-ssp

-

-
TeaTemplateLexer

-

-
Lexer for Tea Templates.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:tea
Filename patterns:*.tea
Mimetypes:text/x-tea

-

-
VelocityHtmlLexer

-

-
Subclass of the VelocityLexer that highlights unlexer data
-with the HtmlLexer.

-
---
-
-
-
-
-
-
-
-



Short names:html+velocity
Filename patterns:None
Mimetypes:text/html+velocity

-

-
VelocityLexer

-

-
Generic Velocity template lexer.

-
Just highlights velocity directives and variable references, other
-data is left untouched by the lexer.

-
---
-
-
-
-
-
-
-
-



Short names:velocity
Filename patterns:*.vm, *.fhtml
Mimetypes:None

-

-
VelocityXmlLexer

-

-
Subclass of the VelocityLexer that highlights unlexer data
-with the XmlLexer.

-
---
-
-
-
-
-
-
-
-



Short names:xml+velocity
Filename patterns:None
Mimetypes:application/xml+velocity

-

-
XmlDjangoLexer

-

-
Subclass of the DjangoLexer that highlights unlexed data with the
-XmlLexer.

-
---
-
-
-
-
-
-
-
-



Short names:xml+django, xml+jinja
Filename patterns:None
Mimetypes:application/xml+django, application/xml+jinja

-

-
XmlErbLexer

-

-
Subclass of ErbLexer which highlights data outside preprocessor
-directives with the XmlLexer.

-
---
-
-
-
-
-
-
-
-



Short names:xml+erb, xml+ruby
Filename patterns:None
Mimetypes:application/xml+ruby

-

-
XmlPhpLexer

-

-
Subclass of PhpLexer that higlights unhandled data with the XmlLexer.

-
---
-
-
-
-
-
-
-
-



Short names:xml+php
Filename patterns:None
Mimetypes:application/xml+php

-

-
XmlSmartyLexer

-

-
Subclass of the SmartyLexer that highlights unlexed data with the
-XmlLexer.

-
---
-
-
-
-
-
-
-
-



Short names:xml+smarty
Filename patterns:None
Mimetypes:application/xml+smarty

-

-

-

-
Lexers for non-source code file types

-
ApacheConfLexer

-

-
Lexer for configuration files following the Apache config file
-format.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:apacheconf, aconf, apache
Filename patterns:.htaccess, apache.conf, apache2.conf
Mimetypes:text/x-apacheconf

-

-
BBCodeLexer

-

-
A lexer that highlights BBCode(-like) syntax.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:bbcode
Filename patterns:None
Mimetypes:text/x-bbcode

-

-
BaseMakefileLexer

-

-
Lexer for simple Makefiles (no preprocessing).

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:basemake
Filename patterns:None
Mimetypes:None

-

-
CMakeLexer

-

-
Lexer for CMake files.

-
New in Pygments 1.2.

-
---
-
-
-
-
-
-
-
-



Short names:cmake
Filename patterns:*.cmake, CMakeLists.txt
Mimetypes:text/x-cmake

-

-
DarcsPatchLexer

-

-
DarcsPatchLexer is a lexer for the various versions of the darcs patch
-format.  Examples of this format are derived by commands such as
-darcs annotate --patch and darcs send.

-
New in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:dpatch
Filename patterns:*.dpatch, *.darcspatch
Mimetypes:None

-

-
DebianControlLexer

-

-
Lexer for Debian control files and apt-cache show <pkg> outputs.

-
New in Pygments 0.9.

-
---
-
-
-
-
-
-
-
-



Short names:control
Filename patterns:control
Mimetypes:None

-

-
DiffLexer

-

-
Lexer for unified or context-style diffs or patches.

-
---
-
-
-
-
-
-
-
-



Short names:diff, udiff
Filename patterns:*.diff, *.patch
Mimetypes:text/x-diff, text/x-patch

-

-
GettextLexer

-

-
Lexer for Gettext catalog files.

-
New in Pygments 0.9.

-
---
-
-
-
-
-
-
-
-



Short names:pot, po
Filename patterns:*.pot, *.po
Mimetypes:application/x-gettext, text/x-gettext, text/gettext

-

-
GroffLexer

-

-
Lexer for the (g)roff typesetting language, supporting groff
-extensions. Mainly useful for highlighting manpage sources.

-
New in Pygments 0.6.

-
---
-
-
-
-
-
-
-
-



Short names:groff, nroff, man
Filename patterns:*.[1234567], *.man
Mimetypes:application/x-troff, text/troff

-

-
HttpLexer

-

-
Lexer for HTTP sessions.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:http
Filename patterns:None
Mimetypes:None

-

-
HxmlLexer

-

-
Lexer for haXe build files.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:haxeml, hxml
Filename patterns:*.hxml
Mimetypes:None

-

-
IniLexer

-

-
Lexer for configuration files in INI style.

-
---
-
-
-
-
-
-
-
-



Short names:ini, cfg
Filename patterns:*.ini, *.cfg
Mimetypes:text/x-ini

-

-
IrcLogsLexer

-

-
Lexer for IRC logs in irssi, xchat or weechat style.

-
---
-
-
-
-
-
-
-
-



Short names:irc
Filename patterns:*.weechatlog
Mimetypes:text/x-irclog

-

-
LighttpdConfLexer

-

-
Lexer for Lighttpd configuration files.

-
New in Pygments 0.11.

-
---
-
-
-
-
-
-
-
-



Short names:lighty, lighttpd
Filename patterns:None
Mimetypes:text/x-lighttpd-conf

-

-
MakefileLexer

-

-
Lexer for BSD and GNU make extensions (lenient enough to handle both in
-the same file even).

-
Rewritten in Pygments 0.10.

-
---
-
-
-
-
-
-
-
-



Short names:make, makefile, mf, bsdmake
Filename patterns:*.mak, Makefile, makefile, Makefile.*, GNUmakefile
Mimetypes:text/x-makefile

-

-
MoinWikiLexer

-

-
For MoinMoin (and Trac) Wiki markup.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:trac-wiki, moin
Filename patterns:None
Mimetypes:text/x-trac-wiki

-

-
NginxConfLexer

-

-
Lexer for Nginx configuration files.

-
New in Pygments 0.11.

-
---
-
-
-
-
-
-
-
-



Short names:nginx
Filename patterns:None
Mimetypes:text/x-nginx-conf

-

-
PropertiesLexer

-

-
Lexer for configuration files in Java's properties format.

-
New in Pygments 1.4.

-
---
-
-
-
-
-
-
-
-



Short names:properties
Filename patterns:*.properties
Mimetypes:text/x-java-properties

-

-
PyPyLogLexer

-

-
Lexer for PyPy log files.

-
New in Pygments 1.5.

-
---
-
-
-
-
-
-
-
-



Short names:pypylog, pypy
Filename patterns:*.pypylog
Mimetypes:application/x-pypylog

-

-
RegeditLexer

-

-
Lexer for Windows Registry files produced
-by regedit.

-
New in Pygments 1.6.

-
---
-
-
-
-
-
-
-
-



Short names:None
Filename patterns:*.reg
Mimetypes:text/x-windows-registry

-

-
RstLexer

-

-
For reStructuredText markup.

-
New in Pygments 0.7.

-
Additional options accepted:

-

-
handlecodeblocks

-
Highlight the contents of .. sourcecode:: langauge and
-.. code:: language directives with a lexer for the given
-language (default: True). New in Pygments 0.8.

-

-
---
-
-
-
-
-
-
-
-



Short names:rst, rest, restructuredtext
Filename patterns:*.rst, *.rest
Mimetypes:text/x-rst, text/prs.fallenstein.rst

-

-
SourcesListLexer

-

-
Lexer that highlights debian sources.list files.

-
New in Pygments 0.7.

-
---
-
-
-
-
-
-
-
-



Short names:sourceslist, sources.list
Filename patterns:sources.list
Mimetypes:None

-

-
SquidConfLexer

-

-
Lexer for squid configuration files.

-
New in Pygments 0.9.

-
---
-
-
-
-
-
-
-
-



Short names:squidconf, squid.conf, squid
Filename patterns:squid.conf
Mimetypes:text/x-squidconf

-

-
TexLexer

-

-
Lexer for the TeX and LaTeX typesetting languages.

-
---
-
-
-
-
-
-
-
-



Short names:tex, latex
Filename patterns:*.tex, *.aux, *.toc
Mimetypes:text/x-tex, text/x-latex

-

-
VimLexer

-

-
Lexer for VimL script files.

-
New in Pygments 0.8.

-
---
-
-
-
-
-
-
-
-



Short names:vim
Filename patterns:*.vim, .vimrc, .exrc, .gvimrc, vimrc, exrc, gvimrc, vimrc, gvimrc
Mimetypes:text/x-vim

-

-
YamlLexer

-

-
Lexer for YAML, a human-friendly data serialization
-language.

-
New in Pygments 0.11.

-
---
-
-
-
-
-
-
-
-



Short names:yaml
Filename patterns:*.yaml, *.yml
Mimetypes:text/x-yaml

-

-

-
-

-
Iterating over all lexers

-
New in Pygments 0.6.

-
To get all lexers (both the builtin and the plugin ones), you can
-use the get_all_lexers() function from the pygments.lexers
-module:

-
>>> from pygments.lexers import get_all_lexers
->>> i = get_all_lexers()
->>> i.next()
-('Diff', ('diff',), ('*.diff', '*.patch'), ('text/x-diff', 'text/x-patch'))
->>> i.next()
-('Delphi', ('delphi', 'objectpascal', 'pas', 'pascal'), ('*.pas',), ('text/x-pascal',))
->>> i.next()
-('XML+Ruby', ('xml+erb', 'xml+ruby'), (), ())
-

-
As you can see, the return value is an iterator which yields tuples
-in the form (name, aliases, filetypes, mimetypes).

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/moinmoin.html b/docs/build/moinmoin.html
deleted file mode 100644
index 4851501..0000000
--- a/docs/build/moinmoin.html
+++ /dev/null
@@ -1,245 +0,0 @@
-
-
-
-  Using Pygments with MoinMoin — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Using Pygments with MoinMoin

-    
-      « Back To Index
-    
-    
-    
-
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.

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/plugins.html b/docs/build/plugins.html
deleted file mode 100644
index 5cb2229..0000000
--- a/docs/build/plugins.html
+++ /dev/null
@@ -1,294 +0,0 @@
-
-
-
-  Register Plugins — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Register Plugins

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
If you want to extend Pygments without hacking the sources, but want to
-use the lexer/formatter/style/filter lookup functions (lexers.get_lexer_by_name
-et al.), you can use setuptools entrypoints to add new lexers, formatters
-or styles as if they were in the Pygments core.

-
That means you can use your highlighter modules with the pygmentize script,
-which relies on the mentioned functions.

-

-
Entrypoints

-
Here is a list of setuptools entrypoints that Pygments understands:

-
pygments.lexers

-

-
This entrypoint is used for adding new lexers to the Pygments core.
-The name of the entrypoint values doesn't really matter, Pygments extracts
-required metadata from the class definition:

-
[pygments.lexers]
-yourlexer = yourmodule:YourLexer
-

-
Note that you have to define name, aliases and filename
-attributes so that you can use the highlighter from the command line:

-
class YourLexer(...):
-    name = 'Name Of Your Lexer'
-    aliases = ['alias']
-    filenames = ['*.ext']
-

-

-
pygments.formatters

-

-
You can use this entrypoint to add new formatters to Pygments. The
-name of an entrypoint item is the name of the formatter. If you
-prefix the name with a slash it's used as a filename pattern:

-
[pygments.formatters]
-yourformatter = yourmodule:YourFormatter
-/.ext = yourmodule:YourFormatter
-

-

-
pygments.styles

-

-
To add a new style you can use this entrypoint. The name of the entrypoint
-is the name of the style:

-
[pygments.styles]
-yourstyle = yourmodule:YourStyle
-

-

-
pygments.filters

-

-
Use this entrypoint to register a new filter. The name of the
-entrypoint is the name of the filter:

-
[pygments.filters]
-yourfilter = yourmodule:YourFilter
-

-

-

-

-
How To Use Entrypoints

-
This documentation doesn't explain how to use those entrypoints because this is
-covered in the setuptools documentation. That page should cover everything
-you need to write a plugin.

-

-

-
Extending The Core

-
If you have written a Pygments plugin that is open source, please inform us
-about that. There is a high chance that we'll add it to the Pygments
-distribution.

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/quickstart.html b/docs/build/quickstart.html
deleted file mode 100644
index 234aa80..0000000
--- a/docs/build/quickstart.html
+++ /dev/null
@@ -1,390 +0,0 @@
-
-
-
-  Introduction and Quickstart — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Introduction and Quickstart

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
Welcome to Pygments! This document explains the basic concepts and terms and
-gives a few examples of how to use the library.

-

-
Architecture

-
There are four types of components that work together highlighting a piece of
-code:

-
    
-
  • A lexer splits the source into tokens, fragments of the source that
-have a token type that determines what the text represents semantically
-(e.g., keyword, string, or comment). There is a lexer for every language
-or markup format that Pygments supports.
    • 
-
  • The token stream can be piped through filters, which usually modify
-the token types or text fragments, e.g. uppercasing all keywords.
    • 
-
  • A formatter then takes the token stream and writes it to an output
-file, in a format such as HTML, LaTeX or RTF.
    • 
-
  • While writing the output, a style determines how to highlight all the
-different token types. It maps them to attributes like "red and bold".
    • 
-

-

-

-
Example

-
Here is a small example for highlighting Python code:

-
from pygments import highlight
-from pygments.lexers import PythonLexer
-from pygments.formatters import HtmlFormatter
-
-code = 'print "Hello World"'
-print highlight(code, PythonLexer(), HtmlFormatter())
-

-
which prints something like this:

-
<div class="highlight">
-<pre><span class="k">print</span> <span class="s">&quot;Hello World&quot;</span></pre>
-</div>
-

-
As you can see, Pygments uses CSS classes (by default, but you can change that)
-instead of inline styles in order to avoid outputting redundant style information over
-and over. A CSS stylesheet that contains all CSS classes possibly used in the output
-can be produced by:

-
print HtmlFormatter().get_style_defs('.highlight')
-

-
The argument to get_style_defs is used as an additional CSS selector: the output
-may look like this:

-
.highlight .k { color: #AA22FF; font-weight: bold }
-.highlight .s { color: #BB4444 }
-...
-

-

-

-
Options

-
The highlight() function supports a fourth argument called outfile, it must be
-a file object if given. The formatted output will then be written to this file
-instead of being returned as a string.

-
Lexers and formatters both support options. They are given to them as keyword
-arguments either to the class or to the lookup method:

-
from pygments import highlight
-from pygments.lexers import get_lexer_by_name
-from pygments.formatters import HtmlFormatter
-
-lexer = get_lexer_by_name("python", stripall=True)
-formatter = HtmlFormatter(linenos=True, cssclass="source")
-result = highlight(code, lexer, formatter)
-

-
This makes the lexer strip all leading and trailing whitespace from the input
-(stripall option), lets the formatter output line numbers (linenos option),
-and sets the wrapping <div>'s class to source (instead of
-highlight).

-
Important options include:

-

-
encoding : for lexers and formatters

-
Since Pygments uses Unicode strings internally, this determines which
-encoding will be used to convert to or from byte strings.

-
style : for formatters

-
The name of the style to use when writing the output.

-

-
For an overview of builtin lexers and formatters and their options, visit the
-lexer and formatters lists.

-
For a documentation on filters, see this page.

-

-

-
Lexer and formatter lookup

-
If you want to lookup a built-in lexer by its alias or a filename, you can use
-one of the following methods:

-
>>> from pygments.lexers import (get_lexer_by_name,
-...     get_lexer_for_filename, get_lexer_for_mimetype)
-
->>> get_lexer_by_name('python')
-<pygments.lexers.PythonLexer>
-
->>> get_lexer_for_filename('spam.rb')
-<pygments.lexers.RubyLexer>
-
->>> get_lexer_for_mimetype('text/x-perl')
-<pygments.lexers.PerlLexer>
-

-
All these functions accept keyword arguments; they will be passed to the lexer
-as options.

-
A similar API is available for formatters: use get_formatter_by_name() and
-get_formatter_for_filename() from the pygments.formatters module
-for this purpose.

-

-

-
Guessing lexers

-
If you don't know the content of the file, or you want to highlight a file
-whose extension is ambiguous, such as .html (which could contain plain HTML
-or some template tags), use these functions:

-
>>> from pygments.lexers import guess_lexer, guess_lexer_for_filename
-
->>> guess_lexer('#!/usr/bin/python\nprint "Hello World!"')
-<pygments.lexers.PythonLexer>
-
->>> guess_lexer_for_filename('test.py', 'print "Hello World!"')
-<pygments.lexers.PythonLexer>
-

-
guess_lexer() passes the given content to the lexer classes' analyse_text()
-method and returns the one for which it returns the highest number.

-
All lexers have two different filename pattern lists: the primary and the
-secondary one. The get_lexer_for_filename() function only uses the primary
-list, whose entries are supposed to be unique among all lexers.
-guess_lexer_for_filename(), however, will first loop through all lexers and
-look at the primary and secondary filename patterns if the filename matches.
-If only one lexer matches, it is returned, else the guessing mechanism of
-guess_lexer() is used with the matching lexers.

-
As usual, keyword arguments to these functions are given to the created lexer
-as options.

-

-

-
Command line usage

-
You can use Pygments from the command line, using the pygmentize script:

-
-$ pygmentize test.py
-

-
will highlight the Python file test.py using ANSI escape sequences
-(a.k.a. terminal colors) and print the result to standard output.

-
To output HTML, use the -f option:

-
-$ pygmentize -f html -o test.html test.py
-

-
to write an HTML-highlighted version of test.py to the file test.html.
-Note that it will only be a snippet of HTML, if you want a full HTML document,
-use the "full" option:

-
-$ pygmentize -f html -O full -o test.html test.py
-

-
This will produce a full HTML document with included stylesheet.

-
A style can be selected with -O style=<name>.

-
If you need a stylesheet for an existing HTML file using Pygments CSS classes,
-it can be created with:

-
-$ pygmentize -S default -f html > style.css
-

-
where default is the style name.

-
More options and tricks and be found in the command line reference.

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/rstdirective.html b/docs/build/rstdirective.html
deleted file mode 100644
index f7f54ec..0000000
--- a/docs/build/rstdirective.html
+++ /dev/null
@@ -1,229 +0,0 @@
-
-
-
-  Using Pygments in ReST documents — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Using Pygments in ReST documents

-    
-      « Back To Index
-    
-    
-    
-
Many Python people use ReST for documentation their sourcecode, programs,
-scripts et cetera. This also means that documentation often includes sourcecode
-samples or snippets.

-
You can easily enable Pygments support for your ReST texts using a custom
-directive -- this is also how this documentation displays source code.

-
From Pygments 0.9, the directive is shipped in the distribution as
-external/rst-directive.py.  You can copy and adapt this code to your liking.

-
-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/styles.html b/docs/build/styles.html
deleted file mode 100644
index 0a897de..0000000
--- a/docs/build/styles.html
+++ /dev/null
@@ -1,341 +0,0 @@
-
-
-
-  Styles — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Styles

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
Pygments comes with some builtin styles that work for both the HTML and
-LaTeX formatter.

-
The builtin styles can be looked up with the get_style_by_name function:

-
>>> from pygments.styles import get_style_by_name
->>> get_style_by_name('colorful')
-<class 'pygments.styles.colorful.ColorfulStyle'>
-

-
You can pass a instance of a Style class to a formatter as the style
-option in form of a string:

-
>>> from pygments.styles import get_style_by_name
->>> HtmlFormatter(style='colorful').style
-<class 'pygments.styles.colorful.ColorfulStyle'>
-

-
Or you can also import your own style (which must be a subclass of
-pygments.style.Style) and pass it to the formatter:

-
>>> from yourapp.yourmodule import YourStyle
->>> HtmlFormatter(style=YourStyle).style
-<class 'yourapp.yourmodule.YourStyle'>
-

-

-
Creating Own Styles

-
So, how to create a style? All you have to do is to subclass Style and
-define some styles:

-
from pygments.style import Style
-from pygments.token import Keyword, Name, Comment, String, Error, \
-     Number, Operator, Generic
-
-class YourStyle(Style):
-    default_style = ""
-    styles = {
-        Comment:                'italic #888',
-        Keyword:                'bold #005',
-        Name:                   '#f00',
-        Name.Function:          '#0f0',
-        Name.Class:             'bold #0f0',
-        String:                 'bg:#eee #111'
-    }
-

-
That's it. There are just a few rules. When you define a style for Name
-the style automatically also affects Name.Function and so on. If you
-defined 'bold' and you don't want boldface for a subtoken use 'nobold'.

-
(Philosophy: the styles aren't written in CSS syntax since this way
-they can be used for a variety of formatters.)

-
default_style is the style inherited by all token types.

-
To make the style usable for Pygments, you must

-
    
-
  • either register it as a plugin (see the plugin docs)
    • 
-
  • or drop it into the styles subpackage of your Pygments distribution one style
-class per style, where the file name is the style name and the class name is
-StylenameClass. For example, if your style should be called
-"mondrian", name the class MondrianStyle, put it into the file
-mondrian.py and this file into the pygments.styles subpackage
-directory.
    • 
-

-

-

-
Style Rules

-
Here a small overview of all allowed styles:

-

-
bold

-
render text as bold

-
nobold

-
don't render text as bold (to prevent subtokens being highlighted bold)

-
italic

-
render text italic

-
noitalic

-
don't render text as italic

-
underline

-
render text underlined

-
nounderline

-
don't render text underlined

-
bg:

-
transparent background

-
bg:#000000

-
background color (black)

-
border:

-
no border

-
border:#ffffff

-
border color (white)

-
#ff0000

-
text color (red)

-
noinherit

-
don't inherit styles from supertoken

-

-
Note that there may not be a space between bg: and the color value
-since the style definition string is split at whitespace.
-Also, using named colors is not allowed since the supported color names
-vary for different formatters.

-
Furthermore, not all lexers might support every style.

-

-

-
Builtin Styles

-
Pygments ships some builtin styles which are maintained by the Pygments team.

-
To get a list of known styles you can use this snippet:

-
>>> from pygments.styles import STYLE_MAP
->>> STYLE_MAP.keys()
-['default', 'emacs', 'friendly', 'colorful']
-

-

-

-
Getting a list of available styles

-
New in Pygments 0.6.

-
Because it could be that a plugin registered a style, there is
-a way to iterate over all styles:

-
>>> from pygments.styles import get_all_styles
->>> styles = list(get_all_styles())
-

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/tokens.html b/docs/build/tokens.html
deleted file mode 100644
index fe919ec..0000000
--- a/docs/build/tokens.html
+++ /dev/null
@@ -1,541 +0,0 @@
-
-
-
-  Builtin Tokens — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Builtin Tokens

-    
-      « Back To Index
-    
-    
-      

-        
Contents

-        
-      

-    
-    
-
Inside the pygments.token module, there is a special object called Token
-that is used to create token types.

-
You can create a new token type by accessing an attribute of Token:

-
>>> from pygments.token import Token
->>> Token.String
-Token.String
->>> Token.String is Token.String
-True
-

-
Note that tokens are singletons so you can use the is operator for comparing
-token types.

-
As of Pygments 0.7 you can also use the in operator to perform set tests:

-
>>> from pygments.token import Comment
->>> Comment.Single in Comment
-True
->>> Comment in Comment.Multi
-False
-

-
This can be useful in filters and if you write lexers on your own without
-using the base lexers.

-
You can also split a token type into a hierarchy, and get the parent of it:

-
>>> String.split()
-[Token, Token.Literal, Token.Literal.String]
->>> String.parent
-Token.Literal
-

-
In principle, you can create an unlimited number of token types but nobody can
-guarantee that a style would define style rules for a token type. Because of
-that, Pygments proposes some global token types defined in the
-pygments.token.STANDARD_TYPES dict.

-
For some tokens aliases are already defined:

-
>>> from pygments.token import String
->>> String
-Token.Literal.String
-

-
Inside the pygments.token module the following aliases are defined:

-
-----
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-





TextToken.Textfor any type of text data
WhitespaceToken.Text.Whitespacefor specially highlighted whitespace
ErrorToken.Errorrepresents lexer errors
OtherToken.Otherspecial token for data not
-matched by a parser (e.g. HTML
-markup in PHP code)
KeywordToken.Keywordany kind of keywords
NameToken.Namevariable/function names
LiteralToken.LiteralAny literals
StringToken.Literal.Stringstring literals
NumberToken.Literal.Numbernumber literals
OperatorToken.Operatoroperators (+, not...)
PunctuationToken.Punctuationpunctuation ([, (...)
CommentToken.Commentany kind of comments
GenericToken.Genericgeneric tokens (have a look at
-the explanation below)

-
The Whitespace token type is new in Pygments 0.8. It is used only by the
-VisibleWhitespaceFilter currently.

-
Normally you just create token types using the already defined aliases. For each
-of those token aliases, a number of subtypes exists (excluding the special tokens
-Token.Text, Token.Error and Token.Other)

-
The is_token_subtype() function in the pygments.token module can be used to
-test if a token type is a subtype of another (such as Name.Tag and Name).
-(This is the same as Name.Tag in Name. The overloaded in operator was newly
-introduced in Pygments 0.7, the function still exists for backwards
-compatiblity.)

-
With Pygments 0.7, it's also possible to convert strings to token types (for example
-if you want to supply a token from the command line):

-
>>> from pygments.token import String, string_to_tokentype
->>> string_to_tokentype("String")
-Token.Literal.String
->>> string_to_tokentype("Token.Literal.String")
-Token.Literal.String
->>> string_to_tokentype(String)
-Token.Literal.String
-

-

-
Keyword Tokens

-

-
Keyword

-
For any kind of keyword (especially if it doesn't match any of the
-subtypes of course).

-
Keyword.Constant

-
For keywords that are constants (e.g. None in future Python versions).

-
Keyword.Declaration

-
For keywords used for variable declaration (e.g. var in some programming
-languages like JavaScript).

-
Keyword.Namespace

-
For keywords used for namespace declarations (e.g. import in Python and
-Java and package in Java).

-
Keyword.Pseudo

-
For keywords that aren't really keywords (e.g. None in old Python
-versions).

-
Keyword.Reserved

-
For reserved keywords.

-
Keyword.Type

-
For builtin types that can't be used as identifiers (e.g. int,
-char etc. in C).

-

-

-

-
Name Tokens

-

-
Name

-
For any name (variable names, function names, classes).

-
Name.Attribute

-
For all attributes (e.g. in HTML tags).

-
Name.Builtin

-
Builtin names; names that are available in the global namespace.

-
Name.Builtin.Pseudo

-
Builtin names that are implicit (e.g. self in Ruby, this in Java).

-
Name.Class

-
Class names. Because no lexer can know if a name is a class or a function
-or something else this token is meant for class declarations.

-
Name.Constant

-
Token type for constants. In some languages you can recognise a token by the
-way it's defined (the value after a const keyword for example). In
-other languages constants are uppercase by definition (Ruby).

-
Name.Decorator

-
Token type for decorators. Decorators are synatic elements in the Python
-language. Similar syntax elements exist in C# and Java.

-
Name.Entity

-
Token type for special entities. (e.g. &nbsp; in HTML).

-
Name.Exception

-
Token type for exception names (e.g. RuntimeError in Python). Some languages
-define exceptions in the function signature (Java). You can highlight
-the name of that exception using this token then.

-
Name.Function

-
Token type for function names.

-
Name.Label

-
Token type for label names (e.g. in languages that support goto).

-
Name.Namespace

-
Token type for namespaces. (e.g. import paths in Java/Python), names following
-the module/namespace keyword in other languages.

-
Name.Other

-
Other names. Normally unused.

-
Name.Tag

-
Tag names (in HTML/XML markup or configuration files).

-
Name.Variable

-
Token type for variables. Some languages have prefixes for variable names
-(PHP, Ruby, Perl). You can highlight them using this token.

-
Name.Variable.Class

-
same as Name.Variable but for class variables (also static variables).

-
Name.Variable.Global

-
same as Name.Variable but for global variables (used in Ruby, for
-example).

-
Name.Variable.Instance

-
same as Name.Variable but for instance variables.

-

-

-

-
Literals

-

-
Literal

-
For any literal (if not further defined).

-
Literal.Date

-
for date literals (e.g. 42d in Boo).

-
String

-
For any string literal.

-
String.Backtick

-
Token type for strings enclosed in backticks.

-
String.Char

-
Token type for single characters (e.g. Java, C).

-
String.Doc

-
Token type for documentation strings (for example Python).

-
String.Double

-
Double quoted strings.

-
String.Escape

-
Token type for escape sequences in strings.

-
String.Heredoc

-
Token type for "heredoc" strings (e.g. in Ruby or Perl).

-
String.Interpol

-
Token type for interpolated parts in strings (e.g. #{foo} in Ruby).

-
String.Other

-
Token type for any other strings (for example %q{foo} string constructs
-in Ruby).

-
String.Regex

-
Token type for regular expression literals (e.g. /foo/ in JavaScript).

-
String.Single

-
Token type for single quoted strings.

-
String.Symbol

-
Token type for symbols (e.g. :foo in LISP or Ruby).

-
Number

-
Token type for any number literal.

-
Number.Float

-
Token type for float literals (e.g. 42.0).

-
Number.Hex

-
Token type for hexadecimal number literals (e.g. 0xdeadbeef).

-
Number.Integer

-
Token type for integer literals (e.g. 42).

-
Number.Integer.Long

-
Token type for long integer literals (e.g. 42L in Python).

-
Number.Oct

-
Token type for octal literals.

-

-

-

-
Operators

-

-
Operator

-
For any punctuation operator (e.g. +, -).

-
Operator.Word

-
For any operator that is a word (e.g. not).

-

-

-

-
Punctuation

-
New in Pygments 0.7.

-

-
Punctuation

-
For any punctuation which is not an operator (e.g. [, (...)

-

-

-

-
Comments

-

-
Comment

-
Token type for any comment.

-
Comment.Multiline

-
Token type for multiline comments.

-
Comment.Preproc

-
Token type for preprocessor comments (also <?php/<% constructs).

-
Comment.Single

-
Token type for comments that end at the end of a line (e.g. # foo).

-
Comment.Special

-
Special data in comments. For example code tags, author and license
-information, etc.

-

-

-

-
Generic Tokens

-
Generic tokens are for special lexers like the DiffLexer that doesn't really
-highlight a programming language but a patch file.

-

-
Generic

-
A generic, unstyled token. Normally you don't use this token type.

-
Generic.Deleted

-
Marks the token value as deleted.

-
Generic.Emph

-
Marks the token value as emphasized.

-
Generic.Error

-
Marks the token value as an error message.

-
Generic.Heading

-
Marks the token value as headline.

-
Generic.Inserted

-
Marks the token value as inserted.

-
Generic.Output

-
Marks the token value as program output (e.g. for python cli lexer).

-
Generic.Prompt

-
Marks the token value as command prompt (e.g. bash lexer).

-
Generic.Strong

-
Marks the token value as bold (e.g. for rst lexer).

-
Generic.Subheading

-
Marks the token value as subheadline.

-
Generic.Traceback

-
Marks the token value as a part of an error traceback.

-

-

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/build/unicode.html b/docs/build/unicode.html
deleted file mode 100644
index ba7784a..0000000
--- a/docs/build/unicode.html
+++ /dev/null
@@ -1,249 +0,0 @@
-
-
-
-  Unicode and Encodings — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
Unicode and Encodings

-    
-      « Back To Index
-    
-    
-    
Since Pygments 0.6, all lexers use unicode strings internally. Because of that
-you might encounter the occasional UnicodeDecodeError if you pass strings with the
-wrong encoding.

-
Per default all lexers have their input encoding set to latin1.
-If you pass a lexer a string object (not unicode), it tries to decode the data
-using this encoding.
-You can override the encoding using the encoding lexer option. If you have the
-chardet library installed and set the encoding to chardet if will ananlyse
-the text and use the encoding it thinks is the right one automatically:

-
from pygments.lexers import PythonLexer
-lexer = PythonLexer(encoding='chardet')
-

-
The best way is to pass Pygments unicode objects. In that case you can't get
-unexpected output.

-
The formatters now send Unicode objects to the stream if you don't set the
-output encoding. You can do so by passing the formatters an encoding option:

-
from pygments.formatters import HtmlFormatter
-f = HtmlFormatter(encoding='utf-8')
-

-
You will have to set this option if you have non-ASCII characters in the
-source and the output stream does not accept Unicode written to it!
-This is the case for all regular files and for terminals.

-
Note: The Terminal formatter tries to be smart: if its output stream has an
-encoding attribute, and you haven't set the option, it will encode any
-Unicode string with this encoding before writing it. This is the case for
-sys.stdout, for example. The other formatters don't have that behavior.

-
Another note: If you call Pygments via the command line (pygmentize),
-encoding is handled differently, see the command line docs.

-
New in Pygments 0.7: the formatters now also accept an outencoding option
-which will override the encoding option if given. This makes it possible to
-use a single options dict with lexers and formatters, and still have different
-input and output encodings.

-
-  

-
-
-
\ No newline at end of file
diff --git a/docs/generate.py b/docs/generate.py
deleted file mode 100755
index f540507..0000000
--- a/docs/generate.py
+++ /dev/null
@@ -1,472 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-"""
-    Generate Pygments Documentation
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Generates a bunch of html files containing the documentation.
-
-    :copyright: Copyright 2006-2013 by the Pygments team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
-
-import os
-import sys
-from datetime import datetime
-from cgi import escape
-
-from docutils import nodes
-from docutils.parsers.rst import directives
-from docutils.core import publish_parts
-from docutils.writers import html4css1
-
-from jinja2 import Template
-
-# try to use the right Pygments to build the docs
-sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
-
-from pygments import highlight, __version__
-from pygments.lexers import get_lexer_by_name
-from pygments.formatters import HtmlFormatter
-
-
-LEXERDOC = '''
-`%s`
-%s
-    :Short names: %s
-    :Filename patterns: %s
-    :Mimetypes: %s
-
-'''
-
-def generate_lexer_docs():
-    from pygments.lexers import LEXERS
-
-    out = []
-
-    modules = {}
-    moduledocstrings = {}
-    for classname, data in sorted(LEXERS.iteritems(), key=lambda x: x[0]):
-        module = data[0]
-        mod = __import__(module, None, None, [classname])
-        cls = getattr(mod, classname)
-        if not cls.__doc__:
-            print "Warning: %s does not have a docstring." % classname
-        modules.setdefault(module, []).append((
-            classname,
-            cls.__doc__,
-            ', '.join(data[2]) or 'None',
-            ', '.join(data[3]).replace('*', '\\*').replace('_', '\\') or 'None',
-            ', '.join(data[4]) or 'None'))
-        if module not in moduledocstrings:
-            moduledocstrings[module] = mod.__doc__
-
-    for module, lexers in sorted(modules.iteritems(), key=lambda x: x[0]):
-        heading = moduledocstrings[module].splitlines()[4].strip().rstrip('.')
-        out.append('\n' + heading + '\n' + '-'*len(heading) + '\n')
-        for data in lexers:
-            out.append(LEXERDOC % data)
-    return ''.join(out).decode('utf-8')
-
-def generate_formatter_docs():
-    from pygments.formatters import FORMATTERS
-
-    out = []
-    for cls, data in sorted(FORMATTERS.iteritems(),
-                            key=lambda x: x[0].__name__):
-        heading = cls.__name__
-        out.append('`' + heading + '`\n' + '-'*(2+len(heading)) + '\n')
-        out.append(cls.__doc__)
-        out.append('''
-    :Short names: %s
-    :Filename patterns: %s
-
-
-''' % (', '.join(data[1]) or 'None', ', '.join(data[2]).replace('*', '\\*') or 'None'))
-    return ''.join(out).decode('utf-8')
-
-def generate_filter_docs():
-    from pygments.filters import FILTERS
-
-    out = []
-    for name, cls in FILTERS.iteritems():
-        out.append('''
-`%s`
-%s
-    :Name: %s
-''' % (cls.__name__, cls.__doc__, name))
-    return ''.join(out).decode('utf-8')
-
-def generate_changelog():
-    fn = os.path.abspath(os.path.join(os.path.dirname(__file__), '..',
-                         'CHANGES'))
-    f = file(fn)
-    result = []
-    in_header = False
-    header = True
-    for line in f:
-        if header:
-            if not in_header and line.strip():
-                in_header = True
-            elif in_header and not line.strip():
-                header = False
-        else:
-            result.append(line.rstrip())
-    f.close()
-    return '\n'.join(result).decode('utf-8')
-
-def generate_authors():
-    fn = os.path.abspath(os.path.join(os.path.dirname(__file__), '..',
-                         'AUTHORS'))
-    f = file(fn)
-    r = f.read().rstrip().decode('utf-8')
-    f.close()
-    return r
-
-LEXERDOCS = generate_lexer_docs()
-FORMATTERDOCS = generate_formatter_docs()
-FILTERDOCS = generate_filter_docs()
-CHANGELOG = generate_changelog()
-AUTHORS = generate_authors()
-
-
-PYGMENTS_FORMATTER = HtmlFormatter(style='pastie', cssclass='syntax')
-
-USAGE = '''\
-Usage: %s   [ ...]
-
-Generate either python or html files out of the documentation.
-
-Mode can either be python or html.\
-''' % sys.argv[0]
-
-TEMPLATE = '''\
-
-
-
-  {{ title }} — Pygments
-  
-  
-
-
-  

-    
Pygments

-    
{{ title }}

-    {% if file_id != "index" %}
-      « Back To Index
-    {% endif %}
-    {% if toc %}
-      

-        
Contents

-        
    
-        {% for key, value in toc %}
-          
  • {{ value }}
    • 
-        {% endfor %}
-        

-      

-    {% endif %}
-    {{ body }}
-  

-
-
-\
-'''
-
-STYLESHEET = '''\
-body {
-    background-color: #f2f2f2;
-    margin: 0;
-    padding: 0;
-    font-family: 'Georgia', serif;
-    color: #111;
-}
-
-#content {
-    background-color: white;
-    padding: 20px;
-    margin: 20px auto 20px auto;
-    max-width: 800px;
-    border: 4px solid #ddd;
-}
-
-h1 {
-    font-weight: normal;
-    font-size: 40px;
-    color: #09839A;
-}
-
-h2 {
-    font-weight: normal;
-    font-size: 30px;
-    color: #C73F00;
-}
-
-h1.heading {
-    margin: 0 0 30px 0;
-}
-
-h2.subheading {
-    margin: -30px 0 0 45px;
-}
-
-h3 {
-    margin-top: 30px;
-}
-
-table.docutils {
-    border-collapse: collapse;
-    border: 2px solid #aaa;
-    margin: 0.5em 1.5em 0.5em 1.5em;
-}
-
-table.docutils td {
-    padding: 2px;
-    border: 1px solid #ddd;
-}
-
-p, li, dd, dt, blockquote {
-    font-size: 15px;
-    color: #333;
-}
-
-p {
-    line-height: 150%;
-    margin-bottom: 0;
-    margin-top: 10px;
-}
-
-hr {
-    border-top: 1px solid #ccc;
-    border-bottom: 0;
-    border-right: 0;
-    border-left: 0;
-    margin-bottom: 10px;
-    margin-top: 20px;
-}
-
-dl {
-    margin-left: 10px;
-}
-
-li, dt {
-    margin-top: 5px;
-}
-
-dt {
-    font-weight: bold;
-}
-
-th {
-    text-align: left;
-}
-
-a {
-    color: #990000;
-}
-
-a:hover {
-    color: #c73f00;
-}
-
-pre {
-    background-color: #f9f9f9;
-    border-top: 1px solid #ccc;
-    border-bottom: 1px solid #ccc;
-    padding: 5px;
-    font-size: 13px;
-    font-family: Bitstream Vera Sans Mono,monospace;
-}
-
-tt {
-    font-size: 13px;
-    font-family: Bitstream Vera Sans Mono,monospace;
-    color: black;
-    padding: 1px 2px 1px 2px;
-    background-color: #f0f0f0;
-}
-
-cite {
-    /* abusing , it's generated by ReST for `x` */
-    font-size: 13px;
-    font-family: Bitstream Vera Sans Mono,monospace;
-    font-weight: bold;
-    font-style: normal;
-}
-
-#backlink {
-    float: right;
-    font-size: 11px;
-    color: #888;
-}
-
-div.toc {
-    margin: 0 0 10px 0;
-}
-
-div.toc h2 {
-    font-size: 20px;
-}
-''' #'
-
-
-def pygments_directive(name, arguments, options, content, lineno,
-                      content_offset, block_text, state, state_machine):
-    try:
-        lexer = get_lexer_by_name(arguments[0])
-    except ValueError:
-        # no lexer found
-        lexer = get_lexer_by_name('text')
-    parsed = highlight(u'\n'.join(content), lexer, PYGMENTS_FORMATTER)
-    return [nodes.raw('', parsed, format="html")]
-pygments_directive.arguments = (1, 0, 1)
-pygments_directive.content = 1
-directives.register_directive('sourcecode', pygments_directive)
-
-
-def create_translator(link_style):
-    class Translator(html4css1.HTMLTranslator):
-        def visit_reference(self, node):
-            refuri = node.get('refuri')
-            if refuri is not None and '/' not in refuri and refuri.endswith('.txt'):
-                node['refuri'] = link_style(refuri[:-4])
-            html4css1.HTMLTranslator.visit_reference(self, node)
-    return Translator
-
-
-class DocumentationWriter(html4css1.Writer):
-
-    def __init__(self, link_style):
-        html4css1.Writer.__init__(self)
-        self.translator_class = create_translator(link_style)
-
-    def translate(self):
-        html4css1.Writer.translate(self)
-        # generate table of contents
-        contents = self.build_contents(self.document)
-        contents_doc = self.document.copy()
-        contents_doc.children = contents
-        contents_visitor = self.translator_class(contents_doc)
-        contents_doc.walkabout(contents_visitor)
-        self.parts['toc'] = self._generated_toc
-
-    def build_contents(self, node, level=0):
-        sections = []
-        i = len(node) - 1
-        while i >= 0 and isinstance(node[i], nodes.section):
-            sections.append(node[i])
-            i -= 1
-        sections.reverse()
-        toc = []
-        for section in sections:
-            try:
-                reference = nodes.reference('', '', refid=section['ids'][0], *section[0])
-            except IndexError:
-                continue
-            ref_id = reference['refid']
-            text = escape(reference.astext())
-            toc.append((ref_id, text))
-
-        self._generated_toc = [('#%s' % href, caption) for href, caption in toc]
-        # no further processing
-        return []
-
-
-def generate_documentation(data, link_style):
-    writer = DocumentationWriter(link_style)
-    data = data.replace('[builtin_lexer_docs]', LEXERDOCS).\
-                replace('[builtin_formatter_docs]', FORMATTERDOCS).\
-                replace('[builtin_filter_docs]', FILTERDOCS).\
-                replace('[changelog]', CHANGELOG).\
-                replace('[authors]', AUTHORS)
-    parts = publish_parts(
-        data,
-        writer=writer,
-        settings_overrides={
-            'initial_header_level': 3,
-            'field_name_limit': 50,
-        }
-    )
-    return {
-        'title':        parts['title'],
-        'body':         parts['body'],
-        'toc':          parts['toc']
-    }
-
-
-def handle_python(filename, fp, dst):
-    now = datetime.now()
-    title = os.path.basename(filename)[:-4]
-    content = fp.read()
-    def urlize(href):
-        # create links for the pygments webpage
-        if href == 'index.txt':
-            return '/docs/'
-        else:
-            return '/docs/%s/' % href
-    parts = generate_documentation(content, urlize)
-    result = file(os.path.join(dst, title + '.py'), 'w')
-    result.write('# -*- coding: utf-8 -*-\n')
-    result.write('"""\n    Pygments Documentation - %s\n' % title)
-    result.write('    %s\n\n' % ('~' * (24 + len(title))))
-    result.write('    Generated on: %s\n"""\n\n' % now)
-    result.write('import datetime\n')
-    result.write('DATE = %r\n' % now)
-    result.write('TITLE = %r\n' % parts['title'])
-    result.write('TOC = %r\n' % parts['toc'])
-    result.write('BODY = %r\n' % parts['body'])
-    result.close()
-
-
-def handle_html(filename, fp, dst):
-    now = datetime.now()
-    title = os.path.basename(filename)[:-4]
-    content = fp.read().decode('utf-8')
-    c = generate_documentation(content, (lambda x: './%s.html' % x))
-    result = file(os.path.join(dst, title + '.html'), 'w')
-    c['style'] = STYLESHEET + PYGMENTS_FORMATTER.get_style_defs('.syntax')
-    c['generation_date'] = now
-    c['file_id'] = title
-    t = Template(TEMPLATE)
-    result.write(t.render(c).encode('utf-8'))
-    result.close()
-
-
-def run(handle_file, dst, sources=()):
-    path = os.path.abspath(os.path.join(os.path.dirname(__file__), 'src'))
-    if not sources:
-        sources = [os.path.join(path, fn) for fn in os.listdir(path)]
-    if not os.path.isdir(dst):
-        os.makedirs(dst)
-    print 'Making docs for Pygments %s in %s' % (__version__, dst)
-    for fn in sources:
-        if not os.path.isfile(fn):
-            continue
-        print 'Processing %s' % fn
-        f = open(fn)
-        try:
-            handle_file(fn, f, dst)
-        finally:
-            f.close()
-
-
-def main(mode, dst='build/', *sources):
-    try:
-        handler = {
-            'html':         handle_html,
-            'python':       handle_python
-        }[mode]
-    except KeyError:
-        print 'Error: unknown mode "%s"' % mode
-        sys.exit(1)
-    run(handler, os.path.realpath(dst), sources)
-
-
-if __name__ == '__main__':
-    if len(sys.argv) == 1:
-        print USAGE
-    else:
-        main(*sys.argv[1:])
diff --git a/docs/pygmentize.1 b/docs/pygmentize.1
deleted file mode 100644
index 71bb6f9..0000000
--- a/docs/pygmentize.1
+++ /dev/null
@@ -1,94 +0,0 @@
-.TH PYGMENTIZE 1 "February 15, 2007"
-
-.SH NAME
-pygmentize \- highlights the input file
-
-.SH SYNOPSIS
-.B \fBpygmentize\fP
-.RI  [-l\ \fI\fP]\ [-F\ \fI\fP[:\fI\fP]]\ [-f\ \fI\fP]
-.RI  [-O\ \fI\fP]\ [-P\ \fI\fP]\ [-o\ \fI\fP]\ [\fI\fP]
-.br
-.B \fBpygmentize\fP
-.RI -S\ \fI