Changeset db2cef1


Ignore:
Timestamp:
2010-07-13T00:09:40Z (9 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
06b39f2
Parents:
badd148
Message:

Document this complex new beast.

Location:
doc/user-guide
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/user-guide/commands.xml

    rbadd148 rdb2cef1  
    764764
    765765        <bitlbee-setting name="nick" type="string" scope="chat">
    766 
    767766                <description>
    768767                        <para>
    769768                                You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname.
     769                        </para>
     770                </description>
     771        </bitlbee-setting>
     772
     773        <bitlbee-setting name="nick_format" type="string" scope="both">
     774                <default>%-@nick</default>
     775
     776                <description>
     777                        <para>
     778                                By default, BitlBee tries to derive sensible nicknames for all your contacts from their IM handles. In some cases, IM modules (ICQ for example) will provide a nickname suggestion, which will then be used instead. This setting lets you change this behaviour.
     779                        </para>
     780
     781                        <para>
     782                                Whenever this setting is set for an account, it will be used for all its contacts. If it's not set, the global value will be used.
     783                        </para>
     784
     785                        <para>
     786                                It's easier to describe this setting using a few examples:
     787                        </para>
     788
     789                        <para>
     790                                FB-%full_name will make all nicknames start with "FB-", followed by the person's full name. For example you can set this format for your Facebook account so all Facebook contacts are clearly marked.
     791                        </para>
     792
     793                        <para>
     794                                [%group]%-@nick will make all nicknames start with the group the contact is in between square brackets, followed by the nickname suggestions from the IM module if available, or otherwise the handle. Because of the "-@" part, everything from the first @ will be stripped.
     795                        </para>
     796
     797                        <para>
     798                                See <emphasis>help nick_format</emphasis> for more information.
    770799                        </para>
    771800                </description>
  • doc/user-guide/misc.xml

    rbadd148 rdb2cef1  
    180180</sect1>
    181181
     182<sect1 id="nick_format">
     183<title>Nickname formatting</title>
     184
     185<para>
     186The <emphasis>nick_format</emphasis> setting can be set globally using the
     187<emphasis>set</emphasis> command, or per account using <emphasis>account
     188set</emphasis> (so that you can set a per-account suffix/prefix or have
     189nicknames generated from full names for certain accounts).
     190</para>
     191
     192<para>
     193The setting is basically some kind of format string. It can contain normal
     194text that will be copied to the nick, combined with several variables:
     195</para>
     196
     197<variablelist>
     198        <varlistentry><term>%nick</term><listitem><para>Nickname suggested for this contact by the IM protocol, or just the handle if no nickname was suggested.</para></listitem></varlistentry>
     199        <varlistentry><term>%handle</term><listitem><para>The handle/screenname of the contact.</para></listitem></varlistentry>
     200        <varlistentry><term>%full_name</term><listitem><para>The full name of the contact.</para></listitem></varlistentry>
     201        <varlistentry><term>%first_name</term><listitem><para>The first name of the contact (the full name up to the first space).</para></listitem></varlistentry>
     202        <varlistentry><term>%group</term><listitem><para>The name of the group this contact is a member of</para></listitem></varlistentry>
     203</variablelist>
     204
     205<para>
     206One modifier is currently available: %-@variable will remove all characters from the first @ in the string.
     207</para>
     208
     209<para>
     210In all cases, invalid characters (like spaces) will be stripped. Depending
     211on your locale settings, characters with accents will be converted to ASCII.
     212</para>
     213
     214</sect1>
     215
    182216</chapter>
Note: See TracChangeset for help on using the changeset viewer.