299313 - Add a Customization section on adding User Settings

Status: RESOLVED FIXED

(Bugzilla :: Documentation, enhancement)

Description

[Max Kanat-Alexander]

We should add a bit to the customization section about how to make one's own
User Setting (Preference). The Release Notes for 2.20 have some good info on
this that could be used as a base.

Comment 1

[Sam Folk-Williams]

For reference (Max correct me if I'm wrong), this is the bit from the release notes:

User Preferences
----------------

Bugzilla now has a "User Preferences" system! These preferences are stored
in the database, and specified by a Bugzilla developer. The Bugzilla
developers actually call these "settings," but we called them "User 
Preferences" in the UI to make things clearer.

You access a user's settings differently depending on if you are in a
.cgi file or in a template file:

CGI: Bugzilla->user->settings->{'setting_name'}->value
Template: Bugzilla.user.settings.setting_name.value

Where "setting_name" is the name of the setting. You can see the current
setting names in the "setting" table in the database.

Remember that sometimes you may want to check a user's settings when 
making a customization.

To see how to add new settings, search for "add_setting" in checksetup.pl.
Also see the template: template/en/default/global/setting-descs.none.tmpl.

Comment 2

[Max Kanat-Alexander]

Yes, that is the correct bit from the release notes! :-)

Comment 3

[Gervase Markham [:gerv]]

This is documented here:
http://bugzilla.readthedocs.org/en/latest/integrating/extensions.html#adding-user-preferences

Gerv