Fossil SCM

Add documentation for chat-timeline-user.

drh 2022-09-15 17:11 trunk
Commit 24c71dfb1ea93f0cdaa8e8dbc8d0a18943c46142c73389ec4c6bb0d1b578e62a
2 files changed +6 -3 +12
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,13 +1,16 @@
11
<title>Change Log</title>
22
33
<h2 id='v2_20'>Changes for version 2.20 (pending)</h2>
4
+ * Added the [/help?cmd=chat-timeline-user|chat-timeline-user setting]. If
5
+ it is not an empty string, then any changes that would appear on the timeline
6
+ are announced in [./chat.md|the chat room].
7
+ * The /unsubscribe page now requests comformation. [./alerts.md|Email notifications]
8
+ now contain only an "Unsubscribe" link, and not a link to subscription management.
9
+ * More elements of the /info page are now inside of an accordion.
410
* Replace the <tt>--dryrun</tt> flag with <tt>--dry-run</tt> in all
511
commands which still used the former name, for consistency.
6
- * Add the [/help?cmd=chat-timeline-user|chat-timeline-user setting],
7
- which enables posting of new timeline entries to [/help?cmd=/chat|the
8
- /chat page].
912
1013
<h2 id='v2_19'>Changes for version 2.19 (2022-07-21)</h2>
1114
* On file listing pages, sort filenames using the "uintnocase" collating
1215
sequence, so that filenames that contains embedded integers sort in
1316
numeric order even if they contain a different number of digits.
1417
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,13 +1,16 @@
1 <title>Change Log</title>
2
3 <h2 id='v2_20'>Changes for version 2.20 (pending)</h2>
 
 
 
 
 
 
4 * Replace the <tt>--dryrun</tt> flag with <tt>--dry-run</tt> in all
5 commands which still used the former name, for consistency.
6 * Add the [/help?cmd=chat-timeline-user|chat-timeline-user setting],
7 which enables posting of new timeline entries to [/help?cmd=/chat|the
8 /chat page].
9
10 <h2 id='v2_19'>Changes for version 2.19 (2022-07-21)</h2>
11 * On file listing pages, sort filenames using the "uintnocase" collating
12 sequence, so that filenames that contains embedded integers sort in
13 numeric order even if they contain a different number of digits.
14
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,13 +1,16 @@
1 <title>Change Log</title>
2
3 <h2 id='v2_20'>Changes for version 2.20 (pending)</h2>
4 * Added the [/help?cmd=chat-timeline-user|chat-timeline-user setting]. If
5 it is not an empty string, then any changes that would appear on the timeline
6 are announced in [./chat.md|the chat room].
7 * The /unsubscribe page now requests comformation. [./alerts.md|Email notifications]
8 now contain only an "Unsubscribe" link, and not a link to subscription management.
9 * More elements of the /info page are now inside of an accordion.
10 * Replace the <tt>--dryrun</tt> flag with <tt>--dry-run</tt> in all
11 commands which still used the former name, for consistency.
 
 
 
12
13 <h2 id='v2_19'>Changes for version 2.19 (2022-07-21)</h2>
14 * On file listing pages, sort filenames using the "uintnocase" collating
15 sequence, so that filenames that contains embedded integers sort in
16 numeric order even if they contain a different number of digits.
17
+12
--- www/chat.md
+++ www/chat.md
@@ -153,10 +153,22 @@
153153
--message 'MESSAGE TEXT' --file file-to-attach.txt
154154
~~~~
155155
156156
Substitute the appropriate project URL, robot account
157157
name and password, message text and file attachment, of course.
158
+
159
+### <a id="chat-robot"></a> Chat Messages For Timeline Events
160
+
161
+If the [chat-timeline-user setting](/help?cmd=chat-timeline-user) is not a
162
+empty string, then any change to the repository that would normally result
163
+in a new timeline entry is announced in the chatroom. The announcement
164
+appears to come from a user whose name is given by the chat-timeline-user
165
+setting.
166
+
167
+This mechanism is similar to [email notification](./alerts.md) except that
168
+the notification is sent via chat instead of via email.
169
+
158170
159171
## Implementation Details
160172
161173
*You do not need to understand how Fossil chat works in order to use it.
162174
But many developers prefer to know how their tools work.
163175
--- www/chat.md
+++ www/chat.md
@@ -153,10 +153,22 @@
153 --message 'MESSAGE TEXT' --file file-to-attach.txt
154 ~~~~
155
156 Substitute the appropriate project URL, robot account
157 name and password, message text and file attachment, of course.
 
 
 
 
 
 
 
 
 
 
 
 
158
159 ## Implementation Details
160
161 *You do not need to understand how Fossil chat works in order to use it.
162 But many developers prefer to know how their tools work.
163
--- www/chat.md
+++ www/chat.md
@@ -153,10 +153,22 @@
153 --message 'MESSAGE TEXT' --file file-to-attach.txt
154 ~~~~
155
156 Substitute the appropriate project URL, robot account
157 name and password, message text and file attachment, of course.
158
159 ### <a id="chat-robot"></a> Chat Messages For Timeline Events
160
161 If the [chat-timeline-user setting](/help?cmd=chat-timeline-user) is not a
162 empty string, then any change to the repository that would normally result
163 in a new timeline entry is announced in the chatroom. The announcement
164 appears to come from a user whose name is given by the chat-timeline-user
165 setting.
166
167 This mechanism is similar to [email notification](./alerts.md) except that
168 the notification is sent via chat instead of via email.
169
170
171 ## Implementation Details
172
173 *You do not need to understand how Fossil chat works in order to use it.
174 But many developers prefer to know how their tools work.
175

Keyboard Shortcuts

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