wiki:DeveloperGuidelines/Templates

Version 5 (modified by Fran Boon, 12 years ago) ( diff )

--

Templates

Table of Contents

  1. Introduction
  2. Design
  3. Prepopulate Data
  4. Theme
    1. Default
    2. User Theme
    3. ToDo
  5. References

Introduction

Templates allow selecting alternate configuration sets.

This allows a separation between Core Code & Settings/Custom Code.

This helps prevent merge conflicts between different deployment branches & hence reduces the risk of forking.

Design

Configuration is done using these files:

  • /private/templates/000_config.py
  • /private/templates/default/config.py
  • /private/templates/<template>/config.py

During 1st_run, 000_config.py is copied to models/

000_config.py includes:

  • FINISHED_EDITING_CONFIG_FILE
  • VERSION
  • machine-specific configuration (Debug, Database, SMTP, API Keys, etc)
  • a setting to define which template folder to run
  • importing of settings from templates/<template>/config.py
  • optional local overrides to the template's settings

Prepopulate Data

Prepopulate options are defined in the template's config.py (ut can be overridden in the running 000_config.py):

Theme

Default

By default these files are used:

  • /private/templates/default/views/layout.html

in non-Debug mode:

  • /private/templates/default/views/style.html
  • /static/styles/default/sahana.min.css

in Debug mode:

  • /private/templates/default/style.cfg
  • /static/styles/default/layout.css
  • /static/styles/S3/sahana.css

User Theme

Optionally a template's config.py (or running 000_config.py) can specify a 'theme' folder (usually the same as the template folder), so that these are used instead:

  • /private/templates/<theme>/views/layout.html

in non-Debug mode:

  • /private/templates/<theme>/views/style.html
  • static/styles/<theme>/sahana.min.css

in Debug mode:

  • /private/templates/<theme>/style.cfg
  • /static/styles/<theme>/layout.css
  • /static/styles/S3/sahana.css (this file should generally not be changed by deployments)
  • /static/styles/<theme>/style.css (for overrides to core CSS)

By convention, suporting files specific to this theme should be placed in:

  • static/styles/<theme>/*.css
  • static/img/<theme>/*.png

NB Production sites who wish to compile their code either need to hardcode the theme name in their views/layout.html & views/style.html or upgrade to Web2Py version: 2.00.0 (2012-06-17 23:36:32) or newer

ToDo

  • controllers/default.py index()
    • Make a controller which can create arbitrary pages based on args &/or vars
  • modules/eden/layouts.py & modules/eden/menus.py

References

DeveloperGuidelines

Note: See TracWiki for help on using the wiki.