From a89327153865493f5a86cb6a4b005f150a54cb3b Mon Sep 17 00:00:00 2001 From: Alex Schroeder Date: Wed, 9 Aug 2017 08:36:20 +0200 Subject: Twitter documentation: move commands to a chapter The Twitter commands are now documented in their own chapter accessed by `help twitter` instead of being hidden in `help set commands`. --- doc/user-guide/Makefile | 2 +- doc/user-guide/commands.xml | 19 +------------------ doc/user-guide/help.xml | 1 + doc/user-guide/twitter.xml | 28 ++++++++++++++++++++++++++++ doc/user-guide/user-guide.xml | 1 + 5 files changed, 32 insertions(+), 19 deletions(-) create mode 100644 doc/user-guide/twitter.xml (limited to 'doc/user-guide') diff --git a/doc/user-guide/Makefile b/doc/user-guide/Makefile index 01fd9aa2..541d8c46 100644 --- a/doc/user-guide/Makefile +++ b/doc/user-guide/Makefile @@ -34,7 +34,7 @@ help.xml: commands.xml %.db.xml: %.xml docbook.xsl xsltproc --xinclude --output $@ docbook.xsl $< -help.txt: $(_SRCDIR_)help.xml $(_SRCDIR_)commands.xml $(_SRCDIR_)misc.xml $(_SRCDIR_)quickstart.xml +help.txt: $(_SRCDIR_)help.xml $(_SRCDIR_)commands.xml $(_SRCDIR_)misc.xml $(_SRCDIR_)quickstart.xml $(_SRCDIR_)twitter.xml $(PYTHON) $(_SRCDIR_)genhelp.py $< $@ clean: diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 1ddf9764..b21f75a2 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -890,24 +890,7 @@ - With this setting enabled, you can use some commands in your Twitter channel/query. The commands are simple and not documented in too much detail: - - - - undo #[<id>]Delete your last Tweet (or one with the given ID) - rt <screenname|#id>Retweet someone's last Tweet (or one with the given ID) - reply <screenname|#id>Reply to a Tweet (with a reply-to reference) - rawreply <screenname|#id>Reply to a Tweet (with no reply-to reference) - report <screenname|#id>Report the given user (or the user who posted the tweet with the given ID) for sending spam. This will also block them. - follow <screenname>Start following a person - unfollow <screenname>Stop following a person - favourite <screenname|#id>Favourite the given user's most recent tweet, or the given tweet ID. - post <message>Post a tweet - url <screenname|#id>Show URL for a tweet to open it in a browser (and see context) - - - - Anything that doesn't look like a command will be treated as a tweet. Watch out for typos, or to avoid this behaviour, you can set this setting to strict, which causes the post command to become mandatory for posting a tweet. + With this setting enabled, you can use some commands in your Twitter channel/query. See help twitter for the list of extra commands available. diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml index 1b68413a..810731b5 100644 --- a/doc/user-guide/help.xml +++ b/doc/user-guide/help.xml @@ -59,6 +59,7 @@ You can read more about them with help <subject> + diff --git a/doc/user-guide/twitter.xml b/doc/user-guide/twitter.xml new file mode 100644 index 00000000..3827464a --- /dev/null +++ b/doc/user-guide/twitter.xml @@ -0,0 +1,28 @@ + +Twitter + + +Twitter allows you to use a set of commands in the Twitter channel/query. See help set commands. + + + +Anything that doesn't look like a command will be treated as a new message. Watch out for typos, or to avoid this behaviour, set the commands setting to strict, which causes the post command to become mandatory for posting. See help set commands. + + + +Here is a short description of the commands available: + +undo [<#id>]Delete your last message (or one with the given ID) +rt <screenname|#id>Retweet someone's last message (or one with the given ID) +reply <screenname|#id>Reply to a message (with a reply-to reference) +rawreply <screenname|#id>Reply to a message (with no reply-to reference) +report <screenname|#id>Report the given user (or the user who posted the message with the given ID) for sending spam. This will also block them. +follow <screenname>Start following a person +unfollow <screenname>Stop following a person +favourite <screenname|#id>Favourite the given user's most recent message, or the given ID. +post <message>Post a message +url <screenname|#id>Show URL for a message to open it in a browser (and see context) + + + + diff --git a/doc/user-guide/user-guide.xml b/doc/user-guide/user-guide.xml index 5e1c8fe0..16b974db 100644 --- a/doc/user-guide/user-guide.xml +++ b/doc/user-guide/user-guide.xml @@ -36,6 +36,7 @@ + -- cgit v1.2.3 From af6b7fa14a1362c8f12e07360a4cd011dd07c542 Mon Sep 17 00:00:00 2001 From: Jesse Kennedy Date: Wed, 16 Aug 2017 15:36:08 -0700 Subject: channel operates on channel ids not account ids --- doc/user-guide/commands.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index b21f75a2..f20e3298 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -183,7 +183,7 @@ Channel list maintenance - channel [<account id>] <action> [<arguments>] + channel [<channel id>] <action> [<arguments>] -- cgit v1.2.3