Changeset a893271

Timestamp:

2017-08-26T18:15:04Z (7 years ago)

Author:

dx <dx@…>

Branches:

master

Children:

af6b7fa

Parents:

d11822a

git-author:

Alex Schroeder <alex@…> (09-08-17 06:36:20)

git-committer:

dx <dx@…> (26-08-17 18:15:04)

Message:

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`.

Location:

doc/user-guide

Files:

• Makefile (modified) (1 diff)
• commands.xml (modified) (1 diff)
• help.xml (modified) (1 diff)
• twitter.xml (added)
• user-guide.xml (modified) (1 diff)

doc/user-guide/Makefile

@@ -35 +35 @@
         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 $< $@
 

doc/user-guide/commands.xml

@@ -891 +891 @@
                 <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 #[&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
-                                <varlistentry><term>rt &lt;screenname|#id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
-                                <varlistentry><term>reply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with a reply-to reference)</para></listitem></varlistentry>
-                                <varlistentry><term>rawreply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with no reply-to reference)</para></listitem></varlistentry>
-                                <varlistentry><term>report &lt;screenname|#id&gt;</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 &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
-                                <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
-                                <varlistentry><term>favourite &lt;screenname|#id&gt;</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 &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
-                                <varlistentry><term>url &lt;screenname|#id&gt;</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>

doc/user-guide/help.xml

@@ -60 +60 @@
 <xi:include href="quickstart.xml"/>
 <xi:include href="commands.xml"/>
+<xi:include href="twitter.xml"/>
 <xi:include href="misc.xml"/>
 

doc/user-guide/user-guide.xml

@@ -37 +37 @@
   <xi:include href="quickstart.xml"/>
   <xi:include href="commands.xml"/>
+  <xi:include href="twitter.xml"/>
   <xi:include href="misc.xml"/>