Fossil SCM
Covered capability 7 in the forum.wiki document, and made several improvements to the "Using the Moderation Feature" section.
Commit
31631b756e08ae1e4840befe24541237d6a8ace3806d8cf52282294ff42d7fc6
Parent
3e75a683efb801f…
1 file changed
+47
-28
+47
-28
| --- www/forum.wiki | ||
| +++ www/forum.wiki | ||
| @@ -129,27 +129,32 @@ | ||
| 129 | 129 | for normal Fossil repository logins. |
| 130 | 130 | |
| 131 | 131 | There are several dedicated forum-related capability bits you can grant |
| 132 | 132 | a user: |
| 133 | 133 | |
| 134 | - * <b>Read Forum</b>: The user may read forum posts | |
| 135 | - | |
| 136 | - * <b>Write Forum</b>: The user may create new forum threads and reply | |
| 137 | - to existing threads. New posts are held for moderation. | |
| 138 | - | |
| 139 | - * <b>WriteTrusted Forum</b>: Same as <b>Write Forum</b> except that | |
| 140 | - posts are inserted into the block chain immediately without being held | |
| 141 | - for moderation. | |
| 142 | - | |
| 143 | - * <b>Moderate Forum</b>: User gets buttons on posts which allow them | |
| 144 | - to either delete or approve posts held for moderation. User also gets | |
| 145 | - access to a page (<tt>/modreq</tt>) showing the list of pending | |
| 146 | - moderation tasks. | |
| 147 | - | |
| 148 | - * <b>Supervise Forum</b>: User can grant or revoke | |
| 134 | + * <b>Read Forum</b> (<tt>2</tt>): The user may read forum posts. | |
| 135 | + | |
| 136 | + * <b>Write Forum</b> (<tt>3</tt>): The user may create new forum | |
| 137 | + threads, reply to existing threads, and edit their own posts. New | |
| 138 | + posts are held for moderation, and they are marked to prevent them | |
| 139 | + from being included in clone and sync operations. | |
| 140 | + | |
| 141 | + * <b>WriteTrusted Forum</b> (<tt>4</tt>): Same as <b>Write Forum</b> | |
| 142 | + except that forum updates bypass the [#moderation | moderation and | |
| 143 | + private artifact restrictions]. | |
| 144 | + | |
| 145 | + * <b>Moderate Forum</b> (<tt>5</tt>): User gets buttons on posts | |
| 146 | + which allow them to either reject or approve posts held for | |
| 147 | + moderation. User also gets access to a page (<tt>/modreq</tt>) | |
| 148 | + showing the list of pending moderation tasks. | |
| 149 | + | |
| 150 | + * <b>Supervise Forum</b> (<tt>6</tt>): User can grant or revoke | |
| 149 | 151 | <b>WriteTrusted</b> capability for other users. (Currently |
| 150 | 152 | unimplemented.) |
| 153 | + | |
| 154 | + * <b>Email Alerts</b> (<tt>7</tt>): User can sign themselves up for | |
| 155 | + email notifications, a.k.a. alerts. | |
| 151 | 156 | |
| 152 | 157 | By default, no Fossil user has permission to use the forums except for |
| 153 | 158 | users with Setup and Admin capabilities, which get these as part of the |
| 154 | 159 | large package of other capabilities they get. |
| 155 | 160 | |
| @@ -167,10 +172,22 @@ | ||
| 167 | 172 | For either type of repository, you are likely to want to give at least |
| 168 | 173 | the WriteTrusted capability (4) to users in the <tt>developer</tt> |
| 169 | 174 | category. If you did not give the Read Forum capability (2) to |
| 170 | 175 | <tt>anonymous</tt> above, you should give <tt>developer</tt> that |
| 171 | 176 | capability here if you choose to give it capability 3 or 4. |
| 177 | + | |
| 178 | +You must give at least one user or user category the Email Alerts | |
| 179 | +capability (7), else the only people able to sign themselves up for | |
| 180 | +email notifications are those with the Setup or Admin capability. Those | |
| 181 | +users could sign others up via Admin → Notification, but you | |
| 182 | +probably want to give this capability to one of the user categories. | |
| 183 | +Give it to <tt>nobody</tt> if you want anyone to sign up without any | |
| 184 | +restrictions. Give it to <tt>anonymous</tt> if you want the user to | |
| 185 | +solve a simple CAPTCHA before signing up. Give it to <tt>reader</tt> or | |
| 186 | +<tt>developer</tt> if you want only users with Fossil logins to have | |
| 187 | +this ability. (That's assuming you give one or both of these | |
| 188 | +capabilities to every user on your Fossil repository.) | |
| 172 | 189 | |
| 173 | 190 | By following this advice, you should not need to tediously add |
| 174 | 191 | capabilities to individual accounts except in atypical cases, such as |
| 175 | 192 | to grant the Moderate Forum capability (5) to an uncommonly |
| 176 | 193 | highly-trusted user. |
| @@ -526,25 +543,27 @@ | ||
| 526 | 543 | Having described all of the work that Fossil performs under the hood on |
| 527 | 544 | behalf of its users, we can now give the short list of work left for the |
| 528 | 545 | repository's administrators and moderators: |
| 529 | 546 | |
| 530 | 547 | <ol> |
| 531 | - <li>Add the <b>Moderate Forum</b> (<tt>5</tt>) capability to any of | |
| 548 | + <li>Add the <b>Moderate Forum</b> capability (<tt>5</tt>) to any of | |
| 532 | 549 | your users who should have this ability. You don't need to do this |
| 533 | 550 | for any user with Setup (<tt>s</tt>) or Admin (<tt>a</tt>) |
| 534 | 551 | capability; it's |
| 535 | 552 | [http://fossil-scm.org/index.html/artifact/b16221ffb736caa2?ln=1246-1257 |
| 536 | 553 | | already included].</li> |
| 537 | 554 | |
| 538 | - <li>When someone without <b>WriteTrusted Forum</b> (<tt>4</tt>) | |
| 539 | - capability submits a post, reply, or edit, an entry will appear on | |
| 540 | - the timeline if the type filter is set to "Forum" or "Any Type". A | |
| 541 | - notification will also appear on the <tt>/modreq</tt> page; a | |
| 542 | - moderator may wish to keep that page open in a browser tab, | |
| 543 | - reloading it occasionally to check for pending moderation | |
| 544 | - requests.</li> | |
| 545 | - | |
| 546 | - <li>A moderator viewing an unmoderated post sees two buttons at the | |
| 547 | - bottom, "Approve" and "Reject" in place of the "Delete" button that | |
| 548 | - the post's creator sees. Beware that both actions are durable and | |
| 549 | - have no undo. Be careful!</li> | |
| 555 | + <li>When someone updates the forum, an entry will appear in the | |
| 556 | + timeline if the type filter is set to "Forum" or "Any Type". If that | |
| 557 | + user has only the <b>Write Forum</b> capability (<tt>3</tt>), any | |
| 558 | + other user with the <b>Moderate Forum</b> capability (<tt>5</tt>) | |
| 559 | + will see a conditional link appear at the top of the main forum | |
| 560 | + page: "Moderation Requests". Clicking this takes the moderator to | |
| 561 | + the <tt>/modreq</tt> page. A moderator may wish to keep the main | |
| 562 | + forum page open in a browser tab, reloading it occasionally to see | |
| 563 | + when the "Moderation Requests" link reappears.</li> | |
| 564 | + | |
| 565 | + <li>A moderator viewing an update pending moderation sees two | |
| 566 | + buttons at the bottom, "Approve" and "Reject" in place of the | |
| 567 | + "Delete" button that the post's creator sees. Beware that both | |
| 568 | + actions are durable and have no undo. Be careful!</li> | |
| 550 | 569 | </ol> |
| 551 | 570 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -129,27 +129,32 @@ | |
| 129 | for normal Fossil repository logins. |
| 130 | |
| 131 | There are several dedicated forum-related capability bits you can grant |
| 132 | a user: |
| 133 | |
| 134 | * <b>Read Forum</b>: The user may read forum posts |
| 135 | |
| 136 | * <b>Write Forum</b>: The user may create new forum threads and reply |
| 137 | to existing threads. New posts are held for moderation. |
| 138 | |
| 139 | * <b>WriteTrusted Forum</b>: Same as <b>Write Forum</b> except that |
| 140 | posts are inserted into the block chain immediately without being held |
| 141 | for moderation. |
| 142 | |
| 143 | * <b>Moderate Forum</b>: User gets buttons on posts which allow them |
| 144 | to either delete or approve posts held for moderation. User also gets |
| 145 | access to a page (<tt>/modreq</tt>) showing the list of pending |
| 146 | moderation tasks. |
| 147 | |
| 148 | * <b>Supervise Forum</b>: User can grant or revoke |
| 149 | <b>WriteTrusted</b> capability for other users. (Currently |
| 150 | unimplemented.) |
| 151 | |
| 152 | By default, no Fossil user has permission to use the forums except for |
| 153 | users with Setup and Admin capabilities, which get these as part of the |
| 154 | large package of other capabilities they get. |
| 155 | |
| @@ -167,10 +172,22 @@ | |
| 167 | For either type of repository, you are likely to want to give at least |
| 168 | the WriteTrusted capability (4) to users in the <tt>developer</tt> |
| 169 | category. If you did not give the Read Forum capability (2) to |
| 170 | <tt>anonymous</tt> above, you should give <tt>developer</tt> that |
| 171 | capability here if you choose to give it capability 3 or 4. |
| 172 | |
| 173 | By following this advice, you should not need to tediously add |
| 174 | capabilities to individual accounts except in atypical cases, such as |
| 175 | to grant the Moderate Forum capability (5) to an uncommonly |
| 176 | highly-trusted user. |
| @@ -526,25 +543,27 @@ | |
| 526 | Having described all of the work that Fossil performs under the hood on |
| 527 | behalf of its users, we can now give the short list of work left for the |
| 528 | repository's administrators and moderators: |
| 529 | |
| 530 | <ol> |
| 531 | <li>Add the <b>Moderate Forum</b> (<tt>5</tt>) capability to any of |
| 532 | your users who should have this ability. You don't need to do this |
| 533 | for any user with Setup (<tt>s</tt>) or Admin (<tt>a</tt>) |
| 534 | capability; it's |
| 535 | [http://fossil-scm.org/index.html/artifact/b16221ffb736caa2?ln=1246-1257 |
| 536 | | already included].</li> |
| 537 | |
| 538 | <li>When someone without <b>WriteTrusted Forum</b> (<tt>4</tt>) |
| 539 | capability submits a post, reply, or edit, an entry will appear on |
| 540 | the timeline if the type filter is set to "Forum" or "Any Type". A |
| 541 | notification will also appear on the <tt>/modreq</tt> page; a |
| 542 | moderator may wish to keep that page open in a browser tab, |
| 543 | reloading it occasionally to check for pending moderation |
| 544 | requests.</li> |
| 545 | |
| 546 | <li>A moderator viewing an unmoderated post sees two buttons at the |
| 547 | bottom, "Approve" and "Reject" in place of the "Delete" button that |
| 548 | the post's creator sees. Beware that both actions are durable and |
| 549 | have no undo. Be careful!</li> |
| 550 | </ol> |
| 551 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -129,27 +129,32 @@ | |
| 129 | for normal Fossil repository logins. |
| 130 | |
| 131 | There are several dedicated forum-related capability bits you can grant |
| 132 | a user: |
| 133 | |
| 134 | * <b>Read Forum</b> (<tt>2</tt>): The user may read forum posts. |
| 135 | |
| 136 | * <b>Write Forum</b> (<tt>3</tt>): The user may create new forum |
| 137 | threads, reply to existing threads, and edit their own posts. New |
| 138 | posts are held for moderation, and they are marked to prevent them |
| 139 | from being included in clone and sync operations. |
| 140 | |
| 141 | * <b>WriteTrusted Forum</b> (<tt>4</tt>): Same as <b>Write Forum</b> |
| 142 | except that forum updates bypass the [#moderation | moderation and |
| 143 | private artifact restrictions]. |
| 144 | |
| 145 | * <b>Moderate Forum</b> (<tt>5</tt>): User gets buttons on posts |
| 146 | which allow them to either reject or approve posts held for |
| 147 | moderation. User also gets access to a page (<tt>/modreq</tt>) |
| 148 | showing the list of pending moderation tasks. |
| 149 | |
| 150 | * <b>Supervise Forum</b> (<tt>6</tt>): User can grant or revoke |
| 151 | <b>WriteTrusted</b> capability for other users. (Currently |
| 152 | unimplemented.) |
| 153 | |
| 154 | * <b>Email Alerts</b> (<tt>7</tt>): User can sign themselves up for |
| 155 | email notifications, a.k.a. alerts. |
| 156 | |
| 157 | By default, no Fossil user has permission to use the forums except for |
| 158 | users with Setup and Admin capabilities, which get these as part of the |
| 159 | large package of other capabilities they get. |
| 160 | |
| @@ -167,10 +172,22 @@ | |
| 172 | For either type of repository, you are likely to want to give at least |
| 173 | the WriteTrusted capability (4) to users in the <tt>developer</tt> |
| 174 | category. If you did not give the Read Forum capability (2) to |
| 175 | <tt>anonymous</tt> above, you should give <tt>developer</tt> that |
| 176 | capability here if you choose to give it capability 3 or 4. |
| 177 | |
| 178 | You must give at least one user or user category the Email Alerts |
| 179 | capability (7), else the only people able to sign themselves up for |
| 180 | email notifications are those with the Setup or Admin capability. Those |
| 181 | users could sign others up via Admin → Notification, but you |
| 182 | probably want to give this capability to one of the user categories. |
| 183 | Give it to <tt>nobody</tt> if you want anyone to sign up without any |
| 184 | restrictions. Give it to <tt>anonymous</tt> if you want the user to |
| 185 | solve a simple CAPTCHA before signing up. Give it to <tt>reader</tt> or |
| 186 | <tt>developer</tt> if you want only users with Fossil logins to have |
| 187 | this ability. (That's assuming you give one or both of these |
| 188 | capabilities to every user on your Fossil repository.) |
| 189 | |
| 190 | By following this advice, you should not need to tediously add |
| 191 | capabilities to individual accounts except in atypical cases, such as |
| 192 | to grant the Moderate Forum capability (5) to an uncommonly |
| 193 | highly-trusted user. |
| @@ -526,25 +543,27 @@ | |
| 543 | Having described all of the work that Fossil performs under the hood on |
| 544 | behalf of its users, we can now give the short list of work left for the |
| 545 | repository's administrators and moderators: |
| 546 | |
| 547 | <ol> |
| 548 | <li>Add the <b>Moderate Forum</b> capability (<tt>5</tt>) to any of |
| 549 | your users who should have this ability. You don't need to do this |
| 550 | for any user with Setup (<tt>s</tt>) or Admin (<tt>a</tt>) |
| 551 | capability; it's |
| 552 | [http://fossil-scm.org/index.html/artifact/b16221ffb736caa2?ln=1246-1257 |
| 553 | | already included].</li> |
| 554 | |
| 555 | <li>When someone updates the forum, an entry will appear in the |
| 556 | timeline if the type filter is set to "Forum" or "Any Type". If that |
| 557 | user has only the <b>Write Forum</b> capability (<tt>3</tt>), any |
| 558 | other user with the <b>Moderate Forum</b> capability (<tt>5</tt>) |
| 559 | will see a conditional link appear at the top of the main forum |
| 560 | page: "Moderation Requests". Clicking this takes the moderator to |
| 561 | the <tt>/modreq</tt> page. A moderator may wish to keep the main |
| 562 | forum page open in a browser tab, reloading it occasionally to see |
| 563 | when the "Moderation Requests" link reappears.</li> |
| 564 | |
| 565 | <li>A moderator viewing an update pending moderation sees two |
| 566 | buttons at the bottom, "Approve" and "Reject" in place of the |
| 567 | "Delete" button that the post's creator sees. Beware that both |
| 568 | actions are durable and have no undo. Be careful!</li> |
| 569 | </ol> |
| 570 |