File: FAQ.html

package info (click to toggle)
roundup 1.2.1-10%2Betch1
links: PTS
area: main
in suites: etch
size: 4,764 kB
ctags: 3,756
sloc: python: 30,296; sh: 1,497; perl: 23; makefile: 22
file content (509 lines) | stat: -rw-r--r-- 17,660 bytes
parent folder | download | duplicates (2)
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>Roundup FAQ</title>
<style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date$
:Revision: $Revision$
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin-left: 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left {
  clear: left }

img.align-right {
  clear: right }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

tt.docutils {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="roundup-faq">
<h1 class="title">Roundup FAQ</h1>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Version:</th>
<td>$Revision$</td></tr>
</tbody>
</table>
<div class="contents topic">
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#installation" id="id1" name="id1">Installation</a><ul>
<li><a class="reference" href="#living-without-a-mailserver" id="id2" name="id2">Living without a mailserver</a></li>
<li><a class="reference" href="#the-cgi-bin-is-very-slow" id="id3" name="id3">The cgi-bin is very slow!</a></li>
<li><a class="reference" href="#how-do-i-put-roundup-behind-apache" id="id4" name="id4">How do I put Roundup behind Apache</a></li>
<li><a class="reference" href="#how-do-i-run-roundup-through-ssl-https" id="id5" name="id5">How do I run Roundup through SSL (HTTPS)?</a></li>
<li><a class="reference" href="#roundup-runs-very-slowly-on-my-xp-machine-when-accessed-from-the-internet" id="id6" name="id6">Roundup runs very slowly on my XP machine when accessed from the Internet</a></li>
</ul>
</li>
<li><a class="reference" href="#templates" id="id7" name="id7">Templates</a><ul>
<li><a class="reference" href="#what-is-that-stuff-in-the-tracker-html-directory" id="id8" name="id8">What is that stuff in the tracker html directory?</a></li>
<li><a class="reference" href="#but-i-just-want-a-select-option-list-for" id="id9" name="id9">But I just want a select/option list for ....</a></li>
<li><a class="reference" href="#great-but-now-the-select-option-list-is-too-big" id="id10" name="id10">Great! But now the select/option list is too big</a></li>
</ul>
</li>
<li><a class="reference" href="#using-roundup" id="id11" name="id11">Using Roundup</a><ul>
<li><a class="reference" href="#i-got-an-error-and-i-cant-reload-it" id="id12" name="id12">I got an error and I cant reload it!</a></li>
<li><a class="reference" href="#i-keep-getting-logged-out" id="id13" name="id13">I keep getting logged out</a></li>
<li><a class="reference" href="#how-is-sorting-performed-and-why-does-it-seem-to-fail-sometimes" id="id14" name="id14">How is sorting performed, and why does it seem to fail sometimes?</a></li>
</ul>
</li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id1" id="installation" name="installation">Installation</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id2" id="living-without-a-mailserver" name="living-without-a-mailserver">Living without a mailserver</a></h2>
<p>Remove the nosy reactor, means delete the tracker file
<tt class="docutils literal"><span class="pre">detectors/nosyreactor.py</span></tt> from your tracker home.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id3" id="the-cgi-bin-is-very-slow" name="the-cgi-bin-is-very-slow">The cgi-bin is very slow!</a></h2>
<p>Yep, it sure is. It has to start up Python and load all of the support
libraries for <em>every</em> request.</p>
<p>The solution is to use the built in server.</p>
<p>To make Roundup more seamless with your website, you may place the built
in server behind apache and link it into your web tree</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id4" id="how-do-i-put-roundup-behind-apache" name="how-do-i-put-roundup-behind-apache">How do I put Roundup behind Apache</a></h2>
<p>We have a project (foo) running on <tt class="docutils literal"><span class="pre">tracker.example:8080</span></tt>.
We want <tt class="docutils literal"><span class="pre">http://tracker.example/issues</span></tt> to use the roundup server, so we
set that up on port 8080 on <tt class="docutils literal"><span class="pre">tracker.example</span></tt> with the <tt class="docutils literal"><span class="pre">config.ini</span></tt> line:</p>
<pre class="literal-block">
[tracker]
...
web = 'http://tracker.example/issues/'
</pre>
<p>We have a &quot;foo_issues&quot; tracker and we run the server with:</p>
<pre class="literal-block">
roundup-server -p 8080 issues=/home/roundup/trackers/issues
</pre>
<p>Then, on the Apache machine (eg. redhat 7.3 with apache 1.3), in
<tt class="docutils literal"><span class="pre">/etc/httpd/conf/httpd.conf</span></tt> uncomment:</p>
<pre class="literal-block">
LoadModule proxy_module       modules/libproxy.so
</pre>
<p>and:</p>
<pre class="literal-block">
AddModule mod_proxy.c
</pre>
<p>Then add:</p>
<pre class="literal-block">
# roundup stuff (added manually)
&lt;IfModule mod_proxy.c&gt;
# proxy through one tracker
ProxyPass /issues/ http://tracker.example:8080/issues/
# proxy through all tracker(*)
#ProxyPass /roundup/ http://tracker.example:8080/
&lt;/IfModule&gt;
</pre>
<p>Then restart Apache. Now Apache will proxy the request on to the
roundup-server.</p>
<p>Note that if you're proxying multiple trackers, you'll need to use the
second ProxyPass rule described above. It will mean that your TRACKER_WEB
will change to:</p>
<pre class="literal-block">
TRACKER_WEB = 'http://tracker.example/roundup/issues/'
</pre>
<p>Once you're done, you can firewall off port 8080 from the rest of the world.</p>
<p>Note that in some situations (eg. virtual hosting) you might need to use a
more complex rewrite rule instead of the simpler ProxyPass above. The
following should be useful as a starting template:</p>
<pre class="literal-block">
# roundup stuff (added manually)
&lt;IfModule mod_proxy.c&gt;

RewriteEngine on

# General Roundup
RewriteRule ^/roundup$  roundup/    [R]
RewriteRule ^/roundup/(.*)$ http://tracker.example:8080/$1   [P,L]

# Handle Foo Issues
RewriteRule ^/issues$  issues/    [R]
RewriteRule ^/issues/(.*)$ http://tracker.example:8080/issues/$1 [P,L]

&lt;/IfModule&gt;
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id5" id="how-do-i-run-roundup-through-ssl-https" name="how-do-i-run-roundup-through-ssl-https">How do I run Roundup through SSL (HTTPS)?</a></h2>
<p>You should proxy through apache and use its SSL service. See the previous
question on how to proxy through apache.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id6" id="roundup-runs-very-slowly-on-my-xp-machine-when-accessed-from-the-internet" name="roundup-runs-very-slowly-on-my-xp-machine-when-accessed-from-the-internet">Roundup runs very slowly on my XP machine when accessed from the Internet</a></h2>
<p>The issue is probably related to host name resolution for the client
performing the request. You can turn off the resolution of the names
when it's so slow like this. To do so, edit the module
roundup/scripts/roundup_server.py around line 77 to add the following
to the RoundupRequestHandler class:</p>
<blockquote>
<dl class="docutils">
<dt>def address_string(self):</dt>
<dd>return self.client_address[0]</dd>
</dl>
</blockquote>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id7" id="templates" name="templates">Templates</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id8" id="what-is-that-stuff-in-the-tracker-html-directory" name="what-is-that-stuff-in-the-tracker-html-directory">What is that stuff in the tracker html directory?</a></h2>
<p>This is the template code that Roundup uses to display the various pages.
This is based upon the template markup language in Zope called, oddly
enough &quot;Zope Page Templates&quot;. There's documentation in the Roundup
<a class="reference" href="customizing.html">customisation</a> documentation. For more information have a look at:</p>
<blockquote>
<a class="reference" href="http://www.zope.org/Documentation/Books/ZopeBook/2_6Edition/">http://www.zope.org/Documentation/Books/ZopeBook/2_6Edition/</a></blockquote>
<p>specifically chapter 10 &quot;Using Zope Page Templates&quot; and chapter 14 &quot;Advanced
Page Templates&quot;.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id9" id="but-i-just-want-a-select-option-list-for" name="but-i-just-want-a-select-option-list-for">But I just want a select/option list for ....</a></h2>
<p>Really easy... edit <tt class="docutils literal"><span class="pre">html/issue.item</span></tt>. For 'nosy', change line 53 from:</p>
<pre class="literal-block">
&lt;span tal:replace=&quot;structure context/nosy/field&quot; /&gt;
</pre>
<p>to:</p>
<pre class="literal-block">
&lt;span tal:replace=&quot;structure context/nosy/menu&quot; /&gt;
</pre>
<p>For 'assigned to', change line 61 from:</p>
<pre class="literal-block">
&lt;td tal:content=&quot;structure context/assignedto/field&quot;&gt;assignedto menu&lt;/td&gt;
</pre>
<p>to:</p>
<pre class="literal-block">
&lt;td tal:content=&quot;structure context/assignedto/menu&quot;&gt;assignedto menu&lt;/td&gt;
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id10" id="great-but-now-the-select-option-list-is-too-big" name="great-but-now-the-select-option-list-is-too-big">Great! But now the select/option list is too big</a></h2>
<p>Thats a little harder (but only a little ;^)</p>
<p>Again, edit <tt class="docutils literal"><span class="pre">html/issue.item</span></tt>. For nosy, change line 53 from:</p>
<blockquote>
&lt;span tal:replace=&quot;structure context/nosy/field&quot; /&gt;</blockquote>
<p>to:</p>
<pre class="literal-block">
&lt;span tal:replace=&quot;structure python:context.nosy.menu(height=3)&quot; /&gt;
</pre>
<p>for more information, go and read about Zope Page Templates.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id11" id="using-roundup" name="using-roundup">Using Roundup</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id12" id="i-got-an-error-and-i-cant-reload-it" name="i-got-an-error-and-i-cant-reload-it">I got an error and I cant reload it!</a></h2>
<p>If you're using Netscape/Mozilla, try holding shift and pressing reload.
If you're using IE then install Mozilla and try again ;^)</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id13" id="i-keep-getting-logged-out" name="i-keep-getting-logged-out">I keep getting logged out</a></h2>
<p>Make sure that the <tt class="docutils literal"><span class="pre">tracker</span></tt> -&gt; <tt class="docutils literal"><span class="pre">web</span></tt> setting in your tracker's
config.ini is set to the URL of the tracker.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id14" id="how-is-sorting-performed-and-why-does-it-seem-to-fail-sometimes" name="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></h2>
<p>When we sort items in the hyperdb, we use one of a number of methods,
depending on the properties being sorted on:</p>
<ol class="arabic simple">
<li>If it's a String, Number, Date or Interval property, we just sort the
scalar value of the property. Strings are sorted case-sensitively.</li>
<li>If it's a Link property, we sort by either the linked item's &quot;order&quot;
property (if it has one) or the linked item's &quot;id&quot;.</li>
<li>Mulitlinks sort similar to #2, but we start with the first
Multilink list item, and if they're the same, we sort by the second item,
and so on.</li>
</ol>
<p>Note that if an &quot;order&quot; property is defined on a Class that is used for
sorting, all items of that Class <em>must</em> have a value against the &quot;order&quot;
property, or sorting will result in random ordering.</p>
<hr class="docutils" />
<p>Back to <a class="reference" href="index.html">Table of Contents</a></p>
</div>
</div>
</div>
<div class="footer">
<hr class="footer" />
Generated on: 2006-08-09.

</div>
</body>
</html>