Changes between Version 47 and Version 48 of InterTrac

Timestamp:

Jan 31, 2016, 10:48:49 AM (8 years ago)

Author:

figaro

Comment:

Cosmetic changes

InterTrac

@@ -9 +9 @@
 == Link Syntax
 
-Simply use the name of the other Trac environment as a prefix, followed by a colon, ending with the resource located in the other environment.
+Simply use the name of the other Trac environment as a prefix, followed by a colon, ending with the resource located in the other environment:
 
 {{{
@@ -18 +18 @@
 
 That target environment name is either the real name of the environment or an alias for it. 
-The aliases are defined in `trac.ini` (see below).
+The aliases are defined in the `trac.ini` file, see below.
 The prefix is case insensitive.
 
-If the InterTrac link is enclosed in square brackets (like `[th:WikiExtrasPlugin]`), the InterTrac prefix is removed in the displayed link like a normal link resolver would be, ie the above would be displayed as `WikiExtrasPlugin`.
+If the InterTrac link is enclosed in square brackets, like `[th:WikiExtrasPlugin]`, the InterTrac prefix is removed in the displayed link like a normal link resolver would be, ie the above would be displayed as `WikiExtrasPlugin`.
 
-For convenience, there's also some alternative short-hand form, where one can use an alias as an immediate prefix for the identifier of a ticket, changeset or report, eg `#T234`, `[T1508]`, `[trac 1508]`.
+For convenience, there is also an alternative short-hand form, where an alias can be used as an immediate prefix for the identifier of a ticket, changeset or report, eg `#T234`, `[T1508]`, `[trac 1508]`.
 
 == Examples
 
-It is necessary to setup a configuration for the InterTrac facility.
-This configuration has to be done in the TracIni file, `[intertrac]` section.
+It is necessary to set up a configuration for the InterTrac facility.
+This configuration has to be done in the TracIni file, `[intertrac]` section, for example:
 
-Example configuration:
 {{{#!ini
 [intertrac]
@@ -44 +43 @@
 This can be a relative URL in case that Trac environment is located on the same server.
 
-The `.title` information will be used for providing an useful tooltip when moving the cursor over an InterTrac links.
+The `.title` information is used in a tooltip, ie when hovering the cursor over an InterTrac link.
 
-Finally, the `.compat` option can be used to activate or disable
-a ''compatibility'' mode:
- * If the targeted Trac is running a version below [trac:milestone:0.10 0.10] 
-   ([trac:r3526 r3526] to be precise), then it doesn't know how to dispatch an InterTrac 
-   link, and it's up to the local Trac to prepare the correct link. 
-   Not all links will work that way, but the most common do. 
-   This is called the compatibility mode, and is `false` by default. 
- * If you know that the remote Trac knows how to dispatch InterTrac links, 
-   you can explicitly disable this compatibility mode and then ''any'' 
-   TracLinks can become an InterTrac link.
+Finally, the `.compat` option can be used to enable or disable a ''compatibility'' mode:
+ * If the targeted Trac is running a version below [trac:milestone:0.10 0.10] ([trac:r3526 r3526] to be precise), then it doesn't know how to dispatch an InterTrac link, and it is up to the local Trac to prepare the correct link. Not all links will work that way, but the most common ones do. This is called the compatibility mode, and is `false` by default. 
+ * If you know that the remote Trac knows how to dispatch InterTrac links, you can explicitly disable this compatibility mode and then ''any'' TracLinks can become an InterTrac link.
 
 Now, given the above configuration, one could create the following links:
@@ -69 +61 @@
    * `trac:changeset:1912` trac:changeset:1912
    * `[T1912]` [T1912]
- * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''
+ * to the log range [3300:3330]: '''Note''': the following ones need `trac.compat=false`:
    * `trac:log:@3300:3330` trac:log:@3300:3330  
    * `[trac 3300:3330]` [trac 3300:3330] 
- * finally, to link to the start page of a remote trac, simply use its prefix followed by ':', inside an explicit link. Example: `[th: Trac Hacks]` (''since 0.11; note that the ''remote'' Trac has to run 0.11 for this to work'')
+ * finally, to link to the start page of a remote Trac, simply use its prefix followed by a colon `:` and inside an explicit link. Example: `[th: Trac Hacks]`. Since Trac 0.11, note that the ''remote'' Trac has to run at least version 0.11 for this to work.
 
 The generic form `intertrac_prefix:module:id` is translated to the corresponding URL `<remote>/module/id`, shorthand links are specific to some modules (e.g. !#T234 is processed by the ticket module) and for the rest (`intertrac_prefix:something`), we rely on the TracSearch#quickjump facility of the remote Trac.