From e6365732c21ba888fc70bfb7eaa7d1d50408bb7a Mon Sep 17 00:00:00 2001
From: "mkanat%bugzilla.org" <>
Date: Sun, 6 May 2007 00:50:54 +0000
Subject: Bug 374331: Bugzilla::Template should use template_include_path from
 Bugzilla::Install::Util Patch By Max Kanat-Alexander <mkanat@bugzilla.org>
 r=myk, a=mkanat

---
 Bugzilla/Install/Util.pm | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

(limited to 'Bugzilla/Install/Util.pm')

diff --git a/Bugzilla/Install/Util.pm b/Bugzilla/Install/Util.pm
index 82edefb3a..32860732b 100644
--- a/Bugzilla/Install/Util.pm
+++ b/Bugzilla/Install/Util.pm
@@ -38,6 +38,7 @@ our @EXPORT_OK = qw(
     indicate_progress
     install_string
     is_web
+    template_include_path
     vers_cmp
 );
 
@@ -454,6 +455,47 @@ inside of the string.
 
 =back
 
+=item C<template_include_path>
+
+Used by L<Bugzilla::Template> and L</install_string> to determine the
+directories where templates are installed. Templates can be installed
+in many places. They're listed here in the basic order that they're
+searched:
+
+=over
+
+=item extensions/C<$extension>/template/C<$language>/C<$project>
+
+=item extensions/C<$extension>/template/C<$language>/custom
+
+=item extensions/C<$extension>/template/C<$language>/default
+
+=item template/C<$language>/C<$project>
+
+=item template/C<$language>/custom
+
+=item template/C<$language>/default
+
+=back
+
+C<$project> has to do with installations that are using the C<$ENV{PROJECT}>
+variable to have different "views" on a single Bugzilla.
+
+The F<default> directory includes templates shipped with Bugzilla.
+
+The F<custom> directory is a directory for local installations to override
+the F<default> templates. Any individual template in F<custom> will
+override a template of the same name and path in F<default>.
+
+C<$language> is a language code, C<en> being the default language shipped
+with Bugzilla. Localizers ship other languages.
+
+C<$extension> is the name of any directory in the F<extensions/> directory.
+Each extension has its own directory.
+
+Note that languages are sorted by the user's preference (as specified
+in their browser, usually), and extensions are sorted alphabetically.
+
 =item C<vers_cmp>
 
 =over
-- 
cgit v1.2.3-24-g4f1b