"Fossies" - the Fresh Open Source Software Archive

Member "roundup-2.0.0/share/doc/roundup/html/implementation.html" (13 Jul 2020, 6633 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>Implementation notes &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="License" href="license.html" />
   28     <link rel="prev" title="Acknowledgements" href="acknowledgements.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="acknowledgements.html"
   47                           title="previous chapter">Acknowledgements</a></p>
   48     <h4>Next topic</h4>
   49     <p class="topless"><a href="license.html"
   50                           title="next chapter">License</a></p>
   51     <h3>This Page</h3>
   52     <ul class="this-page-menu">
   53       <li><a href="_sources/implementation.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="license.html" title="License"
   78              accesskey="N">next</a></li>
   79         <li class="right" >
   80           <a href="acknowledgements.html" title="Acknowledgements"
   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="implementation-notes">
   87 <h1>Implementation notes<a class="headerlink" href="#implementation-notes" title="Permalink to this headline"></a></h1>
   88 <p>[see also the roundup package docstring]</p>
   89 <p>There have been some modifications to the spec. I’ve marked these in the
   90 source with ‘XXX’ comments when I remember to.</p>
   91 <dl class="docutils">
   92 <dt>In short:</dt>
   93 <dd><p class="first">Class.find() - may match multiple properties, uses keyword args.</p>
   94 <dl class="docutils">
   95 <dt>Class.filter() - isn’t in the spec and it’s very useful to have at the</dt>
   96 <dd>Class level.</dd>
   97 <dt>CGI interface index view specifier layout part - lose the ‘+’ from the</dt>
   98 <dd>sorting arguments (it’s a reserved URL character ;). Just made no
   99 prefix mean ascending and ‘-‘ prefix descending.</dd>
  100 <dt>ItemClass - renamed to IssueClass to better match it only having one</dt>
  101 <dd>hypderdb class “issue”. Allowing &gt; 1 hyperdb class breaks the
  102 “superseder” multilink (since it can only link to one thing, and
  103 we’d want bugs to link to support and vice-versa).</dd>
  104 <dt>template - the call=”link()” is handled by special-case mechanisms in</dt>
  105 <dd>my top-level CGI handler. In a nutshell, the handler looks for a
  106 method on itself called ‘index%s’ or ‘item%s’ where %s is a class.
  107 Most items pass on to the templating mechanism, but the file class
  108 _always_ does downloading. It’ll probably stay this way too…</dd>
  109 <dt>template - call=”link(property)” may be used to link “the current item”</dt>
  110 <dd>(from an index) - the link text is the property specified.</dd>
  111 <dt>template - added functions that I found very useful: List, History and</dt>
  112 <dd>Submit.</dd>
  113 <dt>template - items must specify the message lists, history, etc. Having</dt>
  114 <dd>them by default was sometimes not wanted.</dd>
  115 <dt>template - index view determines its default columns from the</dt>
  116 <dd>template’s <code class="docutils literal"><span class="pre">tal:condition=&quot;request/show/&lt;property&gt;&quot;</span></code> directives.</dd>
  117 </dl>
  118 <p>template - menu() and field() look awfully similar now …. ;)</p>
  119 <dl class="last docutils">
  120 <dt>roundup_admin.py - the command-line tool has a lot more commands at its</dt>
  121 <dd>disposal</dd>
  122 </dl>
  123 </dd>
  124 </dl>
  125 <hr class="docutils" />
  126 <p>Back to <a class="reference external" href="index.html">Table of Contents</a></p>
  127 </div>
  128 
  129 
  130        
  131     <div class="related related-bottom">
  132       <ul>
  133         <li class="right" style="margin-right: 10px">
  134           <a href="genindex.html" title="General Index"
  135              accesskey="I">index</a></li>
  136         <li class="right" >
  137           <a href="license.html" title="License"
  138              accesskey="N">next</a></li>
  139         <li class="right" >
  140           <a href="acknowledgements.html" title="Acknowledgements"
  141              accesskey="P">previous</a></li>
  142         <li><a href="index.html">Roundup 2.0.0 documentation</a></li> 
  143       </ul>
  144     </div>
  145     </div>
  146     <div class="footer">
  147         &copy; Copyright 2009-2020, Richard Jones, Roundup-Team.
  148     </div>
  149   </body>
  150 </html>