Skip to content

Commit a4642a4

Browse files
Prettification, punctuation fixes, etc.
Co-authored-by: Ted Thibodeau Jr <[email protected]> Co-authored-by: Vivien Lacourba <[email protected]>
1 parent 4f68e5f commit a4642a4

File tree

2 files changed

+43
-41
lines changed

2 files changed

+43
-41
lines changed

meetings/rrsagent.md

+42-40
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ toc: yes
55

66
## General Description {#general}
77

8-
RRSAgent is a helpful bot for recording an IRC session. All text sent to the channel by any user is logged except '`/me`' text and text send with [logging explicitly turned off](#logoff).
8+
RRSAgent is a helpful bot for recording an IRC session. All text sent to the channel by any user is logged except '`/me`' text and text sent with [logging explicitly turned off](#logoff).
99

1010
In the command descriptions below, optional words in commands are indicated in square brackets. RRSAgent's commands are not case sensitive, but, in general, must be grammatically correct. "`please`" can be abbreviated to "`pls`" if you wish to be polite yet still save keystrokes.
1111

@@ -15,46 +15,48 @@ To use RRSAgent, you must first invite it to your IRC session. When you're finis
1515

1616
- `/invite RRSAgent <channel>`
1717

18-
Brings RRSAgent on to your IRC channel. The log will appear in `https://www.w3.org/yyyy/mm/dd-<channel>-irc` where '`yyyy`' is the current year, '`mm`' is the current month, and '`dd`' is the current day. Three variants of the log are written; `.html` contains XHTML, `.rdf` contains RDF, and `.txt` contains plain text. *Do not* edit these logs if you expect RRSAgent to continue to write to them. (Your CVS commit will cause RRSAgent's additions to cease to appear in the Web. If you're very lucky, they may not actually be lost. But they're not trivial to recover.)
18+
Brings RRSAgent on to your IRC channel. The log will appear in `https://www.w3.org/yyyy/mm/dd-<channel>-irc` where '`yyyy`' is the current year, '`mm`' is the current month, and '`dd`' is the current day. Three variants of the log are written; `.html` contains XHTML, `.rdf` contains RDF, and `.txt` contains plain text. *Do not* edit these logs if you expect RRSAgent to continue to write to them. (Your CVS commit will cause RRSAgent's additions to cease to appear on the Web. If you're very lucky, they may not actually be lost. But they're not trivial to recover.)
1919

2020
Some irc clients let you omit the channel name and will fill in the name of current channel. This is a feature of the irc client, not of RRSAgent.
2121

22+
Any of the following will disconnect the RRSAgent bot from your IRC channel:
23+
2224
- `rrsagent, [please] excuse us`
2325
- `rrsagent, bye`
2426
- `rrsagent, [please] part`
2527
- `rrsagent, [please] leave`
2628

27-
All disconnect the RRSAgent bot from your IRC channel.
29+
RRSAgent will leave the channel if there has been no activity on the channel for more than 2 hours. Should you not want this behaviour you can request that RRSAgent stay regardless of activity.
2830

29-
RRSAgent will leave the channel if there has been no activity on the channel for more than 2 hours. Should you not want this behaviour you can request that RRSAgent stay regardless of activity:
31+
Each of the following disables automatic departure from the channel:
3032

3133
- `rrsagent, [please] stay`
3234
- `rrsagent, [please] do not leave`
3335
- `rrsagent, [please] do not depart`
3436

35-
Each of these disables the automatic departure from the channel. Once this is requested the only way to reset it is to dismiss RRSAgent from the channel and re-invite it.
37+
Once automatic departure is disabled, the only way to re-enable it is to manually dismiss RRSAgent from the channel and then re-invite it.
3638

3739
## Talking to RRSAgent {#talking}
3840

3941
RRSAgent also recognizes several commands during its logging session. Most commands begin with '`rrsagent, `', though a few are recognized without this.
4042

4143
### Action Item Tracking {#actions}
4244

43-
RRSAgent will help track action items recorded while a meeting is in progress. Many of the commands in this set need not be directly addressed to RRSAgent; they will be recognized when addressed to no one in particular and also when received as third person ('`/me`') messages.
45+
RRSAgent will help track action items recorded while a meeting is in progress. Many of the commands in this set need not be directly addressed to RRSAgent; they will be recognized when not addressed to anyone in particular and also when received as third person ('`/me`') messages.
4446

45-
The list of action items may be reviewed and modified during the meeting. The action items will be recorded as they are modified in `https://www.w3.org/yyyy/mm/dd-<channel>-actions` where where '`yyyy`' is the current year, '`mm`' is the current month, and '`dd`' is the current day.
47+
The list of action items may be reviewed and modified during the meeting. Action items will be recorded as they are modified in `https://www.w3.org/yyyy/mm/dd-<channel>-actions` where where '`yyyy`' is the current year, '`mm`' is the current month, and '`dd`' is the current day.
4648

4749
- `[rrsagent,] ACTION: <text>`
4850

49-
Adds an action item described by `<text>`, assigning it the next sequential number. This command need not be addressed to RRSAgent directly. The keyword '`ACTION`' is not case sensitive. Actions may not be assigned in '`/me`' messages.
51+
Adds an action item described by `<text>`, assigning it the next sequential number. This command need not be directly addressed to RRSAgent. The keyword '`ACTION`' is not case sensitive. Actions may not be assigned in '`/me`' messages.
5052

5153
- `[rrsagent,] ACTION <number> = <newtext>`
5254

53-
Replaces the text of action item `<number>` with `<newtext>`. This need not be addressed to RRSAgent directly but will be ignored in '`/me`' lines. The keyword '`ACTION`' must be in all-caps as shown or all lowercase.
55+
Replaces the text of action item `<number>` with `<newtext>`. This need not be directly addressed to RRSAgent, but will be ignored in '`/me`' lines. The keyword '`ACTION`' must be in all-caps or all lowercase, '`action`'.
5456

5557
- `[rrsagent,] ACTION- <number>`
5658

57-
Removes action item `<number>` from the list. This need not be addressed to RRSAgent directly. The keyword '`ACTION`' is not case sensitive..
59+
Removes action item `<number>` from the list. This need not be directly addressed to RRSAgent. The keyword '`ACTION`' is not case sensitive.
5860

5961
- `rrsagent, what [are the] action items?`
6062
- `rrsagent, what [are the] actions?`
@@ -63,21 +65,21 @@ Removes action item `<number>` from the list. This need not be addressed to RRSA
6365
- `rrsagent, [please] list [the] action items`
6466
- `actions?`
6567

66-
Displays the list of action items. The first set of requests must be addressed specifically to RRSAgent. The last request will respond in '`/me`' (third-person or out-of-band) form.
68+
Displays the list of action items. The first several requests must be addressed specifically to RRSAgent, as shown. The last request will also work in '`/me`' (third-person or out-of-band) form.
6769

6870
- `rrsagent, [please] drop action <number>`
6971

70-
Removes action item `<number>` from the list. This form must be addressed specifically to RRSAgent
72+
Removes action item `<number>` from the list. This form must be addressed specifically to RRSAgent.
7173

7274
- `rrsagent, [please] ignore action items`
7375
- `rrsagent, [please] ignore actions`
7476

75-
Requests that RRSAgent stop tracking action items. This request must be addressed specifically to RRSAgent
77+
Requests that RRSAgent stop tracking action items. This request must be addressed specifically to RRSAgent.
7678

7779
- `rrsagent, [please] track action items`
7880
- `rrsagent, [please] track actions`
7981

80-
Requests that RRSAgent begin tracking action items. This request must be addressed specifically to RRSAgent. This is the default state when RRSAgent is invited to a channel
82+
Requests that RRSAgent begin tracking action items. This request must be addressed specifically to RRSAgent. This is the default state when RRSAgent is invited to a channel.
8183

8284
### Searching the Log {#search}
8385

@@ -86,14 +88,14 @@ Requests that RRSAgent begin tracking action items. This request must be address
8688
- `rrsagent, here`
8789
- `rrsagent, where am I?`
8890

89-
Reports a URI to the current location in the log
91+
Returns a URI to the current location in the log.
9092

9193
- `rrsagent, grep [-i] [first-last|max] <text>`
9294
- `rrsagent, search for [-i] [first-last|max] <text>`
9395
- `rrsagent, find [-i] [first-last|max] <text>`
9496
- `rrsagent, <text>?`
9597

96-
Searches the log for `<text>`. The text is interpreted as a perl regex; e.g. '`.`' matches any character, '`<char>+`' matches one or more consecutive occurrences of `<char>`, and '`<char>*`' matches any number of consecutive occurrences of `<char>`, etc. '`-i`' causes the comparison to be case insensitive. '`first`', '`last`', and '`max`' limit the reported results to the specified (first and last) results or to at most (max) results.
98+
Searches the log for `<text>`. The text is interpreted as a perl regex; e.g., '`.`' matches any character, '`<char>+`' matches one or more consecutive occurrences of `<char>`, and '`<char>*`' matches any number of consecutive occurrences of `<char>`, etc. '`-i`' causes the comparison to be case insensitive. '`first`', '`last`', and '`max`' limit the reported results to the specified (first and last) results or to at most (max) results.
9799

98100
### Pausing and Resuming Log Recording {#logoff}
99101

@@ -102,9 +104,9 @@ Searches the log for `<text>`. The text is interpreted as a perl regex; e.g. '`.
102104
- `rrsagent, off`
103105
- `rrsagent, nolisten`
104106

105-
Stops logging channel text to the log
107+
Stops logging channel text to the log.
106108

107-
Any line beginning with '`[off]`' and any message sent with the '`/me`' IRC command will also not be logged. This permits channel participants to interject single-line remarks.
109+
Any line beginning with '`[off]`' and any message sent with the '`/me`' IRC command will also not be logged. This permits channel participants to interject single-line remarks.
108110

109111
- `rrsagent, on`
110112
- `rrsagent, hello`
@@ -114,23 +116,23 @@ Any line beginning with '`[off]`' and any message sent with the '`/me`' IRC comm
114116
- `rrsagent, start`
115117
- `rrsagent, begin`
116118

117-
Resumes logging channel text to the log. This is the default state when RRSAgent is invited to a channel
119+
Resumes logging channel text to the log. This is the default state when RRSAgent is invited to a channel.
118120

119121
- `rrsagent, this meeting spans midnight`
120122
- `rrsagent, do not start a new log [at midnight]`
121123

122-
By default, when RRSAgent is sitting on an irc channel a new log for the channel will be started at midnight UTC. If the channel is being used for a meeting that continues past midnight it may be more convenient to keep the meeting record contiguous in a single log. This request will inform RRSAgent to maintain a single log for the current channel if logging continues past midnight. When RRSAgent joins a channel within 75 minutes of midnight the current log will continue past midnight just as if this request had been issued.
124+
By default, when RRSAgent is sitting on an irc channel, a new log for the channel will be started at midnight UTC (not user local midnight!). If the channel is being used for a meeting that continues past midnight UTC, it may be more convenient to keep the meeting record contiguous in a single log. This command will tell RRSAgent to maintain a single log for the current channel if logging continues past midnight UTC. When RRSAgent joins a channel within 75 minutes of midnight UTC, the current log will continue past midnight, just as if this command had been issued.
123125

124126
- `rrsagent, start a new log [at midnight]`
125127

126-
This restores the default behavior of RRSAgent when logging to a channel and midnight UTC is crossed. When RRSAgent joins a channel within 75 minutes of midnight the current log will continue past midnight unless this request has been issued.
128+
This restores the default behavior of RRSAgent when logging to a channel and midnight UTC is crossed. When RRSAgent joins a channel within 75 minutes of midnight UTC, the current log will continue past midnight unless this request has been issued.
127129

128130
### Setting Log Access {#access}
129131

130132
- `rrsagent, [please] set [these] logs member-visible|world-visible|ab-visible|team-visible`
131133
- `rrsagent, [please] make [these] logs member-visible|world-visible|team-visible|ab-visible`
132134

133-
Sets the access control on the logs, recorded action items, and draft minutes (if any). The group '`world`' may also be written as '`public`'. The suffix '`-visible`' may also be written as '`-access`', '`-conf`', '`-confidential`', '`-only`', '`-read`', or '`-readable`' or may be omitted entirely. '`record`' is recognized as a synonym for '`log`'.
135+
Sets the access control on the logs, recorded action items, and draft minutes (if any). The group '`world`' may also be written as '`public`'. The suffix '`-visible`' may also be written as '`-access`', '`-conf`', '`-confidential`', '`-only`', '`-read`', or '`-readable`', or may be omitted entirely. '`record`' is recognized as a synonym for '`log`'.
134136

135137
### Formatting Minutes {#formatMinutes}
136138

@@ -141,47 +143,47 @@ Sets the access control on the logs, recorded action items, and draft minutes (i
141143
- `rrsagent, [please] make [the] minutes`
142144
- `rrsagent, [please] publish [the] minutes`
143145

144-
Runs a [script](https://w3c.github.io/scribe2/scribedoc.html) to reformat the current irc log into HTML-ized minutes. If the access control of the logs has been previously set the formatted minutes will receive the same access. These formatted minutes should subsequently be edited by hand to improve them as a permanent meeting record. This command may be repeated, with RRSAgent over-writing the previously generated minutes. Repeating the request is useful if the diagnostics produced at the bottom of the formatted minutes suggest additional formatting commands that could usefully be added to the log.
146+
Runs a [script](https://w3c.github.io/scribe2/scribedoc.html) to reformat the current irc log into HTML-ized minutes. If the access control of the logs has been previously set, the formatted minutes will receive the same access. These formatted minutes should subsequently be edited by hand to improve them as a permanent meeting record. This command may be repeated, with RRSAgent over-writing the previously generated minutes. Repeating the request is useful if the diagnostics produced at the bottom of the formatted minutes suggest additional formatting commands that could usefully be added to the log.
145147

146-
The [script](https://w3c.github.io/scribe2/scribedoc.html) recognizes instructions found in the irc log, including:
148+
The [script](https://w3c.github.io/scribe2/scribedoc.html) recognizes instructions found in the irc log, including the following:
147149

148-
`Meeting: <name>`
150+
- `Meeting: <name>`
149151

150-
Specifies the name (title) of the meeting
152+
Specifies the name (title) of the meeting.
151153

152-
`Chair: <name>`
154+
- `Chair: <name>`
153155

154-
Specifies the chairperson's name
156+
Specifies the chairperson's name.
155157

156-
`Agenda: <URI>`
158+
- `Agenda: <URI>`
157159

158-
Specifies the Web address of the agenda
160+
Specifies the Web address of the agenda.
159161

160-
`Scribe: <name>`
162+
- `Scribe: <name>`
161163

162-
Specifies the scribe's name
164+
Specifies the scribe's name.
163165

164-
`ScribeNick: <nick>`
166+
- `ScribeNick: <nick>`
165167

166-
Specifies the irc nick of the scribe
168+
Specifies the irc nick of the scribe.
167169

168-
Refer to the scribe [Quick Start Guide](https://w3c.github.io/scribe2/scribedoc.html) for additional details. See also [Making minutes without RRSAgent](https://w3c.github.io/scribe2/rescue) for suggestions on what to do if you wish to generate minutes when RRSAgent was not logging the channel.
170+
Refer to the scribe [Quick Start Guide](https://w3c.github.io/scribe2/scribedoc.html) for additional details. See also [Making minutes without RRSAgent](https://w3c.github.io/scribe2/rescue) for suggestions on what to do if you wish to generate minutes when RRSAgent was not logging the channel.
169171

170-
An [older version of the script](https://w3c.github.io/scribe/scribedoc.htm) can also be invoked by adding '`v1`' to the formatting request; e.g.
172+
An [older version of the script](https://w3c.github.io/scribe/scribedoc.htm) can also be invoked by adding '`v1`' to the formatting request; as below:
171173

172-
- `rrsagent, [please] create [the] minutes v1`
174+
- `rrsagent, [please] create [the] minutes v1`
173175

174176
### Help {#help}
175177

176178
- `rrsagent, [please] help`
177179

178-
Displays an abbreviated list of commands. Due to "flood control" in IRC, this may be slow.
180+
Displays an abbreviated list of commands. Due to "flood control" in IRC, this may be slow.
179181

180182
## Related Tools {#related}
181183

182-
[scribe.perl](https://w3c.github.io/scribe2/scribedoc.html) by Bert Bos (after version 1 created by David Booth) generates nicely formatted HTML from irc logs, well-tuned for the logs produced by RRSAgent. This is the tool invoked by '[`please draft the minutes`](#formatMinutes)'.
184+
- [scribe.perl](https://w3c.github.io/scribe2/scribedoc.html) by Bert Bos (after version 1 created by David Booth) generates nicely formatted HTML from irc logs, well-tuned for the logs produced by RRSAgent. This is the tool invoked by '[`please draft the minutes`](#formatMinutes)'.
183185

184-
[Zakim](zakim.md) is a Semantic Web agent ("swagent") that helps facilitate meetings using IRC.
186+
- [Zakim](zakim.md) is a Semantic Web agent ("swagent") that helps facilitate meetings using IRC.
185187

186188
## Change History {#changes}
187189

meetings/zakim.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Once Zakim is on your IRC channel, all commands to Zakim begin with
4242

4343
Zakim's commands are not case sensitive, but, in general, must be grammatically correct.
4444

45-
Zakim will respond to normal irc lines and to `ACTION` lines (typically entered with the '`/me`' command in many irc clients). The '`/me`' form is especially recommended for avoiding clutter in [RRSAgent](rrsagent.md) logs; interactions that serve no useful purpose in the permanent irc record can be prefixed with '`/me`'. This typically includes '`q+`' and '`ack`' commands; e.g. '`q+`' will be logged by RRSAgent whereas '`/me q+`' will not (see [RRSAgent log recording](rrsagent.md#logoff)). Zakim will generally mimic the same usage in the reply. For the commands such as '`agenda?`' to which Zakim will respond without being directly addressed, Zakim responds directly if he is addressed and in third-person ('`/me`') form if he was not addressed.
45+
Zakim will respond to normal irc lines and to `ACTION` lines (typically entered with the '`/me`' command in many irc clients). The '`/me`' form is especially recommended for avoiding clutter in [RRSAgent](rrsagent.md) logs; interactions that serve no useful purpose in the permanent irc record can be prefixed with '`/me`'. This typically includes '`q+`' and '`ack`' commands; e.g., '`q+`' will be logged by RRSAgent whereas '`/me q+`' will not (see [RRSAgent log recording](rrsagent.md#logoff)). Zakim will generally mimic the same usage in the reply. For the commands such as '`agenda?`' to which Zakim will respond without being directly addressed, Zakim responds directly if he is addressed and in third-person ('`/me`') form if he was not addressed.
4646

4747
## Identifying your particular teleconference {#info}
4848

0 commit comments

Comments
 (0)