diff --git a/.travis.yml b/.travis.yml index c41b47079..b98320c70 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,21 +8,22 @@ matrix: - env: TOXENV=py33-dj17-postgres - env: TOXENV=py34-dj17-postgres - env: TOXENV=py34-dj17-sqlite + - env: TOXENV=py34-dj17-mysql - env: TOXENV=py27-dj18-postgres # - env: TOXENV=py27-dj18-mysql # - env: TOXENV=py27-dj18-sqlite # - env: TOXENV=py33-dj18-postgres - env: TOXENV=py34-dj18-postgres - env: TOXENV=py34-dj18-sqlite + - env: TOXENV=py34-dj18-mysql allow_failures: - - env: TOXENV=py27-dj17-mysql - env: TOXENV=py27-dj18-postgres - env: TOXENV=py34-dj18-postgres - env: TOXENV=py34-dj18-sqlite + - env: TOXENV=py34-dj18-mysql # Services services: - - redis-server - elasticsearch # Package installation @@ -32,6 +33,8 @@ install: # Pre-test configuration before_script: - psql -c 'create database wagtaildemo;' -U postgres + - mysql -e "SET GLOBAL wait_timeout = 36000;" + - mysql -e "SET GLOBAL max_allowed_packet = 134209536;" # Run the tests script: diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 41adcf38d..7bfe3c294 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -1,9 +1,11 @@ Changelog ========= -0.9 (xx.xx.xxxx) +1.0 (xx.xx.xxxx) ~~~~~~~~~~~~~~~~ + * Added StreamField, a model field for freeform page content + * MySQL support * Javascript includes in the admin backend have been moved to the HTML header, to accommodate form widgets that render inline scripts that depend on libraries such as jQuery * Improvements to the layout of the admin menu footer. * Added thousands separator for counters on dashboard @@ -36,6 +38,7 @@ Changelog * Plain text fields in the page editor now use auto-expanding text areas * Date / time pickers now consistently use times without seconds, to prevent Javascript behaviour glitches when focusing / unfocusing fields * Added hooks `register_rich_text_embed_handler` and `register_rich_text_link_handler` for customising link / embed handling within rich text fields + * Added hook `construct_homepage_summary_items` for customising the site summary panel on the admin homepage 0.8.6 (10.03.2015) diff --git a/docs/contrib_components/frontendcache.rst b/docs/contrib/frontendcache.rst similarity index 100% rename from docs/contrib_components/frontendcache.rst rename to docs/contrib/frontendcache.rst diff --git a/docs/contrib_components/index.rst b/docs/contrib/index.rst similarity index 73% rename from docs/contrib_components/index.rst rename to docs/contrib/index.rst index 4a68c6ad2..482b2748b 100644 --- a/docs/contrib_components/index.rst +++ b/docs/contrib/index.rst @@ -7,15 +7,16 @@ Wagtail ships with a variety of extra optional modules. .. toctree:: :maxdepth: 2 - static_site_generation - sitemap_generation + staticsitegen + sitemaps frontendcache + routablepage ``wagtailmedusa`` ----------------- -:doc:`static_site_generation` +:doc:`staticsitegen` Provides a management command that turns a Wagtail site into a set of static HTML files. @@ -23,7 +24,7 @@ Provides a management command that turns a Wagtail site into a set of static HTM ``wagtailsitemaps`` ------------------- -:doc:`sitemap_generation` +:doc:`sitemaps` Provides a view that generates a Google XML sitemap of your public wagtail content. @@ -34,3 +35,11 @@ Provides a view that generates a Google XML sitemap of your public wagtail conte :doc:`frontendcache` A module for automatically purging pages from a cache (Varnish, Squid or Cloudflare) when their content is changed. + + +``wagtailroutablepage`` +----------------------- + +:doc:`routablepage` + +Provides a way of embedding Django URLconfs into pages. diff --git a/docs/core_components/pages/advanced_topics/routable_page_mixin.rst b/docs/contrib/routablepage.rst similarity index 70% rename from docs/core_components/pages/advanced_topics/routable_page_mixin.rst rename to docs/contrib/routablepage.rst index 1fb9dab62..8d1581b14 100644 --- a/docs/core_components/pages/advanced_topics/routable_page_mixin.rst +++ b/docs/contrib/routablepage.rst @@ -14,7 +14,7 @@ A ``Page`` using ``RoutablePageMixin`` exists within the page tree like any othe The basics ========== -To use ``RoutablePageMixin``, you need to make your class inherit from both :class:`wagtail.contrib.wagtailroutablepage.models.RoutablePageMixin` and :class:`wagtail.wagtailcore.models.Page`, and configure the ``subpage_urls`` attribute with your URL configuration. +To use ``RoutablePageMixin``, you need to make your class inherit from both :class:`wagtail.contrib.wagtailroutablepage.models.RoutablePageMixin` and :class:`wagtail.wagtailcore.models.Page`, then define a ``subpage_urls`` property that returns a tuple of ``django.conf.url`` objects. Here's an example of an ``EventPage`` with three views: @@ -27,11 +27,13 @@ Here's an example of an ``EventPage`` with three views: class EventPage(RoutablePageMixin, Page): - subpage_urls = ( - url(r'^$', 'current_events', name='current_events'), - url(r'^past/$', 'past_events', name='past_events'), - url(r'^year/(\d+)/$', 'events_for_year', name='events_for_year'), - ) + @property + def subpage_urls(self): + return ( + url(r'^$', self.current_events, name='current_events'), + url(r'^past/$', self.past_events, name='past_events'), + url(r'^year/(\d+)/$', self.events_for_year, name='events_for_year'), + ) def current_events(self, request): """ @@ -51,6 +53,16 @@ Here's an example of an ``EventPage`` with three views: """ ... +You can also set this as an attribute on the class. This will not work on Django 1.8 and above as the ``url`` function no longer allows strings to be specified as view names. + +.. code-block:: python + + class EventPage(RoutablePageMixin, Page): + subpage_urls = ( + url(r'^$', 'current_events', name='current_events'), + url(r'^past/$', 'past_events', name='past_events'), + url(r'^year/(\d+)/$', 'events_for_year', name='events_for_year'), + ) The ``RoutablePageMixin`` class =============================== @@ -60,6 +72,10 @@ The ``RoutablePageMixin`` class .. autoattribute:: subpage_urls + .. versionchanged:: 0.9 + + It was previously recommended to define ``subpage_urls`` as a class attribute. It is now recommend to define it as a property as Django 1.8 and above requires that the view argument to the ``url`` function is a callable and not a string. + Example: .. code-block:: python @@ -70,16 +86,17 @@ The ``RoutablePageMixin`` class class MyPage(RoutablePageMixin, Page): - subpage_urls = ( - url(r'^$', 'main', name='main'), - url(r'^archive/$', 'archive', name='archive'), - url(r'^archive/(?P[0-9]{4})/$', 'archive', name='archive'), - ) + def subpage_urls(self): + return ( + url(r'^$', self.main_view, name='main'), + url(r'^archive/$', self.archive_view, name='archive'), + url(r'^archive/(?P[0-9]{4})/$', self.archive_view, name='archive'), + ) - def main(self, request): + def main_view(self, request): ... - def archive(self, request, year=None): + def archive_view(self, request, year=None): ... .. automethod:: resolve_subpage @@ -99,7 +116,6 @@ The ``RoutablePageMixin`` class url = page.url + page.reverse_subpage('archive', kwargs={'year': '2014'}) - .. _routablepageurl_template_tag: The ``routablepageurl`` template tag diff --git a/docs/contrib_components/sitemap_generation.rst b/docs/contrib/sitemaps.rst similarity index 100% rename from docs/contrib_components/sitemap_generation.rst rename to docs/contrib/sitemaps.rst diff --git a/docs/contrib_components/static_site_generation.rst b/docs/contrib/staticsitegen.rst similarity index 100% rename from docs/contrib_components/static_site_generation.rst rename to docs/contrib/staticsitegen.rst diff --git a/docs/core_components/index.rst b/docs/core_components/index.rst deleted file mode 100644 index bd55db7e5..000000000 --- a/docs/core_components/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -Core components -=============== - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - sites - pages/index - images/index - snippets - search/index - form_builder - diff --git a/docs/core_components/form_builder.rst b/docs/form_builder.rst similarity index 100% rename from docs/core_components/form_builder.rst rename to docs/form_builder.rst diff --git a/docs/core_components/images/feature_detection.rst b/docs/images/feature_detection.rst similarity index 100% rename from docs/core_components/images/feature_detection.rst rename to docs/images/feature_detection.rst diff --git a/docs/core_components/images/index.rst b/docs/images/index.rst similarity index 100% rename from docs/core_components/images/index.rst rename to docs/images/index.rst diff --git a/docs/core_components/images/using_images_outside_wagtail.rst b/docs/images/using_images_outside_wagtail.rst similarity index 100% rename from docs/core_components/images/using_images_outside_wagtail.rst rename to docs/images/using_images_outside_wagtail.rst diff --git a/docs/index.rst b/docs/index.rst index 80b30e8db..e730e6d8a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,10 +13,10 @@ Below are some useful links to help you get started with Wagtail. * **Creating your Wagtail site** - * :doc:`core_components/pages/creating_pages` - * :doc:`Writing templates ` - * :doc:`core_components/images/index` - * :doc:`core_components/search/index` + * :doc:`pages/creating_pages` + * :doc:`pages/writing_templates` + * :doc:`images/index` + * :doc:`search/index` * :doc:`howto/third_party_tutorials` @@ -33,8 +33,12 @@ Index :titlesonly: getting_started/index - core_components/index - contrib_components/index + pages/index + images/index + snippets + search/index + form_builder + contrib/index howto/index reference/index support diff --git a/docs/core_components/pages/advanced_topics/private_pages.rst b/docs/pages/advanced_topics/private_pages.rst similarity index 100% rename from docs/core_components/pages/advanced_topics/private_pages.rst rename to docs/pages/advanced_topics/private_pages.rst diff --git a/docs/core_components/pages/advanced_topics/queryset_methods.rst b/docs/pages/advanced_topics/queryset_methods.rst similarity index 100% rename from docs/core_components/pages/advanced_topics/queryset_methods.rst rename to docs/pages/advanced_topics/queryset_methods.rst diff --git a/docs/core_components/pages/creating_pages.rst b/docs/pages/creating_pages.rst similarity index 100% rename from docs/core_components/pages/creating_pages.rst rename to docs/pages/creating_pages.rst diff --git a/docs/core_components/pages/editing_api.rst b/docs/pages/editing_api.rst similarity index 63% rename from docs/core_components/pages/editing_api.rst rename to docs/pages/editing_api.rst index a228421ea..df3e593d7 100644 --- a/docs/core_components/pages/editing_api.rst +++ b/docs/pages/editing_api.rst @@ -1,10 +1,7 @@ .. _editing-api: -Displaying fields with the Editing API -====================================== - -.. note:: - This documentation is currently being written. +Setting up the page editor interface +==================================== Wagtail provides a highly-customizable editing interface consisting of several components: @@ -34,7 +31,7 @@ There are four basic types of panels: ``InlinePanel( relation_name, panels=None, classname=None, label='', help_text='' )`` This panel allows for the creation of a "cluster" of related objects over a join to a separate model, such as a list of related links or slides to an image carousel. This is a very powerful, but tricky feature which will take some space to cover, so we'll skip over it for now. For a full explanation on the usage of ``InlinePanel``, see :ref:`inline_panels`. - ``FieldRowPanel( children, classname=None)`` + ``FieldRowPanel( children, classname=None )`` This panel is purely aesthetic. It creates a columnar layout in the editing interface, where each of the child Panels appears alongside each other rather than below. Use of FieldRowPanel particularly helps reduce the "snow-blindness" effect of seeing so many fields on the page, for complex models. It also improves the perceived association between fields of a similar nature. For example if you created a model representing an "Event" which had a starting date and ending date, it may be intuitive to find the start and end date on the same "row". FieldRowPanel should be used in combination with ``col*`` classnames added to each of the child Panels of the FieldRowPanel. The Wagtail editing interface is layed out using a grid system, in which the maximum width of the editor is 12 columns wide. Classes ``col1``-``col12`` can be applied to each child of a FieldRowPanel. The class ``col3`` will ensure that field appears 3 columns wide or a quarter the width. ``col4`` would cause the field to be 4 columns wide, or a third the width. @@ -425,277 +422,6 @@ hallo.js plugin names are prefixed with the ``"IKS."`` namespace, but the ``name For information on developing custom hallo.js plugins, see the project's page: https://github.com/bergie/hallo -Edit Handler API -~~~~~~~~~~~~~~~~ - -.. _admin_hooks: - -Admin Hooks ------------ - -On loading, Wagtail will search for any app with the file ``wagtail_hooks.py`` and execute the contents. This provides a way to register your own functions to execute at certain points in Wagtail's execution, such as when a ``Page`` object is saved or when the main menu is constructed. - -.. versionadded:: 0.5 - Decorator syntax was added in 0.5; earlier versions only supported ``hooks.register`` as an ordinary function call. - -Registering functions with a Wagtail hook is done through the ``@hooks.register`` decorator: - -.. code-block:: python - - from wagtail.wagtailcore import hooks - - @hooks.register('name_of_hook') - def my_hook_function(arg1, arg2...) - # your code here - - -Alternatively, ``hooks.register`` can be called as an ordinary function, passing in the name of the hook and a handler function defined elsewhere: - -.. code-block:: python - - hooks.register('name_of_hook', my_hook_function) - - -The available hooks are: - -.. _before_serve_page: - -``before_serve_page`` - .. versionadded:: 0.4 - - Called when Wagtail is about to serve a page. The callable passed into the hook will receive the page object, the request object, and the args and kwargs that will be passed to the page's ``serve()`` method. If the callable returns an ``HttpResponse``, that response will be returned immediately to the user, and Wagtail will not proceed to call ``serve()`` on the page. - - .. code-block:: python - - from wagtail.wagtailcore import hooks - - @hooks.register('before_serve_page') - def block_googlebot(page, request, serve_args, serve_kwargs): - if request.META.get('HTTP_USER_AGENT') == 'GoogleBot': - return HttpResponse("

