Mercurial > p > roundup > code
comparison doc/customizing.txt @ 5064:46da0db55545
Document some existing property attributes
.. like 'do_journal' for Link/Multilink properties, this also adds
missing documentation for issue1444214.
| author | Ralf Schlatterbeck <rsc@runtux.com> |
|---|---|
| date | Tue, 10 May 2016 16:27:45 +0200 |
| parents | b8a04cce88ff |
| children | e424987d294a |
comparison
equal
deleted
inserted
replaced
| 5063:2840a9e86ef2 | 5064:46da0db55545 |
|---|---|
| 660 * A Link property refers to a single other item selected from a | 660 * A Link property refers to a single other item selected from a |
| 661 specified class. The class is part of the property; the value is an | 661 specified class. The class is part of the property; the value is an |
| 662 integer, the id of the chosen item. | 662 integer, the id of the chosen item. |
| 663 * A Multilink property refers to possibly many items in a specified | 663 * A Multilink property refers to possibly many items in a specified |
| 664 class. The value is a list of integers. | 664 class. The value is a list of integers. |
| 665 | |
| 666 Properties can have additional attributes to change the default | |
| 667 behaviour: | |
| 668 | |
| 669 * String properties can have an ``indexme`` attribute that defines if the | |
| 670 property should be part of the index. The default is 'yes' but this | |
| 671 can be set to 'no' to prevent a property from being indexed. | |
| 672 * Link and Multilink properties can have several attributes: | |
| 673 | |
| 674 - ``do_journal``: By default, every change of a link property is | |
| 675 recorded in the item being linked to (or being unlinked). A typical | |
| 676 use-case for setting ``do_journal='no'`` would be to turn off | |
| 677 journalling of nosy list, message author and message recipient link | |
| 678 and unlink events to prevent the journal from clogged with these | |
| 679 events. | |
| 680 - ``try_id_parsing`` is turned on by default. If entering a number | |
| 681 into a Link or Multilink field, roundup interprets this number as an | |
| 682 ID of the item to link to. Sometimes items can have numeric names | |
| 683 (like, e.g., product codes). For these roundup needs to match the | |
| 684 numeric name and should never match an ID. In this case you can set | |
| 685 ``try_id_parsing='no'``. | |
| 686 - The ``msg_header_property`` is used in the mail gateway when sending | |
| 687 out messages: By default roundup creates headers of the form:: | |
| 688 | |
| 689 X-Roundup-issue-prop: value | |
| 690 | |
| 691 for all properties prop of issue that have a ``name`` property. This | |
| 692 definition allows to override the name of the property used for | |
| 693 generating headers. A common use-case is adding a mail-header with | |
| 694 the ``assigned_to`` property to allow user mail-filtering of | |
| 695 issue-emails for which they're responsible. In that case setting:: | |
| 696 | |
| 697 msg_header_property="username" | |
| 698 | |
| 699 for the assigned_to property will generated message headers of the | |
| 700 form:: | |
| 701 | |
| 702 X-Roundup-issue-assigned_to: joe_user | |
| 703 | |
| 704 for issues where joe_user is the username of the person responsible | |
| 705 for this issue. | |
| 665 | 706 |
| 666 All Classes automatically have a number of properties by default: | 707 All Classes automatically have a number of properties by default: |
| 667 | 708 |
| 668 *creator* | 709 *creator* |
| 669 Link to the user that created the item. | 710 Link to the user that created the item. |