wagtail/docs/reference/contrib/index.rst

Contrib modules
===============

Wagtail ships with a variety of extra optional modules.


.. toctree::
    :maxdepth: 2

    settings
    forms/index
    sitemaps
    frontendcache
    routablepage
    api/index
    modeladmin/index
    searchpromotions
    table_block


:doc:`settings`
---------------

Site-wide settings that are editable by administrators in the Wagtail admin.


:doc:`forms/index`
------------------

Allows forms to be created by admins and provides an interface for browsing form submissions.


:doc:`sitemaps`
---------------

Provides a view that generates a Google XML sitemap of your public Wagtail content.


:doc:`frontendcache`
--------------------

A module for automatically purging pages from a cache (Varnish, Squid, Cloudflare or Cloudfront) when their content is changed.


:doc:`routablepage`
-------------------

Provides a way of embedding Django URLconfs into pages.


:doc:`api/index`
----------------

A module for adding a read only, JSON based web API to your Wagtail site


:doc:`modeladmin/index`
-----------------------

A module allowing for more customisable representation and management of custom models in Wagtail's admin area.


:doc:`searchpromotions`
-----------------------

A module for managing "Promoted Search Results"


:doc:`table_block`
-----------------------

Provides a TableBlock for adding HTML tables to pages.
Improvements to contrib section index 2015-02-19 18:07:21 +01:00			`Contrib modules`
			`===============`

Fix whitespace errors in docs Trimmed trailing whitespace, convert tabs to 4 spaces, add preference for spaces to `.editorconfig`. 2016-11-28 02:40:15 +01:00			`Wagtail ships with a variety of extra optional modules.`
Added components sections 2014-07-25 16:26:35 +02:00

			`.. toctree::`
			`:maxdepth: 2`

Move wagtailsettings into contrib module The `wagtailsettings` module is useful enough that it should be included in the Wagtail contrib section, to make it available to all Wagtail developers. All the code has been given a once-over to make sure it is nice and polished before being copied in. As such, this is not a direct copy of the `wagtailsettings` module. It should be backwards compatible though, excepting the new location. It has been moved to `wagtail.contrib.settings`, following the naming scheme set out in #1504. Documentation has been concatenated in to a single page, and added to the contrib reference section. 2015-09-30 07:28:33 +02:00			`settings`
Add docs about wagtailforms customisation Fixes #2945 2016-12-21 13:51:58 +01:00			`forms/index`
Renamed a couple of contrib docs 2015-03-26 14:56:43 +01:00			`sitemaps`
Docs for cloudflare cache invalidation 2014-10-08 12:32:44 +02:00			`frontendcache`
Moved routablepage docs to contrib 2015-03-26 14:53:50 +01:00			`routablepage`
Added contrib.wagtailapi module. Closes #926 Imported from: https://github.com/torchbox/wagtailapi Thanks to @timheap for the review 2015-03-02 11:19:58 +01:00			`api/index`
Add documentation to help with customisation of `contrib.modeladmin` 2016-08-08 22:19:33 +02:00			`modeladmin/index`
Renamed searchpicks app to searchpromotions 2015-07-07 17:25:06 +02:00			`searchpromotions`
Added documentation for table_block. 2016-05-02 01:48:53 +02:00			`table_block`
Moved some docs into contrib components 2014-07-25 16:38:53 +02:00
Improvements to contrib section index 2015-02-19 18:07:21 +01:00
Move wagtailsettings into contrib module The `wagtailsettings` module is useful enough that it should be included in the Wagtail contrib section, to make it available to all Wagtail developers. All the code has been given a once-over to make sure it is nice and polished before being copied in. As such, this is not a direct copy of the `wagtailsettings` module. It should be backwards compatible though, excepting the new location. It has been moved to `wagtail.contrib.settings`, following the naming scheme set out in #1504. Documentation has been concatenated in to a single page, and added to the contrib reference section. 2015-09-30 07:28:33 +02:00			:doc:`settings`
			`---------------`

			`Site-wide settings that are editable by administrators in the Wagtail admin.`


