From: <it_...@us...> - 2007-10-29 00:39:43
|
Revision: 2148 http://kmess.svn.sourceforge.net/kmess/?rev=2148&view=rev Author: it_amroth Date: 2007-10-28 17:39:48 -0700 (Sun, 28 Oct 2007) Log Message: ----------- Updated again the user manual, this time with all latest KMess features; reorganized the sections to be easier to browse, corrected a couple typos. The images are currently placeholders. Modified Paths: -------------- trunk/kmess/ChangeLog trunk/kmess/doc/en/chatwindow-emoticons.png trunk/kmess/doc/en/index.docbook Added Paths: ----------- trunk/kmess/doc/en/chatwindow-custom-emoticons-add.png trunk/kmess/doc/en/settings-dialog-account.png trunk/kmess/doc/en/settings-dialog-chatlogs.png trunk/kmess/doc/en/settings-dialog-chatting.png trunk/kmess/doc/en/settings-dialog-email.png trunk/kmess/doc/en/settings-dialog-emoticons-custom.png trunk/kmess/doc/en/settings-dialog-emoticons.png trunk/kmess/doc/en/settingswindow-emoticons.png Modified: trunk/kmess/ChangeLog =================================================================== --- trunk/kmess/ChangeLog 2007-10-28 16:48:34 UTC (rev 2147) +++ trunk/kmess/ChangeLog 2007-10-29 00:39:48 UTC (rev 2148) @@ -6,6 +6,8 @@ * Disabled the Browse button when adding a new emoticon clicked in a chat window. Also fixed a compiler error with debugging on. * Fixed display and parsing issues with received custom emoticons; they weren't being displayed correctly sometimes, and weren't being converted when downloaded. * Added file size to the message displayed when sending a file. + * Updated again the user manual with all latest KMess features; reorganized the sections to be easier to browse, corrected + a couple typos. 2007-10-25 (Valerio) * Improved direct connection read sensing, to avoid non-existant socket read errors. Added: trunk/kmess/doc/en/chatwindow-custom-emoticons-add.png =================================================================== (Binary files differ) Property changes on: trunk/kmess/doc/en/chatwindow-custom-emoticons-add.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/kmess/doc/en/chatwindow-emoticons.png =================================================================== (Binary files differ) Modified: trunk/kmess/doc/en/index.docbook =================================================================== --- trunk/kmess/doc/en/index.docbook 2007-10-28 16:48:34 UTC (rev 2147) +++ trunk/kmess/doc/en/index.docbook 2007-10-29 00:39:48 UTC (rev 2148) @@ -153,7 +153,8 @@ <listitem><para> Chat conversations. </para></listitem> <listitem><para> Display pictures exchange. </para></listitem> <listitem><para> Fast file transfers. </para></listitem> - <listitem><para> Receiving nudges, winks, custom emoticons and offline-im messages. </para></listitem> + <listitem><para> Receiving and sending nudges. </para></listitem> + <listitem><para> Receiving winks, custom emoticons and offline-im messages. </para></listitem> <listitem><para> Exchange of <quote>Now Playing...</quote> information. </para></listitem> <listitem><para> Transferring file thumbnail previews. </para></listitem> <listitem><para> E-mail notifications for Hotmail accounts. </para></listitem> @@ -182,7 +183,12 @@ <sect1 id="login"> <title>Logging in</title> - <!-- TODO: intro --> + <para> + Being an MSN Messenger client, you need to access the MSN Service to be able to see your contacts and + chat with them. To do so, you can use your account details - right as you do with the official client + on Microsoft Windows - or register a new account on the Microsoft Passport web site. After you log in, + you will be able to use &kapp;. + </para> <sect2 id="login-create-account"> <title>Creating an account</title> @@ -192,6 +198,12 @@ at <ulink url="http://register.passport.com">register.passport.com</ulink> to create the account. After the registration process, you can use your e-mail address to login to the MSN Messenger Service. </para> + <para> + After you create an account, you will receive an MSN confirmation email and have to click on the confirmation + link which is in that email. Until you click on that link, your account will be restricted: you will be able to + add very few contacts and your will not be able to change your own friendly name. In your Passport Account page, + you can make MSN to send you another activation email. + </para> </sect2> @@ -229,12 +241,12 @@ </sect1> - <sect1 id="contactlist"> - <title>Updating the contacts list</title> + <sect1 id="using-list"> + <title>Using the Contacts List</title> <para> - The contact list gives you an overview of the buddies you can chat with. + The contact list gives you an organized overview of the buddies (the "contacts") you can chat with. To view the contact list, you need to be logged in first. - The following screenshot gives an overview of the contact list: + The following image gives an example of a contact list: <screenshot> <screeninfo>Here's a screenshot of &kapp;</screeninfo> @@ -245,7 +257,73 @@ </screenshot> </para> + <sect2 id="using-list-appearance"> + <title>Setting your appearance</title> + <sect3 id="using-list-appearance-status"> + <title>Changing your status</title> + <para> + There are three ways to change the your current status when you are connected to the <ulink url="http://messenger.msn.com">MSN Messenger Service</ulink>. + One way is to use the dropdown menu in the main &kmess; window. The second way is changing the status in <guimenu>Connect</guimenu> from the main &kmess; window. + Another one is to right-click on the &kmess; tray icon, then click <guimenu>My Status</guimenu>. + There are different statuses available: + </para> + <para> + <itemizedlist> + <listitem><para> Online </para></listitem> + <listitem><para> Away </para></listitem> + <listitem><para> Away with auto reply </para></listitem> + <listitem><para> Be right Back </para></listitem> + <listitem><para> Busy </para></listitem> + <listitem><para> Out for Lunch </para></listitem> + <listitem><para> On the Phone </para></listitem> + <listitem><para> Invisible </para></listitem> + </itemizedlist> + </para> + <para> + &kmess; differentiates between three 'Away' kinds of status. + The standard 'Away' status is the one you may be familiar with from other MSN Messenger clients. + </para> + <para> + When you set your status to 'Away with auto reply', a window appears and you can type in your auto reply message. + This message will be sent automatically to every person who starts a chat with you. + </para> + <para> + After 5 minutes of inactivity, most clients change the status to "Away-Idle" by default. + While most MSN Messenger clients display this status as "Away", &kmess; explicitly distuinguishes between the two states. + The contact list tells you whether the contact set it's status to "Away", or it was automatically set to away (displayed as "Away-Idle"). + </para> + <para> + By default, &kmess; switches to "Away-Idle" too after 5 minutes of inactivity. + This setting can be changed or disabled in the "Alerts" section of the profile settings. + </para> + </sect3> + </sect2> + + + <sect2 id="using-chat"> + <title>Starting chat conversations</title> + + <sect3 id="using-chat-single"> + <title>Starting a chat with a contact</title> + <para> + Click on an online contact on the contact list, + or choose "Chat" from its right-click menu. + The chat window opens, and you can send the first message to the contact. + </para> + </sect3> + + <sect3 id="using-chat-multiple"> + <title>Starting a chat with multiple participants</title> + <para> + Open a chat with a contact as described in <link linkend="using-chat-single">How to start a chat with a contact</link>. + In the opened chat window, go to <menuchoice><guimenu>Chat</guimenu> <guimenuitem>Invite</guimenuitem></menuchoice>. + In the submenu choose the contact you want to add to the existing chat. Do this + with all contacts you'd like to add. + </para> + </sect3> + </sect2> + <sect2 id="contactlist-contacts"> <title>Managing contacts</title> @@ -376,13 +454,23 @@ <sect2 id="contactlist-other"> <title>Other actions in the contact list window</title> + <sect3 id="contactlist-other-personalmessage"> + <title>Changing your own Personal Message</title> + <para> + &kmess; supports the MSN Personal Message feature: under the displayed friendly name in the Contact list window, + you'll see a rectangle with "<Enter your personal message here>" written on it. Click it, and you will be + able to change it. To confirm your changes, press Enter or click somewhere else. If you want to no longer display + a personal message, just empty the field. + </para> + </sect3> + <sect3 id="contactlist-other-sendmail"> <title>Send an e-mail to a contact using my Hotmail Account</title> <para> Right-click on the contact you wish to write an email to, and click on "Send Email". &kmess; will open your Hotmail Account with the "Compose" interface and the contact's email address in the "To" line. - When you are in a chat, you can also click, in the <link linkend="actions-chat-sidebar">contact sidebar</link>, + When you are in a chat, you can also click, in the <link linkend="using-chat-sidebar">contact sidebar</link>, on the email address beneath the contact's image to send an email to that person. Also see <link linkend="settings-dialog-email">Email options</link>. </para> @@ -394,7 +482,7 @@ Right-click on the contact you want to see the profile of, and click on "Show Profile". &kmess; will open the MSN Profile of that contact in a web browser. When you are in a chat, you can also click on the contact's image - in the <link linkend="actions-chat-sidebar">contact sidebar</link> + in the <link linkend="using-chat-sidebar">contact sidebar</link> to open that contact's profile. </para> </sect3> @@ -438,287 +526,217 @@ </sect2> </sect1> + <sect1 id="using-chat-windows"> + <title>Using the Chat Windows</title> + <para> + The Chat Window is the place where your conversations happen. You can chat with one or more contacts together in a + single chat window: see <link linkend="using-chat-single">Starting a chat with a contact</link> and + <link linkend="using-chat-multiple">Starting a chat with multiple participants</link> for more details. + </para> + <mediaobject> + <imageobject><imagedata fileref="chatwindow-withsidebar.png" format="PNG"/></imageobject> + <textobject><phrase>The &kmess; chat window</phrase></textobject> + </mediaobject> - <sect1 id="actions"> - <title>Standard actions</title> + <sect2 id="using-chat-chatting"> + <title>Chatting</title> + <para> + Once you have a chat window open, either opened by you or by some of your contacts which wants to talk to you, the + chat can begin. Arrived messages are visible in the big upper area of the window, and you can type your own + messages in the smaller area on the window bottom. + </para> + <para> + Then you can press Enter to instantly send your message, or Shift+Enter to insert a new line in your typed message. + The two buttons at the right side of the typing area do just that without using the keyboard. + </para> + <para> + On the right side of the window, you will by default see the Sidebar (see <link linkend="using-chat-sidebar">Using + the Sidebar</link> to learn more about it). It displays the names and pictures of all contacts who are currently + participating to the conversation. If you don't like it, you can click on the + <guiicon> + Contact Sidebar + <inlinemediaobject> + <imageobject><imagedata fileref="sidebarbutton.png" format="PNG"/></imageobject> + </inlinemediaobject> + </guiicon> + Toolbar button to hide it. The names of the people who are chatting with you will still be visible on the + window titlebar. + </para> + </sect2> - <sect2 id="actions-appearance"> - <title>Setting your appearance</title> + <sect2 id="using-chat-emoticons-standard"> + <title>Emoticons</title> + <para> + &kmess; comes with the default Emoticons theme made by David Vignoni. + </para> + <para> + <mediaobject> + <imageobject><imagedata fileref="chatwindow-emoticons.png" format="PNG"/></imageobject> + <textobject><phrase>The default &kmess; Emoticons</phrase></textobject> + </mediaobject> + </para> + <para> + In the chat window you will find a button in the top in the toolbar, with a smilie. + <guiicon> + Emoticon Sidebar + <inlinemediaobject> + <imageobject><imagedata fileref="emoticonsbutton.png" format="PNG"/></imageobject> + </inlinemediaobject> + </guiicon> - <sect3 id="actions-appearance-status"> - <title>Changing your status</title> - <para> - There are three ways to change the your current status when you are connected to the <ulink url="http://messenger.msn.com">MSN Messenger Service</ulink>. - One way is to use the dropdown menu in the main &kmess; window. The second way is changing the status in <guimenu>Connect</guimenu> from the main &kmess; window. - Another one is to right-click on the &kmess; tray icon, then click <guimenu>My Status</guimenu>. - There are different statuses available: - </para> - <para> - <itemizedlist> - <listitem><para> Online </para></listitem> - <listitem><para> Away </para></listitem> - <listitem><para> Away with auto reply </para></listitem> - <listitem><para> Be right Back </para></listitem> - <listitem><para> Busy </para></listitem> - <listitem><para> Out for Lunch </para></listitem> - <listitem><para> On the Phone </para></listitem> - <listitem><para> Invisible </para></listitem> - </itemizedlist> - </para> - <para> - &kmess; differentiates between three 'Away' kinds of status. - The standard 'Away' status is the one you may be familiar with from other MSN Messenger clients. - </para> - <para> - When you set your status to 'Away with auto reply', a window appears and you can type in your auto reply message. - This message will be sent automatically to every person who starts a chat with you. - </para> - <para> - After 5 minutes of inactivity, most clients change the status to "Away-Idle" by default. - While most MSN Messenger clients display this status as "Away", &kmess; explicitly distuinguishes between the two states. - The contact list tells you whether the contact set it's status to "Away", or it was automatically set to away (displayed as "Away-Idle"). - </para> - <para> - By default, &kmess; switches to "Away-Idle" too after 5 minutes of inactivity. - This setting can be changed or disabled in the "Alerts" section of the profile settings. - </para> - </sect3> + By clicking this button the Emoticons Sidebar will open. Clicking on one emoticon will insert it in your textbox. Sending the message now will display the emoticon in the chat. + + See also <link linkend="settings-dialog-emoticons">Emoticon Themes</link>. + </para> </sect2> + <sect2 id="using-chat-emoticons-custom"> + <title>Custom Emoticons</title> + <para> + With &kmess; you can also exchange your own emoticons with your friends. To use them, click on the My Emoticons + label in the Sidebar, and choose a custom emoticon from the list, just like you do with <link linkend="using-chat-emoticons-standard">standard emoticons</link>. + </para> + <para> + When you first use &kmess; or create a new account, the list will be empty. But adding new ones is easy, you can + do it in two ways: - <sect2 id="actions-chat"> - <title>Starting chat conversations</title> + <itemizedlist> + <listitem><para> Save the emoticons sent to you by your contacts; or </para></listitem> + <listitem><para> Add them by choosing images from your computer. </para></listitem> + </itemizedlist> - <sect3 id="actions-chat-single"> - <title>Starting a chat with a contact</title> - <para> - Click on an online contact on the contact list, - or choose "Chat" from its right-click menu. - The chat window opens, and you can send the first message to the contact. - </para> - </sect3> + When a contact who you are chatting with sends to you a custom emoticon, you can click on it + to add it to your own custom emoticon theme. A dialog window will pop up: - <sect3 id="actions-chat-multiple"> - <title>Starting a chat with multiple participants</title> - <para> - Open a chat with a contact as described in <link linkend="actions-chat-single">How to start a chat with a contact</link>. - In the opened chat window, go to <menuchoice><guimenu>Chat</guimenu> <guimenuitem>Invite</guimenuitem></menuchoice>. - In the submenu choose the contact you want to add to the existing chat. Do this - with all contacts you'd like to add. - </para> - </sect3> - </sect2> + <mediaobject> + <imageobject><imagedata fileref="chatwindow-custom-emoticons-add.png" format="PNG"/></imageobject> + <textobject><phrase>The Add Custom Emoticon dialog</phrase></textobject> + </mediaobject> - <sect2 id="actions-chat2"> - <title>Other actions in the chat window</title> + If you want, you can change there the text shortcut associated to the new emoticon; then by + clicking the <guibutton>Ok</guibutton> button you'll be instantly able to select the new emoticon from the + My Emoticons tab, in the chat window's Sidebar. + </para> - <sect3 id="actions-chat-emoticons"> - <title>Emoticons</title> - <para> - &kmess; comes with the default Emoticons by David Vignoni. - </para> - <para> - <mediaobject> - <imageobject><imagedata fileref="chatwindow-emoticons.png" format="PNG"/></imageobject> - <textobject><phrase>The default &kmess; Emoticons</phrase></textobject> - </mediaobject> - </para> - <para> - In the chat window you will find a button in the top in the toolbar, with a smilie. - <guiicon> - Emoticon Sidebar - <inlinemediaobject> - <imageobject><imagedata fileref="emoticonsbutton.png" format="PNG"/></imageobject> - </inlinemediaobject> - </guiicon> + <para> + Alternatively, you can open your account's Settings dialog, select <menuchoice><guimenu>Emoticons></guimenu> <guimenuitem>Custom Emoticons icons</guimenuitem> </menuchoice> + and click the <guibutton>Add new...</guibutton> button. + </para> + </sect2> - By clicking this button the Emoticons Sidebar will open. Clicking on one emoticon will insert it in your textbox. Sending the message now will display the emoticon in the chat. + <sect2 id="using-chat-filetransfer"> + <title>File transfer</title> + <para> + &kmess; supports transferring files through MSN. Please note, that there could be problems if you + are behind a router or a NAT. To send a file to a contact you first have to open a chat with + him or her. + </para> + <para> + Then you can send a file by choosing <menuchoice><guimenu>Chat></guimenu> <guimenuitem>Send File</guimenuitem> </menuchoice> from the menu. Choose the file you want to send to the contact. Confirm the action by clicking <guibutton>OK</guibutton>. Otherwise, you can click on the "Send a File" button located on the chat toolbar. + But by far, the easiest method to send one or more files to your contacts is drag and drop: just drag some + files from the desktop or a folder in Konqueror, and drop them over the chat messages view, or over the message + editor box. They will be immediately sent. + </para> + <para> + After your contact accepts to receive the file, The File Transfer Window of &kmess; will be opened and the + file will start to be transferred. + </para> + </sect2> - See also <link linkend="settings-dialog-emoticons">Emoticon Themes</link>. - </para> - </sect3> + <sect2 id="using-chat-sidebar"> + <title>Contact Sidebar</title> + <para> + You will find the contact sidebar in the chatwindow. You can display or hide it using the button + in the toolbar + <guiicon> + Contact Sidebar + <inlinemediaobject> + <imageobject><imagedata fileref="sidebarbutton.png" format="PNG"/></imageobject> + </inlinemediaobject> + </guiicon> + or using the menu entry + <menuchoice> <guimenu>Preferences</guimenu> <guimenuitem>Show/Hide Contact Sidebar</guimenuitem></menuchoice>. + The Contacts sidebar provides you with information and functions associated with each contact in + the chat. It shows various informations about the contacts you are in a conversation with: - <sect3 id="actions-chat-filetransfer"> - <title>File transfer</title> - <para> - &kmess; supports transferring files through MSN. Please note, that there could be problems if you - are behind a router or a NAT. To send a file to a contact you first have to open a chat with - him or her. Go to <menuchoice><guimenu>Chat></guimenu> <guimenuitem>Send File</guimenuitem> </menuchoice>. Choose the file you want to send to the contact. Confirm the action by clicking <guibutton>OK</guibutton>. - The File Transfer Window of &kmess; will be opened and the file will start transferring. - </para> - </sect3> + <itemizedlist> + <listitem><para> Nickname </para></listitem> + <listitem><para> Display picture </para></listitem> + <listitem><para> Current status </para></listitem> + <listitem><para> Email address </para></listitem> + <listitem><para> Personal Message </para></listitem> + </itemizedlist> - <sect3 id="actions-chat-sidebar"> - <title>Contact Sidebar</title> - <para> - You will find the contact sidebar in the chatwindow. You can display or hide it using the button - in the toolbar - <guiicon> - Contact Sidebar - <inlinemediaobject> - <imageobject><imagedata fileref="sidebarbutton.png" format="PNG"/></imageobject> - </inlinemediaobject> - </guiicon> - or using the menu entry - <menuchoice> <guimenu>Preferences</guimenu> <guimenuitem>Show/Hide Contact Sidebar</guimenuitem></menuchoice>. - The Contacts sidebar provides you with information and functions associated with each contact in - the chat. It shows various informations about the contacts you are in a conversation with: + More than that, when you make a right click on a contact in the Contact Sidebar, a menu with various + options will pop up. The menu will allow you to perform basic operations about the contact, and also + to copy to the clipboard some of its details: + </para> - <itemizedlist> - <listitem><para> Nickname </para></listitem> - <listitem><para> Display picture </para></listitem> - <listitem><para> Current status </para></listitem> - <listitem><para> Email address </para></listitem> - <listitem><para> Personal Message </para></listitem> - </itemizedlist> + <para> + <mediaobject> + <imageobject><imagedata fileref="chatwindow-contextmenu.png" format="PNG"/></imageobject> + <textobject><phrase>A contact's right-click menu.</phrase></textobject> + </mediaobject> + </para> - More than that, when you make a right click on a contact in the Contact Sidebar, a menu with various - options will pop up. The menu will allow you to perform basic operations about the contact, and also - to copy to the clipboard some of its details: - </para> + <para> + The Contact Sidebar has even more: when the person is writing a message, the contact image becomes + brighter. If you click it at any time, &kmess; will display that person's profile in your web browser. + Clicking the email address below it, will instead open your Hotmail Account at the "Compose Mail" + page, and the contact's email address in the "To" line. (See <link linkend="settings-dialog-email">Email Options</link> + as well). + </para> + </sect2> - <para> - <mediaobject> - <imageobject><imagedata fileref="chatwindow-contextmenu.png" format="PNG"/></imageobject> - <textobject><phrase>A contact's right-click menu.</phrase></textobject> - </mediaobject> - </para> + <sect2 id="using-chat-nudges"> + <title>Nudges</title> + <para> + &kmess; can send and receive MSN's nudges. They are a good way to gather attention from your contacts, but they can + also easily annoy them. + </para> + <para> + Click on the "Send a nudge!" button from the toolbar: your chat window will be shaken for a little while. Your + contact will "receive" the nudge in the same way, his or hers chat window will be shaken; they will also hear a + sound, as if they had received a message. + </para> + <para> + Unlike MSN Messenger, &kmess; does not limit the number of nudges you can send or receive every minute. But try not + abusing them, as it's easy to make someone angry by using them too much. If you don't like the graphical effect + caused by nudges, you can disable it in the Account settings. See the <link linkend="settings-dialog-alerts">Alerts settings</link> for details. + </para> + </sect2> - <para> - The Contact Sidebar has even more: when the person is writing a message, the contact image becomes - brighter. If you click it at any time, &kmess; will display that person's profile in your web browser. - Clicking the email address below it, will instead open your Hotmail Account at the "Compose Mail" - page, and the contact's email address in the "To" line. (See <link linkend="settings-dialog-email">Email Options</link> - as well). - </para> - </sect3> + <sect2 id="using-chat-zooming"> + <title>Zooming</title> + <para> + You may find that the text in your chat windows is too small or too big. Use the "+" and "-" toolbar buttons, or + the menu items <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Zoom In/Out</guimenuitem></menuchoice>, to + increase or decrease the font sizes displayed into the conversations. + </para> + </sect2> - <sect3 id="actions-chat-save"> - <title>Save chat sessions</title> - <para> - Click in the chatwindow on - <menuchoice> <guimenu>Chat</guimenu> <guimenuitem>Save</guimenuitem> </menuchoice>. - Choose the directory where the chat should be saved and give a name for the file. - Save the chat now by clicking <guibutton>OK</guibutton>. - See also <link linkend="settings-dialog-chatlog">Automatic chat logging</link>. - </para> - </sect3> + <sect2 id="using-chat-save"> + <title>Save chat sessions</title> + <para> + Click in the chatwindow on + <menuchoice> <guimenu>Chat</guimenu> <guimenuitem>Save</guimenuitem> </menuchoice>. + Choose the directory where the chat should be saved and give a name for the file. + Save the chat now by clicking <guibutton>OK</guibutton>. + See also <link linkend="settings-dialog-chatlogs">Automatic chat logging</link>. + </para> + </sect2> - </sect2> </sect1> <sect1 id="settings"> <title>Configuring &kmess;</title> + <para> + &kmess; can be customized as you wish: the main method to modify the application behavior is the <link linkend="settings-dialog">Settings Dialog</link>, there + is one for every account registered in &kmess;. You can also personalize many details about your contacts with the <link linkend="settings-contact">Contact Settings</link> dialogs, and change how &kmess; sends feedback to you via the + <link linkend="settings-knotify">Sound notifications</link> dialog. + </para> - <sect2 id="settings-dialog"> - <title>The settings dialog</title> - <!-- TODO: lots of panels --> - - <sect3 id="settings-dialog-emoticons"> - <title>Emoticon Themes</title> - <para> - &kmess; supports many different emoticon themes, and can use those coming from other instant messaging software, such as Kopete. - New themes can be downloaded by visiting the <ulink url="http://www.kde-look.org/index.php?xsortmode=high&page=0&xcontentmode=23">www.kde-look.org</ulink>. - </para> - </sect3> - - <sect3 id="settings-dialog-chatlog"> - <title>Automatic Chat Logging</title> - <para> - &kmess; gives you the opportunity to automatically save all chats. - To enable this open the preferences for your profile and switch to the "Chat Logging" section. - Enable the checkbox "Save all Chats" and specify the directory where you want the chats to be stored. - After applying the settings, &kmess; will automatically save all chat logs. - </para> - </sect3> - - <sect3 id="settings-dialog-chatstyles"> - <title>Chat Styles</title> - <para> - &kmess; allows you to choose between various styles for your chat windows. - The default theme is called 'Fresh', which displays the participants' pictures: - </para> - - <para> - <mediaobject> - <imageobject><imagedata fileref="styles-fresh.png" format="PNG"/></imageobject> - <textobject><phrase>The Fresh chat style.</phrase></textobject> - </mediaobject> - </para> - - <para> - Another style is 'Classic'. - his theme comes into two flavors, the default one, and a Compact one. - The second lets &kmess; display the messages in a more compact fashion than the first. - Take a look at the image below to see the difference: - </para> - - <para> - <mediaobject> - <imageobject><imagedata fileref="styles-classic.png" format="PNG"/></imageobject> - <textobject><phrase>The Classic chat style...</phrase></textobject> - </mediaobject> - <mediaobject> - <imageobject><imagedata fileref="styles-classic-compact.png" format="PNG"/></imageobject> - <textobject><phrase>...and the Classic-Compact style.</phrase></textobject> - </mediaobject> - </para> - - <para> - There are even more chat styles you can choose from. - Just open your account's settings, by clicking on - <menuchoice> - <guimenu>Actions</guimenu> - <guimenuitem>Account Settings</guimenuitem> - <guisubmenu>(your account's email)</guisubmenu> - </menuchoice> - Then change to the tab 'Chatting' and use the <guibutton>Chat Style</guibutton> dropdown menu - to change the theme. - </para> - </sect3> - - <sect3 id="settings-dialog-timestamps"> - <title>Timestamps</title> - <para> - &kmess; has a function that displays in every sent and recieved message a timestamp. - Take a look at the screenshot below. - </para> - <para> - <mediaobject> - <imageobject><imagedata fileref="styles-fresh.png" format="PNG"/></imageobject> - <textobject><phrase>The timestamps, shown and hidden, in the Fresh chat style.</phrase></textobject> - </mediaobject> - </para> - </sect3> - - <sect3 id="settings-dialog-email"> - <title>Email options</title> - <para> - &kmess; provides the option to use a custom email client instead of your <ulink url="http://www.hotmail.com/">Hotmail</ulink> account. - To use eg, KMail instead of Hotmail, open your profile preferences: - <menuchoice> - <guimenu>Actions</guimenu> - <guimenuitem>Account Settings</guimenuitem> - <guisubmenu>(your account's email)</guisubmenu> - </menuchoice>. - Then change to the tab 'Email' and change the radiobutton from 'Use Hotmail' to 'Use a specified command'. - The enter "kmail" in the textbox and apply the settings. - To open KMail in Kontact, use 'kontact --module kmail'. - </para> - </sect3> - - <sect3 id="settings-dialog-deleteprofile"> - <title>Deleting a saved &kmess; Profile</title> - <para> - Start &kmess; and go to the preferences of the profile that you want to be deleted. Click on the <guibutton>Delete</guibutton> button at the bottom of the preferences dialog. You will be asked - if you are sure if you want to delete the profile. The changes will be applied after restarting - &kmess;. - </para> - </sect3> - </sect2> - - <sect2 id="settings-contact"> <title>The contact properties dialog</title> <para> @@ -781,7 +799,7 @@ <sect2 id="settings-knotify"> - <title>The sound notifications</title> + <title>The sound notifications dialog</title> <sect3 id="settings-knotify-change"> <title>Changing the sound notifications</title> @@ -800,13 +818,267 @@ </itemizedlist> </para> <para> - &kmess; uses KNotify for its notifications. You can enable/disable them using the KDE Control Center. - Look for the section "Sounds" and from there choose "System Notifications". - You will find &kmess; between the event sources. + &kmess; uses KNotify for its notifications. You can enable/disable them by selecting <menuchoice><guimenu>Actions></guimenu> <guimenuitem>Configure Notifications</guimenuitem> </menuchoice>. + The same settings are also accessible by using the KDE Control Center: choose the section + <menuchoice><guimenu>Sounds></guimenu> <guimenuitem>System Notifications</guimenuitem> </menuchoice> + and you will find &kmess; between the event sources. </para> </sect3> + </sect2> + </sect1> + <sect1 id="settings-dialog"> + <title>The settings dialog</title> + <para> + The &kmess; configuration dialog allows to customize the application behavior in many ways. It's divided in pages + accessible by the icons on the left area of the Settings window. Each one contains settings for a different aspect + of &kmess;. + </para> + + <sect2 id="settings-dialog-account"> + <title>Account</title> + <para> + <mediaobject> + <imageobject><imagedata fileref="settings-dialog-account.png" format="PNG"/></imageobject> + <textobject><phrase>The Account Settings page</phrase></textobject> + </mediaobject> + + Here you can change the details of your MSN account. + </para> + <para> + The friendly name field contains the name that your contacts will see in their contact lists. You cannot change it + if your account is not verified with Passport (see <link linkend="login-create-account">Creating an account</link> for more details). You cannot change it also when you are not currently connected with that account. + You can also change the email address of your account. If you change MSN address, you can just change it here to + avoid losing your preferences. + The password field is usually blank, insert here a new password if you wish to change it. + </para> + <para> + Your displayed picture can be changed easily by clicking on the <guibutton>Browse...</guibutton> button. and selecting + one of the two options: the first, <guibutton>Browse...</guibutton>, just lets you select an image from your PC and + automatically scales down its size to fit MSN's pictures size, which is 96x96 pixels. + The second option, <guibutton>Browse and crop image...</guibutton> after you select an image, will let you select by + yourself which part of the image you wish to keep as display picture. + Below it, the "Don't show a display picture" checkbox allows you to avoid choosing a picture + at all. + </para> + <para> + The "Login with this account automatically at start-up" automatically connects &kmess; to MSN + with this account details everytime the application is started. + Finally, choosing an MSN status from the <guibutton>Status to set at login</guibutton> dropdown menu, will force + &kmess; to set that status when you login to the MSN Messenger service. + </para> </sect2> + + <sect2 id="settings-dialog-alerts"> + <title>Alerts</title> + <para> + &kmess; can use pop-up balloons to notify you about the presence of your contacts. The "Popup Notifications" box + groups together the options to display or not a balloon when one of your contacts performs a certain action. + You can show a popup balloon when your contacts log in, log out or change status; or when they start chatting with + you or everytime they send you a message. + Balloons can also be shown when you receive an email at your MSN mail address. + Balloons hide themselves after a default time of 10 seconds, but you can customize this time via the "Hide popups + after ... seconds" control. + </para> + <para> + To avoid seeing the graphical effects seen when receiving and sending nudges, you can disable the relative checkbox, + "Shake the chat window when a nudge is received or sent". + </para> + <para> + &kmess; supports the MSN feature to notify your contacts about the music you are listening to. Unlike MSN, which only + notifies them about what's playing in Windows Media Player, &kmess; will find out by itself which media player you + are using - searching within a wide range of media-playing applications - and automatically tell your friends the + details of the tracks you listen to. + + Enable the checkbox "Inform contacts of which song I am listening to" to activate this feature. When you listen to + music, &kmess; will show the track name in the upper part of your contact list. + + The following players are currently supported by this feature (And more will be added!): + </para> + <itemizedlist> + <listitem><para> Amarok </para></listitem> + <listitem><para> Kaffeine </para></listitem> + <listitem><para> KsCD </para></listitem> + <listitem><para> Juk </para></listitem> + <listitem><para> Noatun </para></listitem> + </itemizedlist> + <para> + &kmess; can also detect user inactivity. When you do nothing for some time, which defaults to 5 minutes, your MSN + status will be set to Idle, if it was previously set to Online. + </para> + </sect2> + + <sect2 id="settings-dialog-emoticons"> + <title>Emoticon Themes</title> + <mediaobject> + <imageobject><imagedata fileref="settings-dialog-emoticons.png" format="PNG"/></imageobject> + <textobject><phrase>The Emoticons page of the Settings Dialog - Standard emoticons tab</phrase></textobject> + </mediaobject> + <para> + &kmess; supports many different emoticon themes, and can use those coming from other instant messaging software, such as Kopete. + New themes can be downloaded by visiting the <ulink url="http://www.kde-look.org/index.php?xsortmode=high&page=0&xcontentmode=23">www.kde-look.org</ulink> site. + </para> + <para> + The default &kmess; theme of emoticons is named "KMess-New", which contains the emoticons created by David Vignoni. + </para> + <mediaobject> + <imageobject><imagedata fileref="settings-dialog-emoticons-custom.png" format="PNG"/></imageobject> + <textobject><phrase>The Emoticons page of the Settings Dialog - Custom emoticons tab</phrase></textobject> + </mediaobject> + <para> + Other than MSN emoticons themes, &kmess; can also manage custom emoticons. See the <link linkend="using-chat-emoticons-custom">Custom Emoticons</link> to learn more about their usage. Each account has + its own set of them; in the Settings dialog, you will be able to browse, rename, create or delete your account's + custom emoticons. + </para> + <para> + Any item you see in the list, has an image and the shortcut text which you must type, to send that image to + your contacts. + Select an item and click the <guibutton>Remove</guibutton> button to delete it. Click the <guibutton>Rename</guibutton> button or press the F2 key to change the shortcut. + </para> + <para> + To create a new custom emoticon from an image present on your PC, click on the <guibutton>Add new...</guibutton> + button. A dialog window will pop up: + + <mediaobject> + <imageobject><imagedata fileref="chatwindow-custom-emoticons-add.png" format="PNG"/></imageobject> + <textobject><phrase>The Add Custom Emoticon dialog</phrase></textobject> + </mediaobject> + + Click the <guibutton>...</guibutton> button to select the image to be transformed in an emoticon from your PC; you + can also directly type or paste from the clipboard the file's path in the field next to the button. If the image + is valid, it will be displayed in the square on the dialog's top left corner. Then choose a text shortcut to + associate to the new emoticon, and finally click the <guibutton>Ok</guibutton> button to instantly add it to your + Custom Emoticons theme. + </para> + <para> + To save your changes to the theme, be sure to confirm them by clicking the <guibutton>Ok</guibutton> or <guibutton>Apply</guibutton> buttons. + </para> + </sect2> + + <sect2 id="settings-dialog-chatting"> + <title>Chatting</title> + <mediaobject> + <imageobject><imagedata fileref="settings-dialog-chatting.png" format="PNG"/></imageobject> + <textobject><phrase>The Chatting page of the Settings Dialog</phrase></textobject> + </mediaobject> + <para> + This page customizes the appearance of your chats and how the text in chat messages is formatted. + To change how your own chat messages are formatted, use the two controls next to the "Your message font" label, + to change the font's attributes (like font name, size, italics, bold) with the left one, and the font color with + the right one. + </para> + <para> + Activating the "Force contacts' messages to use this font" and setting up the font setting controls below it you + can display all the messages incoming from your contacts in the same way as for your own messages font. + </para> + <para> + The chat style chooser and preview are made to select a visual style for your conversations: see <link linkend="settings-dialog-chatting-styles">Chat Styles</link> for more details. + </para> + <para> + The controls below fine-tune the displayed style of your chat. The "Show graphics in chat messages" box, if + disabled, will make &kmess; not to show any emoticon in your conversations. The "Show time in chat messages" + checkbox is used to display the message sending/receiving time, see <link linkend="settings-dialog-chatting-timestamps">Timestamps</link> for more details. + "Use font effects" will enable effects to words as often seen in IRC clients: *bold* will be displayed + with a bold font, /italics/ will be shown italicized, and _underline_ will be underlined. + "Group follow-up messages from the same contacts", when enabled, groups together all messages sent or received + without interruption by intervention of another contact. + </para> + + <sect3 id="settings-dialog-chatting-styles"> + <title>Chat Styles</title> + <para> + &kmess; allows you to choose between various styles for your chat windows. + The default theme is called 'Fresh', which displays the participants' pictures: + </para> + <mediaobject> + <imageobject><imagedata fileref="styles-fresh.png" format="PNG"/></imageobject> + <textobject><phrase>The Fresh chat style.</phrase></textobject> + </mediaobject> + <para> + Another style is 'Classic'. + his theme comes into two flavors, the default one, and a Compact one. + The second lets &kmess; display the messages in a more compact fashion than the first. + Take a look at the image below to see the difference: + </para> + <mediaobject> + <imageobject><imagedata fileref="styles-classic.png" format="PNG"/></imageobject> + <textobject><phrase>The Classic chat style...</phrase></textobject> + </mediaobject> + <mediaobject> + <imageobject><imagedata fileref="styles-classic-compact.png" format="PNG"/></imageobject> + <textobject><phrase>...and the Classic-Compact style.</phrase></textobject> + </mediaobject> + <para> + There are even more chat styles you can choose from. + Just open your account's settings, by clicking on + <menuchoice> + <guimenu>Actions</guimenu> + <guimenuitem>Account Settings</guimenuitem> + <guisubmenu>(your account's email)</guisubmenu> + </menuchoice> + Then change to the tab 'Chatting' and use the <guibutton>Chat Style</guibutton> dropdown menu + to change the theme. + </para> + </sect3> + + <sect3 id="settings-dialog-chatting-timestamps"> + <title>Timestamps</title> + <para> + &kmess; has a function that displays in every sent and recieved message a timestamp. + Take a look at the screenshot below. + </para> + <para> + <mediaobject> + <imageobject><imagedata fileref="styles-fresh.png" format="PNG"/></imageobject> + <textobject><phrase>The timestamps, shown and hidden, in the Fresh chat style.</phrase></textobject> + </mediaobject> + </para> + </sect3> + </sect2> + + <sect2 id="settings-dialog-chatlogs"> + <title>Automatic Chat Logging</title> + <mediaobject> + <imageobject><imagedata fileref="settings-dialog-chatlogs.png" format="PNG"/></imageobject> + <textobject><phrase>The Chat Logs page of the Settings Dialog</phrase></textobject> + </mediaobject> + <para> + &kmess; gives you the opportunity to automatically save all chats when they end (that means, when you close that + chat's window). + Enable the checkbox "Log all Chats" and specify the directory where you want the chats to be stored. + You can also select how to group together your chat log files: by year, by month, or by day. Folders will be + created into the chosen directory, accordingly to your choice. + After applying the settings, &kmess; will automatically save all chat logs. + </para> + </sect2> + + <sect2 id="settings-dialog-email"> + <title>Email options</title> + <mediaobject> + <imageobject><imagedata fileref="settings-dialog-email.png" format="PNG"/></imageobject> + <textobject><phrase>The Email page of the Settings Dialog</phrase></textobject> + </mediaobject> + <para> + &kmess; provides the option to use a custom email client instead of your <ulink url="http://www.hotmail.com/">Hotmail</ulink> account. + To use eg, KMail instead of Hotmail, change the radiobutton from 'Use Hotmail' to 'Use a specified command'. + Then enter "kmail" in the textbox and apply the settings. + To open KMail within Kontact, use 'kontact --module kmail'. + </para> + <para> + Two additional options are available: the first, "Show email information", will display on top of your contact + list the number of unread messages which are waiting in your mail inbox; the second one, "Show a notification + when email is received in other folders", will display an email popup balloon even if the received mail is not + being stored in the Inbox, but it Junk or in any other folder. + </para> + </sect2> + + <sect2 id="settings-dialog-deleteprofile"> + <title>Deleting a saved &kmess; Profile</title> + <para> + Click on the <guibutton>Delete</guibutton> button at the bottom of the settings dialog. You will be asked + if you are sure if you want to delete the profile. The changes will be applied immediately. + </para> + </sect2> </sect1> </chapter> @@ -973,14 +1245,14 @@ <question><para>Why should I use &kmess; instead of GAIM/Kopete/aMsn?</para></question> <answer> <para> - Short answer: if you have a KDE desktop and use MSN Messenger only + Short answer: if you have a KDE desktop and use MSN Messenger only, &kmess; is made for you. </para> <para> - Some clients are written to support multiple protocols. - &kmess; tries to support one at the fullest, - optimizing the user interface for one protocol. - &kmess; also stays true to KDE standards, look and feel. - There is a choice for everyone, you're free to use what you like. + Some clients are written to support multiple protocols. Kopete, for example, supports many. + But &kmess; tries to support only one, and its developers are working to support the MSN native + features at their best, optimizing the user interface for one protocol. + &kmess; also stays true to KDE standards for look and feel. + There is a choice for everyone, you're free to use what you like! </para> </answer> </qandaentry> @@ -989,8 +1261,8 @@ <question><para>What is the story behind the name of &kmess;?</para></question> <answer> <para> - There was already a KMsn, though that changed. - "Mess" as sort of short for "Messenger" and also to be a self-deprecating joke. + There was already a KMsn, though that was later changed to KMerlin. + "Mess" is a short form for "Messenger" and also is somehow a self-deprecating joke. When I named it that, I didn't think anyone would actually end up using it. ;-) </para> </answer> @@ -1067,6 +1339,7 @@ <listitem><para> Jaume Cornadó (Catalan) <email>ja...@ll...</email> </para></listitem> <listitem><para> Lin Haoxiang (Simplified Chinese) <email>lin...@ho...</email> </para></listitem> + <listitem><para> Liu Sizhuang (More Simplified Chinese) <email>chi...@ho...</email> </para></listitem> <listitem><para> Yen-chou Chen (Traditional Chinese) <email>yen...@nc...</email> </para></listitem> <listitem><para> Lars Sommer (Danish) <email>ad...@la...</email> </para></listitem> @@ -1078,6 +1351,7 @@ <listitem><para> Jyri Toomessoo (Estonian) <email>nu...@ho...</email> </para></listitem> <listitem><para> Markus Vuori (Finnish) <email>ma...@vu...</email> </para></listitem> <listitem><para> Joonas Niilola (More Finnish) <email>ju...@ro...</email> </para></listitem> + <listitem><para> Jussi Timperi (More Finnish) <email>jus...@gm...</email> </para></listitem> <listitem><para> Choplair (French) <email>pac...@ya...</email> </para></listitem> <listitem><para> Vincent Fretin (More French) <email>fre...@ho...</email> </para></listitem> @@ -1086,6 +1360,8 @@ <listitem><para> Jan Tönjes (German) <email>jan...@we...</email> </para></listitem> <listitem><para> Páder Rezsõ (Hungarian) <email>re...@re...</email> </para></listitem> <listitem><para> Valerio Pilo (More Italian) <email>am...@co...</email> </para></listitem> + <listitem><para> Vincenzo Reale (More Italian) <email>sma...@ba...</email> </para></listitem> + <listitem><para> Park Dong Cheon (Korean) <email>pd...@ka...</email> </para></listitem> <listitem><para> Øyvind Sæther (Norsk Bokmål) <email>oy...@sa...</email> </para></listitem> @@ -1103,10 +1379,10 @@ </itemizedlist> </para> <para> - Note some translators also made other contributions. + Note that some translators also made other contributions. </para> <para> - Contributors - which without - we won't be where we are either: + Contributors - without which we won't be where - are: </para> <para> <itemizedlist> Added: trunk/kmess/doc/en/settings-dialog-account.png =================================================================== (Binary files differ) Property changes on: trunk/kmess/doc/en/settings-dialog-account.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/kmess/doc/en/settings-dialog-chatlogs.png =================================================================== (Binary files differ) Property changes on: trunk/kmess/doc/en/settings-dialog-chatlogs.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/kmess/doc/en/settings-dialog-chatting.png =================================================================== (Binary files differ) Property changes on: trunk/kmess/doc/en/settings-dialog-chatting.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/kmess/doc/en/settings-dialog-email.png =================================================================== (Binary files differ) Property changes on: trunk/kmess/doc/en/settings-dialog-email.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/kmess/doc/en/settings-dialog-emoticons-custom.png =================================================================== (Binary files differ) Property changes on: trunk/kmess/doc/en/settings-dialog-emoticons-custom.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/kmess/doc/en/settings-dialog-emoticons.png =================================================================== (Binary files differ) Property changes on: trunk/kmess/doc/en/settings-dialog-emoticons.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/kmess/doc/en/settingswindow-emoticons.png =================================================================== (Binary files differ) Property changes on: trunk/kmess/doc/en/settingswindow-emoticons.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |