cms.apps.faq package

Submodules

cms.apps.faq.admin module

class cms.apps.faq.admin.FaqCategoryAdmin(model, admin_site)

Bases: cms.core.admin.ContentAdmin, cms.core.admin.OrderableSelfAdmin, cms.core.admin.OrderableManyToManyAdmin, cms.apps.menus.admin.MenuableAdmin

Admin class for FaqCategory.

autocomplete_lookup_fields = {'generic': [], 'm2m': ['sites'], 'fk': ['author', 'parent']}
fieldsets_append = {<django.utils.functional.__proxy__ object at 0x593bcd0>: ('parent', 'items')}
fieldsets_exclude = {<django.utils.functional.__proxy__ object at 0x593bb10>: ('keywords',), <django.utils.functional.__proxy__ object at 0x593bc50>: ('schema',)}
list_display = ('get_published_date', 'get_title', 'parent', 'count_children', 'count_items', 'order')
list_editable = ('order', 'parent')
list_filter = ('published_date', 'status', 'login_required', 'keywords__keyword', 'parent')
media
raw_id_fields = ('author', 'sites', 'parent')
sortable_field_name = 'order'
class cms.apps.faq.admin.FaqCategoryInline(parent_model, admin_site)

Bases: cms.contrib.admin.admin.CMSTabularInline

exclude = ('order',)
extra_on_add = 1
media
model

alias of FaqCategory_items

verbose_name = <django.utils.functional.__proxy__ object at 0x593bdd0>
verbose_name_plural = <django.utils.functional.__proxy__ object at 0x593bd90>
class cms.apps.faq.admin.FaqItemAdmin(model, admin_site)

Bases: cms.core.admin.ContentAdmin, cms.contrib.comments.admin.CommentableAdmin, cms.contrib.ratings.admin.RateableAdmin

Admin class for FaqItem.

fieldsets_exclude = {<django.utils.functional.__proxy__ object at 0x5925050>: ('schema',)}
get_categories(obj)
inlines = [<class 'cms.apps.faq.admin.FaqCategoryInline'>, <class 'cms.contrib.galleries.admin.GalleriesGalleryInline'>, <class 'cms.contrib.attachments.admin.AttachmentFileInline'>]
list_display = ('get_published_date', 'get_title', 'get_categories')
media

cms.apps.faq.cms_plugin module

class cms.apps.faq.cms_plugin.CMSPlugin

Bases: cms.core.plugins.CMSPluginBase

admin_icon_class = 'icon-faq'
description = <django.utils.functional.__proxy__ object at 0x33cedd0>
status = 'stable'
verbose_name = <django.utils.functional.__proxy__ object at 0x33cee10>
version = '0.3'

cms.apps.faq.cms_sitemaps module

class cms.apps.faq.cms_sitemaps.FaqCategorySitemap

Bases: cms.contrib.sitemaps.sitemap.SitemapBase

app_label = 'faq'
get_only_fields()
model_name = 'FaqCategory'
class cms.apps.faq.cms_sitemaps.FaqItemSitemap

Bases: cms.contrib.sitemaps.sitemap.SitemapBase

app_label = 'faq'
get_queryset(model)
model_name = 'FaqItem'

cms.apps.faq.management module

cms.apps.faq.management.create_group(sender, **kwargs)

cms.apps.faq.models module

class cms.apps.faq.models.FaqCategory(*args, **kwargs)

Bases: cms.core.models.Content, cms.core.models.Ownable, cms.core.models.OrderableSelf

Main node for a topic area or sub-topic area.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

class FaqCategory.Menus
exception FaqCategory.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

class FaqCategory.Settings
ITEMS_PER_PAGE = {'default': 10}
MEDIA_PATH = {'default': 'categories'}
SITEMAP_CHANGEFREQ = 'weekly'
SITEMAP_PRIORITY = 0.8
FaqCategory.author
FaqCategory.clean_fields(exclude=None)
FaqCategory.content

A descriptor used for the original translated field.

FaqCategory.created_by
FaqCategory.description

A descriptor used for the original translated field.

FaqCategory.faqcategory_set
FaqCategory.get_absolute_url()
FaqCategory.get_keywordsfield_name()
FaqCategory.get_mark_display(*moreargs, **morekwargs)
FaqCategory.get_next_by_created_date(*moreargs, **morekwargs)
FaqCategory.get_next_by_modified_date(*moreargs, **morekwargs)
FaqCategory.get_next_by_published_date(*moreargs, **morekwargs)
FaqCategory.get_previous_by_created_date(*moreargs, **morekwargs)
FaqCategory.get_previous_by_modified_date(*moreargs, **morekwargs)
FaqCategory.get_previous_by_published_date(*moreargs, **morekwargs)
FaqCategory.get_schema_display(*moreargs, **morekwargs)
FaqCategory.get_status_display(*moreargs, **morekwargs)
FaqCategory.image

