Mercurial > p > roundup > code
comparison doc/admin_guide.txt @ 7976:adc3db39cb53
docs: more cleanups
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 21 May 2024 20:13:18 -0400 |
| parents | 16c2e2849fd6 |
| children | d3c0d3c9f5e7 |
comparison
equal
deleted
inserted
replaced
| 7975:16c2e2849fd6 | 7976:adc3db39cb53 |
|---|---|
| 640 data-search-with: | 640 data-search-with: |
| 641 * this attribute is optional. If it is not set, a search | 641 * this attribute is optional. If it is not set, a search |
| 642 panel is not created to allow the user to search within | 642 panel is not created to allow the user to search within |
| 643 the class. | 643 the class. |
| 644 * Adding ``data-search-with`` specifies the fields that can | 644 * Adding ``data-search-with`` specifies the fields that can |
| 645 be used for searching. | 645 be used for searching. For example when invoking the |
| 646 E.G. ``data-search-with="title,status,keyword"`` | 646 classhelper for the issue class, using |
| 647 ``data-search-with="title,status,keyword"`` wil enable | |
| 648 three search fields. | |
| 647 * The search can be customized using the following syntax: | 649 * The search can be customized using the following syntax: |
| 648 | 650 |
| 649 * Adding ``[]`` at then end of a field (``"status[]"``) | 651 * Adding ``[]`` at then end of a field (``"status[]"``) |
| 650 will displays a dropdown for the "status" field | 652 will displays a dropdown for the "status" field |
| 651 listing all the values the user can access. E.G.:: | 653 listing all the values the user can access. E.G.:: |
| 666 example ``keyword[]+name`` sorts the keyword | 668 example ``keyword[]+name`` sorts the keyword |
| 667 dropdown in ascending order by name. While | 669 dropdown in ascending order by name. While |
| 668 ``keyword[]-name`` sorts the keyword dropdown in | 670 ``keyword[]-name`` sorts the keyword dropdown in |
| 669 descending order by name. If the sort order is not | 671 descending order by name. If the sort order is not |
| 670 specified, the default order for the class is used. | 672 specified, the default order for the class is used. |
| 671 | |
| 672 .. : | |
| 673 remove in 2.5 release if /data/user/roles endpoint | |
| 674 in rest.py is successful. | |
| 675 | |
| 676 * Note that the ``roles`` field for the user class is | |
| 677 special. If you have not modified ``interfaces.py``, | |
| 678 roles can not be displayed as a dropdown. It will be | |
| 679 displayed as a text search field instead. | |
| 680 | 673 |
| 681 <roundup-classhelper> styling | 674 <roundup-classhelper> styling |
| 682 ----------------------------- | 675 ----------------------------- |
| 683 | 676 |
| 684 The roundup-classhelper component uses minimal styling so it | 677 The roundup-classhelper component uses minimal styling so it |