Fossil SCM

Improved documentation. No substantive code changes.

drh 2018-06-23 16:44 trunk
Commit 9cf915d4af14ec641d744b1e103f6bb029346351f48633c62cb96c926f7a4e71
Parent 17b4d3e49a3797f…
3 files changed +25 -6 +2 -1 +23
~ src/email.c ~ src/setup.c ~ www/emaildesign.md
M src/email.c
+25 -6
--- src/email.c
+++ src/email.c
@@ -152,11 +152,12 @@
152152
153153
154154
 /*
155155
 ** WEBPAGE: setup_email
156156
 **
157
-** Administrative page for configuring and controlling email notification
157
+** Administrative page for configuring and controlling email notification.
158
+** Normally accessible via the /Admin/Email menu.
158159
 */
159160
 void setup_email(void){
160161
 static const char *const azSendMethods[] = {
161162
 "off", "Disabled",
162163
 "pipe", "Pipe to a command",
@@ -812,12 +813,23 @@
812813
 ;
813814
814815
 /*
815816
 ** WEBPAGE: subscribe
816817
 **
817
-** Allow users to subscribe to email notifications, or to change or
818
-** verify their subscription.
818
+** Allow users to subscribe to email notifications.
819
+**
820
+** This page is usually run by users who are not logged in.
821
+** A logged-in user can add email notificates on the /alerts page.
822
+** Access to this page by a logged in user (other than an
823
+** administrator) results in a redirect to the /alerts page.
824
+**
825
+** Administrators can visit this page in order to sign up other
826
+** users.
827
+**
828
+** The Email-Alerts permission ("7") is required to access this
829
+** page. To allow anonymous passers-by to sign up for email
830
+** notification, set Email-Alerts on user "nobody" or "anonymous".
819831
 */
820832
 void subscribe_page(void){
821833
 int needCaptcha;
822834
 unsigned int uSeed;
823835
 const char *zDecoded;
@@ -1026,11 +1038,11 @@
10261038
 /*
10271039
 ** WEBPAGE: alerts
10281040
 **
10291041
 ** Edit email alert and notification settings.
10301042
 **
1031
-** The subscriber entry is identified in either of two ways:
1043
+** The subscriber is identified in either of two ways:
10321044
 **
10331045
 ** (1) The name= query parameter contains the subscriberCode.
10341046
 **
10351047
 ** (2) The user is logged into an account other than "nobody" or
10361048
 ** "anonymous". In that case the notification settings
@@ -1372,12 +1384,14 @@
13721384
13731385
 /*
13741386
 ** WEBPAGE: subscribers
13751387
 **
13761388
 ** This page, accessible to administrators only,
1377
-** shows a list of email notification email addresses with
1378
-** links to facilities for editing.
1389
+** shows a list of email notification email addresses.
1390
+** Clicking on an email takes one to the /alerts page
1391
+** for that email where the delivery settings can be
1392
+** modified.
13791393
 */
13801394
 void subscriber_list_page(void){
13811395
 Blob sql;
13821396
 Stmt q;
13831397
 login_check_credentials();
@@ -1582,10 +1596,15 @@
15821596
 ** Usage: %fossil test-add-alerts EVENTID ...
15831597
 **
15841598
 ** Add one or more events to the pending_alert queue. Use this
15851599
 ** command during testing to force email notifications for specific
15861600
 ** events.
1601
+**
1602
+** EVENTIDs are text. The first character is 'c', 'w', or 't'
1603
+** for check-in, wiki, or ticket. The remaining text is a
1604
+** integer that references the EVENT.OBJID value for the event.
1605
+** Run /timeline?showid to see these OBJID values.
15871606
 */
15881607
 void test_add_alert_cmd(void){
15891608
 int i;
15901609
 db_find_and_open_repository(0, 0);
15911610
 verify_all_options();
15921611
--- src/email.c
+++ src/email.c
@@ -152,11 +152,12 @@
152
153
154 /*
155 ** WEBPAGE: setup_email
156 **
157 ** Administrative page for configuring and controlling email notification
 
158 */
159 void setup_email(void){
160 static const char *const azSendMethods[] = {
161 "off", "Disabled",
162 "pipe", "Pipe to a command",
@@ -812,12 +813,23 @@
812 ;
813
814 /*
815 ** WEBPAGE: subscribe
816 **
817 ** Allow users to subscribe to email notifications, or to change or
818 ** verify their subscription.
 
 
 
 
 
 
 
 
 
 
 
819 */
820 void subscribe_page(void){
821 int needCaptcha;
822 unsigned int uSeed;
823 const char *zDecoded;
@@ -1026,11 +1038,11 @@
1026 /*
1027 ** WEBPAGE: alerts
1028 **
1029 ** Edit email alert and notification settings.
1030 **
1031 ** The subscriber entry is identified in either of two ways:
1032 **
1033 ** (1) The name= query parameter contains the subscriberCode.
1034 **
1035 ** (2) The user is logged into an account other than "nobody" or
1036 ** "anonymous". In that case the notification settings
@@ -1372,12 +1384,14 @@
1372
1373 /*
1374 ** WEBPAGE: subscribers
1375 **
1376 ** This page, accessible to administrators only,
1377 ** shows a list of email notification email addresses with
1378 ** links to facilities for editing.
 
 
1379 */
1380 void subscriber_list_page(void){
1381 Blob sql;
1382 Stmt q;
1383 login_check_credentials();
@@ -1582,10 +1596,15 @@
1582 ** Usage: %fossil test-add-alerts EVENTID ...
1583 **
1584 ** Add one or more events to the pending_alert queue. Use this
1585 ** command during testing to force email notifications for specific
1586 ** events.
 
 
 
 
 
1587 */
1588 void test_add_alert_cmd(void){
1589 int i;
1590 db_find_and_open_repository(0, 0);
1591 verify_all_options();
1592
--- src/email.c
+++ src/email.c
@@ -152,11 +152,12 @@
152
153
154 /*
155 ** WEBPAGE: setup_email
156 **
157 ** Administrative page for configuring and controlling email notification.
158 ** Normally accessible via the /Admin/Email menu.
159 */
160 void setup_email(void){
161 static const char *const azSendMethods[] = {
162 "off", "Disabled",
163 "pipe", "Pipe to a command",
@@ -812,12 +813,23 @@
813 ;
814
815 /*
816 ** WEBPAGE: subscribe
817 **
818 ** Allow users to subscribe to email notifications.
819 **
820 ** This page is usually run by users who are not logged in.
821 ** A logged-in user can add email notificates on the /alerts page.
822 ** Access to this page by a logged in user (other than an
823 ** administrator) results in a redirect to the /alerts page.
824 **
825 ** Administrators can visit this page in order to sign up other
826 ** users.
827 **
828 ** The Email-Alerts permission ("7") is required to access this
829 ** page. To allow anonymous passers-by to sign up for email
830 ** notification, set Email-Alerts on user "nobody" or "anonymous".
831 */
832 void subscribe_page(void){
833 int needCaptcha;
834 unsigned int uSeed;
835 const char *zDecoded;
@@ -1026,11 +1038,11 @@
1038 /*
1039 ** WEBPAGE: alerts
1040 **
1041 ** Edit email alert and notification settings.
1042 **
1043 ** The subscriber is identified in either of two ways:
1044 **
1045 ** (1) The name= query parameter contains the subscriberCode.
1046 **
1047 ** (2) The user is logged into an account other than "nobody" or
1048 ** "anonymous". In that case the notification settings
@@ -1372,12 +1384,14 @@
1384
1385 /*
1386 ** WEBPAGE: subscribers
1387 **
1388 ** This page, accessible to administrators only,
1389 ** shows a list of email notification email addresses.
1390 ** Clicking on an email takes one to the /alerts page
1391 ** for that email where the delivery settings can be
1392 ** modified.
1393 */
1394 void subscriber_list_page(void){
1395 Blob sql;
1396 Stmt q;
1397 login_check_credentials();
@@ -1582,10 +1596,15 @@
1596 ** Usage: %fossil test-add-alerts EVENTID ...
1597 **
1598 ** Add one or more events to the pending_alert queue. Use this
1599 ** command during testing to force email notifications for specific
1600 ** events.
1601 **
1602 ** EVENTIDs are text. The first character is 'c', 'w', or 't'
1603 ** for check-in, wiki, or ticket. The remaining text is a
1604 ** integer that references the EVENT.OBJID value for the event.
1605 ** Run /timeline?showid to see these OBJID values.
1606 */
1607 void test_add_alert_cmd(void){
1608 int i;
1609 db_find_and_open_repository(0, 0);
1610 verify_all_options();
1611
M src/setup.c
+2 -1
--- src/setup.c
+++ src/setup.c
@@ -362,12 +362,13 @@
362362
 @ <td><i>Forum-Trusted:</i> Add pre-approved forum posts </td></tr>
363363
 @ <tr><th valign="top">5</th>
364364
 @ <td><i>Forum-Moderator:</i> Approve or disapprove forum posts</td></tr>
365365
 @ <tr><th valign="top">6</th>
366366
 @ <td><i>Forum-Supervisor:</i> \
367
+ @ Forum administrator
367368
 @ <tr><th valign="top">7</th>
368
- @ <td><i>Email-Notify:</i> \
369
+ @ <td><i>Email-Alerts:</i> \
369370
 @ Sign up for email notifications</td></tr>
370371
 @ </table>
371372
 }
372373
373374
 /*
374375
--- src/setup.c
+++ src/setup.c
@@ -362,12 +362,13 @@
362 @ <td><i>Forum-Trusted:</i> Add pre-approved forum posts </td></tr>
363 @ <tr><th valign="top">5</th>
364 @ <td><i>Forum-Moderator:</i> Approve or disapprove forum posts</td></tr>
365 @ <tr><th valign="top">6</th>
366 @ <td><i>Forum-Supervisor:</i> \
 
367 @ <tr><th valign="top">7</th>
368 @ <td><i>Email-Notify:</i> \
369 @ Sign up for email notifications</td></tr>
370 @ </table>
371 }
372
373 /*
374
--- src/setup.c
+++ src/setup.c
@@ -362,12 +362,13 @@
362 @ <td><i>Forum-Trusted:</i> Add pre-approved forum posts </td></tr>
363 @ <tr><th valign="top">5</th>
364 @ <td><i>Forum-Moderator:</i> Approve or disapprove forum posts</td></tr>
365 @ <tr><th valign="top">6</th>
366 @ <td><i>Forum-Supervisor:</i> \
367 @ Forum administrator
368 @ <tr><th valign="top">7</th>
369 @ <td><i>Email-Alerts:</i> \
370 @ Sign up for email notifications</td></tr>
371 @ </table>
372 }
373
374 /*
375
M www/emaildesign.md
+23
--- www/emaildesign.md
+++ www/emaildesign.md
@@ -105,5 +105,28 @@
105105
106106
 Inbound email messages (for example bounces from failed notification
107107
 emails) should be relayed to the "fossil email inbound" command. That
108108
 command is currently a no-op place-holder. At some point, we will need
109109
 to design and write a bounce-message processing system for Fossil.
110
+
111
+Controlling The Setup
112
+---------------------
113
+
114
+Commands:
115
+
116
+ * The [email](/help?cmd=email) command
117
+
118
+Web pages:
119
+
120
+ * The [/subscribe](/help?cmd=/subscribe) page
121
+ * The [/alerts](/help?cmd=/alerts) page
122
+ * The [/unsubscribe](/help?cmd=/unsubscribe) page
123
+
124
+Web pages for administrators only:
125
+
126
+ * The [/setup_email](/help?cmd=/setup_email) page
127
+ * The [/subscribers](/help?cmd=/subscribers) page
128
+
129
+Test command:
130
+
131
+ * The [test-alert](/help?cmd=test-alert) command
132
+ * The [test-add-alerts](/help?cmd=test-add-alerts) command
110133
--- www/emaildesign.md
+++ www/emaildesign.md
@@ -105,5 +105,28 @@
105
106 Inbound email messages (for example bounces from failed notification
107 emails) should be relayed to the "fossil email inbound" command. That
108 command is currently a no-op place-holder. At some point, we will need
109 to design and write a bounce-message processing system for Fossil.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
110
--- www/emaildesign.md
+++ www/emaildesign.md
@@ -105,5 +105,28 @@
105
106 Inbound email messages (for example bounces from failed notification
107 emails) should be relayed to the "fossil email inbound" command. That
108 command is currently a no-op place-holder. At some point, we will need
109 to design and write a bounce-message processing system for Fossil.
110
111 Controlling The Setup
112 ---------------------
113
114 Commands:
115
116 * The [email](/help?cmd=email) command
117
118 Web pages:
119
120 * The [/subscribe](/help?cmd=/subscribe) page
121 * The [/alerts](/help?cmd=/alerts) page
122 * The [/unsubscribe](/help?cmd=/unsubscribe) page
123
124 Web pages for administrators only:
125
126 * The [/setup_email](/help?cmd=/setup_email) page
127 * The [/subscribers](/help?cmd=/subscribers) page
128
129 Test command:
130
131 * The [test-alert](/help?cmd=test-alert) command
132 * The [test-add-alerts](/help?cmd=test-add-alerts) command
133

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button