A descriptor used for the original translated field.

FaqCategory.image_de

A placeholder class that provides a way to set the attribute on the model.

FaqCategory.image_en

A placeholder class that provides a way to set the attribute on the model.

FaqCategory.imagedescription

A descriptor used for the original translated field.

FaqCategory.imageteaser

A descriptor used for the original translated field.

FaqCategory.imageteaser_de

A placeholder class that provides a way to set the attribute on the model.

FaqCategory.imageteaser_en

A placeholder class that provides a way to set the attribute on the model.

FaqCategory.imageteaserdescription

A descriptor used for the original translated field.

FaqCategory.items
FaqCategory.keywords

This class provides the functionality that makes the related-object managers available as attributes on a model class, for fields that have multiple “remote” values and have a GenericRelation defined in their model (rather than having another model pointed at them). In the example “article.publications”, the publications attribute is a ReverseGenericRelatedObjectsDescriptor instance.

FaqCategory.keywords_string

A descriptor used for the original translated field.

FaqCategory.license
FaqCategory.modified_by
FaqCategory.objects = <cms.core.translations.translator.NewMultilingualManager object at 0x4570dd0>
FaqCategory.parent
FaqCategory.sites
FaqCategory.slug

A descriptor used for the original translated field.

FaqCategory.subcategories_deferred()

Returns a recursively generated list of intermediate childrens for the category

FaqCategory.teaser

A descriptor used for the original translated field.

FaqCategory.title

A descriptor used for the original translated field.

FaqCategory.trail_path
class cms.apps.faq.models.FaqItem(*args, **kwargs)

Bases: cms.core.models.Content, cms.core.models.Ownable, cms.core.models.Ratable, cms.core.models.Commentable

Holds the actual faq item info

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

class FaqItem.Menus
exception FaqItem.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

class FaqItem.Settings
ITEMS_PUBDATE = {'default': 'modified_date'}
ITEMS_TEASER_LIMIT = {'default': 50}
MEDIA_PATH = {'default': 'questions'}
SCHEMA = {'default': 'Answer'}
SITEMAP_CHANGEFREQ = 'weekly'
SITEMAP_PRIORITY = 0.8
FaqItem.author
FaqItem.clean_fields(exclude=None)
FaqItem.comments

This class provides the functionality that makes the related-object managers available as attributes on a model class, for fields that have multiple “remote” values and have a GenericRelation defined in their model (rather than having another model pointed at them). In the example “article.publications”, the publications attribute is a ReverseGenericRelatedObjectsDescriptor instance.

FaqItem.comments_count

A descriptor used for the original translated field.

FaqItem.content

A descriptor used for the original translated field.

FaqItem.created_by
FaqItem.description

A descriptor used for the original translated field.

FaqItem.faqcategory_set
FaqItem.get_absolute_url(**kwargs)
FaqItem.get_commentsfield_name()
FaqItem.get_keywordsfield_name()
FaqItem.get_mark_display(*moreargs, **morekwargs)
FaqItem.get_next_by_created_date(*moreargs, **morekwargs)
FaqItem.get_next_by_modified_date(*moreargs, **morekwargs)
FaqItem.get_next_by_published_date(*moreargs, **morekwargs)
FaqItem.get_parent()
FaqItem.get_previous_by_created_date(*moreargs, **morekwargs)
FaqItem.get_previous_by_modified_date(*moreargs, **morekwargs)
FaqItem.get_previous_by_published_date(*moreargs, **morekwargs)
FaqItem.get_ratingfield_name()
FaqItem.get_schema_display(*moreargs, **morekwargs)
FaqItem.get_status_display(*moreargs, **morekwargs)
FaqItem.image

A descriptor used for the original translated field.

FaqItem.image_de

A placeholder class that provides a way to set the attribute on the model.

FaqItem.image_en

A placeholder class that provides a way to set the attribute on the model.

FaqItem.imagedescription

A descriptor used for the original translated field.

FaqItem.imageteaser

A descriptor used for the original translated field.

FaqItem.imageteaser_de

A placeholder class that provides a way to set the attribute on the model.

FaqItem.imageteaser_en

A placeholder class that provides a way to set the attribute on the model.

FaqItem.imageteaserdescription

A descriptor used for the original translated field.

FaqItem.keywords

This class provides the functionality that makes the related-object managers available as attributes on a model class, for fields that have multiple “remote” values and have a GenericRelation defined in their model (rather than having another model pointed at them). In the example “article.publications”, the publications attribute is a ReverseGenericRelatedObjectsDescriptor instance.

FaqItem.keywords_string

A descriptor used for the original translated field.

