diff options
Diffstat (limited to 'doc/user-guide')
| -rw-r--r-- | doc/user-guide/Makefile | 2 | ||||
| -rw-r--r-- | doc/user-guide/commands.xml | 19 | ||||
| -rw-r--r-- | doc/user-guide/help.xml | 1 | ||||
| -rw-r--r-- | doc/user-guide/twitter.xml | 28 | ||||
| -rw-r--r-- | doc/user-guide/user-guide.xml | 1 |
5 files changed, 32 insertions, 19 deletions
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 @@ <description> <para> - 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: - </para> - - <variablelist> - <varlistentry><term>undo #[<id>]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry> - <varlistentry><term>rt <screenname|#id></term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry> - <varlistentry><term>reply <screenname|#id></term><listitem><para>Reply to a Tweet (with a reply-to reference)</para></listitem></varlistentry> - <varlistentry><term>rawreply <screenname|#id></term><listitem><para>Reply to a Tweet (with no reply-to reference)</para></listitem></varlistentry> - <varlistentry><term>report <screenname|#id></term><listitem><para>Report the given user (or the user who posted the tweet with the given ID) for sending spam. This will also block them.</para></listitem></varlistentry> - <varlistentry><term>follow <screenname></term><listitem><para>Start following a person</para></listitem></varlistentry> - <varlistentry><term>unfollow <screenname></term><listitem><para>Stop following a person</para></listitem></varlistentry> - <varlistentry><term>favourite <screenname|#id></term><listitem><para>Favo<emphasis>u</emphasis>rite the given user's most recent tweet, or the given tweet ID.</para></listitem></varlistentry> - <varlistentry><term>post <message></term><listitem><para>Post a tweet</para></listitem></varlistentry> - <varlistentry><term>url <screenname|#id></term><listitem><para>Show URL for a tweet to open it in a browser (and see context)</para></listitem></varlistentry> - </variablelist> - - <para> - 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 <emphasis>strict</emphasis>, which causes the <emphasis>post</emphasis> command to become mandatory for posting a tweet. + With this setting enabled, you can use some commands in your Twitter channel/query. See <emphasis>help twitter</emphasis> for the list of extra commands available. </para> </description> </bitlbee-setting> 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 <emphasis>help <subject></emphasis> <xi:include href="quickstart.xml"/> <xi:include href="commands.xml"/> +<xi:include href="twitter.xml"/> <xi:include href="misc.xml"/> </book> 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 @@ +<chapter id="twitter"> +<title>Twitter</title> + +<para> +Twitter allows you to use a set of commands in the Twitter channel/query. See <emphasis>help set commands</emphasis>. +</para> + +<para> +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 <emphasis>commands</emphasis> setting to <emphasis>strict</emphasis>, which causes the <emphasis>post</emphasis> command to become mandatory for posting. See <emphasis>help set commands</emphasis>. +</para> + +<para> +Here is a short description of the commands available: +<variablelist> +<varlistentry><term>undo [<#id>]</term><listitem><para>Delete your last message (or one with the given ID)</para></listitem></varlistentry> +<varlistentry><term>rt <screenname|#id></term><listitem><para>Retweet someone's last message (or one with the given ID)</para></listitem></varlistentry> +<varlistentry><term>reply <screenname|#id></term><listitem><para>Reply to a message (with a reply-to reference)</para></listitem></varlistentry> +<varlistentry><term>rawreply <screenname|#id></term><listitem><para>Reply to a message (with no reply-to reference)</para></listitem></varlistentry> +<varlistentry><term>report <screenname|#id></term><listitem><para>Report the given user (or the user who posted the message with the given ID) for sending spam. This will also block them.</para></listitem></varlistentry> +<varlistentry><term>follow <screenname></term><listitem><para>Start following a person</para></listitem></varlistentry> +<varlistentry><term>unfollow <screenname></term><listitem><para>Stop following a person</para></listitem></varlistentry> +<varlistentry><term>favourite <screenname|#id></term><listitem><para>Favo<emphasis>u</emphasis>rite the given user's most recent message, or the given ID.</para></listitem></varlistentry> +<varlistentry><term>post <message></term><listitem><para>Post a message</para></listitem></varlistentry> +<varlistentry><term>url <screenname|#id></term><listitem><para>Show URL for a message to open it in a browser (and see context)</para></listitem></varlistentry> +</variablelist> +</para> + +</chapter> 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 @@ <xi:include href="Support.xml"/> <xi:include href="quickstart.xml"/> <xi:include href="commands.xml"/> + <xi:include href="twitter.xml"/> <xi:include href="misc.xml"/> </book> |