Skip to content

Commit 7fbe012

Browse files
committed
Added to the FAQ: how to filter roundup emails and a reference to the wiki for linking to revisions in a version control system.
1 parent ac3df5d commit 7fbe012

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

doc/FAQ.txt

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,17 @@ to::
161161

162162
for more information, go and read about Zope Page Templates.
163163

164+
I want to link version identifiers from my messages to svn/mercurial/git
165+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166+
167+
See: the LinkFormatingExample at:
168+
169+
http://www.roundup-tracker.org/cgi-bin/moin.cgi/LinkFormattingExample?highlight=%28local%5C_replace%29
170+
171+
There are examples in the devel and responsive templates. Search for
172+
LocalReplace to find the extension file and the change that has to be
173+
made to the item template.
174+
164175

165176
Using Roundup
166177
-------------
@@ -204,5 +215,36 @@ Note that if an "order" property is defined on a Class that is used for
204215
sorting, all items of that Class *must* have a value against the "order"
205216
property, or sorting will result in random ordering.
206217

218+
219+
How do I filter roundup emails?
220+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221+
222+
When roundup emails users, it provides an email header::
223+
224+
X-Roundup-(class)-(property): values
225+
226+
for every property that is a link or multilink (usually things
227+
set by a dropdown or selection in the web interface).
228+
229+
For example, assume you have a category field for issues in your tracker.
230+
You respond to issues that fall into the catagories: Network and Security.
231+
232+
You will see headers like:
233+
234+
X-Roundup-issue-category: Network
235+
236+
or
237+
238+
X-Roundup-issue-category: Network, Security, Linux
239+
240+
Then you can set up a filter looking for X-Roundup-issue-category
241+
followed by Network or Security in your mail program. Directions on
242+
using your mail program ae beyond the scope of theis FAQ entry.
243+
244+
(If you don't see a header for a multilink or link property, look for
245+
msg_header_property in the roundup docs. In some cases you have to
246+
explicitly enable the header.)
247+
248+
207249
.. _`customisation`: customizing.html
208250

0 commit comments

Comments
 (0)