Changes between Version 4 and Version 5 of WikiContext

Timestamp:

May 15, 2007, 9:28:20 PM (17 years ago)

Author:

Christian Boos

Comment:

Update to the current status as some features that were previously only on the security branch are now in trunk

WikiContext

@@ -1 @@
-[[PageOutline(3-6,inline)]]
+[[PageOutline(3-6)]]
 = Wiki Rendering Context =
+
+ '''`trac.context.Context`''' ''(current [milestone:0.11])''
  
- '''`trac.wiki.api.Context`''' ''(current [milestone:0.11]dev, r4451)''
-
  '''`trac.resource.Context`''' ''(see [#FutureDirections])''
 
@@ -11 +11 @@
  - Identify the resource to which the wiki text belongs (`.env`, `.realm`, `.id`)
  - Access to parent context, if there's one (`.parent`) [[br]]
-   By extension, this enables one to unwind the stack of context embedding
+   By following that link, this enables one to unwind the stack of context embedding
  - Knows about how the rendered Wiki text is being accessed (`.req`, `.abs_urls`) 
    so that the proper links can be generated:
    - `.href`: the appropriate Href instance for generating any kind of links
-   - `.self_href`: a link targeting the current Wiki context itself [[br]]
-     ''renamed to `.resource_href` in the security branch''
- - ''Allow easy access to the corresponding resource itself (`.resource`) - security branch only''
+   - `.resource_href`: a link targeting the current Wiki context itself
+ - Provide access to the corresponding resource itself (`.resource`)
 
-Besides, it keeps a handle to a database connection (`.db`) the way the `Formatter` objects used to do.
+''Besides, it keeps a handle to a database connection (`.db`) the way the `Formatter` objects used to do.'' -- will probably change in milestone:0.12''
 
-Such a context can be used for generating wiki texts in different flavors, using the `.wiki_to_...` methods. ''Note: this is susceptible to change''
+The `wiki_to_xyz(ctx, wiki)` template functions currently expect a Context for the first argument, and the wiki text as the second argument. ''Note: this is susceptible to change''
 
 It's very easy to manipulate contexts, or create sub-contexts. Here are some examples:
@@ -54 +53 @@
 == API Changes ==
 
-Besides the new trac.wiki.api.Context class, a few existing interfaces have been modified:
+Besides the new trac.context.Context class, a few existing interfaces have been modified:
  - `IWikiMacroProvider.render_macro` still takes a `req` as its first argument (#4139),
    but it's now deprecated and `IWikiMacroProvider.expand_macro` should be preferred, 
@@ -61 +60 @@
    (`formatter.context`).
  - `IHTMLPreviewRenderer.render` takes a `context` instead of a `req` as its first argument
- - `TimelineEvent.set_context` takes a `context` first argument and a `wikitext` second argument. That wiki text can now be retrieved in the `.wikitext` property instead of the `.message` one.
+ - `TimelineEvent.set_context` takes a `context` first argument and a `wikitext` second argument. That wiki text can now be retrieved in the `.wikitext` property instead of the `.message` one. ''Note: this is still subject to change''
 
 
@@ -68 +67 @@
 === Fine-grained Permission Checking ===
 
-The source:sandbox/security branch already contains a much empowered version of the Context class.
-
 As a context can describe precisely ''which'' resource is accessed and at the same time ''how'' it is accessed (and more specifically ''who'' accesses it), it is also a perfect fit for the fine-grained PermissionPolicy (see also the [PermissionPolicy@16 design document]).
 
-In order to be used as a lightweight descriptor of a resource, Context can also be subclassed. The user of a context doesn't need to have to think about this, as the correct subclass is always used, based on the `.realm` information.
+In order to be used as a lightweight descriptor of a resource, Context can also be sub-classed. The user of a context doesn't need to have to think about this, as the correct subclass is always used, based on the `.realm` information.
 
 === Multiple Project Support ===