Created attachment 18987 [details]
A new version for KSirc docbook, with all errors corrected

Created attachment 18988 [details]
A 'svn diff' output for the index.docbook on SVN

Created attachment 19002 [details]
Validated Patch for KSirc Bug 139046

Per Phil Rodriguez in #kde-docs (IRC)

This patch is validated and shows no errors for KSirc documentation.

SVN commit 619143 by lueck:

reviewed patches provided by Richard Johnson and Jose Nuno Coelho Pires, thanks a lot. Fixed some wrong guiitems and menu shortcuts
BUG:139046

 M  +34 -38    index.docbook  


--- trunk/KDE/kdenetwork/doc/ksirc/index.docbook #619142:619143
@@ -1,7 +1,7 @@
 <?xml version="1.0" ?>
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   <!ENTITY mirc "<application>mIrc</application>">
-  <!ENTITY sirc "<application>sIrc</appliation>">
+  <!ENTITY sirc "<application>sIrc</application>">
   <!ENTITY kappname "&ksirc;">
   <!ENTITY package "kdenetwork">
   <!ENTITY irc "<acronym>IRC</acronym>">
@@ -97,8 +97,7 @@
 
 <para>To connect to a server, open &ksirc;.  The first time use it, the
 <guilabel>Server Control</guilabel> window will appear.  Choose 
-<guimenuitem><menuchoice>Connections</guimenuitem></menuchoice>
-<guimenuitem><menuchoice>New Server</menuchoice></guimenuitem> or press <keycap>F2</keycap>. In the
+<menuchoice><guimenu>Connections</guimenu><guimenuitem>New Server...</guimenuitem></menuchoice> or press <keycap>F2</keycap>. In the
 dialog box that is displayed, select a group from the leftmost drop-down
 box and then a server from the middle drop-down box. If you know the name of the
 server you wish to connect to, you may type it directly into the middle drop-down box.  The port, 
@@ -110,8 +109,8 @@
 this command, because it may take a lot of server resources if there is a large number
 of channels.  To join a channel,
 type: <userinput><command>/join</command>
-<replaceable>#channelname</replaceable></userinput>. Alternately, choose <guimenuitem><menuchoice>Channel</menuchoice></guimenuitem>
-and then <guimenuitem><menuchoice>New</menuchoice></guimenuitem>.  To leave a channel,
+<replaceable>#channelname</replaceable></userinput>. Alternately, choose 
+<menuchoice><guimenu>Channel</guimenu><guimenuitem>New</guimenuitem></menuchoice>.  To leave a channel,
 just type <userinput><command>/part</command></userinput>.</para>
 
 <para>That's the basics; for more detailed information, read
@@ -128,7 +127,7 @@
 <para>&ksirc; allows you to connect to any number of
 servers. To connect to a server, select
 <menuchoice><guimenu>Connections</guimenu><guimenuitem>New
-Server</guimenuitem></menuchoice> or press <keycap>F2</keycap>.The
+Server...</guimenuitem></menuchoice> or press <keycap>F2</keycap>.The
 <guilabel>Connect to Server</guilabel> Dialog appears, and you can select a
 <guilabel>Group</guilabel>, then a <guilabel>Server</guilabel>, and also
 a <guilabel>Port</guilabel> to connect to.</para>
@@ -172,12 +171,12 @@
 
 <varlistentry>
 <term><menuchoice>
-<shortcut><keycombo>&Ctrl;<keycap>N</keycap>
+<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap>
 </keycombo></shortcut>
 <guimenuitem>New</guimenuitem>
 </menuchoice></term>
 <listitem>
-<para><action>Brings up the <guilabel>New Channel</guilabel> dialog.</action></para>
+<para><action>Brings up the <guilabel>New Window For</guilabel> dialog.</action></para>
 </listitem>
 </varlistentry>
 
@@ -185,16 +184,16 @@
 <term><menuchoice>
 <shortcut><keycap>F2</keycap>
 </shortcut>
-<guimenuitem>New Server</guimenuitem>
+<guimenuitem>New Server...</guimenuitem>
 </menuchoice></term>
 <listitem>
-<para><action>Brings up the <guilabel>New Server</guilabel> dialog.</action></para>
+<para><action>Brings up the <guilabel>Connect to Server</guilabel> dialog.</action></para>
 </listitem>
 </varlistentry>
 
 <varlistentry>
 <term><menuchoice>
-<shortcut><keycombo>&Ctrl;<keycap>S</keycap>
+<shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap>
 </keycombo></shortcut>
 <guimenuitem>Save to Logfile...</guimenuitem>
 </menuchoice></term>
@@ -206,7 +205,7 @@
 
 <varlistentry>
 <term><menuchoice>
