summaryrefslogtreecommitdiff
path: root/pygments/formatters/bbcode.py
diff options
context:
space:
mode:
authorgbrandl <devnull@localhost>2007-01-12 22:53:02 +0100
committergbrandl <devnull@localhost>2007-01-12 22:53:02 +0100
commit75dee451b1902e95b91c97f998af4c38e4ce670a (patch)
treeeb7a1df61a6a1d8b0d75ae1dd957005a1b680005 /pygments/formatters/bbcode.py
parentefaccf6fd1322930aca142dd1a96d06d1bae84a3 (diff)
downloadpygments-75dee451b1902e95b91c97f998af4c38e4ce670a.tar.gz
[svn] Generate lexer, formatter and filter docs from docstrings.
There is the problem of ordering, though.
Diffstat (limited to 'pygments/formatters/bbcode.py')
-rw-r--r--pygments/formatters/bbcode.py19
1 files changed, 11 insertions, 8 deletions
diff --git a/pygments/formatters/bbcode.py b/pygments/formatters/bbcode.py
index d9b96485..2f15884a 100644
--- a/pygments/formatters/bbcode.py
+++ b/pygments/formatters/bbcode.py
@@ -18,12 +18,14 @@ __all__ = ['BBCodeFormatter']
class BBCodeFormatter(Formatter):
"""
- Output BBCode tags with appropiate colors and formatting.
+ Formats 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 doesn't support background colors and borders, as there are
- no common BBcodes for that.
+ 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 markup in their [code] tag,
+ 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
@@ -31,12 +33,13 @@ class BBCodeFormatter(Formatter):
Additional options accepted:
- ``codetag``
- If set to true, put the output into [code] tags (default: false).
+ `codetag`
+ If set to true, put the output into ``[code]`` tags (default:
+ ``false``)
- ``monofont``
+ `monofont`
If set to true, add a tag to show the code with a monospace font
- (default: false).
+ (default: ``false``).
"""
def __init__(self, **options):