Mercurial > p > roundup > code
changeset 7276:90c70726e882
Fix: nested lists, wide example, wiki schema examples
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 24 Apr 2023 19:01:08 -0400 |
| parents | c5d01886b27d |
| children | 41b2a0e12899 |
| files | doc/customizing.txt |
| diffstat | 1 files changed, 39 insertions(+), 39 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/customizing.txt Mon Apr 24 17:51:49 2023 -0400 +++ b/doc/customizing.txt Mon Apr 24 19:01:08 2023 -0400 @@ -851,24 +851,24 @@ * All properties support the following attributes: - - ``required``: see `design documentation`_. Adds the property to - the list returned by calling get_required_props for the class. - - ``default_value``: see `design documentation`_ Sets the default - value if the property is not set. - - ``quiet``: see `design documentation`_. Suppresses user visible - to changes to this property. The property change is not reported: - - - in the change feedback/confirmation message in the web - interface - - the property change section of the nosy email - - the web history at the bottom of an item's page - - This can be used to store state of the user interface (e.g. the - names of elements that are collapsed or hidden from the - user). Making properties that are updated as an indirect result of - a user's change (e.g. updating a blockers property, counting - number of times an issue was reopened or reassigned etc.) should - not be displayed to the user as they can be confusing. + - ``required``: see `design documentation`_. Adds the property to + the list returned by calling get_required_props for the class. + - ``default_value``: see `design documentation`_ Sets the default + value if the property is not set. + - ``quiet``: see `design documentation`_. Suppresses user visible + to changes to this property. The property change is not reported: + + - in the change feedback/confirmation message in the web + interface + - the property change section of the nosy email + - the web history at the bottom of an item's page + + This can be used to store state of the user interface (e.g. the + names of elements that are collapsed or hidden from the + user). Making properties that are updated as an indirect result of + a user's change (e.g. updating a blockers property, counting + number of times an issue was reopened or reassigned etc.) should + not be displayed to the user as they can be confusing. .. index:: triple: schema; property attributes; indexme @@ -1091,21 +1091,20 @@ so again it allows a silent change. To do this you need to make two rest requests. An example using curl is:: - $ curl -u demo:demo -s - -H "X-requested-with: rest" \ - -H "Referer: https://tracker.example.com/demo/" \ - -X GET \ - https://tracker.example.com/demo/rest/data/file/30/content - { - "data": { - "id": "30", - "type": "<class 'str'>", - "link": "https://tracker.example.com/demo/rest/data/file/30/conten - t", - "data": "hello3", - "@etag": "\"3f2f8063dbce5b6bd43567e6f4f3c671\"" - } - } + $ curl -u demo:demo -s + -H "X-requested-with: rest" \ + -H "Referer: https://tracker.example.com/demo/" \ + -X GET \ + https://tracker.example.com/demo/rest/data/file/30/content + { + "data": { + "id": "30", + "type": "<class 'str'>", + "link": "https://tracker.example.com/demo/rest/data/file/30/content", + "data": "hello3", + "@etag": "\"3f2f8063dbce5b6bd43567e6f4f3c671\"" + } + } using the etag, overwrite the content with:: @@ -1254,11 +1253,12 @@ Some examples are in the :ref:`CustomExamples` section below. -Also the `Roundup wiki`_ has additional examples of how schemas can be -customised to add new functionality. - -.. _Roundup wiki: - https://wiki.roundup-tracker.org/ +Also you can start with `Roundup wiki CategorySchema`_ to see a list +of additional examples of how schemas can be customised to add new +functionality. + +.. _Roundup wiki CategorySchema: + https://wiki.roundup-tracker.org/CategorySchema .. index:: !detectors .. _detectors: @@ -1389,7 +1389,7 @@ The reason for this is that Microsoft Internet Explorer will not open things with a .eml attachment, as they deem it 'unsafe'. Worse yet, they'll just give you an incomprehensible error message. For more - information, see the detector code - it has a length explanation. + information, see the detector code - it has a lengthy explanation. .. index:: auditors; rules for use
