File: kdenetwork/doc/ksirc/index.docbook The KSirc configuration dialog has a lot of new items which are currently undocumented. Description of the behavior of each of these items should be added. If you wish to take up this todo, please contact kde-doc-english@kde.org to avoid duplicating effort.
Anne-Marie Mahfouf has already improved the configuration section, but some work remains (see log for r397089).
Created attachment 19021 [details] KSirc patch to add to configuration and fix validation errors This patch adds the extra information to the configuration section as well as validates the entire book now.
SVN commit 619158 by lueck: patch provided by Richard Johnson, thanks a lot. BUG:74425 M +51 -19 index.docbook --- trunk/KDE/kdenetwork/doc/ksirc/index.docbook #619157:619158 @@ -430,7 +430,7 @@ <variablelist> <varlistentry> -<term><guilabel>SDI node (old behavior)</guilabel></term> +<term><guilabel>SDI mode (old behavior)</guilabel></term> <listitem><para>Causes &ksirc; to use single document interface mode, in which each new channel or <command>/query</command> window has its own, separate window.</para></listitem> @@ -597,7 +597,8 @@ <varlistentry> <term><guilabel>Show topic</guilabel></term> -<listitem><para>Displays the channel topic on top of each channel window.</para></listitem> +<listitem><para>If enabled, shows the topic for each channel, either in the title of the window or in the top section of the channel's tab. +If disabled, you must type <userinput>/topic</userinput> to see the topic of the channel.</para></listitem> </varlistentry> <varlistentry> @@ -608,22 +609,15 @@ </varlistentry> <varlistentry> -<term><guilabel>Hide part/join messages</guilabel></term> -<listitem><para>Don't show part/join messages. This is useful in a channel with many people.</para></listitem> -</varlistentry> - -<varlistentry> -<term><guilabel>Show topic</guilabel></term> -<listitem><para>If enabled, shows the topic for each channel, either in the title of the window or in the top section of the channel's tab. -If disabled, you must type <userinput>/topic</userinput> to see the topic of the channel.</para></listitem> -</varlistentry> - -<varlistentry> <term><guilabel>Enable logging</guilabel></term> <listitem><para>Creates log files for each channel, each day. These log files are stored in <systemitem class="filesystem">$KDEHOME/share/apps/ksirc/logs/</systemitem> and the files are named as follows: <systemitem class="filesystem">$KDEHOME/share/apps/ksirc/logs/#channelname_year_month_day_servername.log</systemitem></para></listitem> </varlistentry> +<varlistentry> +<term><guilabel>Hide part/join messages</guilabel></term> +<listitem><para>Don't show part/join messages. This is useful in a channel with many people.</para></listitem> +</varlistentry> <varlistentry> <term><guilabel>Default encoding</guilabel></term> @@ -731,11 +725,17 @@ </varlistentry> <varlistentry> - <term><guilabel>Color Codes</guilabel></term> - <listitem><para>Here you can set whether &ksirc; allows native color codes (see <xref - linkend="sectcolors"/>) and also whether &mirc; color codes are allowed.</para> - </listitem> +<term><guilabel>Highlight Messages</guilabel></term> +<listitem><para>Choose how the messages you have chosen to highlight are colored. You can choose the color for messages containing your nick in the <guilabel>Containing your nick</guilabel> field. You can select highlighting for up to two custom expressions in the <guilabel>Containing</guilabel> fields.</para> +</listitem> </varlistentry> + +<varlistentry> +<term><guilabel>Color Codes</guilabel></term> +<listitem><para>Here you can set whether &ksirc; allows native color codes (see <xref +linkend="sectcolors"/>) and also whether &mirc; color codes are allowed.</para> +</listitem> +</varlistentry> </variablelist> </sect2> @@ -753,12 +753,44 @@ by choosing the correct folder tab at the top. </para> +<sect2 id="dark-colors"> +<title>The <guilabel>Dark Colors</guilabel> Tab</title> +<para>Here you can configure the darker colors used by &ksirc;. The available colors are: +<itemizedlist> +<listitem><para><guilabel>White</guilabel></para></listitem> +<listitem><para><guilabel>Black</guilabel></para></listitem> +<listitem><para><guilabel>Dark blue</guilabel></para></listitem> +<listitem><para><guilabel>Dark green</guilabel></para></listitem> +<listitem><para><guilabel>Red</guilabel></para></listitem> +<listitem><para><guilabel>Brown</guilabel></para></listitem> +<listitem><para><guilabel>Magenta</guilabel></para></listitem> +<listitem><para><guilabel>Orange</guilabel></para></listitem> +</itemizedlist> +</para> +</sect2> + +<sect2 id="light-colors"> +<title>The <guilabel>Light Colors</guilabel> Tab</title> +<para>Here you can configure the lighter colors used by &ksirc;. The available colors are: +<itemizedlist> +<listitem><para><guilabel>Yellow</guilabel></para></listitem> +<listitem><para><guilabel>Green</guilabel></para></listitem> +<listitem><para><guilabel>Dark cyan</guilabel></para></listitem> +<listitem><para><guilabel>Cyan</guilabel></para></listitem> +<listitem><para><guilabel>Blue</guilabel></para></listitem> +<listitem><para><guilabel>Purple</guilabel></para></listitem> +<listitem><para><guilabel>Gray</guilabel></para></listitem> +<listitem><para><guilabel>Light gray</guilabel></para></listitem> +</itemizedlist> +</para> +</sect2> + </sect1> <sect1 id="user-menu-tab"> <title>The <guilabel>User Menu</guilabel> Tab</title> -<para>This page allows configuration for the RMB (Right Mouse Button) menu for the nick list located on the right in each channel. When you right click on a nickname, some actions are defined by default. These are the actions listed on the left. You can change these actions order, delete some and add others. The ampersand (<keycap>&</keycap>) should be placed before the letter in the command which will be the shortcut key. To access this key, you would press the <keycap>Tab</keycap> key. Look at the predefined commands to get a feel for the syntax. -</para> +<para>This page allows configuration for the RMB (Right Mouse Button) menu for the nick list located on the right in each channel. When you right click on a nickname, some actions are defined by default. These are the actions listed on the left. You can change these actions order, delete some and add others. The ampersand (<keycap>&</keycap>) should be placed before the letter in the command which will be the shortcut key. To access this key, you would press <keycombo><keycap><userinput>key</userinput></keycap></keycombo>. Look at the predefined commands to get a feel for the syntax. +See also <xref linkend="user-options"/> for details about the predefined commands.</para> </sect1> <sect1 id="server-channel-tab">