473943 - Accesskeys should be highlighted via a FILTER

Status: RESOLVED WONTFIX

(Bugzilla :: Bugzilla-General, enhancement)

Description

[miketosh]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.5) Gecko/2008120122 Firefox/3.0.5
Build Identifier: Bugzilla Tip

Bug 218746 requests that all field names use the adapted values.  However this makes assigning accesskeys a little difficult.

In order to fix this, I propose that highlighting of accesskeys for bug/edit.html.tmpl be put into Bugzilla/Template.pm as a FILTER.  I'm not sure how to do, so hopefully some discussion can come from this.

For Example, my site has customized Operating System to be Operating Stage.  (as in who owns the bug now: SE, SW, Test, Delivered)

If the field name in bug/edit.html.tmpl was identified by: 
    [% field_descs.op_sys FILTER accesskey("O") %]
My output would be: <b><u>O</u>perating Stage</b> without any customizations to bug/edit.html.tmpl directly.

It would make customizing much easier.  I don't see how to add additional parameters to a filter though.  That is the difficult part.  Maybe it needs to be a separate template, global/field_accesskey.html.tmpl

Reproducible: Always

Comment 1

[Vitaly Fedrushkov]

Filters with parameters are not so hard to implement, look at 'wrap' or 'l'

To keep things centralized we should store access keys near field_descs:

  [% field_descs.op_sys FILTER accesskey(hotkeys.op_sys) %]

Also the same letter SHOULD be used in <label>.  To avoid inconsistency, one can have a MACRO for:

  <label accesskey="[% hotkeys.op_sys FILTER lower %]" 
   for="op_sys">[% field_descs.op_sys FILTER accesskey(hotkeys.op_sys) %]</label>

Comment 2

[Max Kanat-Alexander]

Note that the output should be <span class="accesskey">O</span> probably, so that things can be styled with CSS. Or a <u> with a class.

Comment 3

[Max Kanat-Alexander]

Instead of this, I'd rather see a field_label() MACRO in field-descs.none.tmpl that just creates a properly-formatted field label for a particular field, and then put the accesskey information all into a hash somewhere in field-descs.none.tmpl so that we don't have to re-write it all over in the code.