-<shortcut><keycombo action="seq">&Ctrl;<keycap>T</keycap></keycombo>
+<shortcut><keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>
 </shortcut>
 <guimenuitem>Time Stamp</guimenuitem>
 </menuchoice></term>
@@ -225,10 +224,8 @@
 </listitem>
 </varlistentry>
 
-
-
 <varlistentry>
-<term><menuchoice> <shortcut><keycombo action="seq">&Alt;<keycap>C</keycap>
+<term><menuchoice> <shortcut><keycombo action="simul">&Ctrl;
 <keycap>H</keycap></keycombo></shortcut>
 <guimenuitem>Character Table</guimenuitem>
 </menuchoice></term>
@@ -238,7 +235,7 @@
 </varlistentry>
 
 <varlistentry>
-<term><menuchoice><shortcut><keycombo action="seq">&Alt;<keycap>C</keycap>
+<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;
 <keycap>P</keycap></keycombo></shortcut>
 <guimenuitem>Notify on Change</guimenuitem>
 </menuchoice></term>
@@ -249,7 +246,7 @@
 
 <varlistentry>
 <term><menuchoice>
-<shortcut><keycombo action="seq">&Ctrl;<keycap>O</keycap></keycombo>
+<shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
 </shortcut>
 <guimenuitem>Show Topic</guimenuitem>
 </menuchoice></term>
@@ -276,8 +273,8 @@
 <para><action>Opens a sub-menu which allows you to specify the character encoding method you would like to use.
 </action></para>
 </listitem>
+</varlistentry>
 
-
 </variablelist>
 
 </sect2>
@@ -286,8 +283,8 @@
 <title>User Options</title>
 
 <para>In a channel, the user list is displayed along the right hand
-side. Right-clicking a nickname in that list gives you a popup menu of
-options, most of which are self-explanatory. Those actions can be configured (changing the order, adding or removing some) in the <guilabel><menuoption>Settings</menuoption></guilabel><guilabel><menuitem>Configure &ksirc;</menuitem></guilabel> dialog in the <guilabel>Server Control</guilabel> window. The default actions are the following:</para>
+side. <mousebutton>Right</mousebutton> clicking a nickname in that list gives you a popup menu of
+options, most of which are self-explanatory. Those actions can be configured (changing the order, adding or removing some) in the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &ksirc;</guimenuitem></menuchoice> dialog in the Server Control window. The default actions are the following:</para>
 
 <variablelist>
 
@@ -344,8 +341,8 @@
 <varlistentry>
 <term><guimenuitem>Abuse</guimenuitem></term>
 <listitem>
-<para><action><wordasword>Abuses</wordasword> the user in one of various amusing
-ways.</action></para>
+<para><wordasword>Abuses</wordasword> the user in one of various amusing
+ways.</para>
 </listitem>
 </varlistentry>
 
@@ -405,10 +402,10 @@
 KSirc</guimenuitem></menuchoice>, and in the dialog which appears,
 select the <guilabel>Auto Connect</guilabel> page. Fill in the <guilabel>Server</guilabel> and, 
 optionally, the <guilabel>Channel</guilabel>, and then click the
-<guibutton>Add</guibutton>. To add another channel on this server,
+<guibutton>Add</guibutton> button. To add another channel on this server,
 select the server name in the tree view, enter the channel name in the
 <guilabel>Channel</guilabel> text box, and click the
-<guibutton>Update/Add</guibutton> button. Repeat this process for each
+<guibutton>Add</guibutton> button. Repeat this process for each
 server you would like to add.</para>
 </sect1>
 
@@ -420,7 +417,7 @@
 <sect1 id="config-intro">
 <title>Introduction to Configuration</title>
 <para>The &ksirc; configuration dialog is available from
-<menuchoice><guimenu>Options</guimenu><guimenuitem>Preferences...</guimenuitem></menuchoice>
+<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &ksirc;...</guimenuitem></menuchoice>
 in the &ksirc; <guilabel>Server Control</guilabel> window.
 </para>
 </sect1>
@@ -433,7 +430,7 @@
 <variablelist>
 
 <varlistentry>
