| | 1 | |
| | 2 | == Extension Point : <Name>, E.g. ''IAuthenticator'' == |
| | 3 | |
| | 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 | |
| | 8 | Provide a short introductory explanation of the interface and its overall purpose here. |
| | 9 | |
| | 10 | == Purpose == |
| | 11 | |
| | 12 | 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. |
| | 13 | |
| | 14 | == Usage == |
| | 15 | |
| | 16 | Provide detailed usage information of the extension point and implementations thereof. E.g. when is a method of the implementation being called and so on. |
| | 17 | |
| | 18 | |
| | 19 | == Examples == |
| | 20 | |
| | 21 | Provide one or more example implementations of the interface. |
| | 22 | |
| | 23 | == Available Implementations == |
| | 24 | |
| | 25 | Provide 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. |
