Package trac :: Package wiki :: Module macros :: Class WikiMacroBase

Class WikiMacroBase

    object --+    
             |    
core.Component --+
                 |
                WikiMacroBase

Known Subclasses:

Abstract base class for wiki macros and processors.

On usage error, the MacroError or ProcessorError exception should be raised, to ensure proper display of the error message in the rendered wiki content.

The _description attribute contains the macro help.

Set the hide_from_macro_index attribute to True to prevent displaying help in the macro index ([[MacroList]]). If the default value of False and the _description is empty, "No documentation found" will be displayed.

Nested Classes
Inherited from `core.Component`: `__metaclass__`

Instance Methods

expand_macro(self, formatter, name, content, args=None)

source code

get_macro_description(self, name)
Return the subclass's gettext domain and macro description

source code

get_macros(self)
Yield the name of the macro based on the class name.

source code

parse_macro(self, parser, name, content)

source code

Inherited from core.Component: __repr__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods
Inherited from `core.Component`: `implements`

Class Variables
	abstract = `True`
	hide_from_macro_index = `False`

Properties
Inherited from `object`: `__class__`