Creating a new rich content model

You may at points need to create new :term:rich content models. These can either be a (polymorphic) subclass of an existing content model, or an entirely new model.

Page types

ICEkit uses [django-fluent-pages] to provide a tree of pages for your site. Each page is an instance of a Page Type.

Pages can be arranged in any tree shape. The URL of a page is made up of its slug plus that of its parents.

Pages are meant for ‘permanent’ parts of your site, ie that represent a section of your site, and which may appear in permanent site navigation.

Collections of things don’t normally work well as pages, because usually it is not desirable to put each item in the collection in a different place in the tree, and the tree can get cluttered. For those, consider using a more traditional Django model, and maybe define a Page Type and/or Content Plugin for listing/navigating through the collection.

Examples of content that works well as Pages are Homepage, About Us, Press Room, Terms & Conditions, Search.

Examples of content that would not work well as Pages (because they are more conveniently modelled as large collections of similar things) are Blog Post, Press Release, User, Image, etc.

Implementation

Although Pages appear in a single tree, each page can be any Page Type. For example, you can freely mix general-purpose pages with special-purpose pages like search or redirects. (This is implemented using django-polymorphic).

A Page Type always inherits:

  • Fluent’s URLNode, giving it a title, slug and some other features.

Page Types normally, but don’t have to, inherit from:

  • ICEkit’s publishing, enabling the page to be published and unpublished.
  • Fluent-contents, enabling the page to have rich modular content.

Creating a new rich content model

To create a model that has rich content, look in the table below to see which mixins you should inherit your model and admin from.

If your new model has URLs that content editors will want to link to, don’t forget to register the model with ICEkitURLField in models.py:

from any_urlfield.forms import SimpleRawIdWidget
from icekit.fields import ICEkitURLField
ICEkitURLField.register_model(MyModel, widget=SimpleRawIdWidget(MyModel), title="My model")

Abstract Page Type mixins

ICEkit comes with a number of mixins to create different types of content. Here’s a rough guide:

Rich Content Regions In the Fluent Page tree Publi shabl e Inherit model from Inherit admin from
No No No models.Model ``models.ModelAdmin` `
No No Yes PublishingModel PublishingAdmin
No Yes No HtmlPage or Page or UrlNode HtmlPageAdmin or PageAdmin or ModelAdmin
No Yes Yes PublishableFluentConten tsPage PublishingAdmin
Static No No models.Model (use PlaceholderFields) PlaceholderFieldAd min
Static No Yes PublishingModel (use PlaceholderFields) (PublishingAdmin, PlaceholderFieldAdmi n)
Static Yes No FluentContentsPage FluentContentsPage Admin
Static Yes Yes PublishableFluentConten tsPage (use PlaceholderFields) (FluentContentsPag eAdmin, PublishingAd min)
Dynamic No No FluentFieldsMixin ``FluentLayoutsMixin ``
Dynamic No Yes PublishableFluentConten ts PublishableFluentC ontentsAdmin
Dynamic Yes No AbstractUnpublishableLa youtPage UnpublishableLayou tPageAdmin
Dynamic Yes Yes AbstractLayoutPage LayoutPageAdmin