aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user-guide
diff options
context:
space:
mode:
authorWilliam Pettersson <william.pettersson@gmail.com>2015-01-11 15:08:37 +1000
committerdequis <dx@dxzone.com.ar>2015-01-26 04:50:54 -0300
commitce402b20d82ec323e6bd5e306de934773590742d (patch)
tree10e545944b9602a53300e97354f011395d2b0afd /doc/user-guide
parentdfaa46d37c5a71e7d8c413c7c9714db854b8b559 (diff)
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
Diffstat (limited to 'doc/user-guide')
-rw-r--r--doc/user-guide/commands.xml62
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml
index 6ce19774..b840350c 100644
--- a/doc/user-guide/commands.xml
+++ b/doc/user-guide/commands.xml
@@ -1090,6 +1090,68 @@
</bitlbee-setting>
+ <bitlbee-setting name="format_string" type="string" scope="account">
+ <default>^B[^B%i^B]^B %c</default>
+
+ <description>
+ <para>
+ 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. "%%").
+ </para>
+
+ <para>
+ 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.
+ </para>
+
+ <variablelist>
+ <varlistentry><term>%i</term><listitem><para>The ID of the tweet</para></listitem></varlistentry>
+ <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
+ </variablelist>
+ </description>
+
+ </bitlbee-setting>
+
+ <bitlbee-setting name="reply_format_string" type="string" scope="account">
+ <default>^B[^B%i->%t^B]^B %c</default>
+
+ <description>
+ <para>
+ 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. "%%").
+ </para>
+
+ <para>
+ 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.
+ </para>
+
+ <variablelist>
+ <varlistentry><term>%i</term><listitem><para>The ID of this tweet</para></listitem></varlistentry>
+ <varlistentry><term>%r</term><listitem><para>The ID of the tweet being replied to</para></listitem></varlistentry>
+ <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
+ </variablelist>
+ </description>
+
+ </bitlbee-setting>
+
+ <bitlbee-setting name="retweet_format_string" type="string" scope="account">
+ <default>^B[^B%i^B]^B RT @%a: %c</default>
+
+ <description>
+ <para>
+ 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. "%%").
+ </para>
+
+ <para>
+ 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.
+ </para>
+
+ <variablelist>
+ <varlistentry><term>%i</term><listitem><para>The ID of the tweet</para></listitem></varlistentry>
+ <varlistentry><term>%a</term><listitem><para>The author of the original tweet</para></listitem></varlistentry>
+ <varlistentry><term>%c</term><listitem><para>The text of the tweet</para></listitem></varlistentry>
+ </variablelist>
+ </description>
+
+ </bitlbee-setting>
+
<bitlbee-setting name="mobile_is_away" type="boolean" scope="global">
<default>false</default>