From: lpsolit%gmail.com <>
Date: Tue, 23 Oct 2007 02:41:58 +0000 (+0000)
Subject: Part 2 of bug 182083: add Help for more admin pages - Patch by me, r=Colin
X-Git-Tag: bugzilla-3.1.3~484
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f7b1c511e04eadfe10af75a84225b441b4abadd2;p=thirdparty%2Fbugzilla.git

Part 2 of bug 182083: add Help for more admin pages - Patch by me, r=Colin
---

diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml
index 50ffe43f09..cdb48cdbd7 100644
--- a/docs/xml/administration.xml
+++ b/docs/xml/administration.xml
@@ -1036,9 +1036,9 @@
      <title>Administering Flags</title>
 
      <para>
-       If you have the <quote>editcomponents</quote> permission, you will
-       have <quote>Edit: ... | Flags | ...</quote> in your page footer.
-       Clicking on that link will bring you to the <quote>Administer 
+       If you have the <quote>editcomponents</quote> permission, you can
+       edit Flag Types from the main administration page. Clicking the
+       <quote>Flags</quote> link will bring you to the <quote>Administer
        Flag Types</quote> page. Here, you can select whether you want 
        to create (or edit) a Bug flag, or an Attachment flag.
      </para>
@@ -1047,6 +1047,15 @@
        just go over it once.
      </para>
 
+     <section id="flags-edit">
+       <title>Editing a Flag</title>
+       <para>
+         To edit a flag's properties, just click on the <quote>Edit</quote>
+         link next to the flag's description. That will take you to the same
+         form as described below (<xref linkend="flags-create"/>).
+       </para>
+     </section>
+
      <section id="flags-create">
        <title>Creating a Flag</title>
        
@@ -1257,15 +1266,6 @@
         </warning>
       </section>
 
-      <section id="flags-edit">
-        <title>Editing a Flag</title>
-        <para>
-          To edit a flag's properties, just click on the <quote>Edit</quote>
-          link next to the flag's description. That will take you to the same
-          form described in the <quote>Creating a Flag</quote> section.
-        </para>
-      </section>
-
     </section> <!-- flags-admin -->
 
     <!-- XXX We should add a "Uses of Flags" section, here, with examples. -->
