Replace [trac] mainnav and [trac] metanav with order attributes of the corresponding sections

[Ryan J Ollos]

Since we have [mainnav] and [metanav] sections in trac.ini, it seems odd to have the order of the entries still determined through the [trac] mainnav and metanav options. Instead we could add an .order attribute to each option in the [mainnav] and [metanav] section.

This might also give us a way to address the issue of the names of the items being undocumented, particularly for plugins (​gmessage:trac-users:rGMQ0XPRsww/8Rm85C0F8wQJ). Perhaps all the navigation items provided by plugins could be written to the section with a .order attribute. This might somehow be related to #11437.

[Ryan J Ollos]

I'm debating some points. It makes sense to have all the navigation item configuration options in the [mainnav] and [metanav] sections. However, it is potentially more difficult to reorder those items using the .order attribute. For example, suppose I want to add new as the first item.

wiki.order = 1
tickets.order = 2
timeline.order = 3
admin.order = 4

→

wiki.order = 2
tickets.order = 3
timeline.order = 4
admin.order = 5
new.order = 1

We potentially have to edit all N navigation items. Maybe that isn't too inconvenient though since it's unrealistic to have more than 10 or so items on the mainnav. After #11469 is implemented we could add an admin panel for conveniently reordering the items, similar to the ticket enums (Severities, Versions, …).

[Jun Omae]

Replying to rjollos:

I'm debating some points. It makes sense to have all the navigation item configuration options in the [mainnav] and [metanav] sections. However, it is potentially more difficult to reorder those items using the .order attribute. For example, suppose I want to add new as the first item.

We use ​th:MenusPlugin. I use multiples of 100 for .order property to add a new entry without changes during a situation like this.

wiki.order = 100
tickets.order = 200
timeline.order = 300
admin.order = 400
new.order = 50

It might be good to allow float values for .order property.

wiki.order = 1
tickets.order = 2
timeline.order = 3
admin.order = 4
new.order = 0.5

[Ryan J Ollos]

I'll also add a ConfigSection​ for mainnav and metanav.

[Ryan J Ollos]

Proposed changes in log:rjollos.git:t11956.

Documentation updated in 1.1/TracNavigation@2.

[Jun Omae]

I tried the proposed branch. New environment doesn't have [mainnav] and [metanav] sections. As the result, the navigations have broken orders. We should generate the sections with default orders on initenv.

Also, I think we should sort by .order and the name because list.sort method is unstable sort.

-            nav[category].sort(key=lambda e: order[e['name']])
+            nav[category].sort(key=lambda e: (order[e['name']], e['name']))

[Ryan J Ollos]

Thanks for the feedback. Revised changes in log:rjollos.git:t11956-nav-order. The behavior has changed slightly. Previously Admin was not specified in the ordering, but it is now specified as the last (right-most) entry.

Documentation updated in 1.1/TracNavigation@3.

[Jun Omae]

I tried the rjollos.git@t11956-nav-order. The changes look good to me.

[Ryan J Ollos]

I made a minor modification to write floating point values to the config file on initialization (e.g. 1.0 rather than 1). Changes committed to trunk in [14045].

[Jun Omae]

Comment of do_upgrade() in db41.py says [ticket-custom] section like this.

    """Move [trac] mainnav and [trac] metanav to .order attributes
    of the [ticket-custom] section.

That should be [mainnav] and [metanav] sectinos….

[Ryan J Ollos]

Comment corrected in [14046].