wagtail/docs/reference/contrib/index.rst

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

Wagtail ships with a variety of extra optional modules. 


.. toctree::
    :maxdepth: 2

    settings
    forms
    staticsitegen
    sitemaps
    frontendcache
    routablepage
    api/index
    searchpromotions


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

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


:doc:`forms`
------------

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


:doc:`staticsitegen`
--------------------

Provides a management command that turns a Wagtail site into a set of static HTML files.


: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 or Cloudflare) 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:`searchpromotions`
-----------------------

A module for managing "Promoted Search Results"
Improvements to contrib section index 2015-02-19 17:07:21 +00:00			`Contrib modules`
			`===============`

			`Wagtail ships with a variety of extra optional modules.`
Added components sections 2014-07-25 14:26:35 +00: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 05:28:33 +00:00			`settings`
Moved form builder to contrib It will soon be contrib 2015-05-29 13:35:37 +00:00			`forms`
Renamed a couple of contrib docs 2015-03-26 13:56:43 +00:00			`staticsitegen`
			`sitemaps`
Docs for cloudflare cache invalidation 2014-10-08 10:32:44 +00:00			`frontendcache`
Moved routablepage docs to contrib 2015-03-26 13:53:50 +00:00			`routablepage`
Added contrib.wagtailapi module. Closes #926 Imported from: https://github.com/torchbox/wagtailapi Thanks to @timheap for the review 2015-03-02 10:19:58 +00:00			`api/index`
Renamed searchpicks app to searchpromotions 2015-07-07 15:25:06 +00:00			`searchpromotions`
Moved some docs into contrib components 2014-07-25 14:38:53 +00:00
Improvements to contrib section index 2015-02-19 17:07:21 +00: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 05:28:33 +00:00			:doc:`settings`
			`---------------`

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


Fix reference to forms doc 2015-06-19 09:19:03 +00:00			:doc:`forms`
			`------------`
Moved form builder to contrib It will soon be contrib 2015-05-29 13:35:37 +00: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 13:56:43 +00:00			:doc:`staticsitegen`
Change titles to links on contrib index 2015-05-14 15:01:03 +00:00			`--------------------`
Improvements to contrib section index 2015-02-19 17:07:21 +00:00
			`Provides a management command that turns a Wagtail site into a set of static HTML files.`


Renamed a couple of contrib docs 2015-03-26 13:56:43 +00:00			:doc:`sitemaps`
Change titles to links on contrib index 2015-05-14 15:01:03 +00:00			`---------------`
Improvements to contrib section index 2015-02-19 17:07:21 +00:00
			`Provides a view that generates a Google XML sitemap of your public wagtail content.`


			:doc:`frontendcache`
Change titles to links on contrib index 2015-05-14 15:01:03 +00:00			`--------------------`
Improvements to contrib section index 2015-02-19 17:07:21 +00:00
			`A module for automatically purging pages from a cache (Varnish, Squid or Cloudflare) when their content is changed.`
Moved routablepage docs to contrib 2015-03-26 13:53:50 +00:00

			:doc:`routablepage`
Change titles to links on contrib index 2015-05-14 15:01:03 +00:00			`-------------------`
Moved routablepage docs to contrib 2015-03-26 13:53:50 +00: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 10:19:58 +00:00

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

Renamed searchpicks app to searchpromotions 2015-07-07 15:25:06 +00:00			:doc:`searchpromotions`
			`-----------------------`
Docs for searchpicks module 2015-07-06 10:35:38 +00:00
			`A module for managing "Promoted Search Results"`