comparison doc/reference.txt @ 8475:bc3d3c54e1f0

doc: removed line referencing API change in 1.6 Removed sentence: This may be fixed in Roundup 1.6 by introducing ``init_web(client)`` callback or a more flexible extension point mechanism. as I think RegisterAction can be used for both cgi/html interface (action inherits from roundup.cgi.actions.Action) and rest/xmlrpc interface (action inherits from roundup.actions.Action).
author John Rouillard <rouilj@ieee.org>
date Sat, 08 Nov 2025 00:40:39 -0500
parents 5346abcf429e
children b99c40b40f18
comparison
equal deleted inserted replaced
8474:5346abcf429e 8475:bc3d3c54e1f0
1366 tracker ``extensions`` directory. The tracker loads all the files 1366 tracker ``extensions`` directory. The tracker loads all the files
1367 from this directory, at which point it calls ``init(instance)`` from 1367 from this directory, at which point it calls ``init(instance)`` from
1368 each file supplying itself as a first argument. 1368 each file supplying itself as a first argument.
1369 1369
1370 Note that at this point web interface is not loaded, but 1370 Note that at this point web interface is not loaded, but
1371 extensions still can register actions for it in the tracker 1371 extensions can register actions for it in the tracker
1372 instance. This may be fixed in Roundup 1.6 by introducing 1372 instance.
1373 ``init_web(client)`` callback or a more flexible extension point
1374 mechanism.
1375 1373
1376 * ``instance.registerUtil`` is used for adding `templating utilities`_ 1374 * ``instance.registerUtil`` is used for adding `templating utilities`_
1377 (see `adding a time log to your issues 1375 (see `adding a time log to your issues
1378 <customizing.html#adding-a-time-log-to-your-issues-4>`_ for an example) 1376 <customizing.html#adding-a-time-log-to-your-issues-4>`_ for an example)
1379 1377
1382 the function. This makes more complex templating actions easier to 1380 the function. This makes more complex templating actions easier to
1383 use. (see :ref:`dynamic_csp` for an example) 1381 use. (see :ref:`dynamic_csp` for an example)
1384 1382
1385 * ``instance.registerAction`` is used to add more actions to the 1383 * ``instance.registerAction`` is used to add more actions to the
1386 instance and to web interface. See `Defining new web actions`_ 1384 instance and to web interface. See `Defining new web actions`_
1387 for details. Generic action can be added by inheriting from 1385 for details. Generic action (used by xmlrpc or rest interfaces) can
1388 ``action.Action`` instead of ``cgi.action.Action``. 1386 be added by inheriting from ``action.Action`` instead of
1387 ``cgi.action.Action``.
1389 1388
1390 .. _interfaces.py: 1389 .. _interfaces.py:
1391 .. _modifying the core of Roundup: 1390 .. _modifying the core of Roundup:
1392 1391
1393 .. index:: single: interfaces.py; hooking into the roundup core 1392 .. index:: single: interfaces.py; hooking into the roundup core

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