make Keywords field optional

[wkornew]

It is very annoying that the Keywords field takes up screen space even if it's not needed. I know that it has been requested by many people, but I'm sure that there are even more people who don't use it, at all. Please make it optional.

Why is it not possible to make the Keywords field one of those [TracTicketsCustomFields]?

[wkornew]

please patch ticket/api.py

[wkornew]

BTW, the patch is for V0.9.5. ;)

[wkornew]

cleaned up. includes documentation for show_keywords. patch against trunk

[wkornewald <wkornewald>]

So, will nothing happen with this? Will it be fixed with the workflow branch?

[Noah Kantrowitz <coderanger@…>]

The SimpleTicket plugin already fixes this. You can hide whatever fields you want.

[Waldemar Kornewald <wkornewald>]

Actually, I wanted a less hacky solution (SimpleTicket requires having a new permission policy, etc.). Keywords could be implemented with custom fields or is there special code for them somewhere?

[Noah Kantrowitz <coderanger@…>]

Replying to Waldemar Kornewald <wkornewald>:

Actually, I wanted a less hacky solution (SimpleTicket requires having a new permission policy, etc.). Keywords could be implemented with custom fields or is there special code for them somewhere?

SimpleTicket does not require anything related to the security branch, it runs on plain ol' 0.10.x.

[Waldemar Kornewald <wkornewald>]

No, I meant that you must give people a new permission (SIMPLE_TICKET or something like that).

[ilias@…]

you can verify ​this issue from the tracx plugin (on top of 0.11dev), which goes a step further to provide different ticket-fields for different ticket-types.

Once implemented, this should cover your needs.

sidenot: stable versions get only 'bugfixes'. So, your patch (functionality) provided for 0.9.5 will most possibly not be applied (= 'wontfix').

To team: this issue should be generalized ('make ticket fields optional', for 0.11dev) or alternatively closed as 'wontfix', as it affects an old release.

[Waldemar Kornewald <wkornewald>]

Just to clarify. This has the problem that TRAC_ADMIN and TICKET_ADMIN still have access to the keywords field. I can provide a new patch (for 0.10 or 0.11), of course, but the real solution would probably be to remove the field completely. It's not needed everywhere, anyway. This should probably be implemented with a generic "tag" plugin which also allows for showing tag clouds. At least, this field isn't used by everyone and Trac should only provide the greatest common denominator. The rest should be done with modules or custom fields. IMHO, of course.

[Christian Boos]

Thinking about #2464 and its generalization to conditional custom fields, I wonder if that could not be extended to regular fields as well (and anyway, the difference is blurred in the GenericTrac proposal).

In this view, the precondition for the Keyword: field could simply be false, so that it'll never apply.

In a similar way, the ​th:SimpleTicketPlugin effects could be obtained by having tests for the permissions in the precondition.

[Christian Boos]

#5078 was another request for the same feature.

[asloan12@…]

adding my request for this change, we don't need the Keywords field and would like to be able to make it disappear. Thanks

[immanuel.scholz@…]

Two years passed and keyword is still there.

I found this through Google and can only support all the guys wanting it to be removed. For their very reasons (unused, drains up user attention.)

[anatoly techtonik <techtonik@…>]

Keywords is the only default way to structure information in your own way. They should be present. There could be an option to turn them off, though.

[Fabien COMBERNOUS]

I agree with the idea of being able to turn off the keyworks.

[cmc]

We remove this in our ticket template file. Seems like an acceptable solution to me.

[Carsten Klein <carsten.klein@…>]

Why not implement post_process_request on an request filter installed by a plugin of yours? That way, you could remove the field from the template prior to that it gets served to the client, without the need to have yet another configuration option.

[Christian Boos]

Milestone 1.0 deleted

[anonymous]

This keyword field annoys. Kindly remove this keyword from the main template or make it optional.If needed we can add it as a custom field.

[Cinc-th]

Here is a quick patch for this ticket. Just hiding the field from the ticket page should be enough to satisfy the most urgent needs and those who don't want to install a plugin.

This will not remove the field from the Query page, though, but that is a minor caveat imho considering the minimal impact on the codebase.

Unit tests and functional tests are passing in the default configuration.

trac/ticket/web_ui.py

@@ -100 +100 @@
             [TracQuery#UsingTracLinks Trac links].
             """)
 
+    hide_keywords_field = BoolOption('ticket', 'hide_keywords_field', 'false',
+        """Hide the keywords field from the ticket page.
+        Note that the field is still visible when doing a ticket query.
+        """)
+
     ticket_path_re = re.compile(r'/ticket/([0-9]+)$')
 
     def __init__(self):
@@ -1584 +1589 @@
                         del field_changes['cc']
                     else:
                         field_changes['cc']['new'] = ', '.join(new_cc_list)
+            elif name == 'keywords':
+                if self.hide_keywords_field:
+                    field['skip'] = True
 
             # per type settings
             if type_ in ('radio', 'select'):

[Cinc-th]

Patch to hide the ticket field keywords from the ticket page.

[Cinc-th]

I considered skipping the field in TicketSystem.fields or TicketSystem.get_ticket_fields() but wasn't sure about any side effects.

Doing it there would also remove the field from the query page and any other place it can be seen. Such a thing is done for the select fields (milestone, component, …), see trunk/trac/ticket/api.py@17500:364-389#L360​

I'll change the patch if it is found that removing the field completely has no ill effects.

[Ryan J Ollos]

If we add a hide_keywords_field option we'll likely need to remove it later. We should consider solving this issue in combination with other ticket field options in a section:

[ticket-custom]
priority.order = 1
milestone.order = 2
...
keywords.hide = 1

There are many related tickets on the ticket field option topic.

[Cinc-th]

While I may agree in general the section [ticket-custom] isn't the right one imho because the keywords field is no custom field. That would be rather confusing for the user…

The options for the other default fields (for example the select fields milestone, component, …) are all to be found in section [ticket].

[Ryan J Ollos]

Yeah, it was just an example. The section naming could be discussed in the implementation, but the main point is we need to consider this ticket in the context of all ticket customization features.

[anonymous]

So I'd suggest to go with:

[ticket]
keywords.hide = True

That's in line with how things are done for ticket custom fields.

While at it the same could be done for the cc field, too.

[Ryan J Ollos]

Closing since this needs to be addressed in the context of ticket field customization. A complete proposal will need to be written. We can address in #2464.