diff --git a/editclassifications.cgi b/editclassifications.cgi
index 03d3af81cb..44a627054a 100755
--- a/editclassifications.cgi
+++ b/editclassifications.cgi
@@ -39,6 +39,9 @@ sub LoadTemplate {
     my $action = shift;
     my $cgi = Bugzilla->cgi;
     my $template = Bugzilla->template;
+    # There is currently only one section about classifications,
+    # so all pages point to it. Let's define it here.
+    $vars->{'doc_section'} = 'classifications.html';
 
     $action =~ /(\w+)/;
     $action = $1;
diff --git a/editcomponents.cgi b/editcomponents.cgi
index 46b319edd3..2dabaf898b 100755
--- a/editcomponents.cgi
+++ b/editcomponents.cgi
@@ -37,6 +37,9 @@ use Bugzilla::Token;
 my $cgi = Bugzilla->cgi;
 my $template = Bugzilla->template;
 my $vars = {};
+# There is only one section about components in the documentation,
+# so all actions point to the same page.
+$vars->{'doc_section'} = 'components.html';
 
 #
 # Preliminary checks:
diff --git a/editmilestones.cgi b/editmilestones.cgi
index 0be0f6c7f1..2682b6fcab 100755
--- a/editmilestones.cgi
+++ b/editmilestones.cgi
@@ -29,6 +29,9 @@ my $cgi = Bugzilla->cgi;
 my $dbh = Bugzilla->dbh;
 my $template = Bugzilla->template;
 my $vars = {};
+# There is only one section about milestones in the documentation,
+# so all actions point to the same page.
+$vars->{'doc_section'} = 'milestones.html';
 
 #
 # Preliminary checks:
diff --git a/editproducts.cgi b/editproducts.cgi
index 7c6c52f7d3..82f0bf99f9 100755
--- a/editproducts.cgi
+++ b/editproducts.cgi
@@ -61,6 +61,9 @@ my $dbh = Bugzilla->dbh;
 my $cgi = Bugzilla->cgi;
 my $template = Bugzilla->template;
 my $vars = {};
+# Remove this as soon as the documentation about products has been
+# improved and each action has its own section.
+$vars->{'doc_section'} = 'products.html';
 
 print $cgi->header();
 
diff --git a/editversions.cgi b/editversions.cgi
index ac7b2c7a03..06a58ea03a 100755
--- a/editversions.cgi
+++ b/editversions.cgi
@@ -42,6 +42,9 @@ my $cgi = Bugzilla->cgi;
 my $dbh = Bugzilla->dbh;
 my $template = Bugzilla->template;
 my $vars = {};
+# There is only one section about versions in the documentation,
+# so all actions point to the same page.
+$vars->{'doc_section'} = 'versions.html';
 
 #
 # Preliminary checks:
diff --git a/template/en/default/admin/admin.html.tmpl b/template/en/default/admin/admin.html.tmpl
index 0a1aed2899..dc8859537f 100644
--- a/template/en/default/admin/admin.html.tmpl
+++ b/template/en/default/admin/admin.html.tmpl
@@ -22,6 +22,7 @@
 
 [% PROCESS global/header.html.tmpl title = title
                                    style_urls = ['skins/standard/admin.css']
+                                   doc_section = "administration.html"
 %]
 
 <div>
diff --git a/template/en/default/admin/flag-type/confirm-delete.html.tmpl b/template/en/default/admin/flag-type/confirm-delete.html.tmpl
index 131dc73d95..cc6a064a92 100644
--- a/template/en/default/admin/flag-type/confirm-delete.html.tmpl
+++ b/template/en/default/admin/flag-type/confirm-delete.html.tmpl
@@ -22,7 +22,10 @@
 
 [% title = BLOCK %]Confirm Deletion of Flag Type '[% flag_type.name FILTER html %]'[% END %]
 
-[% PROCESS global/header.html.tmpl title = title %]
+[% PROCESS global/header.html.tmpl
+  title = title
+  doc_section = "flags-overview.html#flags-delete"
+%]
 
 <p>
    There are [% flag_type.flag_count %] flags of type [% flag_type.name FILTER html %].
diff --git a/template/en/default/admin/flag-type/edit.html.tmpl b/template/en/default/admin/flag-type/edit.html.tmpl
index 609e3db9dd..ebebf50821 100644
--- a/template/en/default/admin/flag-type/edit.html.tmpl
+++ b/template/en/default/admin/flag-type/edit.html.tmpl
@@ -33,10 +33,12 @@
   [% typeLabelLowerSingular = BLOCK %]attachment[% END %]
 [% END %]
 
+[% doc_section = "flags-overview.html#flags-create" %]
 [% IF last_action == "copy" %]
   [% title = BLOCK %]Create Flag Type Based on [% type.name FILTER html %][% END %]
 [% ELSIF last_action == "edit" %]
   [% title = BLOCK %]Edit Flag Type [% type.name FILTER html %][% END %]
+  [% doc_section = "flags-overview.html#flags-edit" %]
 [% END %]
 
 [% PROCESS global/header.html.tmpl
@@ -47,6 +49,7 @@
   "
   onload="var f = document.forms[0]; selectProduct(f.product, f.component, null, null, '__Any__');"
   javascript_urls=["js/productform.js"]
+  doc_section = doc_section
 %]
 
 <form method="post" action="editflagtypes.cgi">
diff --git a/template/en/default/admin/flag-type/list.html.tmpl b/template/en/default/admin/flag-type/list.html.tmpl
index 6f9fe4d0d1..d4bba945a2 100644
--- a/template/en/default/admin/flag-type/list.html.tmpl
+++ b/template/en/default/admin/flag-type/list.html.tmpl
@@ -32,6 +32,7 @@
   "
   onload="var f = document.forms[0]; selectProduct(f.product, f.component, null, null, '__All__');"
   javascript_urls=["js/productform.js"]
+  doc_section = "flags-overview.html#flag-types"
 %]
 
 <p>
