Forms¶

Form classes for story creation and editing.

Admin Forms¶

CategoryAdminForm¶

class CategoryAdminForm(*args, **kwargs)¶

Bases: ConfigFormBase, TranslatableModelForm

__init__(*args, **kwargs)¶

class Meta¶

Bases: object

model¶: alias of PostCategory

fields = '__all__'¶

base_fields = {'abstract': <djangocms_text.fields.HTMLFormField object>, 'app_config': <django.forms.models.ModelChoiceField object>, 'main_image': <filer.fields.image.AdminImageFormField object>, 'main_image_full': <django.forms.models.ModelChoiceField object>, 'main_image_thumbnail': <django.forms.models.ModelChoiceField object>, 'meta_description': <django.forms.fields.CharField object>, 'name': <django.forms.fields.CharField object>, 'parent': <django.forms.models.ModelChoiceField object>, 'priority': <django.forms.fields.IntegerField object>, 'slug': <django.forms.fields.SlugField object>}¶

declared_fields = {'abstract': <djangocms_text.fields.HTMLFormField object>, 'meta_description': <django.forms.fields.CharField object>, 'name': <django.forms.fields.CharField object>, 'slug': <django.forms.fields.SlugField object>}¶

property media¶: Return all media required to render the widgets on this form.

StoriesConfigForm¶

class StoriesConfigForm(*args, **kwargs)¶

Bases: TranslatableModelForm

Form for StoriesConfig model.

class Meta¶

Bases: object

model¶: alias of StoriesConfig

fields = '__all__'¶

widgets = {'gplus_type': <django.forms.widgets.Select object>, 'menu_structure': <django.forms.widgets.Select object>, 'object_type': <django.forms.widgets.Select object>, 'og_type': <django.forms.widgets.Select object>, 'sitemap_changefreq': <django.forms.widgets.Select object>, 'twitter_type': <django.forms.widgets.Select object>, 'url_patterns': <django.forms.widgets.Select object>}¶

__init__(*args, **kwargs)¶: Initialize the StoriesConfigForm instance with defaults and choices.

base_fields = {'app_title': <django.forms.fields.CharField object>, 'default_image_full': <django.forms.models.ModelChoiceField object>, 'default_image_thumbnail': <django.forms.models.ModelChoiceField object>, 'gplus_author': <django.forms.fields.CharField object>, 'gplus_type': <django.forms.fields.CharField object>, 'menu_empty_categories': <django.forms.fields.BooleanField object>, 'menu_structure': <django.forms.fields.CharField object>, 'namespace': <django.forms.fields.CharField object>, 'object_name': <django.forms.fields.CharField object>, 'object_type': <django.forms.fields.CharField object>, 'og_app_id': <django.forms.fields.CharField object>, 'og_author': <django.forms.fields.CharField object>, 'og_author_url': <django.forms.fields.CharField object>, 'og_profile_id': <django.forms.fields.CharField object>, 'og_publisher': <django.forms.fields.CharField object>, 'og_type': <django.forms.fields.CharField object>, 'paginate_by': <django.forms.fields.IntegerField object>, 'send_knock_create': <django.forms.fields.BooleanField object>, 'send_knock_update': <django.forms.fields.BooleanField object>, 'set_author': <django.forms.fields.BooleanField object>, 'sitemap_changefreq': <django.forms.fields.CharField object>, 'sitemap_priority': <django.forms.fields.DecimalField object>, 'template_prefix': <django.forms.fields.CharField object>, 'twitter_author': <django.forms.fields.CharField object>, 'twitter_site': <django.forms.fields.CharField object>, 'twitter_type': <django.forms.fields.CharField object>, 'type': <django.forms.fields.CharField object>, 'url_patterns': <django.forms.fields.CharField object>, 'use_abstract': <django.forms.fields.BooleanField object>, 'use_placeholder': <django.forms.fields.BooleanField object>, 'use_related': <django.forms.fields.TypedChoiceField object>}¶

declared_fields = {'app_title': <django.forms.fields.CharField object>, 'object_name': <django.forms.fields.CharField object>}¶

property media¶: Return all media required to render the widgets on this form.

Plugin Forms¶

BlogPluginForm¶

class BlogPluginForm(*args, **kwargs)¶

Bases: ModelForm

Base plugin form to inject the list of configured template folders from STORIES_PLUGIN_TEMPLATE_FOLDERS.

__init__(*args, **kwargs)¶

base_fields = {}¶

declared_fields = {}¶

property media¶: Return all media required to render the widgets on this form.

LatestEntriesForm¶

class LatestEntriesForm(*args, **kwargs)¶

Bases: BlogPluginForm

Custom forms for BlogLatestEntriesPlugin to properly load taggit-autosuggest.

__init__(*args, **kwargs)¶

class Media¶

Bases: object

css = {'all': ('djangocms_stories/css/djangocms_stories_admin.css',)}¶

base_fields = {}¶

declared_fields = {}¶

property media¶: Return all media required to render the widgets on this form.

AuthorPostsForm¶

class AuthorPostsForm(*args, **kwargs)¶

Bases: BlogPluginForm

Custom form for BlogAuthorPostsPlugin to apply distinct to the list of authors in plugin changeform.

__init__(*args, **kwargs)¶

base_fields = {}¶

declared_fields = {}¶

property media¶: Return all media required to render the widgets on this form.

Wizard Forms¶

PostWizardForm¶

class PostWizardForm(*args, **kwargs)¶

Bases: ModelForm

Form for the post wizard. It is used to create a new post with the required fields.

default_appconfig = None¶

__init__(*args, **kwargs)¶

class Meta¶

Bases: object

model¶: alias of PostContent

fields = ['title', 'abstract', 'post_text']¶

save(commit=True)¶: Save this form’s self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance.

create_slug()¶: Generate a valid slug, in case the given one is taken

clean_app_config()¶

add_plugin(text)¶

Add text field content as text plugin to the post.

base_fields = {'abstract': <djangocms_text.fields.HTMLFormField object>, 'app_config': <django.forms.fields.IntegerField object>, 'post_text': <djangocms_text.fields.HTMLFormField object>, 'title': <django.forms.fields.CharField object>}¶

declared_fields = {'app_config': <django.forms.fields.IntegerField object>}¶

property media¶: Return all media required to render the widgets on this form.