From 6428fbf3f1f3cf3a1fd9fd2062836366ae2f388c Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" <> Date: Tue, 7 May 2002 02:16:46 +0000 Subject: Bug 141036 - add INTERFACE comments to all templates. This does the first 20 or so - many more to go... Patch by gerv; 2xr=bbaetz. --- template/en/default/global/choose-product.html.tmpl | 5 +++++ template/en/default/global/code-error.html.tmpl | 7 +++++++ template/en/default/global/header.html.tmpl | 11 +++++++++++ template/en/default/global/message.html.tmpl | 5 +++++ template/en/default/global/user-error.html.tmpl | 5 +++++ 5 files changed, 33 insertions(+) (limited to 'template/en/default/global') 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 #%] +[%# 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 #%] +[%# 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 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 #%] +[%# 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 %] -- cgit v1.2.3-24-g4f1b