diff --git a/template/en/default/admin/params/editparams.html.tmpl b/template/en/default/admin/params/editparams.html.tmpl
index ac646f97bf..a35ec0f4ae 100644
--- a/template/en/default/admin/params/editparams.html.tmpl
+++ b/template/en/default/admin/params/editparams.html.tmpl
@@ -57,6 +57,7 @@
    message = message
    style_urls = ['skins/standard/params.css']
    javascript_urls = ['js/params.js']
+   doc_section = "parameters.html"
 %]
 
 <table border="0" width="100%">
diff --git a/template/en/default/admin/sudo.html.tmpl b/template/en/default/admin/sudo.html.tmpl
index 3bdbd9fab3..4dc70f95ac 100644
--- a/template/en/default/admin/sudo.html.tmpl
+++ b/template/en/default/admin/sudo.html.tmpl
@@ -23,6 +23,7 @@
 [% PROCESS global/header.html.tmpl
    title = "Begin sudo session"
    style_urls = ['skins/standard/admin.css']
+   doc_section = "useradmin.html#impersonatingusers"
  %]
  
 [% DEFAULT target_login = "" %]
diff --git a/template/en/default/admin/users/confirm-delete.html.tmpl b/template/en/default/admin/users/confirm-delete.html.tmpl
index d6607c397e..52c98f0b1b 100644
--- a/template/en/default/admin/users/confirm-delete.html.tmpl
+++ b/template/en/default/admin/users/confirm-delete.html.tmpl
@@ -48,6 +48,7 @@
   title = title
   style_urls = ['skins/standard/admin.css',
                 'skins/standard/editusers.css']
+  doc_section = "useradmin.html#user-account-deletion"
 %]
 
 [% PROCESS admin/users/listselectvars.html.tmpl
diff --git a/template/en/default/admin/users/create.html.tmpl b/template/en/default/admin/users/create.html.tmpl
index dd674b7238..6fd5b67e79 100644
--- a/template/en/default/admin/users/create.html.tmpl
+++ b/template/en/default/admin/users/create.html.tmpl
@@ -23,6 +23,7 @@
   title = "Add user"
   style_urls = ['skins/standard/editusers.css']
   onload = "document.forms['f'].login.focus()"
+  doc_section = "useradmin.html#createnewusers"
 %]
 
 [% PROCESS admin/users/listselectvars.html.tmpl
diff --git a/template/en/default/admin/users/edit.html.tmpl b/template/en/default/admin/users/edit.html.tmpl
index 37c0a74b2e..3efa4b8bf1 100644
--- a/template/en/default/admin/users/edit.html.tmpl
+++ b/template/en/default/admin/users/edit.html.tmpl
@@ -30,6 +30,7 @@
   title = title
   message = message
   style_urls = ['skins/standard/admin.css', 'skins/standard/editusers.css']
+  doc_section = "useradmin.html#modifyusers"
 %]
 
 [% PROCESS admin/users/listselectvars.html.tmpl
diff --git a/template/en/default/admin/users/list.html.tmpl b/template/en/default/admin/users/list.html.tmpl
index 4ccc1464d7..4788e527d3 100644
--- a/template/en/default/admin/users/list.html.tmpl
+++ b/template/en/default/admin/users/list.html.tmpl
@@ -24,6 +24,7 @@
 [% PROCESS global/header.html.tmpl
   title = "Select user"
   style_urls = ['skins/standard/editusers.css']
+  doc_section = "useradmin.html"
 %]
 
 [% PROCESS admin/users/listselectvars.html.tmpl
diff --git a/template/en/default/admin/users/search.html.tmpl b/template/en/default/admin/users/search.html.tmpl
index ff1419d981..82e0afda71 100644
--- a/template/en/default/admin/users/search.html.tmpl
+++ b/template/en/default/admin/users/search.html.tmpl
@@ -27,6 +27,7 @@
   title = "Search users"
   style_urls = ['skins/standard/editusers.css']
   onload = "document.forms['f'].matchstr.focus()"
+  doc_section = "useradmin.html#user-account-search"
 %]
 
 [% PROCESS admin/users/listselectvars.html.tmpl