shoop.xtheme.plugins package

Submodules

shoop.xtheme.plugins.consts module

shoop.xtheme.plugins.consts.FALLBACK_LANGUAGE_CODE = '*'

The pseudo-language code used by TranslatedFields and the relevant Plugin API to mark the untranslated/fallback content

shoop.xtheme.plugins.forms module

class shoop.xtheme.plugins.forms.PluginForm(**kwargs)

Bases: django.forms.forms.Form

Base class for plugin configuration forms.

populate()

get_config()

Get the new config dict for a plugin.

Called when the form is valid, akin to django.forms.models.ModelForm.save.

The default implementation just augments the old config with the cleaned data for the form.

Returns:A new JSONable (!) config dict Return type:dict

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shoop.xtheme.plugins.forms.GenericPluginForm(**kwargs)

Bases: shoop.xtheme.plugins.forms.PluginForm

A generic form for Xtheme plugins; populates itself based on fields in the plugin class.

populate()

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shoop.xtheme.plugins.forms.TranslatableField(*args, **kwargs)

Bases: django.forms.fields.Field

widget

alias of TranslatableFieldWidget

clean(value)

shoop.xtheme.plugins.text module

class shoop.xtheme.plugins.text.TextPlugin(config)

Bases: shoop.xtheme.Plugin

Very basic Markdown rendering plugin.

Instantiate a Plugin with the given config dictionary.

Parameters:config (dict) – Dictionary of freeform configuration data

identifier = 'text'

name = 'Text'

fields = [('text', <shoop.xtheme.plugins.forms.TranslatableField object at 0x7f15c0c6ff60>)]

render(context)

shoop.xtheme.plugins.widgets module

class shoop.xtheme.plugins.widgets.TranslatableFieldWidget(languages, input_widget=<class 'django.forms.widgets.TextInput'>, attrs=None)

Bases: django.forms.widgets.Widget

render(name, value, attrs=None)

id_for_label(id_)

value_from_datadict(data, files, name)

format_output(widget_pairs)

decompress(value)

media

Module contents