Modular preference pages with child panels

[Peter Suter]

​th:AnnouncerPlugin has IAnnouncementPreferenceProvider to allow components to add "boxes" to shared pages from IPreferencePanelProvider. Multiple plugins can provide a coherent user interface to notification preferences without impairing modularity in code.

For the Advanced Notification proposal we could instead simply extend IPreferencePanelProvider itself slightly to allow child panels.

Proposed changes: changeset:advanced-notification-preferences.4/psuter.hg

[Peter Suter]

See #11870 for an example​ where Watch Ticket Components is an optional child of the Notifications panel.

[Peter Suter]

Committed in [13510].

[Jun Omae]

Sorry for late response.

}#content.prefs ... in prefs.css should be split by line separator.

-}#content.prefs tr.field { height: 30px; }
+}
+#content.prefs tr.field { height: 30px; }

panel parameter of IPreferencePanelProvider.get_preference_panels() is used without changes in id attribute of h2 element in prefs.html. I think we should prepend userprefs_ to the id like <h2 id="userprefs_$name">.

At trunk/trac/prefs/templates/prefs.html@13510:34#L31​, tab_ prefix is used for id attribute in tabs list.

[Jun Omae]

Or I think it should be like this.

trac/prefs/templates/prefs.html

@@ -38 +38 @@
       <div id="tabcontent" py:with="has_forms = list(select('.//form'))">
         <form id="userprefs" action="" method="post" py:strip="has_forms">
           ${select("*|text()")}
-          <div py:for="(name, title, child) in child_panels">
-            <div class="prefs_child">
-              <h2 id="${name}">${title}</h2>
-              ${child}
-            </div>
+          <div py:for="(name, title, child) in child_panels"
+               id="userprefs_$name" class="prefs_child">
+            <h2>${title}</h2>
+            ${child}
           </div>
           <div class="buttons" py:if="not has_forms">
             <input type="hidden" name="action" value="save" />

[Peter Suter]

Replying to jomae:

}#content.prefs ... in prefs.css should be split by line separator.

Oops, that must have slipped in during rebase. Fixed in [13511]. Thanks.

panel parameter of IPreferencePanelProvider.get_preference_panels() is used without changes in id attribute of h2 element in prefs.html. I think we should prepend userprefs_ to the id like <h2 id="userprefs_$name">.

Or I think it should be like this. […]

I used <h2 id="${name}"> so e.g in this example​ (#11870) we can link to the anchor /prefs/notification#watch_component and the title is highlighted. With your changes that would not work.

Instead of the userprefs_ prefix, would a -section suffix work? (Similar to TracIni#notification-section)

(There's also <h2 id="subscriptions">​ for linking and highlighting /prefs/notification#subscriptions. Do you think it is also problematic?)

Thanks for reviewing!

[Jun Omae]

Replying to psuter:

I used <h2 id="${name}"> so e.g in this example​ (#11870) we can link to the anchor /prefs/notification#watch_component and the title is highlighted. With your changes that would not work.

Okay. I understand use case.

Instead of the userprefs_ prefix, would a -section suffix work? (Similar to TracIni#notification-section)

(There's also <h2 id="subscriptions">​ for linking and highlighting /prefs/notification#subscriptions. Do you think it is also problematic?)

I think that -section suffix would be good as well. I consider that appending prefix or suffix would prevent conflicting with id attribute in other elements. Otherwise, core and plugin developers should be careful about the conflicting. I was not sure that panel parameter is used for id attribute.

[Peter Suter]

OK, committed -section suffix in [13522].