Changes between Version 4 and Version 5 of TracDev/PluginDevelopment/ExtensionPoints/trac.wiki.api.IWikiMacroProvider

Timestamp:

Jul 14, 2012, 9:06:22 PM (12 years ago)

Author:

Peter Suter

Comment:

Copied some improvements from wiki:trac.wiki.api.IWikiSyntaxProvider@2

TracDev/PluginDevelopment/ExtensionPoints/trac.wiki.api.IWikiMacroProvider

@@ -26 +26 @@
 A further parameter `formatter` provides access to various useful objects:
  * `formatter.resource` (a [source:trunk/trac/resource.py trac.resource.Resource])[[BR]]
-   The resource identifier which owns the text being formatted. (E.g. a wiki page, where `formatter.resource.id` is the page name.)
+   The resource identifier which owns the text being formatted. (E.g. a wiki page, where `formatter.resource.id` is the page name.) In practice, it's used to identify the target URL for relative links present in that Wiki text (e.g. `[#section see Section]`) independently from where the rendered text gets displayed (in the timeline, in a report, etc.)
  * `formatter.perm` (a [source:trunk/trac/perm.py trac.perm.PermissionCache])[[BR]]
    The permission cache which can be used to perform fine-grained permission checks.
@@ -32 +32 @@
    The URL builder.
  * `formatter.wiki` (a [source:trunk/trac/wiki/api.py trac.wiki.api.WikiSystem])[[BR]]
-   The wiki system can be used to access wiki pages.
+   The wiki system can be used to access wiki pages, settings and helper functions (e.g. `format_page_name()`).
  * `formatter.wikiparser` (a [source:trunk/trac/wiki/parser.py trac.wiki.parser.WikiParser])[[BR]]
-   The wiki parser.
+   The wiki parser (for now, only the constants used to form the standard regexps are there; the full "parser" is still in formatter.py for historical reasons)
  * `formatter.context` (a [source:trunk/trac/mimeview/api.py trac.mimeview.api.RenderingContext])[[BR]]
-   The rendering context in which this wiki formatting takes place.
+   The rendering context in which this wiki formatting takes place. Use this rather than the `.req` to retrieve information about the author, the permissions and the like.
  * `formatter.req` (a [source:trunk/trac/web/api.py trac.web.api.Request])[[BR]]
    The web request. (to be deprecated)
@@ -136 +136 @@
  * Related to the [[trac.wiki.api.IWikiSyntaxProvider]]
  * Related tickets:
-  * [query:status=!closed&component=wiki+system wiki system component]
+  * [query:"status=!closed&component=wiki system" wiki system component]
   * [query:?status=!closed&keywords=~macro macro keywords]
   * #10038 Translated macro descriptions