Changes between Version 1 and Version 2 of CustomTicketPrefixPlugin

Timestamp:

May 10, 2015, 11:17:01 AM (9 years ago)

Author:

Cinc-th

Comment:

Added configuration example

CustomTicketPrefixPlugin

@@ -5 +5 @@
 == Description
 
-Specify a ticket like {{{PREFIX:#1234}}} similar to intertrac links. The difference is it will be rendered like normal ticket links with the proper hint holding ticket information instead of intertrac information. Closed tickets will be rendered properly as strike through.
+Specify a ticket like {{{PREFIX:#1234}}} similar to intertrac links. The difference is it will be rendered like a normal TracLink {{{#1234}}} with the proper hint holding ticket information instead of intertrac information. Closed tickets will be rendered properly as strike through.
 
 This is useful if you have several Trac instances referencing the same repository. By defining different prefixes for each instance it is possible to reference the correct instance in the commit message. For example:
@@ -37 +37 @@
 This is a single file plugin. For installation just copy the python file to you plugin directory. 
 
+== Example
+To define a ticket prefix add the following to your ''trac.ini'':
+
+{{{#!ini
+[ticket-prefix]
+prefix = Pre1, Foo, BAR
+}}}
+
+As you can see, it's possible to define several prefixes.
+
+You may now reference any ticket by prepending the ticket with the defined prefix(es). With the given example the following links are all referencing the same ticket and all links are rendered the same way.
+
+* {{{#1234}}}
+* {{{Pre1:#1234}}}
+* {{{Foo:#1234}}}
+* {{{Bar:#1234}}}
+
+A closed ticket would be rendered like:
+* ~~{{{#123}}}~~
+* ~~{{{Pre1:#123}}}~~
+* ~~{{{Foo:#123}}}~~
+* ~~{{{Bar:#123}}}~~
+
+
+
 == Recent Changes