-<term><guilabel>SDI Mode (old behavior)</guilabel></term>
+<term><guilabel>SDI node (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>
@@ -544,8 +541,7 @@
 
 <varlistentry>
 <term><guilabel>Use color nick list</guilabel></term>
-<listitem><para>If selected, nicknames will be colored using the colors set in the Colors tab of the <guilabel><menuitem>Settings</menuitem></guilabel>
-<guilabel><menuitem>Configure &ksirc;</menuitem></guilabel> dialog, in a random fashion.</para></listitem>
+<listitem><para>If selected, nicknames will be colored using the colors set in the Colors tab of the <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure &ksirc;</guisubmenu></menuchoice> dialog, in a random fashion.</para></listitem>
 </varlistentry>
 
 <varlistentry>
@@ -589,7 +585,7 @@
 
 <varlistentry>
 <term><guilabel>Override existing channel options</guilabel></term>
-<listitem><para>If this is selected, the settings in this tab will override options set on a per-channel basis in the <guilabel><menuoption>Channel</menuoption></guilabel> menu. This setting will reset to its unchecked state each time you open this dialog. This is because you probably don't want to override the existing channel options all the time.  This option has the functionality of a "Reset" button.</para></listitem>
+<listitem><para>If this is selected, the settings in this tab will override options set on a per-channel basis in the <guimenu>Channel</guimenu> menu. This setting will reset to its unchecked state each time you open this dialog. This is because you probably don't want to override the existing channel options all the time.  This option has the functionality of a "Reset" button.</para></listitem>
 </varlistentry>
 
 <varlistentry>
@@ -725,12 +721,12 @@
 <varlistentry>
 <term><guilabel>Your Nick</guilabel></term>
 <listitem><para>Choose a color for your own nickname to be highlighted.  You can also choose one or more of <guilabel>Bold</guilabel>,
-<guilabel>Reversed</guilabel<, or <guilabel>Underlined</guilabel>.</para></listitem>
+<guilabel>Reverse</guilabel>, or <guilabel>Underlined</guilabel>.</para></listitem>
 </varlistentry>
 
 <varlistentry>
 <term><guilabel>Other Nicks</guilabel></term>
-<listitem><para>Choose how other nicks are colored.  You can choose <guilabel>No Nick Colors</guilabel>, <guilabel>Auto Nick Coloration</guilabel>
+<listitem><para>Choose how other nicks are colored.  You can choose <guilabel>No nick colors</guilabel>, <guilabel>Auto nick colorization</guilabel>
 (uses colors in the next section), or <guilabel>Fixed</guilabel>, which lets you choose the foreground and background for all nicknames.</para></listitem>
 </varlistentry>
 
@@ -746,7 +742,7 @@
 </sect1>
 
 <sect1 id="irc-colors">
-<title><guilabel>IRC colors</guilabel> Configuration</title>
+<title><guilabel>IRC Colors</guilabel> Configuration</title>
 <para>
 Here you can set colors for each of the types of text. Clicking the color
 button to the right of each text type's label will display a color selector box
@@ -761,7 +757,7 @@
 
 <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 <keycombo action="&tab;"><keycap><userinput>key</userinput></keycap></keycombo>.  Look at the predefined commands to get a feel for the syntax.
+<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>&amp;</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>
 </sect1>
 
@@ -771,11 +767,11 @@
 </para>
 <sect2 id="server-config">
 <title>Server</title>
-<para>You add there the servers you want to use. Write the server name in the field and click the Add Server to List button. If you want to delete a server from the list, you click on the server name and then on the Delete Server from List button.</para>
+<para>You add there the servers you want to use. Write the server name in the field and click the <guibutton>Add Server to List</guibutton> button. If you want to delete a server from the list, you click on the server name and then on the <guibutton>Delete Server From List</guibutton> button.</para>
 </sect2>
 <sect2 id="channels-config">
 <title>Channels</title>
-<para>You add there the channels you want to connect to. Write the channel name in the field and click the Add Channel to List button. If you want to delete a channel from the list, you click on the channel name and then on the Delete Channel from List button.</para>
+<para>You add there the channels you want to connect to. Write the channel name in the field and click the <guibutton>Add Channel to List</guibutton> button. If you want to delete a channel from the list, you click on the channel name and then on the <guibutton>Delete Channel From List</guibutton> button.</para>
 </sect2>
 </sect1>
 
@@ -787,10 +783,10 @@
 <title>Auto Connect Setup</title>
 <para>Fill in the <guilabel>Server</guilabel> and, 
 optionally, the <guilabel>Channel</guilabel>, and then click the
-<guibutton>Add</guibutton>. To add another channel on this server,
+<guibutton>Add</guibutton> button. To add another channel on this server,
 select the server name in the tree view, enter the channel name in the
 <guilabel>Channel</guilabel> text box, and click the
-<guibutton>Update/Add</guibutton> button. Repeat this process for each
+<guibutton>Add</guibutton> button. Repeat this process for each
 server you would like to add.</para>
 
 </sect2>
@@ -799,7 +795,7 @@
 <sect1 id="fonts-tab">
 <title>The <guilabel>Fonts</guilabel> Tab</title>
 <para>
-You can change here the font for the main window. Select the font you want then click the Apply button to preview the change. <guibutton>OK</guibutton> applies the changes and quits the dialog.
+You can change here the font for the main window. Select the font you want then click the <guibutton>Apply</guibutton> button to preview the change. <guibutton>OK</guibutton> applies the changes and quits the dialog.
 </para>
 </sect1>