Add docs about wagtailforms customisation Fixes #2945 2016-12-21 13:51:58 +01:00			:doc:`forms/index`
			`------------------`
Moved form builder to contrib It will soon be contrib 2015-05-29 15:35:37 +02:00
			`Allows forms to be created by admins and provides an interface for browsing form submissions.`


Renamed a couple of contrib docs 2015-03-26 14:56:43 +01:00			:doc:`sitemaps`
Change titles to links on contrib index 2015-05-14 17:01:03 +02:00			`---------------`
Improvements to contrib section index 2015-02-19 18:07:21 +01:00
Added documentation for table_block. 2016-05-02 01:48:53 +02:00			`Provides a view that generates a Google XML sitemap of your public Wagtail content.`
Improvements to contrib section index 2015-02-19 18:07:21 +01:00

			:doc:`frontendcache`
Change titles to links on contrib index 2015-05-14 17:01:03 +02:00			`--------------------`
Improvements to contrib section index 2015-02-19 18:07:21 +01:00
Added support for AWS CloudFront in Frontend cache invalidation module (#1845) * added base cloudfrontbackend and testcase * added boto3 cloudfront client * implemented create invalidation method added error handling botocore * added aws docs * fixed typo * flake8 fixes * added boto3 configuration docs * removed return * purge path instead of full url * added multisite hostname mapping * added validation of DISTRIBUTION_ID * renamed Cloudfront to CloudFront * added note to include www in mapping added tests for cloudfront site mapping * removed deprecated has_key, used in fixed _create_invalidation * changed type checking of dict removed debug line of code to check hostname * fixed dict type checking condition added assert t make sure no invalid cache is being purged * changed import order * fixed isort error * more detailed error message for cloudfront pep8 fixes 120 chars per line * Log missing cloudfront distribution id as info Was logging as error, but it may be possible that a developer wants cloudfront on only specific hostnames. * , => . * Docs edits * Removed hard-dependency on boto3 2016-08-29 16:15:27 +02:00			`A module for automatically purging pages from a cache (Varnish, Squid, Cloudflare or Cloudfront) when their content is changed.`
Moved routablepage docs to contrib 2015-03-26 14:53:50 +01:00

			:doc:`routablepage`
Change titles to links on contrib index 2015-05-14 17:01:03 +02:00			`-------------------`
Moved routablepage docs to contrib 2015-03-26 14:53:50 +01:00
			`Provides a way of embedding Django URLconfs into pages.`
Added contrib.wagtailapi module. Closes #926 Imported from: https://github.com/torchbox/wagtailapi Thanks to @timheap for the review 2015-03-02 11:19:58 +01:00

			:doc:`api/index`
Change titles to links on contrib index 2015-05-14 17:01:03 +02:00			`----------------`
Added contrib.wagtailapi module. Closes #926 Imported from: https://github.com/torchbox/wagtailapi Thanks to @timheap for the review 2015-03-02 11:19:58 +01:00
			`A module for adding a read only, JSON based web API to your Wagtail site`
Docs for searchpicks module 2015-07-06 12:35:38 +02:00

Add documentation to help with customisation of `contrib.modeladmin` 2016-08-08 22:19:33 +02:00			:doc:`modeladmin/index`
			`-----------------------`
Added wagtailmodeladmin to contrib with docs 2016-04-13 08:01:04 +02:00
			`A module allowing for more customisable representation and management of custom models in Wagtail's admin area.`


Renamed searchpicks app to searchpromotions 2015-07-07 17:25:06 +02:00			:doc:`searchpromotions`
			`-----------------------`
Docs for searchpicks module 2015-07-06 12:35:38 +02:00
Added documentation for table_block. 2016-05-02 01:48:53 +02:00			`A module for managing "Promoted Search Results"`


			:doc:`table_block`
			`-----------------------`

			`Provides a TableBlock for adding HTML tables to pages.`