locale/en_US/manual-xml/admin.xml

   1 <chapter id="admin" revision="$Revision$">
   2         <title>The Administration Panel</title>
   3
   4         <!-- =================================================================== -->
   5
   6         <section id="admin.about">
   7                 <title>About the Administration Panel</title>
   8                 <para>Once you have logged into your user account, you will see an "Administration" tab in the top navigation bar. Click this to be presented with the login screen. Here, login again for an added layer of security.</para>
   9
  10                 <para>In the administration panel, there are numerous options and features that can be accessed through the <link linkend="admin.menu">main menu</link>.</para>
  11         </section>
  12
  13         <!-- =================================================================== -->
  14
  15         <section id="admin.menu">
  16                 <title>The Main Menu</title>
  17                 <para>The primary page of the administration screen is the main menu:</para>
  18
  19                 <mediaobject>
  20                         <imageobject>
  21                                 <imagedata fileref="images/admin_index/main_menu.png" format="PNG" align="center" />
  22                         </imageobject>
  23                 </mediaobject>
  24
  25                 <para>In this menu there is a listing of all the various mutable aspects of your &product; installation. In this manual, we will explain each item in the main menu in the order that they appear.</para>
  26
  27                 <para>We should also note that any option available in the main menu is also in the navigation menu (the pull down bar in the upper-left corner of the window):</para>
  28
  29                 <mediaobject>
  30                         <imageobject>
  31                                 <imagedata fileref="images/admin_index/navigation_menu.png" format="PNG" align="center" />
  32                         </imageobject>
  33                 </mediaobject>
  34
  35                 <note>The logout link in the administration panel will not log you out of the entire &product; system--just the administration panel. However, the opposite is true of the logout link in the non-administration interface: if you log out there, you will also be logged out of the administration panel.</note>
  36         </section>
  37
  38         <!-- =================================================================== -->
  39
  40         <section id="admin.settings">
  41                 <title>&product; Settings</title>
  42                 <para>&product;'s main options are broken up into three different sections: <property>General Options</property>, <property>Bug Reporting Options</property>, and <property>Pagination Options</property>. For the most part, you will only have to alter the general settings. In the following three pages, we will explain the key options of each page.</para>
  43
  44                 <!-- ################################################################### -->
  45
  46                 <section id="admin.settings.general">
  47                         <title>General Options</title>
  48                         <para>Most of the general settings are explained by their descriptions, however a few of the options are explicated here.</para>
  49
  50                         <variablelist>
  51                                 <varlistentry>
  52                                         <term>Tracker Title</term>
  53                                         <listitem>This is the name of the entire bug tracking system. The value of this setting will appear at the top of the bug tracker and in most emails sent out to users.</listitem>
  54                                 </varlistentry>
  55                                 <varlistentry>
  56                                         <term>Tracker Base URL</term>
  57                                         <listitem>Set this to the root URL of your tracker--the initial location of the tracker in your web browser. Make sure that there is no trailing slash ("/") at the end of the URL as it could possibly break links that the URL is used in.</listitem>
  58                                 </varlistentry>
  59                                 <varlistentry>
  60                                         <term>Date Format</term>
  61                                         <listitem>For most users, this option will not need to change as the default is perfectly fine. However, if you wish to change the way in which dates appear in your bug tracker, you will need to use PHP's date formatting characters. Follow the table <link xlink:href="http://www.php.net/date">here</link> for the formatting characters.</listitem>
  62                                 </varlistentry>
  63                         </variablelist>
  64                 </section>
  65
  66                 <!-- ################################################################### -->
  67
  68                 <section id="admin.settings.reporting">
  69                         <title>Bug Reporting Options</title>
  70                         <variablelist>
  71                                 <varlistentry>
  72                                         <term>Allow HTML in Bug Reports</term>
  73                                         <listitem>This is an option that should be set to <userinput>No</userinput> unless there is good reason to change it. By allowing HTML in bug reports, users would be able to post malicious code that could break the display of the tracker and exploit the system via JavaScript. Only enable this option if you are confident in the users of the system, generally only in private bug trackers.</listitem>
  74                                 </varlistentry>
  75                         </variablelist>
  76
  77                         <para>The rest of the options in <property>Bug Reporting Options</property> are defaults. What that means is that in the new report screen, these values will be entered in by default. If a user has permissions to change the field, he or she can; however, if the user does not, this value will be inserted.</para>
  78                 </section>
  79
  80                 <!-- ################################################################### -->
  81
  82                 <section id="admin.settings.pagination">
  83                         <title>Pagination Options</title>
  84                         <para>The pagination options are advanced features. If you are a novice user and do not have to worry about server load with &product;, these settings do not need changing. These settings control the number of bugs that appear in a listing and how many page navigation links are displayed.</para>
  85
  86                         <variablelist>
  87                                 <varlistentry>
  88                                         <term>Default Per-Page Amount</term>
  89                                         <listitem>The default number of items to be displayed on a single page.</listitem>
  90                                 </varlistentry>
  91                                 <varlistentry>
  92                                         <term>Maximum Per-Page Value</term>
  93                                         <listitem>If a user manually enters a per-page amount, it cannot exceed this value; if it does, the system will use this value instead. If server load is a concern for your system, this setting may need to be lowered.</listitem>
  94                                 </varlistentry>
  95                                 <varlistentry>
  96                                         <term>Number of Page Links</term>
  97                                         <listitem>This controls how many page navigator links appear on either side of the current page. Settings this to <userinput>0</userinput> will display all pages, which is highly not recommended. A setting greater than <userinput>5</userinput> is also not recommended.</listitem>
  98                                 </varlistentry>
  99                         </variablelist>
 100                 </section>
 101
 102         </section>
 103
 104         <!-- =================================================================== -->
 105
 106         <section id="admin.language">
 107                 <title>Manage Languages</title>
 108                 <para>In the <property>Manage Languages</property> section, you are presented with the language manager:</para>
 109
 110                 <mediaobject>
 111                         <imageobject>
 112                                 <imagedata fileref="images/language_manage/language_manager.png" format="PNG" align="center" />
 113                         </imageobject>
 114                 </mediaobject>
 115
 116                 <para>In &product;, the actual English text is embedded in templates and files. When a new language is added, this English text is looked up against a table of the language's translated text; if there's an entry for a given phrase (called a string), it displays that instead.</para>
 117
 118                 <para>What this means is that the default language ("English (US)") doesn't need to exist. However, we have left it in place because if an administrator wants to change a string, all he or she has to do is modify the language file and create a new MO file. To do this, you must be familiar with using <link xlink:href="http://gnu.org/software/gettext">GNU gettext</link>; translating is out of the scope of this manual.</para>
 119
 120                 <!-- ################################################################### -->
 121
 122                 <section id="admin.language.edit">
 123                         <title>Adding or Editing a Language</title>
 124                         When you add or edit a language, you are presented with this screen:
 125
 126                         <mediaobject>
 127                                 <imageobject>
 128                                         <imagedata fileref="images/language_edit/edit_language.png" format="PNG" align="center" />
 129                                 </imageobject>
 130                         </mediaobject>
 131
 132                         <variablelist>
 133                                 <varlistentry>
 134                                         <term>Title</term>
 135                                         <listitem>The name of the language that is to be displayed to users (if they can select it) and in the administration panel.</listitem>
 136                                 </varlistentry>
 137                                 <varlistentry>
 138                                         <term>Character Set</term>
 139                                         <listitem>This character set often determines what symbols can be displayed on a page. English can be <code>iso-8859-1</code> or <code>utf-8</code>, either value will work. By default, however, we have set it to be <code>utf-8</code> because it will display most characters. If you are unsure, use <code>utf-8</code>.</listitem>
 140                                 </varlistentry>
 141                                 <varlistentry>
 142                                         <term>Direction</term>
 143                                         <listitem>This determines the direction of the text on a page. For instance, English is read left-to-right, while Arabic is read right-to-left.</listitem>
 144                                 </varlistentry>
 145                                 <varlistentry>
 146                                         <term>User Selectable</term>
 147                                         <listitem>If this enabled, users will be able to select this language in their options. If it is not, then it will be a private language and only viewable in the administration panel.</listitem>
 148                                 </varlistentry>
 149                         </variablelist>
 150                 </section>
 151
 152                 <!-- ################################################################### -->
 153
 154                 <section id="admin.language.upgrade">
 155                         <title>Languages and Upgrades</title>
 156                         <para>When a new version of &product; is released, you will need to merge the <filename>po/en_US.pot</filename> into your PO file using <application>msgmerge</application>.</para>
 157
 158                         <para>For information on how to merge--both manually and using the translation tool--see the <link xlink:href="http://www.gnu.org/software/gettext/manual/html_chapter/gettext_6.html#SEC36">manual on using <application>msgmerge</application></link>.</para>
 159                 </section>
 160
 161         </section>
 162
 163         <!-- =================================================================== -->
 164
 165         <section id="admin.userhelp">
 166                 <title>Edit User Help</title>
 167                 <para>The user help manager allows you to edit the help text that is displayed in popups in the user's browser. Next to fields that are help-enabled, a small "?" is placed next to the name of the field; clicking this results in a small pop-up that displays help text.</para>
 168
 169                 <para>By default, &product; has default text entries for all the fields. These entries cannot be deleted (but the text can be modified) as they are standard &product; fields.</para>
 170
 171                 <para>The help text for custom fields is set through the <link linkend="admin.customfields.options">description field</link> in the custom field editor.</para>
 172
 173                 <para>You can also create your own help text entries by clicking <guibutton>[Add New Help Text]</guibutton>. You then enter a unique key that is used to identify the text, the title of the text, and then the body.</para>
 174
 175                 <para>Once you have created a custom entry, you can place the following code in any &product; template to create the help link, where "UNIQUE_KEY" is the unique key you specified:</para>
 176
 177                 <programlisting role="php">$help[UNIQUE_KEY]</programlisting>
 178         </section>
 179
 180         <!-- =================================================================== -->
 181
 182         <section id="admin.products">
 183                 <title>Products and Versions</title>
 184                 <para>&product; organizes bugs into products and versions. When a user enters a bug report, he or she is required to specify a product <emphasis>and</emphasis> a version. Therefore, you need at least one product and one version in your system to be usable.</para>
 185
 186                 <para>Components are essentially sub-products. They behave in the exact same fashion as products (in that they require a version to be selected, too) but they are like a part of the project. For instance, in a calendar application there could be components for making events, displaying the calendar, notifications and reminders, etc. These are smaller--but yet still significant--portions of the product.</para>
 187
 188                 <para>In the product manager, you see this:</para>
 189
 190                 <mediaobject>
 191                         <imageobject>
 192                                 <imagedata fileref="images/products_and_versions/product_manager.png" format="PNG" align="center" />
 193                         </imageobject>
 194                 </mediaobject>
 195
 196                 <para>This screen allows you to change the display order (the lower the value, the higher it appears in the list) and manage any components or versions. If you wish to add a component or version, simply choose the option from the pulldown on the far-right.</para>
 197
 198                 <para>In this screen, products (but not components) are bold, both components and products are underlined, and versions have no special formatting. This interface feature will help you differentiate (along with the depth marks) which is a product and which is a version.</para>
 199
 200                 <note>A product has all of its versions and then any global versions. A component will inherit the global versions, its product's versions along with the versions defined specifically for the component. This allows you to specify components without locally-defined versions; instead, they can be inherited.</note>
 201         </section>
 202
 203         <!-- =================================================================== -->
 204
 205         <section id="admin.standardfields">
 206                 <title>Priorities, Resolutions, Severities, and Statuses</title>
 207                 <para>Priorities, resolutions, severities, and statuses all follow the same pattern when adding or editing a new one and therefore they are grouped together in this document. The following is an explanation of each bug field:</para>
 208
 209                 <variablelist>
 210                         <varlistentry>
 211                                 <term>Priority</term>
 212                                 <listitem>This is the field that represents the celerity with witch developers should work with to resolve the bug.</listitem>
 213                         </varlistentry>
 214                         <varlistentry>
 215                                 <term>Resolution</term>
 216                                 <listitem>Usually this is the reason why a certain bug has been marked "closed." For instance, if a bug is not reproducible, then it would be closed and this field would probably be set to "Works for Me."</listitem>
 217                         </varlistentry>
 218                         <varlistentry>
 219                                 <term>Severity</term>
 220                                 <listitem>The user defines this field based on how critical the bug is. Be careful to not confuse this with priority. An example is if a security issue (marked "Critical" in this field) was found in an old version of the software that did not affect the new version; while the severity may be critical, because the version is old, the priority would not need to be marked "High."</listitem>
 221                         </varlistentry>
 222                         <varlistentry>
 223                                 <term>Status</term>
 224                                 <listitem>The state of the bug; this is usually set when the bug is triaged--marked as "Verified" or "Assigned" and then again when it is "Closed." It is usually changed to mark a major shift in the bug's occurrence in a product and version.</listitem>
 225                         </varlistentry>
 226                 </variablelist>
 227
 228                 <para>All of these fields have a title, which is the value of the field; for instance "Normal" is the title of a default priority. Each field also has a display order; this value can be used to control the appearance of a given value in the selection list. If you want to change the default value for new bug reports, see <link linkend="admin.settings.reporting">here</link>.</para>
 229
 230                 <note>The status field also has a colour field associated with it. By filling this value in with a HEX code (be sure to include the <code>#</code> when you specify the value), the background colour of the bug rows in lists will fill to this colour according to bug status (this is a user option). For instance, any unconfirmed bugs will be highlighted in red when viewing the bug list.</note>
 231         </section>
 232
 233         <!-- =================================================================== -->
 234
 235         <section id="admin.customfields">
 236                 <title>Custom Bug Fields</title>
 237                 <para>&product; offers many fields to help you track and triage bugs. However, sometimes additional fields are needed for your specific setup. The additional bug fields feature allows you to create those extra fields and exert fine control over the fields.</para>
 238
 239                 <para>The manager shows you all the information regarding the field:</para>
 240
 241                 <mediaobject>
 242                         <imageobject>
 243                                 <imagedata fileref="images/custom_bug_fields/custom_field_manager.png" format="PNG" align="center" />
 244                         </imageobject>
 245                 </mediaobject>
 246
 247                 <para>There are three types of field that can be created: single-line text boxes, check boxes, and drop-down menus. When you click <guibutton>[Add New Bug Field]</guibutton>, you are presented with this screen:</para>
 248
 249                 <mediaobject>
 250                         <imageobject>
 251                                 <imagedata fileref="images/custom_bug_fields/add_new_field_type.png" format="PNG" align="center" />
 252                         </imageobject>
 253                 </mediaobject>
 254
 255                 <para>Here you select the type of field you want. After selecting the type of field you want and pressing <guibutton>[Submit]</guibutton>, you are taken to the options screen; here you specify all the various options for your field. This is discussed <link linkend="admin.customfields.options">here</link>.</para>
 256
 257                 <!-- ################################################################### -->
 258
 259                 <section id="admin.customfields.options">
 260                         <title>Custom Bug Field Options</title>
 261                         <para>All custom fields have the same standard options:</para>
 262
 263                         <mediaobject>
 264                                 <imageobject>
 265                                         <imagedata fileref="images/custom_bug_fields_options/global_options.png" format="PNG" align="center" />
 266                                 </imageobject>
 267                         </mediaobject>
 268
 269                         <variablelist>
 270                                 <varlistentry>
 271                                         <term>Field Type</term>
 272                                         <listitem>The type of field that you are creating (selected previously)</listitem>
 273                                 </varlistentry>
 274                                 <varlistentry>
 275                                         <term>Description</term>
 276                                         <listitem>Describe the field and its use; this is displayed as the help text to users.</listitem>
 277                                 </varlistentry>
 278                                 <varlistentry>
 279                                         <term>Required</term>
 280                                         <listitem>Whether or not the field is required to be specified by the user.</listitem>
 281                                 </varlistentry>
 282                                 <varlistentry>
 283                                         <term>Can Be Searched</term>
 284                                         <listitem>Whether or not the field appears on the search form.</listitem>
 285                                 </varlistentry>
 286                         </variablelist>
 287
 288                         <para>Additionally, each field has custom permissions that you can set on a per-usergroup level (these can also be set in the <link linkend="admin.usergroups">usergroup editor</link>. You can specify <userinput>No Permission</userinput>, <userinput>Can View</userinput>, or <userinput>Can View and Edit</userinput> settings:</para>
 289
 290                         <mediaobject>
 291                                 <imageobject>
 292                                         <imagedata fileref="images/custom_bug_fields_options/field_permissions.png" format="PNG" align="center" />
 293                                 </imageobject>
 294                         </mediaobject>
 295
 296                         <para>Each type of field also has a unique set of options:</para>
 297
 298                         <section id="admin.customfields.options.singleline">
 299                                 <title>Single-Line Text Field</title>
 300                                 <variablelist>
 301                                         <varlistentry>
 302                                                 <term>Default Value</term>
 303                                                 <listitem>Specify a default value for the field to be entered in new reports.</listitem>
 304                                         </varlistentry>
 305                                         <varlistentry>
 306                                                 <term>Regular Expression Match</term>
 307                                                 <listitem>You can use a regular expression to match against the field's contents and the value will be rejected if the match fails.</listitem>
 308                                         </varlistentry>
 309                                         <varlistentry>
 310                                                 <term>Maximum Length</term>
 311                                                 <listitem>If you want to limit the amount of characters (including spaces) that can be typed in the field, you can specify it here.</listitem>
 312                                         </varlistentry>
 313                                 </variablelist>
 314                         </section>
 315
 316                         <section id="admin.customfields.options.checkbox">
 317                                 <title>Checkbox Flag</title>
 318                                 <variablelist>
 319                                         <varlistentry>
 320                                                 <term>Checked By Default</term>
 321                                                 <listitem>Setting this to <userinput>Yes</userinput> will make the checkbox clicked on.</listitem>
 322                                         </varlistentry>
 323                                 </variablelist>
 324                         </section>
 325
 326                         <section id="admin.customfields.options.dropdown">
 327                                 <title>Drop-Down Menu</title>
 328                                 <variablelist>
 329                                         <varlistentry>
 330                                                 <term>Selection Values</term>
 331                                                 <listitem>A list of values to display in the menu, separated by a new line. If you remove a value that has been set by some bugs, it will still display in the non-edit mode of the bug display.</listitem>
 332                                         </varlistentry>
 333                                         <varlistentry>
 334                                                 <term>Make the First Option Default</term>
 335                                                 <listitem>If you want to make the first option in the selection values list (above) be selected by default, change this to <userinput>Yes</userinput>. Otherwise, the menu will have a blank option selected by default.</listitem>
 336                                         </varlistentry>
 337                                 </variablelist>
 338                         </section>
 339
 340                 </section>
 341
 342         </section>
 343
 344         <!-- =================================================================== -->
 345
 346         <section id="admin.automations">
 347                 <title>Automations</title>
 348                 <para>Often, the same task is performed repeatedly, such as marking a bug "closed and fixed," or "not reproducible," or "please provide more information." These common responses often involve changing multiple fields (status, resolution, etc.) and then leaving a standard comment. Automations make this process significantly easier as you simply define a "macro" of sorts that sets all of the fields and enters the comment automatically. You use these "macros" when viewing a bug. You select one of the automations from a list and when you commit the changes to the bug, the changes specified in the automation will be applied.</para>
 349
 350                 <para>The three required fields are:</para>
 351
 352                 <variablelist>
 353                         <varlistentry>
 354                                 <term>Name</term>
 355                                 <listitem>The name of the automation. This is displayed on the bug display and users select an action by this name.</listitem>
 356                         </varlistentry>
 357                         <varlistentry>
 358                                 <term>Description</term>
 359                                 <listitem>Remarks about what the action does.</listitem>
 360                         </varlistentry>
 361                         <varlistentry>
 362                                 <term>Add Comment</term>
 363                                 <listitem>The comment to add to the bug when the action is run. If the user has specified a comment and runs the automation at the same time, the automatic comment will be appended to the user's.</listitem>
 364                         </varlistentry>
 365                 </variablelist>
 366
 367                 <para>Below this is a list of fields and you can specify a value for each. When the automation is run, these will set the bug's field accordingly. If a field is left blank here, then it will have no effect on the bug. If the user specifies a value for one of the fields and runs an automation at the same time, the automation will take precedence and override the user.</para>
 368
 369                 <note>If the user is in a usergroup that does not have permission to change one of the fields that is specified in the automation, the field will change despite this when the automation is run.</note>
 370         </section>
 371
 372         <!-- =================================================================== -->
 373
 374         <section id="admin.users">
 375                 <title>User Management</title>
 376                 <para>In &product;, you can control and edit the profiles of all registered users. If you want to change a user's options, simply specify a display name, email, or a user ID at this screen:</para>
 377
 378                 <mediaobject>
 379                         <imageobject>
 380                                 <imagedata fileref="images/user_manage/user_search.png" format="PNG" align="center" />
 381                         </imageobject>
 382                 </mediaobject>
 383
 384                 <para>If more than one user matches your search criteria, you will get a listing of users that match. Otherwise, you will be redirected to the edit screen:</para>
 385
 386                 <mediaobject>
 387                         <imageobject>
 388                                 <imagedata fileref="images/user_manage/user_edit.png" format="PNG" align="center" />
 389                         </imageobject>
 390                 </mediaobject>
 391
 392                 <para>Here, you can change all the options that the user can change in his or her profile.</para>
 393         </section>
 394
 395         <!-- =================================================================== -->
 396
 397         <section id="admin.usergroups">
 398                 <title>Usergroups</title>
 399                 <para>Usergroups are at the backbone of &product;'s permissions system. There are two textual options for usergroups:</para>
 400
 401                 <variablelist>
 402                         <varlistentry>
 403                                 <term>Usergroup Title</term>
 404                                 <listitem>This is the internal name of the usergroup; it is never displayed to the users, but administrators use it to place users in groups.</listitem>
 405                         </varlistentry>
 406                         <varlistentry>
 407                                 <term>Display Title</term>
 408                                 <listitem>
 409                                         <para>Under a comment poster's name, this text is placed to help distinguish regular users from developers, administrators, and guests.</para>
 410
 411                                         <para>The majority of the permissions on this page are similar to those of <link linkend="admin.usergroups.permissions">test</link> and they are explained in-depth <link linkend="admin.usergroups.permissions.reference">here</link>. Those that are not part of the usergroup permissions system are listed here.</para>
 412                                 </listitem>
 413                         </varlistentry>
 414                         <varlistentry>
 415                                 <term>Can Search Bugs</term>
 416                                 <listitem>A usergroup's ability to use the search function. If this is not enabled, then searches cannot be performed by the given usergroup.</listitem>
 417                         </varlistentry>
 418                         <varlistentry>
 419                                 <term>Can Be Assigned Bugs</term>
 420                                 <listitem>If this is set to <userinput>Yes</userinput>, all the users in this usergroup will appear in the "Assigned" field drop-down menu for bug reports.</listitem>
 421                         </varlistentry>
 422                         <varlistentry>
 423                                 <term>Can Access Control Panel</term>
 424                                 <listitem>This controls whether or not users in this usergroup can login to the <link linkend="admin.about">Admin Control Panel</link>.</listitem>
 425                         </varlistentry>
 426                         <varlistentry>
 427                                 <term>Can Administer Bug Reports</term>
 428                                 <listitem>Currently, this only controls access to the <link linkend="admin.automations">Automations</link> feature.</listitem>
 429                         </varlistentry>
 430                         <varlistentry>
 431                                 <term>Can Administer Additional Bug Fields</term>
 432                                 <listitem>If this is set to <userinput>Yes</userinput>, users in this group will be able to define and edit <link linkend="admin.customfields">custom bug fields</link>.</listitem>
 433                         </varlistentry>
 434                         <varlistentry>
 435                                 <term>Can Administer Products / Components / Versions</term>
 436                                 <listitem>Allows users to define and edit <link linkend="admin.products">products, versions, and components</link>. This privilege should be sparingly given out as users can also delete products, versions, and components and thus remove all associated bugs.</listitem>
 437                         </varlistentry>
 438                         <varlistentry>
 439                                 <term>Can Administer Users</term>
 440                                 <listitem>Controls access to the <link linkend="admin.users">user manager</link> and the ability to edit and delete users.</listitem>
 441                         </varlistentry>
 442                         <varlistentry>
 443                                 <term>Can Administer Usergroups</term>
 444                                 <listitem>Setting this to <userinput>Yes</userinput> gives the users in this group the ability to control all aspects of usergroups--including permissions. Please be careful when defining this permission.</listitem>
 445                         </varlistentry>
 446                         <varlistentry>
 447                                 <term>Can Administer Settings / Maintenance Tools</term>
 448                                 <listitem>Access to this allows control of <link linkend="admin.language">languages</link> and <link linkend="admin.settings">settings</link>.</listitem>
 449                         </varlistentry>
 450                 </variablelist>
 451
 452                 <para>Additionally, the usergroup manager has the custom field permissions system, similar to the one found on the <link linkend="admin.customfields">custom field editor page</link>, the difference being that this is by field whereas the other is by usergroup.</para>
 453
 454                 <!-- ################################################################### -->
 455
 456                 <section id="admin.usergroups.permissions">
 457                         <title>Usergroup Permissions</title>
 458                         <para>In the <link linkend="admin.usergroups">usergroups manager</link>, you can set the default permissions that apply to every product. However, sometimes you may need finer control over the permissions. Using the permissions manager, you can override the default permissions set by the usergroup.</para>
 459
 460                         <para>The default screen shows a list of all the usergroups with an <guibutton>[Expand]</guibutton> link next to them. Clicking this link will display a list of all available products underneath the usergroup:</para>
 461
 462                         <mediaobject>
 463                                 <imageobject>
 464                                         <imagedata fileref="images/usergroups_permissions/expanded.png" format="PNG" align="center" />
 465                                 </imageobject>
 466                         </mediaobject>
 467
 468                         <para>If you want to override the permissions for a certain product, simply click the <guibutton>[Customize]</guibutton> link to go to a permissions page, similar to the one in the usergroup editor. You can find an explanation of these permissions <link linkend="admin.usergroups.permissions.reference">here</link>.</para>
 469
 470                         <para>After you have customized permissions, but you find that you no longer want the customizations, simply click the <guibutton>[Revert]</guibutton> link.</para>
 471                 </section>
 472
 473                 <!-- ################################################################### -->
 474
 475                 <section id="admin.usergroups.permissions.reference">
 476                         <title>Permissions Reference</title>
 477                         <para>This is a list of the permissions that can be customized on the <link linkend="admin.usergroups.permissions">per-product level</link>. These--plus some additional permissions that are not available on the product-level can be found in the <link linkend="admin.usergroups">usergroup editor</link>.</para>
 478
 479                         <variablelist>
 480                                 <varlistentry>
 481                                         <term>Can View Bugs</term>
 482                                         <listitem>Permits the ability to view bugs of this product.</listitem>
 483                                 </varlistentry>
 484                                 <varlistentry>
 485                                         <term>Can View Hidden Bugs and Comments</term>
 486                                         <listitem>Allows viewing of bugs and comments that have been marked <userinput>Hidden</userinput>. {{NEED LINK: HIDING}}</listitem>
 487                                 </varlistentry>
 488                                 <varlistentry>
 489                                         <term>Can Subscribe to Bugs</term>
 490                                         <listitem>Controls the ability to add bugs of this product to the user's "favourite" list. {{NEED LINK: FAVOURITES}}</listitem>
 491                                 </varlistentry>
 492                                 <varlistentry>
 493                                         <term>Can Vote on Polls</term>
 494                                         <listitem>The ability to vote for a bug. Voting shows the amount of interest in a bug. {{NEED LINK: VOTING}}</listitem>
 495                                 </varlistentry>
 496                                 <varlistentry>
 497                                         <term>Can Submit Bugs</term>
 498                                         <listitem>Determines if users can submit bugs under this product.</listitem>
 499                                 </varlistentry>
 500                                 <varlistentry>
 501                                         <term>Can Post Comments</term>
 502                                         <listitem>Controls whether or not users can post comments to bugs with this product.</listitem>
 503                                 </varlistentry>
 504                                 <varlistentry>
 505                                         <term>Can View Attachments</term>
 506                                         <listitem>Ability to view attachments in bugs with this product.</listitem>
 507                                 </varlistentry>
 508                                 <varlistentry>
 509                                         <term>Can Upload/Edit Own Attachments</term>
 510                                         <listitem>Whether or not the user can edit and upload his or her own attachments to bugs with this product.</listitem>
 511                                 </varlistentry>
 512                                 <varlistentry>
 513                                         <term>Can Manage All Attachments</term>
 514                                         <listitem>Ability to edit other users' attachments.</listitem>
 515                                 </varlistentry>
 516                                 <varlistentry>
 517                                         <term>Can Edit Own Bugs</term>
 518                                         <listitem>Can edit the basic fields of bugs submitted by the user herself. The basic fields are: hidden, summary, product/component/version, severity, duplicates, and dependencies.</listitem>
 519                                 </varlistentry>
 520                                 <varlistentry>
 521                                         <term>Can Edit Others' Bugs</term>
 522                                         <listitem>The same as <property>Can Edit Own Bugs</property> except it applies to bugs that the user did not submit.</listitem>
 523                                 </varlistentry>
 524                                 <varlistentry>
 525                                         <term>Can Edit Own Comments</term>
 526                                         <listitem>Ability to edit comments submitted by the user herself to bugs with this product.</listitem>
 527                                 </varlistentry>
 528                                 <varlistentry>
 529                                         <term>Can Edit Others' Comments</term>
 530                                         <listitem>The same as <property>Can Edit Own Comments</property> but it applies to comments submitted by everybody who is not the current logged in user.</listitem>
 531                                 </varlistentry>
 532                                 <varlistentry>
 533                                         <term>Can Assign Bugs</term>
 534                                         <listitem>The ability to control the "Assigned To" field.</listitem>
 535                                 </varlistentry>
 536                                 <varlistentry>
 537                                         <term>Can Change Status</term>
 538                                         <listitem>Controls the ability to edit the status, resolution, and priority fields.</listitem>
 539                                 </varlistentry>
 540                         </variablelist>
 541                 </section>
 542
 543         </section>
 544
 545 </chapter>