Templates

Introduction

You can set the which template Sahana Eden uses in /models/000_config.py with the line:

settings.base.template = "default"

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.

Examples

See the current templates in Sahana Eden: ​https://github.com/flavour/eden/tree/master/private/templates

The skeleton template is designed to be copied & renamed to create new templates.

Files

Configuration is done using these files:

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

During the 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 /private/templates/<template>/config.py
• optional local overrides to the template's settings

Prepopulate Data

An empty database isn't terribly useful - e.g. maps won't display at all.

Options for how to Prepopulate the database are defined in the template's config.py (but can be overridden in the running 000_config.py):

• settings.base.prepopulate = ("default",)
• DeveloperGuidelines/PrePopulate

Menus

If you need to tweak your menus of build completely new ones:

• DeveloperGuidelines/Menus

Theme

It is possible to develop a custom theme for the look & feel of your system:

• DeveloperGuidelines/Themes

Custom Pages

If you wish to add a new custom page without creating a new module:

• DeveloperGuidelines/Templates/CustomPages

References

• BluePrint/Templates
• DeveloperGuidelines/PrePopulate
• BluePrint/WebSetup

---

DeveloperGuidelines