Mercurial > p > roundup > code
comparison doc/user_guide.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 | 8bc4246480bf |
| children | ce1e65af97fb |
comparison
equal
deleted
inserted
replaced
| 7970:b63fcfc2c984 | 7971:fe0348bbe45b |
|---|---|
| 153 match issues with the keyword "web interface" or "e-mail interface" in | 153 match issues with the keyword "web interface" or "e-mail interface" in |
| 154 their keyword list | 154 their keyword list |
| 155 ``keyword=-1`` | 155 ``keyword=-1`` |
| 156 match issues with no keywords set | 156 match issues with no keywords set |
| 157 | 157 |
| 158 When entering the value for a constrained property you may have a | |
| 159 helper (also called classhelper) available by clicking on a link | |
| 160 usally displayed as ``(list)``. See the section `Using the | |
| 161 Classhelper`_ for details. | |
| 158 | 162 |
| 159 Date properties | 163 Date properties |
| 160 ~~~~~~~~~~~~~~~ | 164 ~~~~~~~~~~~~~~~ |
| 161 | 165 |
| 162 Date-and-time stamps are specified with the date in | 166 Date-and-time stamps are specified with the date in |
| 438 the `documentation for configuring the native-fts`_ backend to find | 442 the `documentation for configuring the native-fts`_ backend to find |
| 439 the supported format and features. | 443 the supported format and features. |
| 440 | 444 |
| 441 .. _`documentation for configuring the native-fts`: admin_guide.html#configuring-native-fts-full-text-search | 445 .. _`documentation for configuring the native-fts`: admin_guide.html#configuring-native-fts-full-text-search |
| 442 | 446 |
| 447 Using the Classhelper | |
| 448 --------------------- | |
| 449 | |
| 450 The classhelper makes finding the id number or name for linked items | |
| 451 easier. It is usually invoked from the parent window by clicking on | |
| 452 the ``(list)`` link. There are two classhelpers: classic and | |
| 453 component. This documentation discusses the newer component | |
| 454 classhelper available with Roundup 2.4.0 or newer. If there is a | |
| 455 problem with the component classhelper, it reports the problem and | |
| 456 falls back to using the classic classhelper. | |
| 457 | |
| 458 The component classhelper is displayed in a popup window. You can | |
| 459 interact with the original window by moving the popup out of the way | |
| 460 or minimizing it. If you don't see a popup, check to see if your | |
| 461 browser has disabled popup windows. | |
| 462 | |
| 463 The classhelper has three parts: | |
| 464 | |
| 465 1. an optional search pane | |
| 466 2. a selection pane | |
| 467 3. an accumulator pane | |
| 468 | |
| 469 .. image:: images/classhelper-issue-all.png | |
| 470 :width: 675 | |
| 471 :height: 914 | |
| 472 :alt: Image of the new component classhelper popup. The image shows | |
| 473 the operating system window decorations with a title of "Superseder | |
| 474 Classhelper - issue2". Then it shows a search panel with options to | |
| 475 enter text to search issue titles or status and a select/dropdown | |
| 476 to search by a keyword on the issue. Below the options are search | |
| 477 and reset buttons. Below the search panel is a selection | |
| 478 panel that shows buttons to move to the previous or next pages and | |
| 479 says that it is displaying items 26 to 50. This is followed by a | |
| 480 scrollable table of issues where each row has a checkbox and the | |
| 481 box for issue 114 is checked. At the bottom of the window is a text | |
| 482 box that lists a number of issue numbers including 114. To the | |
| 483 right of the text box are apply and cancel buttons. | |
| 484 | |
| 485 | |
| 486 The search pane has text or select/dropdown fields to search for a | |
| 487 matching item. The image above shows a search for issues. The Title | |
| 488 and Status properties can be matched using a text input while the | |
| 489 Keyword property can be selected from a dropdown. Hitting enter while | |
| 490 in a text input will trigger a search and the results will be | |
| 491 displayed below the search pane in the selection pane. Tabbing to the | |
| 492 search button and pressing enter will also trigger a search. The reset | |
| 493 button will clear the search form. | |
| 494 | |
| 495 Below the search pane is the select pane. It lists the number of items | |
| 496 displayed (26-50) and includes two buttons to move to the previous or | |
| 497 next page of search results. If there is no search pane, this will | |
| 498 display a page of items from all the items in the class. Below the | |
| 499 pagination component is the scrollable selection table. Each row in | |
| 500 the table has a checkbox and one or more columns of data about the | |
| 501 item. Clicking on a row toggles the item's checkbox and adds or | |
| 502 removes the id or name for the item in the accumulator's | |
| 503 display. Arrow keys or tab/shift-tab can be used to scroll through | |
| 504 each item in the selection table. The space key or enter will | |
| 505 select/deselect the item. You can jump to the page controls using the | |
| 506 '<' and '>' keys. Once the page control button is focused, press enter | |
| 507 to trigger a page change. | |
| 508 | |
| 509 The bottom pane consists of a text input called the accumulator | |
| 510 display. It lists all the items that have been selected. The first two | |
| 511 items in this example were selected from the previous selection | |
| 512 page. Next to the display are the apply and cancel buttons. You can | |
| 513 jump to the apply button quickly by pressing Shift-Enter as long as | |
| 514 you are not in a search input. Once the apply button is focused, press | |
| 515 enter to copy the items in the display to the associated field on the | |
| 516 parent window. If you activate the cancel button or close the window | |
| 517 using the window decoration, the classhelper will close and not change | |
| 518 the parent window. | |
| 519 | |
| 520 The classhelper can also be used in read-only mode. In this mode, the | |
| 521 accumulator is not shown. Also the checkboxes are not displayed. To | |
| 522 close the classhelper in read-only mode use the window decoration or a | |
| 523 hotkey (e.g. control-w). | |
| 524 | |
| 525 You can have multiple classhelpers up at a time. The title on the | |
| 526 window identifies the property and item the classhelper will | |
| 527 modify. For example the image shows the superseder for issue2. | |
| 528 | |
| 529 Do not refresh the classhelper window using the ``F5`` key. This will | |
| 530 erase the contents of the window and you will have to close it and | |
| 531 invoke the link from the parent window again. | |
| 532 | |
| 443 Access Controls | 533 Access Controls |
| 444 --------------- | 534 --------------- |
| 445 | 535 |
| 446 User access is controlled through Permissions. These are are grouped | 536 User access is controlled through Permissions. These are are grouped |
| 447 into Roles, and users have a comma-separated list of Roles assigned to | 537 into Roles, and users have a comma-separated list of Roles assigned to |