view doc/implementation.txt @ 5748:943e61bc26d5

Fix issue2551029 (Jinja2 template install error) by deleting config.ini from all templates. Looks like classic and minimal never included a config.ini. Presence of config.ini stopped 'roundup-admin install' from generating an up to date config.ini. Created special option class for backend database. Comment now uses roundup.backend.list_backends to give user indication of valid values. Also we now get an error if user specifies invalid backend. Moved backend setting to top or [rdbms] section. It is the most important thing in there and if set to anydbm (or some other non-rdbm) the rest of the settings can be ignored. Change rdbms config section comment to indicate that the backend setting was used by other database backends. (e.g. if set to anydbm).
author John Rouillard <rouilj@ieee.org>
date Sat, 01 Jun 2019 09:05:23 -0400
parents 33a1f03b9de0
children 9ca128103a3a
line wrap: on
line source

====================
Implementation notes
====================

[see also the roundup package docstring]

There have been some modifications to the spec. I've marked these in the
source with 'XXX' comments when I remember to.

In short:
 Class.find() - may match multiple properties, uses keyword args.

 Class.filter() - isn't in the spec and it's very useful to have at the
    Class level.

 CGI interface index view specifier layout part - lose the '+' from the
    sorting arguments (it's a reserved URL character ;). Just made no
    prefix mean ascending and '-' prefix descending.

 ItemClass - renamed to IssueClass to better match it only having one
    hypderdb class "issue". Allowing > 1 hyperdb class breaks the
    "superseder" multilink (since it can only link to one thing, and
    we'd want bugs to link to support and vice-versa).

 template - the call="link()" is handled by special-case mechanisms in
    my top-level CGI handler. In a nutshell, the handler looks for a
    method on itself called 'index%s' or 'item%s' where %s is a class.
    Most items pass on to the templating mechanism, but the file class
    _always_ does downloading. It'll probably stay this way too...

 template - call="link(property)" may be used to link "the current item"
    (from an index) - the link text is the property specified.

 template - added functions that I found very useful: List, History and
    Submit.

 template - items must specify the message lists, history, etc. Having
    them by default was sometimes not wanted.

 template - index view determines its default columns from the
    template's ``tal:condition="request/show/<property>"`` directives.

 template - menu() and field() look awfully similar now .... ;)

 roundup_admin.py - the command-line tool has a lot more commands at its
    disposal

-----------------

Back to `Table of Contents`_

.. _`Table of Contents`: index.html


Roundup Issue Tracker: http://roundup-tracker.org/