Fossil

Check-in [4326f76f]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Assorted tweaks and improvements to the new email alerts material in www/forum.wiki.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256:4326f76f7f3e99cbc343c559e8bb89ffe5664c61599b5f7ef8d4ba73f240169a
User & Date: wyoung 2018-08-12 03:00:03
Context
2018-08-12
03:21
Added the "Moderation" section to www/forum.wiki check-in: e06e7f84 user: wyoung tags: trunk
03:00
Assorted tweaks and improvements to the new email alerts material in www/forum.wiki. check-in: 4326f76f user: wyoung tags: trunk
02:47
Added the "Email Notification" section to the forum.wiki document. check-in: 6b275203 user: wyoung tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to www/forum.wiki.

355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
...
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
...
432
433
434
435
436
437
438






439
440
441
442
443
444
445

446
447
448

449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
login/logout link in the upper right corner, then go to "Email Alerts".)
You will need "Forum Posts" checked at the least for the testing steps
below.

If you use the same user name and email address as you used for your
normal user login, Fossil will simply tie your alert preferences to your
login, and it will be considered already-verified. Otherwise, Fossil
will create up an alert-only record, and you will have to verify the
email address before Fossil will send notifications to it.

This shows a key aspect of the way Fossil's email alerts system works,
by the way: a user can be signed up for email alerts without having a
full-fledged Fossil user account. Only when both user names are the same
are the two records tied together under the hood.


<h4>Test the Email Subsystem</h4>

If you'd rather not create an inane "testing" post in your Fossil
instance just to force out an email alert, we can check whether the
email subsystem separate from the rest of the Fossil Email Alerts system
is working with the following command:

<verbatim>
    $ fossil alerts test-message you@example.com --body README.md --subject Test
</verbatim>

That should send you an email with "Test" in the subject line and the
contents of your project's <tt>README.md</tt> file in the body. If it
................................................................................


<h4>Frist Post</h4>

Since you've already edited the skin per [#skin | the instructions
above], you can click the "Forum" link in the navbar and create a new
post. I suggest taking the time to compose a suitable introductory
message especially for your project's forum, suitable for pointing new
forum users at.

Wait a few seconds, and you should receive a notification email with the
post's subject and body text in the email.


<h4>Troubleshooting</h4>

................................................................................
</verbatim>

This should also kick off the backoffice processing, if there are any
pending alerts to send out.

<verbatim>
    $ fossil alert pending






    $ fossil test-add-alerts f5900
    $ fossil alert send
</verbatim>

If the first command gives no output and <tt>pending-alerts</tt> in the
earlier command is 0, the second command will add another alert, which
should shortly cause another notification email. The <tt>f</tt> in the

final parameter means you're scheduling a "forum" alert, and the integer
is the ID of a forum post, which you can find by visiting
<tt>/timeline?showid</tt> on your Fossil instance.


The third command above is necessary because the
<tt>test-add-alerts</tt> command doesn't kick off a backoffice run.

<verbatim>
    $ fossil ale send
</verbatim>

This only does the same thing as the final command above, rather than
send you an ale, as you might be hoping. Sorry.


<h2>Moderation</h2>

TODO







|
|










|
|
|







 







|
|







 







>
>
>
>
>
>




|
<
<
>
|
|
|
>

|













355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
...
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
...
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449


450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
login/logout link in the upper right corner, then go to "Email Alerts".)
You will need "Forum Posts" checked at the least for the testing steps
below.

If you use the same user name and email address as you used for your
normal user login, Fossil will simply tie your alert preferences to your
login, and it will be considered already-verified. Otherwise, Fossil
will create an alert-only record, and you will have to verify the email
address before Fossil will send notifications to it.

This shows a key aspect of the way Fossil's email alerts system works,
by the way: a user can be signed up for email alerts without having a
full-fledged Fossil user account. Only when both user names are the same
are the two records tied together under the hood.


<h4>Test the Email Subsystem</h4>

If you'd rather not create an inane "testing" post in your Fossil
instance just to force out an email alert, we can test the email
subsystem separately from the rest of the Fossil email alerts system
with the following command:

<verbatim>
    $ fossil alerts test-message you@example.com --body README.md --subject Test
</verbatim>

That should send you an email with "Test" in the subject line and the
contents of your project's <tt>README.md</tt> file in the body. If it
................................................................................


<h4>Frist Post</h4>

Since you've already edited the skin per [#skin | the instructions
above], you can click the "Forum" link in the navbar and create a new
post. I suggest taking the time to compose a suitable introductory
message especially for your project's forum, one which a new user would
find helpful.

Wait a few seconds, and you should receive a notification email with the
post's subject and body text in the email.


<h4>Troubleshooting</h4>

................................................................................
</verbatim>

This should also kick off the backoffice processing, if there are any
pending alerts to send out.

<verbatim>
    $ fossil alert pending
</verbatim>

Show any pending alerts. The number of lines output here should equal
the [#status | status output above].

<verbatim>
    $ fossil test-add-alerts f5900
    $ fossil alert send
</verbatim>

Manually create an email alert and push it out immediately.



The <tt>f</tt> in the first command's final parameter means you're
scheduling a "forum" alert. The integer is the ID of a forum post, which
you can find by visiting <tt>/timeline?showid</tt> on your Fossil
instance.

The second command above is necessary because the
<tt>test-add-alerts</tt> command doesn't kick off a backoffice run.

<verbatim>
    $ fossil ale send
</verbatim>

This only does the same thing as the final command above, rather than
send you an ale, as you might be hoping. Sorry.


<h2>Moderation</h2>

TODO