Total Knowledge Projects Jobs Clientele Contact

UU Templates

Personal tools
From Total Knowledge
(Difference between revisions)
Jump to: navigation, search
(Intro: Add Alexey's view of role assignment.)
(Template organization: Add the theme structure document)
Line 37: Line 37:
* Create a skeleton for a new theme
* Create a skeleton for a new theme
* Set default theme for UU instance
* Set default theme for UU instance
 +
 +
==Theme structure==
 +
Right now there are very few restrictions imposed on what theme should be coded like.
 +
The only required thing is set of names theme provides.
 +
There are also few things which are expected:
 +
* Each servlet provides certain data to its view.
 +
  It's expected theme only uses that data.
 +
* Servlet->title mappings exported from libhtmlobjects.
 +
  It's expected that top-level menu is built from them.
 +
* libui/Environment.csinc sets up some common global variables.
 +
  It's expected that each .csp in theme includes it directly or indirectly.
 +
* theme CSPs should '''not''' handle exceptions
 +
  Exceptions are handled by calling servlets by redirecting
 +
  to common error pages.
 +
 +
Finally, there are few recommendations for organizing your theme.
 +
* Theme should have its own external CSS, which will be installed under ''<UU root>/themes/<theme>/styles/''
 +
* Theme should have Header.csinc, included by each .csp, which builds common menus and such.
 +
* Theme should have Footer.csinc, which displays any error messages accumulated during CSP execution in uniform way.

Revision as of 22:33, 4 January 2009

Contents

Intro

Image:HiLevelArch.svg
High-level architecture diagram

UU follow classical MVC pattern.

  • Role of Model will be played by database encapsulating classes (i.e. User, Topic, Course, etc.)
  • Controller classes will be servlets, one servlet for each page (LoginServlet, RegisterServlet, SolveProblemServlet, etc)
  • View classes will be created from CSP (C++ Server Pages)

Alexey thinks that assignment of roles is slightly different: Model is database schema itself, and controller is a set of stored procedures in database that work with data. View, in that case, is all of the C++ code (both servlets and themes).

I guess at this point his view of roles is closer to reality then my original proposal.

Request processing

  • Controller receives request
  • Controller accesses Model objects as needed, potentially altering model state
  • Controller stores results in request context
  • Controller determines which view to forward request to based on user preferences (think themes)
  • Controller determines which language to render page in based on user preferences
  • Controller forwards the request to the view object

Template organization

Template mappings

Templates (CSP pages) will have identical names, and will be mapped to subdirectories named based on theme.

I18N support for templates

All interface strings will be explicitly retrieved using something like _() gettext macro, like this: <HEAD><TITLE><%=_("Moooo")%></TITLE></HEAD> We will provide tools to automate message catalogue creation and translation for templates.

Theme management

Theme management tool provides following functionality

  • Compile and install a theme
  • Create a skeleton for a new theme
  • Set default theme for UU instance

Theme structure

Right now there are very few restrictions imposed on what theme should be coded like. The only required thing is set of names theme provides. There are also few things which are expected:

  • Each servlet provides certain data to its view.
 It's expected theme only uses that data.
  • Servlet->title mappings exported from libhtmlobjects.
 It's expected that top-level menu is built from them.
  • libui/Environment.csinc sets up some common global variables.
 It's expected that each .csp in theme includes it directly or indirectly.
  • theme CSPs should not handle exceptions
 Exceptions are handled by calling servlets by redirecting
 to common error pages.

Finally, there are few recommendations for organizing your theme.

  • Theme should have its own external CSS, which will be installed under <UU root>/themes/<theme>/styles/
  • Theme should have Header.csinc, included by each .csp, which builds common menus and such.
  • Theme should have Footer.csinc, which displays any error messages accumulated during CSP execution in uniform way.