Skip to content
This repository has been archived by the owner on Jun 19, 2021. It is now read-only.

Latest commit

 

History

History
50 lines (31 loc) · 1.84 KB

README.md

File metadata and controls

50 lines (31 loc) · 1.84 KB

symposion-bootstrap-templates

Provides some customisable bootstrap templates for things in Symposion, so that you get basic behaviour automatically.

What is the point of this?

symposion provides a bunch of django views that make the app tick, however, it does not include any templates, which means that as new features are added, things do not work automagically

How does it work

For each template required by symposion, symposion_templates provides two templates. Say the template used by the view is called view.html. We provide:

  • view.html, which is the template that is loaded directly -- this will be very modular, and will let you easily override things that you need to override in your own installations
  • view_.html, which is the thing that lays everything out.

So you can either override view_.html if you're happy with the text and markup that view.html provides, or you can override view.html if you want to change the entire thing. Your choice!

Installation

Ensure that APP_DIRS is switched on in your settings, like so:

TEMPLATES = [{
    'BACKEND': 'django.template.backends.django.DjangoTemplates',
    'APP_DIRS': True,
}]

Then add symposion_templates to your INSTALLED_APPS:

INSTALLED_APPS = [
  ...
  "symposion_templates",
  ...
]

Overriding our defaults:

  • symposion/form.html is used by these templates whenever a form needs to be rendered. The default implementation of this just calls {form}.
  • symposion/base.html extends site_base.html. Each view_.html template that we provide extends symposion/base.html

Using the templates

  • Our default templates place their content in a block called content. Your symposion/base.html MUST include a block called content where you want the content to appear.
  • Each template will document the purpose of the templates