"Fossies" - the Fresh Open Source Software Archive

Member "roundup-2.0.0/share/doc/roundup/html/tracker_templates.html" (13 Jul 2020, 9191 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">
    3 
    4 <html xmlns="http://www.w3.org/1999/xhtml">
    5   <head>
    6     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7     
    8     <title>Roundup Tracker Templates &mdash; Roundup 2.0.0 documentation</title>
    9     
   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="MySQL Backend" href="mysql.html" />
   28     <link rel="prev" title="Developing Roundup" href="developers.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">
   44        
   45     <h4>Previous topic</h4>
   46     <p class="topless"><a href="developers.html"
   47                           title="previous chapter">Developing Roundup</a></p>
   48     <h4>Next topic</h4>
   49     <p class="topless"><a href="mysql.html"
   50                           title="next chapter">MySQL Backend</a></p>
   51     <h3>This Page</h3>
   52     <ul class="this-page-menu">
   53       <li><a href="_sources/tracker_templates.txt"
   54              rel="nofollow">Show Source</a></li>
   55     </ul>
   56   <div id="searchbox" style="display: none">
   57     <h3>Quick search</h3>
   58       <form class="search" action="search.html" method="get">
   59         <input type="text" name="q" size="18" />
   60         <input type="submit" value="Go" />
   61         <input type="hidden" name="check_keywords" value="yes" />
   62         <input type="hidden" name="area" value="default" />
   63       </form>
   64       <p style="font-size: 90%">Enter search terms or a module, class or function name.</p>
   65   </div>
   66   <script type="text/javascript">$('#searchbox').show(0);</script>
   67       </div>
   68     </div>
   69     <div class="content">
   70        
   71     <div class="related related-top">
   72       <ul>
   73         <li class="right" style="margin-right: 10px">
   74           <a href="genindex.html" title="General Index"
   75              accesskey="I">index</a></li>
   76         <li class="right" >
   77           <a href="mysql.html" title="MySQL Backend"
   78              accesskey="N">next</a></li>
   79         <li class="right" >
   80           <a href="developers.html" title="Developing Roundup"
   81              accesskey="P">previous</a></li>
   82         <li><a href="index.html">Roundup 2.0.0 documentation</a></li> 
   83       </ul>
   84     </div>
   85        
   86   <div class="section" id="roundup-tracker-templates">
   87 <h1>Roundup Tracker Templates<a class="headerlink" href="#roundup-tracker-templates" title="Permalink to this headline"></a></h1>
   88 <p>The templates distributed with Roundup are stored in the “share” directory
   89 nominated by Python. On Unix this is typically
   90 <code class="docutils literal"><span class="pre">/usr/share/roundup/templates/</span></code> (or <code class="docutils literal"><span class="pre">/usr/local/share...</span></code>) and
   91 on Windows this is <code class="docutils literal"><span class="pre">c:\python22\share\roundup\templates\</span></code>.</p>
   92 <p>The template loading looks in four places to find the templates:</p>
   93 <ol class="arabic simple">
   94 <li><em>share</em> - eg. <code class="docutils literal"><span class="pre">&lt;prefix&gt;/share/roundup/templates/*</span></code>.
   95 This should be the standard place to find them when Roundup is
   96 installed.</li>
   97 <li><code class="docutils literal"><span class="pre">&lt;roundup.admin.__file__&gt;/../templates/*</span></code>.
   98 This will be used if Roundup’s run in the distro (aka. source)
   99 directory.</li>
  100 <li><code class="docutils literal"><span class="pre">&lt;current</span> <span class="pre">working</span> <span class="pre">dir&gt;/*</span></code>.
  101 This is for when someone unpacks a 3rd-party template.</li>
  102 <li><code class="docutils literal"><span class="pre">&lt;current</span> <span class="pre">working</span> <span class="pre">dir&gt;</span></code>.
  103 This is for someone who “cd”s to the 3rd-party template dir.</li>
  104 </ol>
  105 <p>Templates contain:</p>
  106 <ul class="simple">
  107 <li>modules <code class="docutils literal"><span class="pre">schema.py</span></code> and <code class="docutils literal"><span class="pre">initial_data.py</span></code></li>
  108 <li>directories <code class="docutils literal"><span class="pre">html</span></code>, <code class="docutils literal"><span class="pre">detectors</span></code> and <code class="docutils literal"><span class="pre">extensions</span></code>
  109 (with appropriate contents)</li>
  110 <li>optional <code class="docutils literal"><span class="pre">config_ini.ini</span></code> file. It is structured like a tracker’s
  111 <code class="docutils literal"><span class="pre">config.ini</span></code> but contains only headers (e.g. <code class="docutils literal"><span class="pre">[main]</span></code>) and
  112 <em>required</em> parameters that are different from defaults:
  113 e.g. <code class="docutils literal"><span class="pre">template_engine</span> <span class="pre">=</span> <span class="pre">jinja2</span></code> and <code class="docutils literal"><span class="pre">static_files</span> <span class="pre">=</span>
  114 <span class="pre">static</span></code>. These settings override the default values saved to the
  115 tracker’s <code class="docutils literal"><span class="pre">config.ini</span></code>.</li>
  116 <li>template “marker” file <code class="docutils literal"><span class="pre">TEMPLATE-INFO.txt</span></code>, which contains
  117 the name of the template, a description of the template
  118 and its intended audience.</li>
  119 </ul>
  120 <p>An example TEMPLATE-INFO.txt:</p>
  121 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Name</span><span class="p">:</span> <span class="n">classic</span>
  122 <span class="n">Description</span><span class="p">:</span> <span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">generic</span> <span class="n">issue</span> <span class="n">tracker</span> <span class="n">that</span> <span class="n">may</span> <span class="n">be</span> <span class="n">used</span> <span class="n">to</span> <span class="n">track</span> <span class="n">bugs</span><span class="p">,</span>
  123              <span class="n">feature</span> <span class="n">requests</span><span class="p">,</span> <span class="n">project</span> <span class="n">issues</span> <span class="ow">or</span> <span class="nb">any</span> <span class="n">number</span> <span class="n">of</span> <span class="n">other</span> <span class="n">types</span>
  124              <span class="n">of</span> <span class="n">issues</span><span class="o">.</span> <span class="n">Most</span> <span class="n">users</span> <span class="n">of</span> <span class="n">Roundup</span> <span class="n">will</span> <span class="n">find</span> <span class="n">that</span> <span class="n">this</span> <span class="n">template</span>
  125              <span class="n">suits</span> <span class="n">them</span><span class="p">,</span> <span class="k">with</span> <span class="n">perhaps</span> <span class="n">a</span> <span class="n">few</span> <span class="n">customisations</span><span class="o">.</span>
  126 <span class="n">Intended</span><span class="o">-</span><span class="n">For</span><span class="p">:</span> <span class="n">All</span> <span class="n">first</span><span class="o">-</span><span class="n">time</span> <span class="n">Roundup</span> <span class="n">users</span>
  127 </pre></div>
  128 </div>
  129 </div>
  130 
  131 
  132        
  133     <div class="related related-bottom">
  134       <ul>
  135         <li class="right" style="margin-right: 10px">
  136           <a href="genindex.html" title="General Index"
  137              accesskey="I">index</a></li>
  138         <li class="right" >
  139           <a href="mysql.html" title="MySQL Backend"
  140              accesskey="N">next</a></li>
  141         <li class="right" >
  142           <a href="developers.html" title="Developing Roundup"
  143              accesskey="P">previous</a></li>
  144         <li><a href="index.html">Roundup 2.0.0 documentation</a></li> 
  145       </ul>
  146     </div>
  147     </div>
  148     <div class="footer">
  149         &copy; Copyright 2009-2020, Richard Jones, Roundup-Team.
  150     </div>
  151   </body>
  152 </html>