"Fossies" - the Fresh Open Source Software Archive

Member "roundup-2.0.0/share/doc/roundup/html/FAQ.html" (13 Jul 2020, 26646 Bytes) of package /linux/www/roundup-2.0.0.tar.gz:

The requested HTML page contains a <FORM> tag that is unusable on "Fossies" in "automatic" (rendered) mode so that page is shown as HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4 <html xmlns="http://www.w3.org/1999/xhtml">
    5   <head>
    6     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8     <title>Roundup FAQ &mdash; Roundup 2.0.0 documentation</title>
   10     <link rel="stylesheet" href="_static/basic.css" type="text/css" />
   11     <link rel="stylesheet" href="_static/style.css" type="text/css" />
   12     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   13     <script type="text/javascript">
   14       var DOCUMENTATION_OPTIONS = {
   15           URL_ROOT:    './',
   16           VERSION:     '2.0.0',
   17           COLLAPSE_MODINDEX: false,
   18           FILE_SUFFIX: '.html'
   19       };
   20     </script>
   21     <script type="text/javascript" src="_static/jquery.js"></script>
   22     <script type="text/javascript" src="_static/underscore.js"></script>
   23     <script type="text/javascript" src="_static/doctools.js"></script>
   24     <link rel="index" title="Index" href="genindex.html" />
   25     <link rel="search" title="Search" href="search.html" />
   26     <link rel="top" title="Roundup 2.0.0 documentation" href="index.html" />
   27     <link rel="next" title="User Guide" href="user_guide.html" />
   28     <link rel="prev" title="Upgrading to newer versions of Roundup" href="upgrading.html" /> 
   29   </head>
   30   <body>
   31     <div class="header"><h1>Roundup</h1>
   32         <div id="searchbox" style="display: none">
   33           <form class="search" action="search.html" method="get">
   34             <input type="text" name="q" size="18" />
   35             <input type="submit" value="Search" />
   36             <input type="hidden" name="check_keywords" value="yes" />
   37             <input type="hidden" name="area" value="default" />
   38           </form>
   39         </div>
   40         <script type="text/javascript">$('#searchbox').show(0);</script>
   41     </div>
   42     <div class="navigation">
   43       <div class="menu">
   45     <h3><a href="index.html">Table Of Contents</a></h3>
   46     <ul>
   47 <li><a class="reference internal" href="#">Roundup FAQ</a><ul>
   48 <li><a class="reference internal" href="#installation">Installation</a><ul>
   49 <li><a class="reference internal" href="#living-without-a-mailserver">Living without a mailserver</a></li>
   50 <li><a class="reference internal" href="#the-cgi-bin-is-very-slow">The cgi-bin is very slow!</a></li>
   51 <li><a class="reference internal" href="#how-do-i-put-roundup-behind-apache">How do I put Roundup behind Apache</a></li>
   52 <li><a class="reference internal" href="#how-do-i-run-roundup-through-ssl-https">How do I run Roundup through SSL (HTTPS)?</a></li>
   53 </ul>
   54 </li>
   55 <li><a class="reference internal" href="#templates">Templates</a><ul>
   56 <li><a class="reference internal" href="#what-is-that-stuff-in-the-tracker-html-directory">What is that stuff in the tracker html directory?</a></li>
   57 <li><a class="reference internal" href="#but-i-just-want-a-select-option-list-for">But I just want a select/option list for ….</a></li>
   58 <li><a class="reference internal" href="#great-but-now-the-select-option-list-is-too-big">Great! But now the select/option list is too big</a></li>
   59 <li><a class="reference internal" href="#i-want-to-link-version-identifiers-from-my-messages-to-svn-mercurial-git">I want to link version identifiers from my messages to svn/mercurial/git</a></li>
   60 <li><a class="reference internal" href="#i-can-see-values-in-a-multilink-but-not-display-the-items">I can see values in a multilink but not display the items</a></li>
   61 </ul>
   62 </li>
   63 <li><a class="reference internal" href="#using-roundup">Using Roundup</a><ul>
   64 <li><a class="reference internal" href="#i-got-an-error-and-i-cannot-reload-it">I got an error and I cannot reload it!</a></li>
   65 <li><a class="reference internal" href="#i-keep-getting-logged-out">I keep getting logged out</a></li>
   66 <li><a class="reference internal" href="#i-m-getting-infinite-redirects-in-the-browser">I’m getting infinite redirects in the browser</a></li>
   67 <li><a class="reference internal" href="#how-is-sorting-performed-and-why-does-it-seem-to-fail-sometimes">How is sorting performed, and why does it seem to fail sometimes?</a></li>
   68 <li><a class="reference internal" href="#how-do-i-filter-roundup-emails">How do I filter roundup emails?</a></li>
   69 </ul>
   70 </li>
   71 </ul>
   72 </li>
   73 </ul>
   75     <h4>Previous topic</h4>
   76     <p class="topless"><a href="upgrading.html"
   77                           title="previous chapter">Upgrading to newer versions of Roundup</a></p>
   78     <h4>Next topic</h4>
   79     <p class="topless"><a href="user_guide.html"
   80                           title="next chapter">User Guide</a></p>
   81     <h3>This Page</h3>
   82     <ul class="this-page-menu">
   83       <li><a href="_sources/FAQ.txt"
   84              rel="nofollow">Show Source</a></li>
   85     </ul>
   86   <div id="searchbox" style="display: none">
   87     <h3>Quick search</h3>
   88       <form class="search" action="search.html" method="get">
   89         <input type="text" name="q" size="18" />
   90         <input type="submit" value="Go" />
   91         <input type="hidden" name="check_keywords" value="yes" />
   92         <input type="hidden" name="area" value="default" />
   93       </form>
   94       <p style="font-size: 90%">Enter search terms or a module, class or function name.</p>
   95   </div>
   96   <script type="text/javascript">$('#searchbox').show(0);</script>
   97       </div>
   98     </div>
   99     <div class="content">
  101     <div class="related related-top">
  102       <ul>
  103         <li class="right" style="margin-right: 10px">
  104           <a href="genindex.html" title="General Index"
  105              accesskey="I">index</a></li>
  106         <li class="right" >
  107           <a href="user_guide.html" title="User Guide"
  108              accesskey="N">next</a></li>
  109         <li class="right" >
  110           <a href="upgrading.html" title="Upgrading to newer versions of Roundup"
  111              accesskey="P">previous</a></li>
  112         <li><a href="index.html">Roundup 2.0.0 documentation</a></li> 
  113       </ul>
  114     </div>
  116   <div class="section" id="roundup-faq">
  117 <h1>Roundup FAQ<a class="headerlink" href="#roundup-faq" title="Permalink to this headline"></a></h1>
  118 <div class="contents local topic" id="contents">
  119 <ul class="simple">
  120 <li><a class="reference internal" href="#installation" id="id1">Installation</a><ul>
  121 <li><a class="reference internal" href="#living-without-a-mailserver" id="id2">Living without a mailserver</a></li>
  122 <li><a class="reference internal" href="#the-cgi-bin-is-very-slow" id="id3">The cgi-bin is very slow!</a></li>
  123 <li><a class="reference internal" href="#how-do-i-put-roundup-behind-apache" id="id4">How do I put Roundup behind Apache</a></li>
  124 <li><a class="reference internal" href="#how-do-i-run-roundup-through-ssl-https" id="id5">How do I run Roundup through SSL (HTTPS)?</a></li>
  125 </ul>
  126 </li>
  127 <li><a class="reference internal" href="#templates" id="id6">Templates</a><ul>
  128 <li><a class="reference internal" href="#what-is-that-stuff-in-the-tracker-html-directory" id="id7">What is that stuff in the tracker html directory?</a></li>
  129 <li><a class="reference internal" href="#but-i-just-want-a-select-option-list-for" id="id8">But I just want a select/option list for ….</a></li>
  130 <li><a class="reference internal" href="#great-but-now-the-select-option-list-is-too-big" id="id9">Great! But now the select/option list is too big</a></li>
  131 <li><a class="reference internal" href="#i-want-to-link-version-identifiers-from-my-messages-to-svn-mercurial-git" id="id10">I want to link version identifiers from my messages to svn/mercurial/git</a></li>
  132 <li><a class="reference internal" href="#i-can-see-values-in-a-multilink-but-not-display-the-items" id="id11">I can see values in a multilink but not display the items</a></li>
  133 </ul>
  134 </li>
  135 <li><a class="reference internal" href="#using-roundup" id="id12">Using Roundup</a><ul>
  136 <li><a class="reference internal" href="#i-got-an-error-and-i-cannot-reload-it" id="id13">I got an error and I cannot reload it!</a></li>
  137 <li><a class="reference internal" href="#i-keep-getting-logged-out" id="id14">I keep getting logged out</a></li>
  138 <li><a class="reference internal" href="#i-m-getting-infinite-redirects-in-the-browser" id="id15">I’m getting infinite redirects in the browser</a></li>
  139 <li><a class="reference internal" href="#how-is-sorting-performed-and-why-does-it-seem-to-fail-sometimes" id="id16">How is sorting performed, and why does it seem to fail sometimes?</a></li>
  140 <li><a class="reference internal" href="#how-do-i-filter-roundup-emails" id="id17">How do I filter roundup emails?</a></li>
  141 </ul>
  142 </li>
  143 </ul>
  144 </div>
  145 <div class="section" id="installation">
  146 <h2><a class="toc-backref" href="#id1">Installation</a><a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
  147 <div class="section" id="living-without-a-mailserver">
  148 <h3><a class="toc-backref" href="#id2">Living without a mailserver</a><a class="headerlink" href="#living-without-a-mailserver" title="Permalink to this headline"></a></h3>
  149 <p>Remove the nosy reactor - delete the tracker file
  150 <code class="docutils literal"><span class="pre">detectors/nosyreactor.py</span></code> from your tracker home.</p>
  151 <p>You do need to configure the <code class="docutils literal"><span class="pre">[mail]</span></code> section of
  152 config.ini. Specifically the <code class="docutils literal"><span class="pre">domain</span></code> and <code class="docutils literal"><span class="pre">host</span></code> settings have to
  153 have a value. The values don’t matter, but the config parser will
  154 complain if they are not set.</p>
  155 </div>
  156 <div class="section" id="the-cgi-bin-is-very-slow">
  157 <h3><a class="toc-backref" href="#id3">The cgi-bin is very slow!</a><a class="headerlink" href="#the-cgi-bin-is-very-slow" title="Permalink to this headline"></a></h3>
  158 <p>Yep, it sure is. It has to start up Python and load all of the support
  159 libraries for <em>every</em> request.</p>
  160 <p>The solution is to use the built in server (or possibly mod_wsgi
  161 or other WSGI support).</p>
  162 <p>To make Roundup more seamless with your website, you may place the built
  163 in server behind apache and link it into your web tree (see below).</p>
  164 </div>
  165 <div class="section" id="how-do-i-put-roundup-behind-apache">
  166 <h3><a class="toc-backref" href="#id4">How do I put Roundup behind Apache</a><a class="headerlink" href="#how-do-i-put-roundup-behind-apache" title="Permalink to this headline"></a></h3>
  167 <p>We have a project (foo) running on <code class="docutils literal"><span class="pre">tracker.example:8080</span></code>.
  168 We want <code class="docutils literal"><span class="pre">http://tracker.example/issues</span></code> to use the roundup server, so we
  169 set that up on port 8080 on <code class="docutils literal"><span class="pre">tracker.example</span></code> with the <code class="docutils literal"><span class="pre">config.ini</span></code> line:</p>
  170 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">tracker</span><span class="p">]</span>
  171 <span class="o">...</span>
  172 <span class="n">web</span> <span class="o">=</span> <span class="s1">&#39;http://tracker.example/issues/&#39;</span>
  173 </pre></div>
  174 </div>
  175 <p>We have a “foo_issues” tracker and we run the server with:</p>
  176 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">roundup</span><span class="o">-</span><span class="n">server</span> <span class="o">-</span><span class="n">p</span> <span class="mi">8080</span> <span class="n">issues</span><span class="o">=/</span><span class="n">home</span><span class="o">/</span><span class="n">roundup</span><span class="o">/</span><span class="n">trackers</span><span class="o">/</span><span class="n">issues</span>
  177 </pre></div>
  178 </div>
  179 <p>Then, on the Apache machine (eg. redhat 7.3 with apache 1.3), in
  180 <code class="docutils literal"><span class="pre">/etc/httpd/conf/httpd.conf</span></code> uncomment:</p>
  181 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">LoadModule</span> <span class="n">proxy_module</span>       <span class="n">modules</span><span class="o">/</span><span class="n">libproxy</span><span class="o">.</span><span class="n">so</span>
  182 </pre></div>
  183 </div>
  184 <p>and:</p>
  185 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">AddModule</span> <span class="n">mod_proxy</span><span class="o">.</span><span class="n">c</span>
  186 </pre></div>
  187 </div>
  188 <p>Then add:</p>
  189 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># roundup stuff (added manually)</span>
  190 <span class="o">&lt;</span><span class="n">IfModule</span> <span class="n">mod_proxy</span><span class="o">.</span><span class="n">c</span><span class="o">&gt;</span>
  191 <span class="c1"># proxy through one tracker</span>
  192 <span class="n">ProxyPass</span> <span class="o">/</span><span class="n">issues</span><span class="o">/</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">tracker</span><span class="o">.</span><span class="n">example</span><span class="p">:</span><span class="mi">8080</span><span class="o">/</span><span class="n">issues</span><span class="o">/</span>
  193 <span class="c1"># proxy through all tracker(*)</span>
  194 <span class="c1">#ProxyPass /roundup/ http://tracker.example:8080/</span>
  195 <span class="o">&lt;/</span><span class="n">IfModule</span><span class="o">&gt;</span>
  196 </pre></div>
  197 </div>
  198 <p>Then restart Apache. Now Apache will proxy the request on to the
  199 roundup-server.</p>
  200 <p>Note that if you’re proxying multiple trackers, you’ll need to use the
  201 second ProxyPass rule described above. It will mean that your TRACKER_WEB
  202 will change to:</p>
  203 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TRACKER_WEB</span> <span class="o">=</span> <span class="s1">&#39;http://tracker.example/roundup/issues/&#39;</span>
  204 </pre></div>
  205 </div>
  206 <p>Once you’re done, you can firewall off port 8080 from the rest of the world.</p>
  207 <p>Note that in some situations (eg. virtual hosting) you might need to use a
  208 more complex rewrite rule instead of the simpler ProxyPass above. The
  209 following should be useful as a starting template:</p>
  210 <div class="highlight-default"><div class="highlight"><pre><span></span># roundup stuff (added manually)
  211 &lt;IfModule mod_proxy.c&gt;
  213 RewriteEngine on
  215 # General Roundup
  216 RewriteRule ^/roundup$  roundup/    [R]
  217 RewriteRule ^/roundup/(.*)$ http://tracker.example:8080/$1   [P,L]
  219 # Handle Foo Issues
  220 RewriteRule ^/issues$  issues/    [R]
  221 RewriteRule ^/issues/(.*)$ http://tracker.example:8080/issues/$1 [P,L]
  223 &lt;/IfModule&gt;
  224 </pre></div>
  225 </div>
  226 </div>
  227 <div class="section" id="how-do-i-run-roundup-through-ssl-https">
  228 <h3><a class="toc-backref" href="#id5">How do I run Roundup through SSL (HTTPS)?</a><a class="headerlink" href="#how-do-i-run-roundup-through-ssl-https" title="Permalink to this headline"></a></h3>
  229 <p>The preferred way of using SSL is to proxy through apache and use its
  230 SSL service. See the previous question on how to proxy through apache.</p>
  231 <p>The standalone roundup-server now also has SSL support which is still
  232 considered experimental. For details refer to the documentation of
  233 roundup server, in particular to the generated configuration file
  234 generated with</p>
  235 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">roundup</span><span class="o">-</span><span class="n">server</span> <span class="o">--</span><span class="n">save</span><span class="o">-</span><span class="n">config</span>
  236 </pre></div>
  237 </div>
  238 <p>that describes the needed option in detail. With the standalone server
  239 now XMLRPC over SSL works, too.</p>
  240 </div>
  241 </div>
  242 <div class="section" id="templates">
  243 <h2><a class="toc-backref" href="#id6">Templates</a><a class="headerlink" href="#templates" title="Permalink to this headline"></a></h2>
  244 <div class="section" id="what-is-that-stuff-in-the-tracker-html-directory">
  245 <h3><a class="toc-backref" href="#id7">What is that stuff in the tracker html directory?</a><a class="headerlink" href="#what-is-that-stuff-in-the-tracker-html-directory" title="Permalink to this headline"></a></h3>
  246 <p>This is the template code that Roundup uses to display the various pages.
  247 This is based upon the template markup language in Zope called, oddly
  248 enough, “Zope Page Templates”. There’s documentation in the Roundup
  249 <a class="reference external" href="customizing.html">customisation</a> documentation. For more information have a look at:</p>
  250 <blockquote>
  251 <div><a class="reference external" href="http://docs.zope.org/zope2/zope2book/">http://docs.zope.org/zope2/zope2book/</a></div></blockquote>
  252 <p>specifically chapter 10 “Using Zope Page Templates” and chapter 14 “Advanced
  253 Page Templates”.</p>
  254 </div>
  255 <div class="section" id="but-i-just-want-a-select-option-list-for">
  256 <h3><a class="toc-backref" href="#id8">But I just want a select/option list for ….</a><a class="headerlink" href="#but-i-just-want-a-select-option-list-for" title="Permalink to this headline"></a></h3>
  257 <p>Really easy… edit <code class="docutils literal"><span class="pre">html/issue.item.html</span></code>. For <code class="docutils literal"><span class="pre">nosy</span></code>, change the line
  258 (around line 69) from:</p>
  259 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">span</span> <span class="n">tal</span><span class="p">:</span><span class="n">replace</span><span class="o">=</span><span class="s2">&quot;structure context/nosy/field&quot;</span> <span class="o">/&gt;</span>
  260 </pre></div>
  261 </div>
  262 <p>to:</p>
  263 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">span</span> <span class="n">tal</span><span class="p">:</span><span class="n">replace</span><span class="o">=</span><span class="s2">&quot;structure context/nosy/menu&quot;</span> <span class="o">/&gt;</span>
  264 </pre></div>
  265 </div>
  266 <p>For <code class="docutils literal"><span class="pre">assigned</span> <span class="pre">to</span></code>, this is already done around line 77:</p>
  267 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">td</span> <span class="n">tal</span><span class="p">:</span><span class="n">content</span><span class="o">=</span><span class="s2">&quot;structure context/assignedto/menu&quot;</span><span class="o">&gt;</span><span class="n">assignedto</span> <span class="n">menu</span><span class="o">&lt;/</span><span class="n">td</span><span class="o">&gt;</span>
  268 </pre></div>
  269 </div>
  270 </div>
  271 <div class="section" id="great-but-now-the-select-option-list-is-too-big">
  272 <h3><a class="toc-backref" href="#id9">Great! But now the select/option list is too big</a><a class="headerlink" href="#great-but-now-the-select-option-list-is-too-big" title="Permalink to this headline"></a></h3>
  273 <p>That is a little harder (but only a little ;^)</p>
  274 <p>Again, edit <code class="docutils literal"><span class="pre">html/issue.item</span></code>. For nosy, change line (around line 69) from:</p>
  275 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">span</span> <span class="n">tal</span><span class="p">:</span><span class="n">replace</span><span class="o">=</span><span class="s2">&quot;structure context/nosy/field&quot;</span> <span class="o">/&gt;</span>
  276 </pre></div>
  277 </div>
  278 <p>to:</p>
  279 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">span</span> <span class="n">tal</span><span class="p">:</span><span class="n">replace</span><span class="o">=</span><span class="s2">&quot;structure python:context.nosy.menu(height=3)&quot;</span> <span class="o">/&gt;</span>
  280 </pre></div>
  281 </div>
  282 <p>for more information, go and read about Zope Page Templates.</p>
  283 </div>
  284 <div class="section" id="i-want-to-link-version-identifiers-from-my-messages-to-svn-mercurial-git">
  285 <h3><a class="toc-backref" href="#id10">I want to link version identifiers from my messages to svn/mercurial/git</a><a class="headerlink" href="#i-want-to-link-version-identifiers-from-my-messages-to-svn-mercurial-git" title="Permalink to this headline"></a></h3>
  286 <p>See: the LinkFormatingExample at:</p>
  287 <p><a class="reference external" href="http://www.roundup-tracker.org/cgi-bin/moin.cgi/LinkFormattingExample?highlight=%28local%5C_replace%29">http://www.roundup-tracker.org/cgi-bin/moin.cgi/LinkFormattingExample?highlight=%28local%5C_replace%29</a></p>
  288 <p>There are examples in the devel and responsive templates. Search for
  289 LocalReplace to find the extension file and the change that has to be
  290 made to the item template.</p>
  291 </div>
  292 <div class="section" id="i-can-see-values-in-a-multilink-but-not-display-the-items">
  293 <h3><a class="toc-backref" href="#id11">I can see values in a multilink but not display the items</a><a class="headerlink" href="#i-can-see-values-in-a-multilink-but-not-display-the-items" title="Permalink to this headline"></a></h3>
  294 <p>Make sure that you have allowed the user to view the labelprop for the
  295 multilink class. Look for the setlabelprop explanation in the Roundup
  296 <a class="reference external" href="customizing.html">customisation</a> documentation.</p>
  297 </div>
  298 </div>
  299 <div class="section" id="using-roundup">
  300 <h2><a class="toc-backref" href="#id12">Using Roundup</a><a class="headerlink" href="#using-roundup" title="Permalink to this headline"></a></h2>
  301 <div class="section" id="i-got-an-error-and-i-cannot-reload-it">
  302 <h3><a class="toc-backref" href="#id13">I got an error and I cannot reload it!</a><a class="headerlink" href="#i-got-an-error-and-i-cannot-reload-it" title="Permalink to this headline"></a></h3>
  303 <p>If you’re using Netscape/Mozilla, try holding shift and pressing reload.
  304 If you’re using IE then install Mozilla and try again ;^)</p>
  305 </div>
  306 <div class="section" id="i-keep-getting-logged-out">
  307 <h3><a class="toc-backref" href="#id14">I keep getting logged out</a><a class="headerlink" href="#i-keep-getting-logged-out" title="Permalink to this headline"></a></h3>
  308 <p>Make sure that the <code class="docutils literal"><span class="pre">tracker</span></code> -&gt; <code class="docutils literal"><span class="pre">web</span></code> setting in your tracker’s
  309 config.ini is set to the URL of the tracker.</p>
  310 </div>
  311 <div class="section" id="i-m-getting-infinite-redirects-in-the-browser">
  312 <h3><a class="toc-backref" href="#id15">I’m getting infinite redirects in the browser</a><a class="headerlink" href="#i-m-getting-infinite-redirects-in-the-browser" title="Permalink to this headline"></a></h3>
  313 <p>A wrong value for the <code class="docutils literal"><span class="pre">tracker</span></code> -&gt; <code class="docutils literal"><span class="pre">web</span></code> setting may also result in
  314 infinite redirects, see <a class="reference external" href="https://issues.roundup-tracker.org/issue2537286">https://issues.roundup-tracker.org/issue2537286</a></p>
  315 </div>
  316 <div class="section" id="how-is-sorting-performed-and-why-does-it-seem-to-fail-sometimes">
  317 <h3><a class="toc-backref" href="#id16">How is sorting performed, and why does it seem to fail sometimes?</a><a class="headerlink" href="#how-is-sorting-performed-and-why-does-it-seem-to-fail-sometimes" title="Permalink to this headline"></a></h3>
  318 <p>When we sort items in the hyperdb, we use one of a number of methods,
  319 depending on the properties being sorted on:</p>
  320 <ol class="arabic simple">
  321 <li>If it’s a String, Integer, Number, Date or Interval property, we
  322 just sort the scalar value of the property. Strings are sorted
  323 case-sensitively.</li>
  324 <li>If it’s a Link property, we sort by either the linked item’s “order”
  325 property (if it has one) or the linked item’s “id”.</li>
  326 <li>Mulitlinks sort similar to #2, but we start with the first
  327 Multilink list item, and if they’re the same, we sort by the second item,
  328 and so on.</li>
  329 </ol>
  330 <p>Note that if an “order” property is defined on a Class that is used for
  331 sorting, all items of that Class <em>must</em> have a value against the “order”
  332 property, or sorting will result in random ordering.</p>
  333 </div>
  334 <div class="section" id="how-do-i-filter-roundup-emails">
  335 <h3><a class="toc-backref" href="#id17">How do I filter roundup emails?</a><a class="headerlink" href="#how-do-i-filter-roundup-emails" title="Permalink to this headline"></a></h3>
  336 <p>When roundup emails users, it provides an email header:</p>
  337 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">X</span><span class="o">-</span><span class="n">Roundup</span><span class="o">-</span><span class="p">(</span><span class="n">class</span><span class="p">)</span><span class="o">-</span><span class="p">(</span><span class="nb">property</span><span class="p">):</span> <span class="n">values</span>
  338 </pre></div>
  339 </div>
  340 <p>for every property that is a link or multilink (usually things
  341 set by a dropdown or selection in the web interface).</p>
  342 <p>For example, assume you have a category field for issues in your tracker.
  343 You respond to issues that fall into the catagories: Network and Security.</p>
  344 <p>You will see headers like:</p>
  345 <blockquote>
  346 <div>X-Roundup-issue-category: Network</div></blockquote>
  347 <p>or</p>
  348 <blockquote>
  349 <div>X-Roundup-issue-category: Network, Security, Linux</div></blockquote>
  350 <p>Then you can set up a filter looking for X-Roundup-issue-category
  351 followed by Network or Security in your mail program.</p>
  352 <p>Also for newer (post version 1.6.X) releases there is also a header:</p>
  353 <blockquote>
  354 <div>X-Roundup-issue-Id: 22</div></blockquote>
  355 <p>for messages from issue22. Directions on using your mail program are
  356 beyond the scope of this FAQ entry.</p>
  357 <p>(If you don’t see a header for a multilink or link property, look for
  358 msg_header_property in the roundup docs. In some cases you have to
  359 explicitly enable the header.)</p>
  360 </div>
  361 </div>
  362 </div>
  366     <div class="related related-bottom">
  367       <ul>
  368         <li class="right" style="margin-right: 10px">
  369           <a href="genindex.html" title="General Index"
  370              accesskey="I">index</a></li>
  371         <li class="right" >
  372           <a href="user_guide.html" title="User Guide"
  373              accesskey="N">next</a></li>
  374         <li class="right" >
  375           <a href="upgrading.html" title="Upgrading to newer versions of Roundup"
  376              accesskey="P">previous</a></li>
  377         <li><a href="index.html">Roundup 2.0.0 documentation</a></li> 
  378       </ul>
  379     </div>
  380     </div>
  381     <div class="footer">
  382         &copy; Copyright 2009-2020, Richard Jones, Roundup-Team.
  383     </div>
  384   </body>
  385 </html>