Changeset ce402b2 for doc/user-guide


Ignore:
Timestamp:
2015-01-26T07:50:54Z (10 years ago)
Author:
dequis <dx@…>
Branches:
master
Children:
12fe5ea
Parents:
dfaa46d
git-author:
William Pettersson <william.pettersson@…> (11-01-15 05:08:37)
git-committer:
dequis <dx@…> (26-01-15 07:50:54)
Message:

Twitter format strings

Allow users to specify how tweets should be displayed

3 new settings are available to set how tweets are displayed:

  • twitter_format_string for normal tweets
  • retweet_format_string for retweets
  • reply_format_string for replies

For full documentation see the help files

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/commands.xml

    rdfaa46d rce402b2  
    10911091        </bitlbee-setting>
    10921092
     1093        <bitlbee-setting name="format_string" type="string" scope="account">
     1094                <default>^B[^B%i^B]^B %c</default>
     1095
     1096                <description>
     1097                        <para>
     1098                                This setting controls how tweets are displayed. Below are listed the two replacement attributes you may use in the string. If you wish to use a percent symbol in your string, ensure you escape it with a second percent symbol (i.e. "%%").
     1099                        </para>
     1100
     1101                        <para>
     1102                                The default setting contains ^B as a control code for toggling of the bold property. Other similar properties (including color codes) are also functional in this setting. See the documentation for your IRC client for details on such control codes.
     1103                        </para>
     1104
     1105                        <variablelist>
     1106                                <varlistentry><term>%i</term><listitem><para>The ID of the tweet</para></listitem></varlistentry>
     1107                                <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
     1108                        </variablelist>
     1109                </description>
     1110
     1111        </bitlbee-setting>
     1112
     1113        <bitlbee-setting name="reply_format_string" type="string" scope="account">
     1114                <default>^B[^B%i->%t^B]^B %c</default>
     1115
     1116                <description>
     1117                        <para>
     1118                                This setting controls how replies to tweets are displayed. Below are listed the three replacement attributes you may use in the string. If you wish to use a percent symbol in your string, ensure you escape it with a second percent symbol (i.e. "%%").
     1119                        </para>
     1120
     1121                        <para>
     1122                                The default setting contains ^B as a control code for toggling of the bold property. Other similar properties (including color codes) are also functional in this setting. See the documentation for your IRC client for details on such control codes.
     1123                        </para>
     1124
     1125                        <variablelist>
     1126                                <varlistentry><term>%i</term><listitem><para>The ID of this tweet</para></listitem></varlistentry>
     1127                                <varlistentry><term>%r</term><listitem><para>The ID of the tweet being replied to</para></listitem></varlistentry>
     1128                                <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
     1129                        </variablelist>
     1130                </description>
     1131
     1132        </bitlbee-setting>
     1133
     1134        <bitlbee-setting name="retweet_format_string" type="string" scope="account">
     1135                <default>^B[^B%i^B]^B RT @%a: %c</default>
     1136
     1137                <description>
     1138                        <para>
     1139                                This setting controls how retweets are displayed. Below are listed the three replacement attributes you may use in the string. If you wish to use a percent symbol in your string, ensure you escape it with a second percent symbol (i.e. "%%").
     1140                        </para>
     1141
     1142                        <para>
     1143                                The default setting contains ^B as a control code for toggling of the bold property. Other similar properties (including color codes) are also functional in this setting. See the documentation for your IRC client for details on such control codes.
     1144                        </para>
     1145
     1146                        <variablelist>
     1147                                <varlistentry><term>%i</term><listitem><para>The ID of the tweet</para></listitem></varlistentry>
     1148                                <varlistentry><term>%a</term><listitem><para>The author of the original tweet</para></listitem></varlistentry>
     1149                                <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
     1150                        </variablelist>
     1151                </description>
     1152
     1153        </bitlbee-setting>
     1154
    10931155        <bitlbee-setting name="mobile_is_away" type="boolean" scope="global">
    10941156                <default>false</default>
Note: See TracChangeset for help on using the changeset viewer.