mahara-contributors team mailing list archive

[Mahara Bot <1231755@xxxxxxxxxxxxxxxxxx>]

Reviewed:  https://reviews.mahara.org/3428
Committed: http://gitorious.org/mahara/mahara/commit/97e96de04a988b4144da29806ed94348f3439b37
Submitter: Son Nguyen (son.nguyen@xxxxxxxxxxxxxxx)
Branch:    master

commit 97e96de04a988b4144da29806ed94348f3439b37
Author: Aaron Wells <aaronw@xxxxxxxxxxxxxxx>
Date:   Tue Jun 10 13:19:12 2014 +1200

Refactor the Dwoo_Template_Mahara files

Bug 1231755

- Cleanup, documentation, and removing replicated code.

- Not checking for whether the file exists. We'll just make a list
of search paths and pass those through to Dwoo_Template_File, and
let it determine which path has the file.

- Eliminating the separate Dwoo_Template_Mahara classes for plugintypes,
and moving the custom logic for how plugintypes find their template files,
into the Plugin class itself.

Change-Id: I877a4221323333e8e8b6c6df54062a0f8bf2b817

-- 
You received this bug notification because you are a member of Mahara
Contributors, which is subscribed to Mahara.
Matching subscriptions: Subscription for all Mahara Contributors -- please ask on #mahara-dev or mahara.org forum before editing or unsubscribing it!
https://bugs.launchpad.net/bugs/1231755

Title:
  Allow /local and custom theme override of Plugin templates

Status in Mahara ePortfolio:
  Confirmed

Bug description:
  One of the handiest features for site admins to tweak their Mahara
  site without making hacks that make upgrades difficult, is the
  relatively obscure local theme overrides feature:
  https://wiki.mahara.org/index.php/Customising/Themes/1.2#Local_theme_overrides

  Theme support is there, but you have to put the theme template
  dirctories under the plugin's own theme directory. i.e.
  artefact/internal/theme/primary/static/templates/content.tpl . So,
  this is handy for plugin authors, but not for custom theme developers.

  I propose the following:

  1. We allow for /local overrides of plugin templates. The path should
  be local/theme/templates/{plugintype}/{pluginname}/{template} . Or in
  the case of plugins that live underneath other plugins (i.e.
  blocktypes under artefacts)
  local/theme/templates/{plugintype1}/{pluginname1}/{plugintype2}/{pluginname2}/{template}.

  So:

  local/theme/templates/artefact/internal/content.tpl
  local/theme/templates/artefact/internal/blocktype/textbox/content.tpl

  2. For custom themes, we take a similar approach:
  theme/{themename}/static/templates/{plugintype}/{pluginname}/{template}

  theme/aaronstheme/static/templates/artefact/internal/content.tpl
  theme/aaronstheme/static/templates/artefact/internal/blocktype/textbox/content.tpl

  And in order of precedence:

  1. /local theme overrides
  2. custom theme located under /theme directory
  3. theme template files locate under plugin's directory

To manage notifications about this bug go to:
https://bugs.launchpad.net/mahara/+bug/1231755/+subscriptions