Changes between Initial Version and Version 1 of DeveloperGuidelines/Templates/CustomPages

Timestamp:

06/23/12 15:31:21 (13 years ago)

Author:

Fran Boon

Comment:

--

DeveloperGuidelines/Templates/CustomPages

@@ +1 @@
+= Custom Pages =
+[[TOC]]
+
+Sahana Eden supports custom Pages as part of it's overall [DeveloperGuidelines/Templates Templates] system.
+
+This allows customisation of:
+* Home page
+* Totally new pages
+
+Custom pages are defined within the templates folder to reduce issues with merging.
+
+NOTE: This is still a work-in-progress: not everything here is ready yet & the details may change!
+
+== Home Page ==
+
+The web server is normally configured to redirect requests to:
+{{{
+http://host.domain
+}}}
+to:
+{{{
+http://host.domain/application/default/index
+}}}
+
+Which maps to {{{controllers/default.py}}} & the {{{index()}}} function therein.
+
+The default application & controller can be easily edited in {{{web2py/routes.py}}} or within the web server configuration, however editing the default function might cause problems for other Sahana modules.
+
+Sahana Eden is designed to check for the presence of a custom template and, if one is configured, then it attempts to load:
+{{{
+/private/templates/<template>/controllers.py
+}}}
+& then run the {{{index()}}} function inside there instead.
+
+Note: you must have an {{{__init__.py}}} in your template folder for this to work (it can be empty).
+
+== Custom Page ==
+
+If a URL is specified like:
+{{{
+http://host.domain/application/default/index/<custompage>
+}}}
+
+The this alternate page will attempt to be loaded using the {{{custompage()}}} function in:
+{{{
+/private/templates/<template>/controllers.py
+}}}
+
+== See Also ==
+* [DeveloperGuidelines/Templates Templates]
+* [DeveloperGuidelines/Menus Menus]
+* [DeveloperGuidelines/Themes Themes]