Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 7971:fe0348bbe45b
issue2551353 - Add roundup-classhelper for 2.4.0 release
Changes to the classic template are not done yet. Still testing.
This commit has document updates and changes to rest.py.
rest.py:
add /rest/data/user/role endpoint to core so the user doesn't have
to add the /rest/roles endpoint via interfaces.py. It will only send
roles for a user with Admin role and there is no way to override
this currently.
acknowledgements.txt:
Added members of team3 to other contributors. Specified for all
other contributes what they worked on.
upgrading.txt:
added classhelper section and basic template change
directions. Linked to admin_guide for full directions.
admin_guide.txt:
documented install, translation, troubleshooting, config etc.
user_guide.txt:
added section on using the classhelper. Added reference to section
earlier in the doc. Added image for section.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 21 May 2024 01:17:28 -0400 |
| parents | 791b61ed11c9 |
| children | 1e9c16b079fa |
comparison
equal
deleted
inserted
replaced
| 7970:b63fcfc2c984 | 7971:fe0348bbe45b |
|---|---|
| 247 enhanced. The core Roundup developers don't use MySQL for their | 247 enhanced. The core Roundup developers don't use MySQL for their |
| 248 production workloads so we count on users to help us with this. | 248 production workloads so we count on users to help us with this. |
| 249 | 249 |
| 250 .. _issue2551282: https://issues.roundup-tracker.org/issue2551282 | 250 .. _issue2551282: https://issues.roundup-tracker.org/issue2551282 |
| 251 .. _issue2551115: https://issues.roundup-tracker.org/issue2551115 | 251 .. _issue2551115: https://issues.roundup-tracker.org/issue2551115 |
| 252 | |
| 253 Add new classhelper to your templates (optional) | |
| 254 ------------------------------------------------ | |
| 255 | |
| 256 The classic classhelper invoked by the ``(list)`` link in your | |
| 257 issue.item.html template can be greatly improved by wrapping the | |
| 258 links with the new web-component based ``roundup-classhelper``. | |
| 259 | |
| 260 The new classhelper: | |
| 261 | |
| 262 * allows you to select items from multiple pages | |
| 263 * is usable with a content security policy | |
| 264 * is more easily styled | |
| 265 | |
| 266 To deploy it, install the required files and wrap classhelp calls | |
| 267 in the new ``<roundup-classhelper>`` component. For example, | |
| 268 wrap:: | |
| 269 | |
| 270 <span tal:condition="context/is_edit_ok" tal:replace="structure | |
| 271 python:db.user.classhelp('username,realname,address', | |
| 272 property='nosy', width='600'" /> | |
| 273 | |
| 274 so it looks like:: | |
| 275 | |
| 276 <roundup-classhelper | |
| 277 data-search-with="username,phone,roles[]"> | |
| 278 | |
| 279 <span tal:condition="context/is_edit_ok" tal:replace="structure | |
| 280 python:db.user.classhelp('username,realname,address', | |
| 281 property='nosy', width='600')" /> | |
| 282 | |
| 283 </roundup-classhelper> | |
| 284 | |
| 285 to allow the user to search by: username, phone number and use a | |
| 286 select/dropdown to search by role. Full details about the | |
| 287 attributes and installation instructions can be found in the | |
| 288 `classhelper documentation`_ in the admin guide. | |
| 289 | |
| 252 | 290 |
| 253 Disable performance improvement for wsgi mode (optional) | 291 Disable performance improvement for wsgi mode (optional) |
| 254 -------------------------------------------------------- | 292 -------------------------------------------------------- |
| 255 | 293 |
| 256 In Roundup version 2.2.0, an experimental feature was introduced to | 294 In Roundup version 2.2.0, an experimental feature was introduced to |
| 2604 .. _`xmlrpc guide`: xmlrpc.html | 2642 .. _`xmlrpc guide`: xmlrpc.html |
| 2605 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html | 2643 .. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html |
| 2606 .. _PostgreSQL's full text search: https://www.postgresql.org/docs/current/textsearch.html | 2644 .. _PostgreSQL's full text search: https://www.postgresql.org/docs/current/textsearch.html |
| 2607 .. _`administration guide notes on native-fts`: admin_guide.html#configuring-native-fts-full-text-search | 2645 .. _`administration guide notes on native-fts`: admin_guide.html#configuring-native-fts-full-text-search |
| 2608 .. _Configuring Compression: admin_guide.html#configuring-compression | 2646 .. _Configuring Compression: admin_guide.html#configuring-compression |
| 2647 .. _classhelper documentation: admin_guide.html#classhelper-web-component | |
| 2609 .. _Software Upgrade: admin_guide.html#software-upgrade | 2648 .. _Software Upgrade: admin_guide.html#software-upgrade |
| 2610 .. _new search permissions for query in 1.4.17: | 2649 .. _new search permissions for query in 1.4.17: |
| 2611 upgrading-history.html#new-search-permissions-for-query-in-1-4-17 | 2650 upgrading-history.html#new-search-permissions-for-query-in-1-4-17 |