[PATCH] Allow wiki syntax in labels for custom fields

[pkou <pkou at ua.fm>]

The proposal is to add a possibility to use Wiki syntax in labels for custom fields.

Example 1: We need to put emphasis on Platform field

[ticket-custom]
platform         = select
platform.order   = 1
platform.label   = '''Platform'''
platform.options = |Intel P4|Intel XEON|AMD Athlon 64|Other

Example 2: We need to define a link to help screen for Platform field

[ticket-custom]
platform         = select
platform.order   = 1
platform.label   = [wiki:HelpPlatform Platform]
platform.options = |Intel P4|Intel XEON|AMD Athlon 64|Other

Attached patch contains an implementation for the proposal.

[pkou <pkou at ua.fm>]

Patch for the changes

[pkou at ua.fm]

Thank to refactoring in Trac 0.9, updated patch is the following:

trac/ticket/api.py

@@ -21 +21 @@
 
 from trac import perm, util
 from trac.core import *
+from trac.wiki import wiki_to_oneliner
 
 
 class TicketSystem(Component):
@@ -107 +108 @@
                 'name': name,
                 'type': self.config.get('ticket-custom', name),
                 'order': int(self.config.get('ticket-custom', name + '.order', '0')),
-                'label': self.config.get('ticket-custom', name + '.label', ''),
+                'label': wiki_to_oneliner(self.config.get('ticket-custom', name + '.label', ''), self.env, self.env.get_db_cnx()),
                 'value': self.config.get('ticket-custom', name + '.value', '')
             }
             if field['type'] == 'select' or field['type'] == 'radio':

It is easy :)

[Markus Tacker <m@…>]

This is the patch against [2678]. Why hasn't this been implemented yet?

trac/ticket/api.py

@@ -18 +18 @@
 from trac.core import *
 from trac.perm import IPermissionRequestor
 from trac.wiki import IWikiSyntaxProvider
+from trac.wiki import wiki_to_oneliner
 from trac.Search import ISearchSource, query_to_sql, shorten_result
 
 
@@ -108 +109 @@
                 'name': name,
                 'type': self.config.get('ticket-custom', name),
                 'order': int(self.config.get('ticket-custom', name + '.order', '0')),
-                'label': self.config.get('ticket-custom', name + '.label', ''),
+                'label': wiki_to_oneliner(self.config.get('ticket-custom', name + '.label', ''), self.env, self.env.get_db_cnx()),
                 'value': self.config.get('ticket-custom', name + '.value', '')
             }
             if field['type'] == 'select' or field['type'] == 'radio':

[Christian Boos]

Any objection?

[Markus Tacker <m@…>]

Updated patch for r2894

[Christian Boos]

For info, that's currently done in the WorkFlow branch.

[Alec Thomas]

I'll close this when WorkFlow is merged in 0.11.

[Markus Tacker <m@…>]

Updated patch for r3931

[sid]

#899 proposes a different approach to the same problem.

[Markus Tacker <m@…>]

Can anyone provide a patch for r4458? I failed.

[Tim Hatch <trac@…>]

Updated patch for r4458

[Christian Boos]

See also #6248.

[Remy Blank]

I wanted to tackle this yesterday evening, but it is a lot trickier than it looks. Field labels are not only used on the ticket page, but also in the custom query page, in the query form headers and controls, and in the result table header. Some of these locations can manage HTML, and others require text only.

So this functionality actually requires the hypothetical wiki_to_text function I have seen mentioned in #1502 and on trac-dev.