Changeset a893271


Ignore:
Timestamp:
2017-08-26T18:15:04Z (4 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:
1 added
4 edited

Legend:

Unmodified
Added
Removed
  • doc/user-guide/Makefile

    rd11822a ra893271  
    3535        xsltproc --xinclude --output $@ docbook.xsl $<
    3636
    37 help.txt: $(_SRCDIR_)help.xml $(_SRCDIR_)commands.xml $(_SRCDIR_)misc.xml $(_SRCDIR_)quickstart.xml
     37help.txt: $(_SRCDIR_)help.xml $(_SRCDIR_)commands.xml $(_SRCDIR_)misc.xml $(_SRCDIR_)quickstart.xml $(_SRCDIR_)twitter.xml
    3838        $(PYTHON) $(_SRCDIR_)genhelp.py $< $@
    3939
  • doc/user-guide/commands.xml

    rd11822a ra893271  
    891891                <description>
    892892                        <para>
    893                                 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:
    894                         </para>
    895 
    896                         <variablelist>
    897                                 <varlistentry><term>undo #[&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
    898                                 <varlistentry><term>rt &lt;screenname|#id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
    899                                 <varlistentry><term>reply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with a reply-to reference)</para></listitem></varlistentry>
    900                                 <varlistentry><term>rawreply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with no reply-to reference)</para></listitem></varlistentry>
    901                                 <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>
    902                                 <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
    903                                 <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
    904                                 <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>
    905                                 <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
    906                                 <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>
    907                         </variablelist>
    908 
    909                         <para>
    910                                 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.
     893                                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.
    911894                        </para>
    912895                </description>
  • doc/user-guide/help.xml

    rd11822a ra893271  
    6060<xi:include href="quickstart.xml"/>
    6161<xi:include href="commands.xml"/>
     62<xi:include href="twitter.xml"/>
    6263<xi:include href="misc.xml"/>
    6364
  • doc/user-guide/user-guide.xml

    rd11822a ra893271  
    3737  <xi:include href="quickstart.xml"/>
    3838  <xi:include href="commands.xml"/>
     39  <xi:include href="twitter.xml"/>
    3940  <xi:include href="misc.xml"/>
    4041
Note: See TracChangeset for help on using the changeset viewer.