Opened 14 years ago
Last modified 6 months ago
#9648 new enhancement
Improve ticket fields with tooltips — at Version 3
Reported by: | Owned by: | Remy Blank | |
---|---|---|---|
Priority: | high | Milestone: | next-major-releases |
Component: | ticket system | Version: | 0.12 |
Severity: | normal | Keywords: | patch fieldrefactoring |
Cc: | osimons, Thijs Triemstra, Ryan J Ollos | Branch: | |
Release Notes: | |||
API Changes: | |||
Internal Changes: |
Description (last modified by )
I've created a patch that allows a Trac admin to specify tooltips for arbitrary ticket fields in Trac:
This way the admin can explain a certain field in more detail (for example the difference between priority and severity) or provide information about the syntax used in that field.
The tooltips appear in the following places:
- the ticket box on the top of an existing ticket page (only on labels, not on values)
- in the ticket history for changes values
- the ticket input fields (on labels and input fields)
All labels get a help cursor if a tooltip is available.
Tooltips are specified in the trac.ini
under the new section [ticket-hints]
. Just assign the tooltip value to the name of the field. The user may also provide the same tooltip in multiple languages by appending the language code to the field name. Works for built-in fields as well as for custom fields (this patch is a generalization of #899). Example:
[ticket-hints] reporter = The reporter of this ticket owner = The owner of this ticket blockedby = Tickets preventing this one from closing. Accepts comma delimited ticket number (without #) complexity = The estimated complexity involved in fixing this ticked. complexity_de = Die geschätzte Komplexität zur Lösung des Tickets
I've decided to use the trac.ini
for localization as it would be too much overhead to create translation files for just some tooltips.
Change History (5)
by , 14 years ago
Attachment: | 200_field-hints.patch added |
---|
follow-up: 2 comment:1 by , 14 years ago
Milestone: | → 0.13 |
---|---|
Owner: | set to |
Priority: | normal → high |
Looks nice! I wonder if it wouldn't be better to handle the hints in the same way as the ticket field labels, i.e. inside TicketSystem.get_ticket_fields()
, instead of adding a new method get_field_hints()
.
comment:2 by , 14 years ago
Replying to rblank:
Looks nice! I wonder if it wouldn't be better to handle the hints in the same way as the ticket field labels, i.e. inside
TicketSystem.get_ticket_fields()
, instead of adding a new methodget_field_hints()
.
Yes, and re-use [ticket-custom]
for having a .hint
counterpart to .label
.
The localizations could be done via .hint.de
and we'd get support for .label.de
at little cost, then. I also see no problem in taking extra informations for standard fields from the [ticket-custom]
section, which would then stand for "ticket customizations" rather than "ticket custom fields". We would have in one place the labels, hints and their translations, for standard and custom fields.
comment:3 by , 14 years ago
Description: | modified (diff) |
---|
patch against Trac 0.12.0