summaryrefslogtreecommitdiffstats
path: root/template/en/default/global
diff options
context:
space:
mode:
authorgerv%gerv.net <>2002-05-07 04:16:46 +0200
committergerv%gerv.net <>2002-05-07 04:16:46 +0200
commit6428fbf3f1f3cf3a1fd9fd2062836366ae2f388c (patch)
tree25cb33550b6e1d59c3781920489b407d17f8b690 /template/en/default/global
parent3b0b95d36d3e8b4ebea4d8e32d5337623cc13ba2 (diff)
downloadbugzilla-6428fbf3f1f3cf3a1fd9fd2062836366ae2f388c.tar.gz
bugzilla-6428fbf3f1f3cf3a1fd9fd2062836366ae2f388c.tar.xz
Bug 141036 - add INTERFACE comments to all templates. This does the first 20 or so - many more to go... Patch by gerv; 2xr=bbaetz.
Diffstat (limited to 'template/en/default/global')
-rw-r--r--template/en/default/global/choose-product.html.tmpl5
-rw-r--r--template/en/default/global/code-error.html.tmpl7
-rw-r--r--template/en/default/global/header.html.tmpl11
-rw-r--r--template/en/default/global/message.html.tmpl5
-rw-r--r--template/en/default/global/user-error.html.tmpl5
5 files changed, 33 insertions, 0 deletions
diff --git a/template/en/default/global/choose-product.html.tmpl b/template/en/default/global/choose-product.html.tmpl
index 7bd27ffc8..e8d9aaf5c 100644
--- a/template/en/default/global/choose-product.html.tmpl
+++ b/template/en/default/global/choose-product.html.tmpl
@@ -19,6 +19,11 @@
# Contributor(s): Gervase Markham <gerv@gerv.net>
#%]
+[%# INTERFACE:
+ # proddesc: hash. May be empty. The hash keys are the products, and the values
+ # are their descriptions.
+ #%]
+
[% DEFAULT title = "Choose a Product" %]
[% PROCESS global/header.html.tmpl %]
diff --git a/template/en/default/global/code-error.html.tmpl b/template/en/default/global/code-error.html.tmpl
index b0f21f7ff..637fba6b1 100644
--- a/template/en/default/global/code-error.html.tmpl
+++ b/template/en/default/global/code-error.html.tmpl
@@ -19,6 +19,13 @@
# Contributor(s): Gervase Markham <gerv@gerv.net>
#%]
+[%# INTERFACE:
+ # header_done: boolean. True if the header has already been printed.
+ # error: string. The error message to be printed. May contain HTML.
+ # variables: hash. Useful data about the problem. The keys are the variable
+ # names, and the values the variable values.
+ #%]
+
[% UNLESS header_done %]
[% PROCESS global/header.html.tmpl %]
[% END %]
diff --git a/template/en/default/global/header.html.tmpl b/template/en/default/global/header.html.tmpl
index bba911ff4..f77649ae3 100644
--- a/template/en/default/global/header.html.tmpl
+++ b/template/en/default/global/header.html.tmpl
@@ -19,6 +19,17 @@
# Contributor(s):
#%]
+[%# INTERFACE:
+ # (All the below interface elements are optional.)
+ # title: string. Page title.
+ # h1: string. Main page header.
+ # h2: string. Page subheader.
+ # extra: string. Any other HTML to go inside the <head> tags.
+ # jscript: string. Javascript to go in the header.
+ # style: string. CSS style.
+ # message: string. A message to display to the user. May contain HTML.
+ #%]
+
[% DEFAULT
title = ""
h1 = title
diff --git a/template/en/default/global/message.html.tmpl b/template/en/default/global/message.html.tmpl
index 8738def08..14e1f10d0 100644
--- a/template/en/default/global/message.html.tmpl
+++ b/template/en/default/global/message.html.tmpl
@@ -19,6 +19,11 @@
# Contributor(s):
#%]
+[%# INTERFACE:
+ # url: string. An optional URL to go to.
+ # link: string. The link text for that URL.
+ #%]
+
[% DEFAULT title = "Bugzilla Message" %]
[% PROCESS global/header.html.tmpl %]
diff --git a/template/en/default/global/user-error.html.tmpl b/template/en/default/global/user-error.html.tmpl
index d2e527dda..f24b5293f 100644
--- a/template/en/default/global/user-error.html.tmpl
+++ b/template/en/default/global/user-error.html.tmpl
@@ -19,6 +19,11 @@
# Contributor(s): Gervase Markham <gerv@gerv.net>
#%]
+[%# INTERFACE:
+ # header_done: boolean. True if the header has already been printed.
+ # error: string. The error message to be displayed. May contain HTML.
+ #%]
+
[% UNLESS header_done %]
[% PROCESS global/header.html.tmpl %]
[% END %]