wiki.core.plugins package

Submodules

class wiki.core.plugins.base.BasePlugin

Bases: object

Plugins should inherit from this

class RenderMedia
css = {}
js = []
BasePlugin.article_tab = None
BasePlugin.article_view = None
BasePlugin.markdown_extensions = []
BasePlugin.settings_form = None
BasePlugin.slug = None
BasePlugin.urlpatterns = {'article': [], 'root': []}
class wiki.core.plugins.base.PluginSettingsFormMixin

Bases: object

get_usermessage()
settings_form_headline = u'Settings for plugin'
settings_order = 1
settings_write_access = False
class wiki.core.plugins.base.PluginSidebarFormMixin(data=None, files=None, auto_id=u'id_%s', prefix=None, initial=None, error_class=<class 'django.forms.util.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None)

Bases: django.forms.models.ModelForm

base_fields = {'unsaved_article_title': <django.forms.fields.CharField object at 0x4245dd0>, 'unsaved_article_content': <django.forms.fields.CharField object at 0x4245ed0>}
declared_fields = {'unsaved_article_title': <django.forms.fields.CharField object at 0x4245dd0>, 'unsaved_article_content': <django.forms.fields.CharField object at 0x4245ed0>}
get_usermessage()
media

Credits to ojii, functions get_module and load are from: https://github.com/ojii/django-load.

Thanks for the technique!

wiki.core.plugins.loader.get_module(app, modname, verbose, failfast)

Internal function to load a module from a single app.

wiki.core.plugins.loader.load(modname, verbose=False, failfast=False)

Loads all modules with name ‘modname’ from all installed apps. If verbose is True, debug information will be printed to stdout. If failfast is True, import errors will not be surpressed.

wiki.core.plugins.loader.load_wiki_plugins()
wiki.core.plugins.registry.get_article_tabs()

Get all article tab dictionaries from plugins

wiki.core.plugins.registry.get_markdown_extensions()

Get all markdown extension classes from plugins

wiki.core.plugins.registry.get_plugins()

Get loaded plugins - do not call before all plugins are loaded.

wiki.core.plugins.registry.get_settings_forms()
wiki.core.plugins.registry.get_sidebar()

Returns plugin classes that should connect to the sidebar

wiki.core.plugins.registry.register(PluginClass)

Register a plugin class. This function will call back your plugin’s constructor.

Module contents

Table Of Contents

This Page