FaqItem.license
FaqItem.modified_by
FaqItem.objects = <cms.core.translations.translator.NewMultilingualManager object at 0x4569990>
FaqItem.parent
FaqItem.ratings

This class provides the functionality that makes the related-object managers available as attributes on a model class, for fields that have multiple “remote” values and have a GenericRelation defined in their model (rather than having another model pointed at them). In the example “article.publications”, the publications attribute is a ReverseGenericRelatedObjectsDescriptor instance.

FaqItem.sites
FaqItem.slug

A descriptor used for the original translated field.

FaqItem.teaser

A descriptor used for the original translated field.

FaqItem.title

A descriptor used for the original translated field.

cms.apps.faq.search_indexes module

class cms.apps.faq.search_indexes.FaqCategoryIndex

Bases: cms.apps.search.models.SearchBase, haystack.constants.Indexable

content_auto = <haystack.fields.EdgeNgramField object at 0xa2eed50>
description = <haystack.fields.CharField object at 0xa2ee350>
fields = {'modified_date': <haystack.fields.DateTimeField object at 0x45214d0>, 'text': <haystack.fields.CharField object at 0xa2ee950>, 'description': <haystack.fields.CharField object at 0xa2ee350>, 'published_date': <haystack.fields.DateTimeField object at 0x4521510>, 'url': <haystack.fields.CharField object at 0x4521590>, 'title': <haystack.fields.CharField object at 0x4521550>, 'content_auto': <haystack.fields.EdgeNgramField object at 0xa2eed50>, 'author': <haystack.fields.CharField object at 0x45212d0>, 'created_date': <haystack.fields.DateTimeField object at 0x4521490>}
get_model()
objects = <haystack.manager.SearchIndexManager object at 0xa2df490>
text = <haystack.fields.CharField object at 0xa2ee950>
class cms.apps.faq.search_indexes.FaqItemIndex

Bases: cms.apps.search.models.SearchBase, cms.apps.search.models.SearchContent, haystack.constants.Indexable

fields = {'imageteaser': <haystack.fields.CharField object at 0x4521790>, 'modified_date': <haystack.fields.DateTimeField object at 0x45214d0>, 'published_date': <haystack.fields.DateTimeField object at 0x4521510>, 'description': <haystack.fields.CharField object at 0x45216d0>, 'author': <haystack.fields.CharField object at 0x45212d0>, 'url': <haystack.fields.CharField object at 0x4521590>, 'text': <haystack.fields.CharField object at 0x4521610>, 'image': <cms.apps.search.fields.FileField object at 0x4521710>, 'imagedescription': <haystack.fields.CharField object at 0x4521750>, 'keywords_string': <haystack.fields.CharField object at 0x4521810>, 'content': <haystack.fields.CharField object at 0x4521650>, 'imageteaserdescription': <haystack.fields.CharField object at 0x45217d0>, 'teaser': <haystack.fields.CharField object at 0x4521850>, 'content_auto': <haystack.fields.EdgeNgramField object at 0x4521690>, 'created_date': <haystack.fields.DateTimeField object at 0x4521490>, 'title': <haystack.fields.CharField object at 0x4521550>, 'schema': <haystack.fields.CharField object at 0x4521890>}
get_model()
index_queryset(using=None)
objects = <haystack.manager.SearchIndexManager object at 0xa2df310>

cms.apps.faq.urls module

cms.apps.faq.views module

class cms.apps.faq.views.FaqBaseView(**kwargs)

Bases: cms.core.views.GenericTemplateView

get_category(category, request)
get_data(request)
get_items_for_keywords()
class cms.apps.faq.views.FaqCategoryListView(**kwargs)

Bases: cms.apps.faq.views.FaqBaseView

get(request)
schema_body = 'QAPage'
schema_main = 'ItemList'
template_name = 'faq/category_list.html'
class cms.apps.faq.views.FaqItemDetailView(**kwargs)

Bases: cms.apps.faq.views.FaqBaseView, cms.core.views.GenericTemplateTooltipView

get(request, category=None, item_slug=None)
post(request, category=None, item_slug=None)
schema_body = 'QAPage'
schema_main = 'Question'
template_name = 'faq/item_detail.html'
class cms.apps.faq.views.FaqItemListByKeywordView(**kwargs)

Bases: cms.apps.faq.views.FaqBaseView

get(request, keyword, category=None, page=None)
schema_body = 'QAPage'
schema_main = 'ItemList'
template_name = 'faq/item_list_by_keyword.html'
class cms.apps.faq.views.FaqItemListView(**kwargs)

Bases: cms.apps.faq.views.FaqBaseView, cms.core.views.GenericTemplateTooltipView

get(request, category, page=None)
post(request, category)
schema_body = 'QAPage'
schema_main = 'ItemList'
template_name = 'faq/item_list.html'

Module contents