Fossil SCM
Add initial docs for forum statuses to www/forum.wiki.
Commit
39e97fc0284029de994d90ed47d3c8ecab318b48f9042aa8ce8a240d9f424bd2
Parent
aec2127bedf1441…
1 file changed
+43
+43
| --- www/forum.wiki | ||
| +++ www/forum.wiki | ||
| @@ -407,5 +407,48 @@ | ||
| 407 | 407 | not permitted, without appropriate permissions, to close their own |
| 408 | 408 | posts. This is intentional, as closing one's own post can be used to |
| 409 | 409 | antagonize other forum users. For example, by posting something |
| 410 | 410 | trollish or highly controversial in nature and closing the post to |
| 411 | 411 | further responses. |
| 412 | + | |
| 413 | +<h2 name="status">Setting Post Statuses</h2> | |
| 414 | + | |
| 415 | +The setting <tt>forum-statuses</tt> controls whether this feature is | |
| 416 | +is abled. If it is not set, is not valid JSON5, or has only a single | |
| 417 | +entry, then status are not shown in the forum. | |
| 418 | + | |
| 419 | +<tt>forum-statuses</tt> is a JSON5-format array of objects in the | |
| 420 | +following format: | |
| 421 | + | |
| 422 | +<verbatim> | |
| 423 | +[ | |
| 424 | + {label:"Open", value:"open", description:"Unresolved posts"}, | |
| 425 | + {label:"Resolved", value:"resolved", description:"Resolved posts"} | |
| 426 | + ... | |
| 427 | +]</verbatim> | |
| 428 | + | |
| 429 | +The list defines the legal statuses for forum posts and syncs with | |
| 430 | +other project-level settings. All "label" and "value" members must be | |
| 431 | +unique. | |
| 432 | + | |
| 433 | +If the list has two or more entries then the forum behavior changes in | |
| 434 | +the following ways: | |
| 435 | + | |
| 436 | + * The root of each thread, when selected, gets a new UI control for | |
| 437 | + displaying or editing the status, depending on permissions. | |
| 438 | + * The forum list shows the "label" value of the current status. | |
| 439 | + | |
| 440 | +This is managed via a <tt>status</tt> tag on the first version of | |
| 441 | +that post. That tag may be set to any value from the "values" members | |
| 442 | +of the <tt>forum-statuses</tt> list. | |
| 443 | + | |
| 444 | +Status tag rules: | |
| 445 | + | |
| 446 | + * <tt>status</tt> is only observed on the root of each thread. The UI | |
| 447 | + does nothing with that tag on responses. | |
| 448 | + * The tag is applied only to the first version of any given post. The | |
| 449 | + UI ensures that the tag is applied to the proper post, even when | |
| 450 | + it is rendering a newer version. | |
| 451 | + * The first list entry is considered to be the default status. Any post | |
| 452 | + which has a <tt>status</tt> tag value which is not in the | |
| 453 | + list, or which has no <tt>status</tt> tag, is assumed for most | |
| 454 | + purposes to have the value of the first entry in the list. | |
| 412 | 455 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -407,5 +407,48 @@ | |
| 407 | not permitted, without appropriate permissions, to close their own |
| 408 | posts. This is intentional, as closing one's own post can be used to |
| 409 | antagonize other forum users. For example, by posting something |
| 410 | trollish or highly controversial in nature and closing the post to |
| 411 | further responses. |
| 412 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -407,5 +407,48 @@ | |
| 407 | not permitted, without appropriate permissions, to close their own |
| 408 | posts. This is intentional, as closing one's own post can be used to |
| 409 | antagonize other forum users. For example, by posting something |
| 410 | trollish or highly controversial in nature and closing the post to |
| 411 | further responses. |
| 412 | |
| 413 | <h2 name="status">Setting Post Statuses</h2> |
| 414 | |
| 415 | The setting <tt>forum-statuses</tt> controls whether this feature is |
| 416 | is abled. If it is not set, is not valid JSON5, or has only a single |
| 417 | entry, then status are not shown in the forum. |
| 418 | |
| 419 | <tt>forum-statuses</tt> is a JSON5-format array of objects in the |
| 420 | following format: |
| 421 | |
| 422 | <verbatim> |
| 423 | [ |
| 424 | {label:"Open", value:"open", description:"Unresolved posts"}, |
| 425 | {label:"Resolved", value:"resolved", description:"Resolved posts"} |
| 426 | ... |
| 427 | ]</verbatim> |
| 428 | |
| 429 | The list defines the legal statuses for forum posts and syncs with |
| 430 | other project-level settings. All "label" and "value" members must be |
| 431 | unique. |
| 432 | |
| 433 | If the list has two or more entries then the forum behavior changes in |
| 434 | the following ways: |
| 435 | |
| 436 | * The root of each thread, when selected, gets a new UI control for |
| 437 | displaying or editing the status, depending on permissions. |
| 438 | * The forum list shows the "label" value of the current status. |
| 439 | |
| 440 | This is managed via a <tt>status</tt> tag on the first version of |
| 441 | that post. That tag may be set to any value from the "values" members |
| 442 | of the <tt>forum-statuses</tt> list. |
| 443 | |
| 444 | Status tag rules: |
| 445 | |
| 446 | * <tt>status</tt> is only observed on the root of each thread. The UI |
| 447 | does nothing with that tag on responses. |
| 448 | * The tag is applied only to the first version of any given post. The |
| 449 | UI ensures that the tag is applied to the proper post, even when |
| 450 | it is rendering a newer version. |
| 451 | * The first list entry is considered to be the default status. Any post |
| 452 | which has a <tt>status</tt> tag value which is not in the |
| 453 | list, or which has no <tt>status</tt> tag, is assumed for most |
| 454 | purposes to have the value of the first entry in the list. |
| 455 |