pygments.formatters.bbcode.BBCodeFormatter Class Reference

Inheritance diagram for pygments.formatters.bbcode.BBCodeFormatter:

Collaboration diagram for pygments.formatters.bbcode.BBCodeFormatter:

Public Member Functions
	__init__ (self, **options)
	format_unencoded (self, tokensource, outfile)
Public Member Functions inherited from pygments.formatter.Formatter
	get_style_defs (self, arg='')
	format (self, tokensource, outfile)
	__class_getitem__ (cls, name)

Public Attributes
	styles
Public Attributes inherited from pygments.formatter.Formatter
	style
	full
	title
	encoding
	options

Static Public Attributes
str	name = 'BBCode'
list	aliases = ['bbcode', 'bb']
list	filenames = []
Static Public Attributes inherited from pygments.formatter.Formatter
	name = None
list	aliases = []
list	filenames = []
bool	unicodeoutput = True

Protected Member Functions
	_make_styles (self)

Protected Attributes
	_code
	_mono

Detailed Description

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``).

Constructor & Destructor Documentation

__init__()

pygments.formatters.bbcode.BBCodeFormatter.__init__	(		self,
		**	options
	)

As with lexers, this constructor takes arbitrary optional arguments,
and if you override it, you should first process your own options, then
call the base class implementation.

Reimplemented from pygments.formatter.Formatter.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pygments/formatters/bbcode.py