bad googlebot no cookie

") - - -.. _construct_wagtail_edit_bird: - -``construct_wagtail_edit_bird`` - Add or remove items from the wagtail userbar. Add, edit, and moderation tools are provided by default. The callable passed into the hook must take the ``request`` object and a list of menu objects, ``items``. The menu item objects must have a ``render`` method which can take a ``request`` object and return the HTML string representing the menu item. See the userbar templates and menu item classes for more information. - - .. code-block:: python - - from wagtail.wagtailcore import hooks - - class UserbarPuppyLinkItem(object): - def render(self, request): - return '
  • Puppies!
    • ' - - @hooks.register('construct_wagtail_edit_bird') - def add_puppy_link_item(request, items): - return items.append( UserbarPuppyLinkItem() ) - - -.. _construct_homepage_panels: - -``construct_homepage_panels`` - Add or remove panels from the Wagtail admin homepage. The callable passed into this hook should take a ``request`` object and a list of ``panels``, objects which have a ``render()`` method returning a string. The objects also have an ``order`` property, an integer used for ordering the panels. The default panels use integers between ``100`` and ``300``. - - .. code-block:: python - - from django.utils.safestring import mark_safe - - from wagtail.wagtailcore import hooks - - class WelcomePanel(object): - order = 50 - - def render(self): - return mark_safe(""" -
    -

    No, but seriously -- welcome to the admin homepage.

    -
    - """) - - @hooks.register('construct_homepage_panels') - def add_another_welcome_panel(request, panels): - return panels.append( WelcomePanel() ) - - -.. _after_create_page: - -``after_create_page`` - Do something with a ``Page`` object after it has been saved to the database (as a published page or a revision). The callable passed to this hook should take a ``request`` object and a ``page`` object. The function does not have to return anything, but if an object with a ``status_code`` property is returned, Wagtail will use it as a response object. By default, Wagtail will instead redirect to the Explorer page for the new page's parent. - - .. code-block:: python - - from django.http import HttpResponse - - from wagtail.wagtailcore import hooks - - @hooks.register('after_create_page') - def do_after_page_create(request, page): - return HttpResponse("Congrats on making content!", content_type="text/plain") - - -.. _after_edit_page: - -``after_edit_page`` - Do something with a ``Page`` object after it has been updated. Uses the same behavior as ``after_create_page``. - -.. _after_delete_page: - -``after_delete_page`` - Do something after a ``Page`` object is deleted. Uses the same behavior as ``after_create_page``. - -.. _register_admin_urls: - -``register_admin_urls`` - Register additional admin page URLs. The callable fed into this hook should return a list of Django URL patterns which define the structure of the pages and endpoints of your extension to the Wagtail admin. For more about vanilla Django URLconfs and views, see `url dispatcher`_. - - .. _url dispatcher: https://docs.djangoproject.com/en/dev/topics/http/urls/ - - .. code-block:: python - - from django.http import HttpResponse - from django.conf.urls import url - - from wagtail.wagtailcore import hooks - - def admin_view( request ): - return HttpResponse( \ - "I have approximate knowledge of many things!", \ - content_type="text/plain") - - @hooks.register('register_admin_urls') - def urlconf_time(): - return [ - url(r'^how_did_you_almost_know_my_name/$', admin_view, name='frank' ), - ] - -.. _register_admin_menu_item: - -``register_admin_menu_item`` - .. versionadded:: 0.6 - - Add an item to the Wagtail admin menu. The callable passed to this hook must return an instance of ``wagtail.wagtailadmin.menu.MenuItem``. New items can be constructed from the ``MenuItem`` class by passing in a ``label`` which will be the text in the menu item, and the URL of the admin page you want the menu item to link to (usually by calling ``reverse()`` on the admin view you've set up). Additionally, the following keyword arguments are accepted: - - :name: an internal name used to identify the menu item; defaults to the slugified form of the label. Also applied as a CSS class to the wrapping ``
  • ``, as ``"menu-{name}"``. - :classnames: additional classnames applied to the link, used to give it an icon - :attrs: additional HTML attributes to apply to the link - :order: an integer which determines the item's position in the menu - - ``MenuItem`` can be subclassed to customise the HTML output, specify Javascript files required by the menu item, or conditionally show or hide the item for specific requests (for example, to apply permission checks); see the source code (``wagtail/wagtailadmin/menu.py``) for details. - - .. code-block:: python - - from django.core.urlresolvers import reverse - - from wagtail.wagtailcore import hooks - from wagtail.wagtailadmin.menu import MenuItem - - @hooks.register('register_admin_menu_item') - def register_frank_menu_item(): - return MenuItem('Frank', reverse('frank'), classnames='icon icon-folder-inverse', order=10000) - -.. _register_settings_menu_item: - -``register_settings_menu_item`` - .. versionadded:: 0.7 - - As ``register_admin_menu_item``, but registers menu items into the 'Settings' sub-menu rather than the top-level menu. - -.. _construct_main_menu: - -``construct_main_menu`` - Called just before the Wagtail admin menu is output, to allow the list of menu items to be modified. The callable passed to this hook will receive a ``request`` object and a list of ``menu_items``, and should modify ``menu_items`` in-place as required. Adding menu items should generally be done through the ``register_admin_menu_item`` hook instead - items added through ``construct_main_menu`` will be missing any associated Javascript includes, and their ``is_shown`` check will not be applied. - - .. code-block:: python - - from wagtail.wagtailcore import hooks - - @hooks.register('construct_main_menu') - def hide_explorer_menu_item_from_frank(request, menu_items): - if request.user.username == 'frank': - menu_items[:] = [item for item in menu_items if item.name != 'explorer'] - - -.. _insert_editor_js: - -``insert_editor_js`` - Add additional Javascript files or code snippets to the page editor. Output must be compatible with ``compress``, as local static includes or string. - - .. code-block:: python - - from django.utils.html import format_html, format_html_join - from django.conf import settings - - from wagtail.wagtailcore import hooks - - @hooks.register('insert_editor_js') - def editor_js(): - js_files = [ - 'demo/js/hallo-plugins/hallo-demo-plugin.js', - ] - js_includes = format_html_join('\n', '', - ((settings.STATIC_URL, filename) for filename in js_files) - ) - return js_includes + format_html( - """ - - """ - ) - - -.. _insert_editor_css: - -``insert_editor_css`` - Add additional CSS or SCSS files or snippets to the page editor. Output must be compatible with ``compress``, as local static includes or string. - - .. code-block:: python - - from django.utils.html import format_html - from django.conf import settings - - from wagtail.wagtailcore import hooks - - @hooks.register('insert_editor_css') - def editor_css(): - return format_html('') - -.. _construct_whitelister_element_rules: - -``construct_whitelister_element_rules`` -.. versionadded:: 0.4 - - Customise the rules that define which HTML elements are allowed in rich text areas. By default only a limited set of HTML elements and attributes are whitelisted - all others are stripped out. The callables passed into this hook must return a dict, which maps element names to handler functions that will perform some kind of manipulation of the element. These handler functions receive the element as a `BeautifulSoup `_ Tag object. - - The ``wagtail.wagtailcore.whitelist`` module provides a few helper functions to assist in defining these handlers: ``allow_without_attributes``, a handler which preserves the element but strips out all of its attributes, and ``attribute_rule`` which accepts a dict specifying how to handle each attribute, and returns a handler function. This dict will map attribute names to either True (indicating that the attribute should be kept), False (indicating that it should be dropped), or a callable (which takes the initial attribute value and returns either a final value for the attribute, or None to drop the attribute). - - For example, the following hook function will add the ``
    `` element to the whitelist, and allow the ``target`` attribute on ```` elements: - - .. code-block:: python - - from wagtail.wagtailcore import hooks - from wagtail.wagtailcore.whitelist import attribute_rule, check_url, allow_without_attributes - - @hooks.register('construct_whitelister_element_rules') - def whitelister_element_rules(): - return { - 'blockquote': allow_without_attributes, - 'a': attribute_rule({'href': check_url, 'target': True}), - } - -.. _register_permissions: - -``register_permissions`` - .. versionadded:: 0.7 - - Return a queryset of Permission objects to be shown in the Groups administration area. - - Image Formats in the Rich Text Editor ------------------------------------- diff --git a/docs/core_components/pages/index.rst b/docs/pages/index.rst similarity index 91% rename from docs/core_components/pages/index.rst rename to docs/pages/index.rst index 70d20d116..4e9a5fab0 100644 --- a/docs/core_components/pages/index.rst +++ b/docs/pages/index.rst @@ -1,9 +1,6 @@ Pages ===== -.. note:: - This documentation is currently being written. - Wagtail requires a little careful setup to define the types of content that you want to present through your website. The basic unit of content in Wagtail is the ``Page``, and all of your page-level content will inherit basic webpage-related properties from it. But for the most part, you will be defining content yourself, through the construction of Django models using Wagtail's ``Page`` as a base. Wagtail organizes content created from your models in a tree, which can have any structure and combination of model objects in it. Wagtail doesn't prescribe ways to organize and interrelate your content, but here we've sketched out some strategies for organizing your models. @@ -19,6 +16,7 @@ The presentation of your content, the actual webpages, includes the normal use o writing_templates model_recipes editing_api + streamfield + sites advanced_topics/queryset_methods advanced_topics/private_pages - advanced_topics/routable_page_mixin diff --git a/docs/core_components/pages/model_recipes.rst b/docs/pages/model_recipes.rst similarity index 100% rename from docs/core_components/pages/model_recipes.rst rename to docs/pages/model_recipes.rst diff --git a/docs/core_components/sites.rst b/docs/pages/sites.rst similarity index 100% rename from docs/core_components/sites.rst rename to docs/pages/sites.rst diff --git a/docs/pages/streamfield.rst b/docs/pages/streamfield.rst new file mode 100644 index 000000000..2b8a03bdf --- /dev/null +++ b/docs/pages/streamfield.rst @@ -0,0 +1,449 @@ +.. _streamfield: + +Freeform page content using StreamField +======================================= + +StreamField provides a content editing model suitable for pages that do not follow a fixed structure - such as blog posts or news stories, where the text may be interspersed with subheadings, images, pull quotes and video, and perhaps more specialised content types such as maps and charts (or, for a programming blog, code snippets). In this model, these different content types are represented as a sequence of 'blocks', which can be repeated and arranged in any order. + +For further background on StreamField, and why you would use it instead of a rich text field for the article body, see the blog post `Rich text fields and faster horses `__. + +StreamField also offers a rich API to define your own block types, ranging from simple collections of sub-blocks (such as a 'person' block consisting of first name, surname and photograph) to completely custom components with their own editing interface. Within the database, the StreamField content is stored as JSON, ensuring that the full informational content of the field is preserved, rather than just an HTML representation of it. + + +Using StreamField +----------------- + +``StreamField`` is a model field that can be defined within your page model like any other field: + +.. code-block:: python + + from django.db import models + + from wagtail.wagtailcore.models import Page + from wagtail.wagtailcore.fields import StreamField + from wagtail.wagtailcore import blocks + from wagtail.wagtailadmin.edit_handlers import FieldPanel, StreamFieldPanel + from wagtail.wagtailimages.blocks import ImageChooserBlock + + class BlogPage(Page): + author = models.CharField(max_length=255) + date = models.DateField("Post date") + body = StreamField([ + ('heading', blocks.CharBlock(classname="full title")), + ('paragraph', blocks.RichTextBlock()), + ('image', ImageChooserBlock()), + ]) + + BlogPage.content_panels = [ + FieldPanel('author'), + FieldPanel('date'), + StreamFieldPanel('body'), + ] + + +Note: StreamField is not backwards compatible with other field types such as RichTextField; if you migrate an existing field to StreamField, the existing data will be lost. + +The parameter to ``StreamField`` is a list of (name, block_type) tuples; 'name' is used to identify the block type within templates and the internal JSON representation (and should follow standard Python conventions for variable names: lower-case and underscores, no spaces) and 'block_type' should be a block definition object as described below. (Alternatively, ``StreamField`` can be passed a single ``StreamBlock`` instance - see `Structural block types`_.) + +This defines the set of available block types that can be used within this field. The author of the page is free to use these blocks as many times as desired, in any order. + +Basic block types +----------------- + +All block types accept the following optional keyword arguments: + +``default`` + The default value that a new 'empty' block should receive. + +``label`` + The label to display in the editor interface when referring to this block - defaults to a prettified version of the block name (or, in a context where no name is assigned - such as within a ``ListBlock`` - the empty string). + +``icon`` + The name of the icon to display for this block type in the menu of available block types. For a list of icon names, see the Wagtail style guide, which can be enabled by adding ``wagtail.contrib.wagtailstyleguide`` to your project's ``INSTALLED_APPS``. + +``template`` + The path to a Django template that will be used to render this block on the front end. See `Template rendering`_. + +The basic block types provided by Wagtail are as follows: + +CharBlock +~~~~~~~~~ + +``wagtail.wagtailcore.blocks.CharBlock`` + +A single-line text input. The following keyword arguments are accepted: + +``required`` (default: True) + If true, the field cannot be left blank. + +``max_length``, ``min_length`` + Ensures that the string is at most or at least the given length. + +``help_text`` + Help text to display alongside the field. + +TextBlock +~~~~~~~~~ + +``wagtail.wagtailcore.blocks.TextBlock`` + +A multi-line text input. As with ``CharBlock``, the keyword arguments ``required``, ``max_length``, ``min_length`` and ``help_text`` are accepted. + +URLBlock +~~~~~~~~ + +``wagtail.wagtailcore.blocks.URLBlock`` + +A single-line text input that validates that the string is a valid URL. The keyword arguments ``required``, ``max_length``, ``min_length`` and ``help_text`` are accepted. + +BooleanBlock +~~~~~~~~~~~~ + +``wagtail.wagtailcore.blocks.BooleanBlock`` + +A checkbox. The keyword arguments ``required`` and ``help_text`` are accepted. As with Django's ``BooleanField``, a value of ``required=True`` (the default) indicates that the checkbox must be ticked in order to proceed; for a checkbox that can be ticked or unticked, you must explicitly pass in ``required=False``. + +DateBlock +~~~~~~~~~ + +``wagtail.wagtailcore.blocks.DateBlock`` + +A date picker. The keyword arguments ``required`` and ``help_text`` are accepted. + +TimeBlock +~~~~~~~~~ + +``wagtail.wagtailcore.blocks.TimeBlock`` + +A time picker. The keyword arguments ``required`` and ``help_text`` are accepted. + +DateTimeBlock +~~~~~~~~~~~~~ + +``wagtail.wagtailcore.blocks.DateTimeBlock`` + +A combined date / time picker. The keyword arguments ``required`` and ``help_text`` are accepted. + +RichTextBlock +~~~~~~~~~~~~~ + +``wagtail.wagtailcore.blocks.RichTextBlock`` + +A WYSIWYG editor for creating formatted text including links, bold / italics etc. + +RawHTMLBlock +~~~~~~~~~~~~ + +``wagtail.wagtailcore.blocks.RawHTMLBlock`` + +A text area for entering raw HTML which will be rendered unescaped in the page output. The keyword arguments ``required``, ``max_length``, ``min_length`` and ``help_text`` are accepted. + +.. WARNING:: + When this block is in use, there is nothing to prevent editors from inserting malicious scripts into the page, including scripts that would allow the editor to acquire administrator privileges when another administrator views the page. Do not use this block unless your editors are fully trusted. + +ChoiceBlock +~~~~~~~~~~~ + +``wagtail.wagtailcore.blocks.ChoiceBlock`` + +A dropdown select box for choosing from a list of choices. The following keyword arguments are accepted: + +``choices`` + A list of choices, in any format accepted by Django's ``choices`` parameter for model fields: https://docs.djangoproject.com/en/stable/ref/models/fields/#field-choices + +``required`` (default: True) + If true, the field cannot be left blank. + +``help_text`` + Help text to display alongside the field. + +``ChoiceBlock`` can also be subclassed to produce a reusable block with the same list of choices everywhere it is used. For example, a block definition such as: + +.. code-block:: python + + blocks.ChoiceBlock(choices=[ + ('tea', 'Tea'), + ('coffee', 'Coffee'), + ], icon='cup') + + +could be rewritten as a subclass of ChoiceBlock: + +.. code-block:: python + + class DrinksChoiceBlock(blocks.ChoiceBlock): + choices = [ + ('tea', 'Tea'), + ('coffee', 'Coffee'), + ] + + class Meta: + icon = 'cup' + + +``StreamField`` definitions can then refer to ``DrinksChoiceBlock()`` in place of the full ``ChoiceBlock`` definition. + +PageChooserBlock +~~~~~~~~~~~~~~~~ + +``wagtail.wagtailcore.blocks.PageChooserBlock`` + +A control for selecting a page object, using Wagtail's page browser. The keyword argument ``required`` is accepted. + +DocumentChooserBlock +~~~~~~~~~~~~~~~~~~~~ + +``wagtail.wagtaildocs.blocks.DocumentChooserBlock`` + +A control to allow the editor to select an existing document object, or upload a new one. The keyword argument ``required`` is accepted. + +ImageChooserBlock +~~~~~~~~~~~~~~~~~ + +``wagtail.wagtailimages.blocks.ImageChooserBlock`` + +A control to allow the editor to select an existing image, or upload a new one. The keyword argument ``required`` is accepted. + +SnippetChooserBlock +~~~~~~~~~~~~~~~~~~~ + +``wagtail.wagtailsnippets.blocks.SnippetChooserBlock`` + +A control to allow the editor to select a snippet object. Requires one positional argument: the snippet class to choose from. The keyword argument ``required`` is accepted. + +EmbedBlock +~~~~~~~~~~ + +``wagtail.wagtailembeds.blocks.EmbedBlock`` + +A field for the editor to enter a URL to a media item (such as a YouTube video) to appear as embedded media on the page. The keyword arguments ``required``, ``max_length``, ``min_length`` and ``help_text`` are accepted. + + +Structural block types +---------------------- + +In addition to the basic block types above, it is possible to define new block types made up of sub-blocks: for example, a 'person' block consisting of sub-blocks for first name, surname and image, or a 'carousel' block consisting of an unlimited number of image blocks. These structures can be nested to any depth, making it possible to have a structure containing a list, or a list of structures. + +StructBlock +~~~~~~~~~~~ + +``wagtail.wagtailcore.blocks.StructBlock`` + +A block consisting of a fixed group of sub-blocks to be displayed together. Takes a list of (name, block_definition) tuples as its first argument: + +.. code-block:: python + + ('person', blocks.StructBlock([ + ('first_name', blocks.CharBlock(required=True)), + ('surname', blocks.CharBlock(required=True)), + ('photo', ImageChooserBlock()), + ('biography', blocks.RichTextBlock()), + ], icon='user')) + + +Alternatively, the list of sub-blocks can be provided in a subclass of StructBlock: + +.. code-block:: python + + class PersonBlock(blocks.StructBlock): + first_name = blocks.CharBlock(required=True) + surname = blocks.CharBlock(required=True) + photo = ImageChooserBlock() + biography = blocks.RichTextBlock() + + class Meta: + icon = 'user' + + +The ``Meta`` class supports the properties ``default``, ``label``, ``icon`` and ``template``; these have the same meanings as when they are passed to the block's constructor. + +This defines ``PersonBlock()`` as a block type that can be re-used as many times as you like within your model definitions: + +.. code-block:: python + + body = StreamField([ + ('heading', blocks.CharBlock(classname="full title")), + ('paragraph', blocks.RichTextBlock()), + ('image', ImageChooserBlock()), + ('person', PersonBlock()), + ]) + + +ListBlock +~~~~~~~~~ + +``wagtail.wagtailcore.blocks.ListBlock`` + +A block consisting of many sub-blocks, all of the same type. The editor can add an unlimited number of sub-blocks, and re-order and delete them. Takes the definition of the sub-block as its first argument: + +.. code-block:: python + + ('ingredients_list', blocks.ListBlock(blocks.CharBlock(label="Ingredient"))) + + +Any block type is valid as the sub-block type, including structural types: + +.. code-block:: python + + ('ingredients_list', blocks.ListBlock(blocks.StructBlock( + ('ingredient', blocks.CharBlock(required=True)), + ('amount', blocks.CharBlock()), + ))) + + +StreamBlock +~~~~~~~~~~~ + +``wagtail.wagtailcore.blocks.StreamBlock`` + +A block consisting of a sequence of sub-blocks of different types, which can be mixed and reordered in any order. Used as the overall mechanism of the StreamField itself, but can also be nested or used within other structural block types. Takes a list of (name, block_definition) tuples as its first argument: + +.. code-block:: python + + ('carousel', blocks.StreamBlock( + [ + ('image', ImageChooserBlock()), + ('quotation', blocks.StructBlock([ + ('text', blocks.TextBlock()), + ('author', blocks.CharBlock), + ])), + ('video', blocks.EmbedBlock()), + ], + icon='cogs' + )) + + +As with StructBlock, the list of sub-blocks can also be provided as a subclass of StreamBlock: + +.. code-block:: python + + class CarouselBlock(blocks.StreamBlock): + image = ImageChooserBlock() + quotation = blocks.StructBlock([ + ('text', blocks.TextBlock()), + ('author', blocks.CharBlock), + ]) + video = blocks.EmbedBlock + + class Meta: + icon='cogs' + + +Since ``StreamField`` accepts an instance of ``StreamBlock`` as a parameter, in place of a list of block types, this makes it possible to re-use a common set block types without repeating definitions: + +.. code-block:: python + + class HomePage(Page): + carousel = StreamField(CarouselBlock()) + + +Template rendering +------------------ + +The simplest way to render the contents of a StreamField into your template is to output it as a variable, like any other field: + +.. code-block:: django + + {{ self.body }} + + +This will render each block of the stream in turn, wrapped in a ``
    `` element (where ``my_block_name`` is the block name given in the StreamField definition). If you wish to provide your own HTML markup, you can instead iterate over the field's value to access each block in turn: + +.. code-block:: django + +
    + {% for block in self.body %} +
    {{ block }}
    + {% endfor %} +
    + + +For more control over the rendering of specific block types, each block object provides ``block_type`` and ``value`` properties: + +.. code-block:: django + +
    + {% for block in self.body %} + {% if block.block_type == 'heading' %} +

    {{ block.value }}

    + {% else %} +
    + {{ block }} +
    + {% endif %} + {% endfor %} +
    + + +Each block type provides its own front-end HTML rendering mechanism, and this is used for the output of ``{{ block }}``. For most simple block types, such as CharBlock, this will simply output the field's value, but others will provide their own HTML markup; for example, a ListBlock will output the list of child blocks as a ``