Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 8255:7d72b9a9fe9c
docs: doc new types in user_guide; alphabetize types in reference.
user_guide.txt:
Removed Number from String and Number Properties. Added new Integer
and Number Properties sections to the user guide. Number Proprty
formats defined: no thousand separators, '.' decimal separator,
supports scientific 2E4 style input. Ordered in rough order of use.
reference.txt:
Alphabetized the types in the reference manual for easy lookup.
Fixed sentence on quiet property.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 01 Jan 2025 15:48:01 -0500 |
| parents | cae1bbf2536b |
| children | 2bf0c4e7795e |
comparison
equal
deleted
inserted
replaced
| 8254:c80de1b0dd83 | 8255:7d72b9a9fe9c |
|---|---|
| 112 All interfaces to your tracker use the same format for entering values. | 112 All interfaces to your tracker use the same format for entering values. |
| 113 This means the web interface for entering a new issue, the web interface | 113 This means the web interface for entering a new issue, the web interface |
| 114 for searching issues, the e-mail interface and even the command-line | 114 for searching issues, the e-mail interface and even the command-line |
| 115 administration tool. | 115 administration tool. |
| 116 | 116 |
| 117 String and Numeric properties | 117 String Properties |
| 118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 118 ~~~~~~~~~~~~~~~~~ |
| 119 | 119 |
| 120 These fields just take a plain text value, like ``It's broken``. | 120 These fields just take a plain text value, like ``It's broken``. |
| 121 | 121 |
| 122 Number Properties | |
| 123 ~~~~~~~~~~~~~~~~~ | |
| 124 | |
| 125 These fields take a real number with decimal point like ``+12456.78``, | |
| 126 ``-12456.78`` ``12456.78``. It supports scientific/exponent notation | |
| 127 like ``3.1415E-2``. Decimal commas (e.g. ``123456,78``) or thousand | |
| 128 separators ``-12,456.78`` are not supported. | |
| 129 | |
| 130 Integer Properties | |
| 131 ~~~~~~~~~~~~~~~~~~ | |
| 132 | |
| 133 These fields take a whole/integer number without decimal marker like | |
| 134 ``123``, ``+123``, ``-123``. Exponents are not supported. | |
| 122 | 135 |
| 123 Boolean properties | 136 Boolean properties |
| 124 ~~~~~~~~~~~~~~~~~~ | 137 ~~~~~~~~~~~~~~~~~~ |
| 125 | 138 |
| 126 These fields take a value which indicates "yes"/"no", "true"/"false", | 139 These fields take a value which indicates "yes"/"no", "true"/"false", |