Edgewall Software

Changes between Version 6 and Version 7 of PageTemplates/TracDev/PluginDevelopment/ExtensionPoints


Ignore:
Timestamp:
May 7, 2010, 10:12:02 AM (14 years ago)
Author:
hasienda <hoff.st@…>
Comment:

minor changes, supporting the idea in general

Legend:

Unmodified
Added
Removed
Modified
  • PageTemplates/TracDev/PluginDevelopment/ExtensionPoints

    v6 v7  
    1 
    21== Extension Point : <Name>, E.g. ''IAuthenticator'' ==
    32
    4 ||'''Interface'''||The interface name. E.g. ''IAuthenticator''||
    5 ||'''Module'''||The module from where the interface can be imported from. E.g. trac.web.api||
    6 ||'''Source'''||Provide a source link here. You might also include a line reference if you want. E.g. [source:trac/trunk/web/api.py]||
    7 ||'''Since'''||Since when is the extension point interface available? E.g. [milestone:0.12 0.12]||
     3||'''Interface'''||The interface name. E.g. ''IAuthenticator''||'''Since'''||Since when is the extension point interface available? E.g. [milestone:0.12 0.12]||
     4||'''Module'''||The module from where the interface can be imported from. E.g. trac.web.api||'''Source'''||Provide a source link here. You might also include a line reference if you want. E.g. [source:trac/trunk/web/api.py]||
     5{{{
     6#!comment
     7table header is a good idea, just try to make it as compact as possible, especially module and source of it will fit nicely
     8}}}
    89
    910Provide a short introductory explanation on the interface and the module providing it. E.g. the ''IAuthenticator'' extension point is defined by trac.web.api. It is used by trac's main request dispatcher to authenticate users based on the current request and session thereof.
     
    1112== Purpose ==
    1213
    13 Provide detailed information on the purpose of the interface here. E.g. ''IAuthenticator'' is used by the main request dispatcher to associate the current request's session with a user, or, in case that no such user exists, with the anonymous user. The most basic implementation would search for a cookie in the request. Other, more elaborate implementations for example would provide single sign on by for example evaluating an existing request header, and so on.
     14Provide detailed information on the purpose of the interface here. E.g. ''IAuthenticator'' is used by the main request dispatcher to associate the current request's session with a user, or, in case that no such user exists, with the anonymous user. The most basic implementation would search for a cookie in the request. Other, more elaborated implementations for example would provide single sign on for example by evaluating an existing request header, and so on.
    1415
    1516== Usage ==
     
    2223Provide one or more example implementations of the interface.
    2324
    24 == Available Implementations ==
     25== Available implementations ==
    2526
    2627Provide references to available implementations of the interface, for example by linking to sources in trac trunk or on trac-hacks. You might also include short discussions on how they have been implemented.