Fossil SCM
Added the "How Moderation Works" section to www/forum.wiki, and improved the newly-renamed "Using the Moderation Feature" section as a result.
Commit
812dd52c7d5e305d7f974417f54888f820baf61b3cf7117d4daebb2612fd2247
Parent
03c298dcb9deab7…
1 file changed
+70
-16
+70
-16
| --- www/forum.wiki | ||
| +++ www/forum.wiki | ||
| @@ -337,13 +337,13 @@ | ||
| 337 | 337 | |
| 338 | 338 | <a id="status"></a>If you reload the Email Notification Setup page, the |
| 339 | 339 | Status section at the top should show: |
| 340 | 340 | |
| 341 | 341 | <verbatim> |
| 342 | - Outgoing Email: Piped to command "sendmail -t" | |
| 343 | - Pending Alerts: 0 normal, 0 digest | |
| 344 | - Subscribers: 0 active, 0 total | |
| 342 | + Outgoing Email: Piped to command "sendmail -t" | |
| 343 | + Pending Alerts: 0 normal, 0 digest | |
| 344 | + Subscribers: 0 active, 0 total | |
| 345 | 345 | </verbatim> |
| 346 | 346 | |
| 347 | 347 | |
| 348 | 348 | <h4 id="subscribe">Subscribe to Alerts</h4> |
| 349 | 349 | |
| @@ -462,13 +462,67 @@ | ||
| 462 | 462 | |
| 463 | 463 | This only does the same thing as the final command above, rather than |
| 464 | 464 | send you an ale, as you might be hoping. Sorry. |
| 465 | 465 | |
| 466 | 466 | |
| 467 | -<h2 id="moderation">Moderation</h2> | |
| 467 | +<h2 id="moderation">How Moderation Works</h2> | |
| 468 | + | |
| 469 | +When a person with the normal <b>Write Forum</b> capability (<tt>3</tt>) | |
| 470 | +either: | |
| 471 | + | |
| 472 | + * creates a new post, or | |
| 473 | + * replies to an existing post, or | |
| 474 | + * edits a post/reply | |
| 475 | + | |
| 476 | +...the new content is saved into Fossil's block chain, but two special | |
| 477 | +things happen to it: | |
| 478 | + | |
| 479 | +<ol> | |
| 480 | + <li>The artifact's ID is saved to the <tt>private</tt> table, | |
| 481 | + preventing Fossil from sending such artifacts to any of the | |
| 482 | + repository's clones. (This is the same mechanism behind | |
| 483 | + [./private.wiki | private branches].)</li> | |
| 484 | + | |
| 485 | + <li>A reference to that artifact is saved in the <tt>modreq</tt> | |
| 486 | + table, which backs the moderation feature. This is what causes | |
| 487 | + Fossil to leave out the Reply button when rendering that post's HTML | |
| 488 | + in the forum's web interface.</li> | |
| 489 | +</ol> | |
| 490 | + | |
| 491 | +When a moderator approves a post, Fossil deletes these references in the | |
| 492 | +<tt>private</tt> and <tt>modreq</tt> tables so that the contribution is | |
| 493 | +effectively written semi-permanently into the Fossil block chain. The | |
| 494 | +artifact will now sync to clones, if the clone is done by a user with | |
| 495 | +<b>Check-Out</b> capability (<tt>o</tt>). | |
| 496 | + | |
| 497 | +When a forum user edits a moderator-approved artifact, what actually | |
| 498 | +happens under the hood is that Fossil writes another artifact to the | |
| 499 | +repository which refers to the original version as its parent, causing | |
| 500 | +Fossil UI to present the new version instead of the original. The | |
| 501 | +original version remains in the repository, just as with historical | |
| 502 | +checkins. The parent must remain in the repository for referential | |
| 503 | +integrity purposes. | |
| 504 | + | |
| 505 | +When you "Delete" such content through Fossil UI, it's actually an edit | |
| 506 | +with blank content. The only way to truly delete such artifacts is | |
| 507 | +through [./shunning.wiki | shunning]. | |
| 508 | + | |
| 509 | +When a post is made by a user with <b>WriteTrusted Forum</b> capability | |
| 510 | +(<tt>4</tt>), it is posted in the same way, just with the | |
| 511 | +<tt>private</tt> and <tt>modreq</tt> table insertions skipped. | |
| 512 | + | |
| 513 | +When a moderator rejects a post, reply, or edit, that artifact is | |
| 514 | +unceremoniously removed from the tip of the block chain. This is safe | |
| 515 | +since such a post cannot have any replies, so there will be no other | |
| 516 | +artifacts referring to it. | |
| 517 | + | |
| 518 | + | |
| 519 | +<h2 id="mod-user">Using the Moderation Feature</h2> | |
| 468 | 520 | |
| 469 | -Fossil forum moderation is easy: | |
| 521 | +All of the above is work performed under the hood by Fossil on behalf of | |
| 522 | +its users. There is little work left for the administrators and | |
| 523 | +moderators of the repository: | |
| 470 | 524 | |
| 471 | 525 | <ol> |
| 472 | 526 | <li>Add the <b>Moderate Forum</b> (<tt>5</tt>) capability to any of |
| 473 | 527 | your users who should have this ability. You don't need to do this |
| 474 | 528 | for any user with Setup (<tt>s</tt>) or Admin (<tt>a</tt>) |
| @@ -475,17 +529,17 @@ | ||
| 475 | 529 | capability; it's |
| 476 | 530 | [http://fossil-scm.org/index.html/artifact/b16221ffb736caa2?ln=1246-1257 |
| 477 | 531 | | already included].</li> |
| 478 | 532 | |
| 479 | 533 | <li>When someone without <b>WriteTrusted Forum</b> (<tt>4</tt>) |
| 480 | - capability submits a post, you'll get a notice on the timeline if | |
| 481 | - the type filter is set to "Forum" or "Any Type". It will also appear | |
| 482 | - on the <tt>/modreq</tt> page; you might want to keep that page open | |
| 483 | - in a tab in your browser, and reload it occasionally to check for | |
| 484 | - pending moderation requests.</li> | |
| 485 | - | |
| 486 | - <li>On an unmoderated post, click the "Approve" or "Reject" button. | |
| 487 | - "Approve" writes the message semi-permanently into the Fossil | |
| 488 | - blockchain, from which only [./shunning.wiki | shunning] can remove | |
| 489 | - it. "Reject" deletes the post permanently, with no way to retrieve | |
| 490 | - it. Be careful!</li> | |
| 534 | + capability submits a post, reply, or edit, an entry will appear on | |
| 535 | + the timeline if the type filter is set to "Forum" or "Any Type". A | |
| 536 | + notification will also appear on the <tt>/modreq</tt> page; a | |
| 537 | + moderator may wish to keep that page open in a browser tab, | |
| 538 | + reloading it occasionally to check for pending moderation | |
| 539 | + requests.</li> | |
| 540 | + | |
| 541 | + <li>A moderator viewing an unmoderated post sees two buttons at the | |
| 542 | + bottom, "Approve" and "Reject" in place of the "Delete" button that | |
| 543 | + the post's creator sees. Beware that both actions are durable and | |
| 544 | + have no undo. Be careful!</li> | |
| 491 | 545 | </ol> |
| 492 | 546 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -337,13 +337,13 @@ | |
| 337 | |
| 338 | <a id="status"></a>If you reload the Email Notification Setup page, the |
| 339 | Status section at the top should show: |
| 340 | |
| 341 | <verbatim> |
| 342 | Outgoing Email: Piped to command "sendmail -t" |
| 343 | Pending Alerts: 0 normal, 0 digest |
| 344 | Subscribers: 0 active, 0 total |
| 345 | </verbatim> |
| 346 | |
| 347 | |
| 348 | <h4 id="subscribe">Subscribe to Alerts</h4> |
| 349 | |
| @@ -462,13 +462,67 @@ | |
| 462 | |
| 463 | This only does the same thing as the final command above, rather than |
| 464 | send you an ale, as you might be hoping. Sorry. |
| 465 | |
| 466 | |
| 467 | <h2 id="moderation">Moderation</h2> |
| 468 | |
| 469 | Fossil forum moderation is easy: |
| 470 | |
| 471 | <ol> |
| 472 | <li>Add the <b>Moderate Forum</b> (<tt>5</tt>) capability to any of |
| 473 | your users who should have this ability. You don't need to do this |
| 474 | for any user with Setup (<tt>s</tt>) or Admin (<tt>a</tt>) |
| @@ -475,17 +529,17 @@ | |
| 475 | capability; it's |
| 476 | [http://fossil-scm.org/index.html/artifact/b16221ffb736caa2?ln=1246-1257 |
| 477 | | already included].</li> |
| 478 | |
| 479 | <li>When someone without <b>WriteTrusted Forum</b> (<tt>4</tt>) |
| 480 | capability submits a post, you'll get a notice on the timeline if |
| 481 | the type filter is set to "Forum" or "Any Type". It will also appear |
| 482 | on the <tt>/modreq</tt> page; you might want to keep that page open |
| 483 | in a tab in your browser, and reload it occasionally to check for |
| 484 | pending moderation requests.</li> |
| 485 | |
| 486 | <li>On an unmoderated post, click the "Approve" or "Reject" button. |
| 487 | "Approve" writes the message semi-permanently into the Fossil |
| 488 | blockchain, from which only [./shunning.wiki | shunning] can remove |
| 489 | it. "Reject" deletes the post permanently, with no way to retrieve |
| 490 | it. Be careful!</li> |
| 491 | </ol> |
| 492 |
| --- www/forum.wiki | |
| +++ www/forum.wiki | |
| @@ -337,13 +337,13 @@ | |
| 337 | |
| 338 | <a id="status"></a>If you reload the Email Notification Setup page, the |
| 339 | Status section at the top should show: |
| 340 | |
| 341 | <verbatim> |
| 342 | Outgoing Email: Piped to command "sendmail -t" |
| 343 | Pending Alerts: 0 normal, 0 digest |
| 344 | Subscribers: 0 active, 0 total |
| 345 | </verbatim> |
| 346 | |
| 347 | |
| 348 | <h4 id="subscribe">Subscribe to Alerts</h4> |
| 349 | |
| @@ -462,13 +462,67 @@ | |
| 462 | |
| 463 | This only does the same thing as the final command above, rather than |
| 464 | send you an ale, as you might be hoping. Sorry. |
| 465 | |
| 466 | |
| 467 | <h2 id="moderation">How Moderation Works</h2> |
| 468 | |
| 469 | When a person with the normal <b>Write Forum</b> capability (<tt>3</tt>) |
| 470 | either: |
| 471 | |
| 472 | * creates a new post, or |
| 473 | * replies to an existing post, or |
| 474 | * edits a post/reply |
| 475 | |
| 476 | ...the new content is saved into Fossil's block chain, but two special |
| 477 | things happen to it: |
| 478 | |
| 479 | <ol> |
| 480 | <li>The artifact's ID is saved to the <tt>private</tt> table, |
| 481 | preventing Fossil from sending such artifacts to any of the |
| 482 | repository's clones. (This is the same mechanism behind |
| 483 | [./private.wiki | private branches].)</li> |
| 484 | |
| 485 | <li>A reference to that artifact is saved in the <tt>modreq</tt> |
| 486 | table, which backs the moderation feature. This is what causes |
| 487 | Fossil to leave out the Reply button when rendering that post's HTML |
| 488 | in the forum's web interface.</li> |
| 489 | </ol> |
| 490 | |
| 491 | When a moderator approves a post, Fossil deletes these references in the |
| 492 | <tt>private</tt> and <tt>modreq</tt> tables so that the contribution is |
| 493 | effectively written semi-permanently into the Fossil block chain. The |
| 494 | artifact will now sync to clones, if the clone is done by a user with |
| 495 | <b>Check-Out</b> capability (<tt>o</tt>). |
| 496 | |
| 497 | When a forum user edits a moderator-approved artifact, what actually |
| 498 | happens under the hood is that Fossil writes another artifact to the |
| 499 | repository which refers to the original version as its parent, causing |
| 500 | Fossil UI to present the new version instead of the original. The |
| 501 | original version remains in the repository, just as with historical |
| 502 | checkins. The parent must remain in the repository for referential |
| 503 | integrity purposes. |
| 504 | |
| 505 | When you "Delete" such content through Fossil UI, it's actually an edit |
| 506 | with blank content. The only way to truly delete such artifacts is |
| 507 | through [./shunning.wiki | shunning]. |
| 508 | |
| 509 | When a post is made by a user with <b>WriteTrusted Forum</b> capability |
| 510 | (<tt>4</tt>), it is posted in the same way, just with the |
| 511 | <tt>private</tt> and <tt>modreq</tt> table insertions skipped. |
| 512 | |
| 513 | When a moderator rejects a post, reply, or edit, that artifact is |
| 514 | unceremoniously removed from the tip of the block chain. This is safe |
| 515 | since such a post cannot have any replies, so there will be no other |
| 516 | artifacts referring to it. |
| 517 | |
| 518 | |
| 519 | <h2 id="mod-user">Using the Moderation Feature</h2> |
| 520 | |
| 521 | All of the above is work performed under the hood by Fossil on behalf of |
| 522 | its users. There is little work left for the administrators and |
| 523 | moderators of the repository: |
| 524 | |
| 525 | <ol> |
| 526 | <li>Add the <b>Moderate Forum</b> (<tt>5</tt>) capability to any of |
| 527 | your users who should have this ability. You don't need to do this |
| 528 | for any user with Setup (<tt>s</tt>) or Admin (<tt>a</tt>) |
| @@ -475,17 +529,17 @@ | |
| 529 | capability; it's |
| 530 | [http://fossil-scm.org/index.html/artifact/b16221ffb736caa2?ln=1246-1257 |
| 531 | | already included].</li> |
| 532 | |
| 533 | <li>When someone without <b>WriteTrusted Forum</b> (<tt>4</tt>) |
| 534 | capability submits a post, reply, or edit, an entry will appear on |
| 535 | the timeline if the type filter is set to "Forum" or "Any Type". A |
| 536 | notification will also appear on the <tt>/modreq</tt> page; a |
| 537 | moderator may wish to keep that page open in a browser tab, |
| 538 | reloading it occasionally to check for pending moderation |
| 539 | requests.</li> |
| 540 | |
| 541 | <li>A moderator viewing an unmoderated post sees two buttons at the |
| 542 | bottom, "Approve" and "Reject" in place of the "Delete" button that |
| 543 | the post's creator sees. Beware that both actions are durable and |
| 544 | have no undo. Be careful!</li> |
| 545 | </ol> |
| 546 |