From: Gervase Markham Date: Wed, 12 Nov 2014 13:45:59 +0000 (+0000) Subject: Markup some more parameter names properly. X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=32eeeaa690e05ae2b2f51e902fd50bdcef505017;p=thirdparty%2Fbugzilla.git Markup some more parameter names properly. --- diff --git a/docs/en/rst/administering/categorization.rst b/docs/en/rst/administering/categorization.rst index 0f481d3b8a..3326cfe65c 100644 --- a/docs/en/rst/administering/categorization.rst +++ b/docs/en/rst/administering/categorization.rst @@ -25,7 +25,7 @@ containing a few special products that represent items that are not actually shipping products (for example, "Website", or "Administration"). The classifications layer is disabled by default; it can be turned -on or off using the ``useclassification`` parameter +on or off using the :param:`useclassification` parameter in the *Bug Fields* section of :ref:`parameters`. Access to the administration of classifications is controlled using @@ -96,11 +96,11 @@ Editing Products ================ To edit an existing product, click the "Products" link from the -"Administration" page. If the ``useclassification`` parameter is +"Administration" page. If the :param:`useclassification` parameter is turned on, a table of existing classifications is displayed, including an "Unclassified" category. The table indicates how many products are in each classification. Click on the classification name to see its -products. If the ``useclassification`` parameter is not in use, the table +products. If the :param:`useclassification` parameter is not in use, the table lists all products directly. The product table summarizes the information defined when the product was created. Click on the product name to edit these properties, and to access links to other product attributes such as the @@ -399,7 +399,7 @@ example, if you have a bug that you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. .. note:: Milestone options will only appear for a Product if you turned - on the "usetargetmilestone" parameter in the "Bug Fields" tab of the + on the :param:`usetargetmilestone` parameter in the "Bug Fields" tab of the :ref:`parameters` page. To create new Milestones and set Default Milestones: diff --git a/docs/en/rst/administering/groups.rst b/docs/en/rst/administering/groups.rst index b7bba07d02..a14bb689e9 100644 --- a/docs/en/rst/administering/groups.rst +++ b/docs/en/rst/administering/groups.rst @@ -109,7 +109,7 @@ all users from the group who match the regular expression entered. The The "Group Permissions" section on the "Edit Groups" page contains four sets of permissions that control the relationship of this group to other -groups. If the ``usevisibilitygroups`` parameter is in use (see +groups. If the :param:`usevisibilitygroups` parameter is in use (see :ref:`parameters`) two additional sets of permissions are displayed. Each set consists of two select boxes. On the left, a select box with a list of all existing groups. On the right, a select box listing @@ -142,13 +142,13 @@ Each of the six permissions is described below. *Groups That Can See This Group* Members of any selected group can see the users in this group. - This setting is only visible if the ``usevisibilitygroups`` parameter + This setting is only visible if the :param:`usevisibilitygroups` parameter is enabled on the Bugzilla Configuration page. See :ref:`parameters` for information on configuring Bugzilla. *Groups That This Group Can See* Members of this group can see members in any of the selected groups. - This setting is only visible if the ``usevisibilitygroups`` parameter + This setting is only visible if the :param:`usevisibilitygroups` parameter is enabled on the the Bugzilla Configuration page. See :ref:`parameters` for information on configuring Bugzilla. diff --git a/docs/en/rst/administering/parameters.rst b/docs/en/rst/administering/parameters.rst index 6b04711b41..2af178b6ae 100644 --- a/docs/en/rst/administering/parameters.rst +++ b/docs/en/rst/administering/parameters.rst @@ -60,17 +60,17 @@ maintainer The address need not be that of a valid Bugzilla account. docs_urlbase - The URL that is the common initial leading part of all Bugzilla documentation URLs. It may be an absolute URL, or a URL relative to the urlbase parameter. Leave this empty to suppress links to the documentation. ``%lang%`` will be replaced by user's preferred language (if documentation is available in that language). + The URL that is the common initial leading part of all Bugzilla documentation URLs. It may be an absolute URL, or a URL relative to the :param:`urlbase` parameter. Leave this empty to suppress links to the documentation. ``%lang%`` will be replaced by user's preferred language (if documentation is available in that language). utf8 Use UTF-8 (Unicode) encoding for all text in Bugzilla. Installations where - this parameter is set to "off" should set it to "on" only + this parameter is set to :paramval:`off` should set it to :paramval:`on` only after the data has been converted from existing legacy character encodings to UTF-8, using the :file:`contrib/recode.pl` script. - .. note:: If you turn this parameter from "off" to "on", you must - re-run :file:`checksetup.pl` immediately afterward. + .. note:: If you turn this parameter from :paramval:`off` to :paramval:`on`, + you must re-run :file:`checksetup.pl` immediately afterward. shutdownhtml If there is any text in this field, this Bugzilla installation will @@ -587,7 +587,7 @@ RADIUS_email_suffix Bugzilla offers only a simple way to do this: it can concatenate a suffix to the RADIUS user name to convert it into an email address. - You can specify this suffix in the RADIUS_email_suffix parameter. + You can specify this suffix in the :param:`RADIUS_email_suffix` parameter. If this simple solution does not work for you, you'll probably need to modify :file:`Bugzilla/Auth/Verify/RADIUS.pm` to match your @@ -752,7 +752,7 @@ User Matching The settings on this page control how users are selected and queried when adding a user to a bug. For example, users need to be selected when assigning the bug, adding to the CC list, or -selecting a QA contact. With the "usemenuforusers" parameter, it is +selecting a QA contact. With the :param:`usemenuforusers` parameter, it is possible to configure Bugzilla to display a list of users in the fields instead of an empty text field. If users are selected via a text box, this page also diff --git a/docs/en/rst/administering/quips.rst b/docs/en/rst/administering/quips.rst index 281e27fe1a..789304a33a 100644 --- a/docs/en/rst/administering/quips.rst +++ b/docs/en/rst/administering/quips.rst @@ -8,7 +8,7 @@ can be configured to appear at the top of search results. Each Bugzilla installation has its own specific quips. Whenever a quip needs to be displayed, a random selection is made from the pool of already existing quips. -Quip submission is controlled by the *quip_list_entry_control* +Quip submission is controlled by :param:`quip_list_entry_control` parameter. It has several possible values: open, moderated, or closed. In order to enable quips approval you need to set this parameter to "moderated". In this way, users are free to submit quips for addition, diff --git a/docs/en/rst/administering/users.rst b/docs/en/rst/administering/users.rst index 639b7aec28..b8657e5d9d 100644 --- a/docs/en/rst/administering/users.rst +++ b/docs/en/rst/administering/users.rst @@ -57,7 +57,7 @@ fields: - *Login Name*: This is generally the user's full email address. However, if you - have are using the ``emailsuffix`` parameter, this may + have are using the :param:`emailsuffix` parameter, this may just be the user's login name. Unless you turn off the :param:`allowemailchange` parameter, users can change their login names themselves (to any valid email address). @@ -145,13 +145,13 @@ fields: - **: This allows an administrator to specify the products in which a user can see bugs. If you turn on the - ``makeproductgroups`` parameter in + :param:`makeproductgroups` parameter in the Group Security Panel in the Parameters page, then Bugzilla creates one group per product (at the time you create the product), and this group has exactly the same name as the product itself. Note that for products that already exist when the parameter is turned on, the corresponding group will not be - created. The user must still have the ``editbugs`` + created. The user must still have the :group:`editbugs` privilege to edit bugs in these products. .. _createnewusers: @@ -168,7 +168,7 @@ By default, users can create their own user accounts by clicking the ``New Account`` link at the bottom of each page (assuming they aren't logged in as someone else already). If you want to disable this self-registration, or if you want to restrict who can create their -own user account, you have to edit the ``createemailregexp`` +own user account, you have to edit the :param:`createemailregexp` parameter in the ``Configuration`` page; see :ref:`parameters`. @@ -201,7 +201,7 @@ can create user accounts for other users: Deleting Users ============== -If the ``allowuserdeletion`` parameter is turned on (see +If the :param:`allowuserdeletion` parameter is turned on (see :ref:`parameters`) then you can also delete user accounts. Note that, most of the time, this is not the best thing to do. If only a warning in a yellow box is displayed, then the deletion is safe.