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

Document this complex new beast.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 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.