diff options
26 files changed, 153 insertions, 6 deletions
diff --git a/template/en/default/account/created.html.tmpl b/template/en/default/account/created.html.tmpl index 314b71e47..4a68b63fd 100644 --- a/template/en/default/account/created.html.tmpl +++ b/template/en/default/account/created.html.tmpl @@ -19,6 +19,10 @@ # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # login: string. The user's Bugzilla login email address. + #%] + [% PROCESS global/header.html.tmpl title = "Account Created" %] diff --git a/template/en/default/account/email/change-old.txt.tmpl b/template/en/default/account/email/change-old.txt.tmpl index d50a958c6..cd1334d3f 100644 --- a/template/en/default/account/email/change-old.txt.tmpl +++ b/template/en/default/account/email/change-old.txt.tmpl @@ -18,6 +18,11 @@ # # Contributor(s): John Vandenberg <zeroj@null.net> #%] +[%# INTERFACE: + # emailaddress: string. The user's old Bugzilla login email address. + # newemailaddress: string. The user's new Bugzilla login email address. + # token: string. The token associated with this change. + #%] [% expiration_ts = token_ts + (max_token_age * 86400) %] From: bugzilla-admin-daemon To: [% emailaddress %] diff --git a/template/en/default/account/email/confirm.html.tmpl b/template/en/default/account/email/confirm.html.tmpl index 5fd1570e6..ebba5c76f 100644 --- a/template/en/default/account/email/confirm.html.tmpl +++ b/template/en/default/account/email/confirm.html.tmpl @@ -19,9 +19,12 @@ # Contributor(s): John Vandenberg <zeroj@null.net> #%] +[%# INTERFACE: + # token: string. The token to be used in this address change. + #%] + [% PROCESS global/header.html.tmpl %] - <p> To change your email address, please enter the old email address: </p> diff --git a/template/en/default/account/exists.html.tmpl b/template/en/default/account/exists.html.tmpl index 912b117f9..5281b20cf 100644 --- a/template/en/default/account/exists.html.tmpl +++ b/template/en/default/account/exists.html.tmpl @@ -19,6 +19,10 @@ # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # login: string. The user's Bugzilla login email address. + #%] + [% PROCESS global/header.html.tmpl title = "Account Exists" %] diff --git a/template/en/default/admin/attachstatus/edit.html.tmpl b/template/en/default/admin/attachstatus/edit.html.tmpl index ef8d5cf6a..3c2fc2b90 100644 --- a/template/en/default/admin/attachstatus/edit.html.tmpl +++ b/template/en/default/admin/attachstatus/edit.html.tmpl @@ -19,6 +19,14 @@ # Contributor(s): Myk Melez <myk@mozilla.org> #%] +[%# INTERFACE: + # name: string. The name of the attachment status we are editing. + # desc: string. Its description. + # sortkey: integer. Where it's sorted in the list. + # product: string. Which product it applies to. + # id: integer. Its internal ID number. + #%] + [% PROCESS global/header.html.tmpl title = "Edit Attachment Status" style = " diff --git a/template/en/default/admin/attachstatus/list.html.tmpl b/template/en/default/admin/attachstatus/list.html.tmpl index e03b7dc7a..67d5640ae 100644 --- a/template/en/default/admin/attachstatus/list.html.tmpl +++ b/template/en/default/admin/attachstatus/list.html.tmpl @@ -19,6 +19,16 @@ # Contributor(s): Myk Melez <myk@mozilla.org> #%] +[%# INTERFACE: + # statusdefs: list of hashes. may be empty. Each hash has six members: + # name: string. The name of the attachment status. + # description: string. Its description. + # sortkey: integer. Sorting priority. + # product: string. The product to which the attachment status applies. + # id: integer. Its internal ID number. + # attachcount: integer. How many attachments have that status. + #%] + [% PROCESS global/header.html.tmpl title = 'Administer Attachment Statuses' message = message diff --git a/template/en/default/attachment/created.html.tmpl b/template/en/default/attachment/created.html.tmpl index b4af46e80..880630ba2 100644 --- a/template/en/default/attachment/created.html.tmpl +++ b/template/en/default/attachment/created.html.tmpl @@ -19,6 +19,16 @@ # Contributor(s): Myk Melez <myk@mozilla.org> #%] +[%# INTERFACE: + # bugid: integer. ID of the bug we just attached an attachment to. + # attachid: integer. ID of the attachment just created. + # description: string. Description of the attachment just created. + # contenttype: string. The Content Type we attached it as. + # contenttypemethod: string. How we got the content type of the attachment. + # Possible values: autodetect, list, manual. + # mailresults: string. who was mailed, and who wasn't. + #%] + [% PROCESS global/header.html.tmpl title = "Changes Submitted" style = "th { text-align: left; }" diff --git a/template/en/default/attachment/updated.html.tmpl b/template/en/default/attachment/updated.html.tmpl index d522c638d..5c2ffd10f 100644 --- a/template/en/default/attachment/updated.html.tmpl +++ b/template/en/default/attachment/updated.html.tmpl @@ -20,6 +20,12 @@ # Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # bugid: integer. ID of the bug we are updating. + # attachid: integer. ID of the attachment we just attached. + # mailresults: string. Who was mailed and who wasn't. + #%] + [% PROCESS global/header.html.tmpl title = "Changes Submitted" style = "th { text-align: left; }" diff --git a/template/en/default/bug/choose-xml.html.tmpl b/template/en/default/bug/choose-xml.html.tmpl index d6bae93f6..341df9414 100644 --- a/template/en/default/bug/choose-xml.html.tmpl +++ b/template/en/default/bug/choose-xml.html.tmpl @@ -19,6 +19,10 @@ # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # This template has no interface. + #%] + [% PROCESS global/header.html.tmpl title = "Display bugs as XML" %] diff --git a/template/en/default/bug/create/comment.txt.tmpl b/template/en/default/bug/create/comment.txt.tmpl index 21a9f3ff8..595ad3a80 100644 --- a/template/en/default/bug/create/comment.txt.tmpl +++ b/template/en/default/bug/create/comment.txt.tmpl @@ -18,4 +18,9 @@ # # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # form: hash. This is the $::FORM variable from a bug submission (i.e. the + # fields on a template from enter_bug.cgi.) It can be used to pull out + # various custom fields and format an initial Description entry from them. + #%] [% form.comment %] diff --git a/template/en/default/bug/votes/delete-all.html.tmpl b/template/en/default/bug/votes/delete-all.html.tmpl index f9df23894..c50b0cb1c 100644 --- a/template/en/default/bug/votes/delete-all.html.tmpl +++ b/template/en/default/bug/votes/delete-all.html.tmpl @@ -19,6 +19,10 @@ # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # This template has no interface. + #%] + [% PROCESS global/header.html.tmpl title = "Remove your votes?" %] diff --git a/template/en/default/bug/votes/list-for-bug.html.tmpl b/template/en/default/bug/votes/list-for-bug.html.tmpl index b58ba6ff4..cb68a2a47 100644 --- a/template/en/default/bug/votes/list-for-bug.html.tmpl +++ b/template/en/default/bug/votes/list-for-bug.html.tmpl @@ -19,6 +19,14 @@ # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # bug_id: integer. ID of the bug we are listing the votes for. + # users: list of hashes. May be empty. Each hash has two members: + # name: string. The login name of the user whose vote is attached + # count: integer. The number of times that user has votes for this bug. + # total: integer. The total number of votes for this bug. + #%] + [% PROCESS global/header.html.tmpl title = "Show Votes" h2 = "Bug <a href='show_bug.cgi?id=$bug_id'>$bug_id</a>" diff --git a/template/en/default/bug/votes/list-for-user.html.tmpl b/template/en/default/bug/votes/list-for-user.html.tmpl index 261e0f864..4797d71b7 100644 --- a/template/en/default/bug/votes/list-for-user.html.tmpl +++ b/template/en/default/bug/votes/list-for-user.html.tmpl @@ -21,9 +21,11 @@ [% PROCESS global/header.html.tmpl title = "Show Votes" - h2 = user.name + h2 = voting_user.name %] +[% canedit = 1 IF voting_user.login == user.login %] + [% IF votes_recorded %] <p> <font color="red"> @@ -76,7 +78,7 @@ </a> </td> <td align="right"> - [% IF user.canedit %] + [% IF canedit %] [% IF product.onevoteonly %] <input type="checkbox" name="[% bug.id %]" value="1" [% " checked" IF bug.count %]> @@ -103,7 +105,7 @@ [% END %] </table> - [% IF user.canedit %] + [% IF canedit %] <input type="submit" value="Change My Votes"> <br> <br> @@ -114,7 +116,7 @@ </form> [% ELSE %] <p> - [% IF user.canedit %] + [% IF canedit %] You are [% ELSE %] This user is 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 %] diff --git a/template/en/default/index.html.tmpl b/template/en/default/index.html.tmpl index 35e4e9c85..4a2844255 100644 --- a/template/en/default/index.html.tmpl +++ b/template/en/default/index.html.tmpl @@ -21,6 +21,10 @@ # Jacob Steenhagen <jake@acutex.net> #%] +[%# INTERFACE: + # username: string. The login name of the user, if any. + #%] + [% PROCESS global/header.html.tmpl title = 'Bugzilla Main Page' %] diff --git a/template/en/default/list/edit-multiple.html.tmpl b/template/en/default/list/edit-multiple.html.tmpl index c7c8d00bf..fb28845c5 100644 --- a/template/en/default/list/edit-multiple.html.tmpl +++ b/template/en/default/list/edit-multiple.html.tmpl @@ -280,7 +280,7 @@ Reassign</A> bugs to </label> <input name="assigned_to" - value="[% user FILTER html %]" + value="[% user.login FILTER html %]" onchange="document.forms.changeform.knob[[% knum %]].checked = true;" size="32"><br /> diff --git a/template/en/default/list/list-simple.html.tmpl b/template/en/default/list/list-simple.html.tmpl index b8d8241a3..b86f697ed 100644 --- a/template/en/default/list/list-simple.html.tmpl +++ b/template/en/default/list/list-simple.html.tmpl @@ -19,6 +19,10 @@ # Contributor(s): Myk Melez <myk@mozilla.org> #%] +[%# INTERFACE: + # title: string. The title for this page. (optional) + #%] + [%############################################################################%] [%# Initialization #%] [%############################################################################%] diff --git a/template/en/default/list/quips.html.tmpl b/template/en/default/list/quips.html.tmpl index 1d6143dfe..032f35fcf 100644 --- a/template/en/default/list/quips.html.tmpl +++ b/template/en/default/list/quips.html.tmpl @@ -19,6 +19,13 @@ # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # added_quip: string. Defined if the CGI added a quip data before + # displaying anything; if defined, its value is that quip. + # show_quips: boolean. True if we are showing the entire quip list. + # quips: list of strings. Defined iff show_quips is true. List of all quips. + #%] + [% PROCESS global/header.html.tmpl title = "Bugzilla Quip System" h1 = "Add your own clever headline" diff --git a/template/en/default/list/server-push.html.tmpl b/template/en/default/list/server-push.html.tmpl index 5a2dde0b1..9b7131654 100644 --- a/template/en/default/list/server-push.html.tmpl +++ b/template/en/default/list/server-push.html.tmpl @@ -19,6 +19,11 @@ # Contributor(s): Myk Melez <myk@mozilla.org> #%] +[%# INTERFACE: + # debug: boolean. True if we want the query displayed while we wait. + # query: string. The SQL query which makes the buglist. + #%] + <html> <head> <title>Bugzilla is pondering your query</title> diff --git a/template/en/default/reports/components.html.tmpl b/template/en/default/reports/components.html.tmpl index 9f275eda7..8bc549509 100644 --- a/template/en/default/reports/components.html.tmpl +++ b/template/en/default/reports/components.html.tmpl @@ -19,6 +19,15 @@ # Contributor(s): Bradley Baetz <bbaetz@student.usyd.edu.au> #%] +[%# INTERFACE: + # product: string. The product this is the components list for. + # components: List of hashes. May be empty. Each hash has four members: + # name: string. Name of the component. + # description: string. Description of the component. May contain HTML. + # initialowner: string. Component's initial owner. + # initialqacontact: string. Component's initial QA contact. + #%] + [% filtered_product = product FILTER html %] [% PROCESS global/header.html.tmpl title = "Components for $product" diff --git a/template/en/default/search/search-advanced.html.tmpl b/template/en/default/search/search-advanced.html.tmpl index 63e947ad5..6284ec516 100644 --- a/template/en/default/search/search-advanced.html.tmpl +++ b/template/en/default/search/search-advanced.html.tmpl @@ -19,6 +19,12 @@ # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # This template has no interface. However, to use it, you need to fulfill + # the interfaces of search/form.html.tmpl, search/knob.html.tmpl and + # search/boolean-charts.html.tmpl. + #%] + [% PROCESS global/header.html.tmpl title = "Search for bugs" extra = " onLoad=\"selectProduct(document.forms['queryform']);\"" diff --git a/template/en/default/search/search.html.tmpl b/template/en/default/search/search.html.tmpl index 63e947ad5..6284ec516 100644 --- a/template/en/default/search/search.html.tmpl +++ b/template/en/default/search/search.html.tmpl @@ -19,6 +19,12 @@ # Contributor(s): Gervase Markham <gerv@gerv.net> #%] +[%# INTERFACE: + # This template has no interface. However, to use it, you need to fulfill + # the interfaces of search/form.html.tmpl, search/knob.html.tmpl and + # search/boolean-charts.html.tmpl. + #%] + [% PROCESS global/header.html.tmpl title = "Search for bugs" extra = " onLoad=\"selectProduct(document.forms['queryform']);\"" |