Changes between Version 1 and Version 2 of TracDev/Proposals/AdvancedNotification/IPreferencePanelProvider

Timestamp:

Oct 8, 2013, 8:09:16 AM (11 years ago)

Author:

Peter Suter

Comment:

Describe proposed extension of child panels

TracDev/Proposals/AdvancedNotification/IPreferencePanelProvider

@@ -2 +2 @@
 
 ||'''Interface'''||''IPreferencePanelProvider''||'''Since'''||[wiki:TracDev/ApiChanges/0.11#IPreferencePanelProvider 0.11]||
-||'''Module'''||''trac.prefs''||'''Source'''||[source:trunk/trac/prefs/api.py api.py]||
+||'''Module'''||''trac.prefs''||'''Source'''||[source:psuter/trac/prefs/api.py@advanced-notification-preferences#/IPreferencePanelProvider api.py]||
 
 The ''IPreferencePanelProvider'' allows adding panels to Trac's preferences dialog. 
@@ -11 +11 @@
 
 When a user browses to the preferences dialog, all implementations are called to provide any implemented panels, which are shown as tabs. When the user activates a tab the respective implementation is called to render the page corresponding to that tab.
+
+Since Trac 1.1.2 different implementations can provide ''child panels''. These show up as sections in a tab of their parent panel, which can be implemented by a different plugin. A modular ecosystem of thematically related plugins can use this to populate a shared preferences page.
 
 == Usage ==
@@ -95 +97 @@
  * #9162: Ticket with a patch to split the core {{{IPreferencePanelProviders}}} from the {{{PreferencesModule}}}
  * #9313: Ticket about documenting preference session saving
+
+==== API History ====
+ * [wiki:TracDev/ApiChanges/0.11#IPreferencePanelProvider 0.11] introduced the interface.
+ * [wiki:TracDev/ApiChanges/1.1.2#IPreferencePanelProvider 1.1.2] added possibility to return tuples with a third item `parent_panel` for [wiki:TracDev/Proposals/AdvancedNotification#Modularpreferencepages modular preference pages].