<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY appversion "0.68">
  <!ENTITY manrevision "2.1">
  <!ENTITY date "December 2008">
  <!ENTITY app "Twitux">
]>
<!-- 
      (Do not remove this comment block.)
  Maintained by the GNOME Documentation Project
  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Apr 11, 2002
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo> 
    <title>&app; Manual V&manrevision;</title>       

    <copyright>
      <year>2008</year>
      <holder>Brian Pepple</holder>
    </copyright>
    
<!-- translators: uncomment this:

  <copyright>
   <year>2002</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

   -->
<!-- An address can be added to the publisher information.  If a role is 
     not specified, the publisher/author is the same for all versions of the 
     document.  -->
    <publisher> 
      <publishername>GNOME Documentation Project</publishername> 
    </publisher> 

   &legal;
   <!-- This file  contains link to license for the documentation (GNU FDL), and 
        other legal stuff such as "NO WARRANTY" statement. Please do not change 
	any of this. -->

    <authorgroup> 
      <author role="maintainer">
	        <firstname>Brian</firstname>
	        <surname>Pepple</surname>
	        <affiliation>
	                <orgname>Fedora Project</orgname>
	                <address> <email>bpepple@fedoraproject.org</email> </address>
	        </affiliation>
      </author>
      
<!-- This is appropriate place for other contributors: translators,
     maintainers,  etc. Commented out by default.
     
      <othercredit role="translator">
		<firstname>Latin</firstname> 
		<surname>Translator 1</surname> 
		<affiliation> 
	  		<orgname>Latin Translation Team</orgname> 
	  		<address> <email>translator@gnome.org</email> </address> 
		</affiliation>
		<contrib>Latin translation</contrib>
      </othercredit>
-->
    </authorgroup>


<!-- According to GNU FDL, revision history is mandatory if you are -->
<!-- modifying/reusing someone else's document.  If not, you can omit it. -->
<!-- Remember to remove the &manrevision; entity from the revision entries other
-->
<!-- than the current revision. -->
<!-- The revision numbering system for GNOME manuals is as follows: -->
<!-- * the revision number consists of two components -->
<!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
<!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
<!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
<!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
<!-- to V3.0, and so on. -->  
    <revhistory>
      <revision>
                <revnumber>&app; Manual V&manrevision;</revnumber>
		<date>&date;</date>
		<revdescription>
		        <para role="author">Brian Pepple
			<email>bpepple@fedoraproject.org</email>
			</para>
			<para role="publisher">GNOME Documentation Project</para>
		</revdescription>
      </revision>
      <revision>
                <revnumber>&app; Manual V2.0</revnumber>
		<date>April 2008</date>
		<revdescription>
		        <para role="author">Brian Pepple
			<email>bpepple@fedoraproject.org</email>
			</para>
			<para role="publisher">GNOME Documentation Project</para>
		</revdescription>
      </revision>
     </revhistory>

    <abstract role="description">
      <para>This manual describes the use of &app;.</para>
    </abstract> 

    <releaseinfo>This manual describes version &appversion; of &app;.
    </releaseinfo> 
    <legalnotice> 
      <title>Feedback</title> 
      <para>
        To report a bug or make a suggestion regarding the <application>&app;</application>
        application or this manual, follow the directions in the Feedback section of the
	<ulink url="ghelp:user-guide?feedback-bugs" type="help">GNOME User Guide</ulink>.
      </para>
<!-- Translators may also add here feedback address for translations -->
    </legalnotice> 
  </articleinfo> 

  <indexterm zone="index"> 
    <primary>&app;</primary> 
  </indexterm> 

<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<!-- Use the Introduction section to give a brief overview of what
     the application is and what it does. -->
  <sect1 id="introduction"> 
    <title>Introduction</title> 

    <sect2 id="what-client"> 
    <title>What is &app;</title>
    <para>
	&app; is a client for the social networking site Twitter. It lets users view
	in real time "twitters" or micro-blog posts on the Twitter website as well as
	publish their own. &app; is written to be as simple to use as possible and to
	allow users of the GNOME Desktop to keep in touch with friends.
    </para>
  </sect2>
  <sect2 id="what-micro"> 
    <title>What is Micro-blogging</title>
    <para>
	Micro-blogging is a form of blogging that allows users to write brief text
	updates	(usually less than 200 characters) and publish them, either to be
	viewed by anyone or by a restricted group which can be chosen by the user.
	These messages can be submitted by a variety of means, including text messaging,
	instant messaging, email, MP3 or the web.
    </para>
  </sect2>
  <sect2 id="what-twitter">
    <title>What is Twitter</title>
    <para>
	Twitter is a free social networking and micro-blogging service that allows users
	to send "updates" (or "tweets"; text-based posts, up to 140 characters long) to
	the Twitter website, via short message service (e.g. on a cell phone), instant
	messaging, or a third-party application such as &app;.
    </para>
  </sect2>
    <para>
	This section uses material from the Wikipedia articles
	<ulink url="http://en.wikipedia.org/wiki/Micro-blogging">"Micro-blogging"</ulink>
	and 
	<ulink url="http://en.wikipedia.org/wiki/Twitter">"Twitter"</ulink>
    </para>
  </sect1>

<!-- =========== Getting Started ============================== -->
<!-- Use the Getting Started section to describe the steps required
     to start the application and to describe the user interface components
     of the application. If there is other information that it is important
     for readers to know before they start using the application, you should
     also include this information here. 
     If the information about how to get started is very short, you can 
     include it in the Introduction and omit this section. -->

  <sect1 id="twitux-getting-started"> 
    <title>Getting Started</title> 

    <sect2 id="twitux-start">
    <title>To Start &app;</title>
    <para>You can start <application>&app;</application> in the following ways:
    </para> 
    <variablelist>
    	<varlistentry>
    		<term><guimenu>Applications</guimenu> menu</term>
    		<listitem>
    		  <para>Choose 
    		    <menuchoice>
    		      <guisubmenu>Internet</guisubmenu>
    		      <guimenuitem>Twitux</guimenuitem>
    		    </menuchoice>.
                  </para>
    		</listitem>
    	</varlistentry>
    	<varlistentry>
    		<term>Command line</term>
    		<listitem>
    		<para>
			To start <application>&app;</application> from a command line,
			type <command>twitux</command> and then press <keycap>Return</keycap>.
		</para>
    		</listitem>
    	</varlistentry>
    </variablelist>
    </sect2>
    
    <sect2 id="twitux-start-first">
      <title>When You Start &app; the First Time</title>
      <para>
	When you start <application>&app;</application> the first time, you will be
	shown the <interface>Twitter Account</interface> dialog, so that you can set
	up your	Twitter account credentials.
      </para>
      <orderedlist>
        <listitem>
	  <itemizedlist>
	    <listitem>
	      <para>Enter your Twitter <guilabel>Username</guilabel>.</para>
	    </listitem>
	    <listitem>
	      <para>Enter your Twitter <guilabel>Password</guilabel>.</para>
	    </listitem>
	    <listitem>
	      <para>
		Select <guilabel>Show Password</guilabel> if you wish you
		to have your password visible in the
		<interface>Twitter Account</interface> dialog.
	      </para>
	    </listitem>
	  </itemizedlist>
	</listitem>
      </orderedlist>
    </sect2>	

    <sect2 id="twitux-when-start">
    <title>When You Start &app;</title>
    <para>When you start <application>&app;</application>, the following window is displayed.</para>

    <!-- ==== Figure ==== -->
      <figure id="mainwindow-fig"> 
	<title>&app; Main Window</title> 
	<screenshot> 
	  <mediaobject> 
	    <imageobject><imagedata
		fileref="figures/client.png" format="PNG"/> 
	    </imageobject>
	    <!-- EPS versions of the figures are not required at the moment. -->
            <!-- 
		    <imageobject>
      		<imagedata fileref="figures/image.eps" format="EPS"/>
    		    </imageobject>
	    -->
	    <textobject> 
	      <phrase>
		Shows &app; main window. Contains titlebar, menubar, tweet list,
		and status icon. Menubar contains Twitter, Settings, View, and
		Help menus.
	      </phrase> 
	    </textobject> 
	  </mediaobject> 
	</screenshot> 
      </figure>
    <!-- ==== End of Figure ==== -->

    <!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
    <!-- for example, the items on the menubar and on the toolbar. This section is optional. -->

    <para>
      <xref linkend="twitux-TBL-1"/> describes the components of a browser window.
    </para>
    <table frame="topbot" id="gossip-TBL-1">
      <title>&app; Main Components</title>
	<tgroup cols="2" colsep="0" rowsep="0">
	<colspec colname="colspec0" colwidth="29.39*"/>
	<colspec colname="colspec1" colwidth="70.61*"/>
	<thead>
	  <row rowsep="1">
	    <entry valign="top">
	      <para>Component</para>
	    </entry>
	    <entry valign="top">
	      <para>Description</para>
	    </entry>
	  </row>
	</thead>
	<tbody>
	  <row>
	    <entry valign="top">
	      <para>Menubar</para>
	    </entry>
	    <entry valign="top">
	      <para>Contains menus that are used to perform tasks in &app;.</para>
	    </entry>
	  </row>
	  <row>
	    <entry valign="top">
	      <para>Tweet List</para>
	    </entry>
	    <entry valign="top">
	      <para>Shows the latest tweets received from Twitter.</para>
	    </entry>
	  </row>
	  </tbody>
	</tgroup>
      </table>
    </sect2>
  </sect1>
<!-- ================ Usage ================================ -->
<!-- Use this section to describe how to use the application to perform the tasks for 
  which the application is designed. -->
  <sect1 id="twitux-basic-usage"> 
    <title>Basic Usage</title> 
    <!-- TODO: Maybe the next sentence is obsolete, because usage is splitted in 
      different sections -->
    <para>You can use the &app; application to perform the following tasks:</para>
    <!-- ================ Usage Subsection ================================ -->
    <sect2 id="twitux-connect"> 
      <title>Connect to Twitter</title>
      <para>To connect to Twitter, choose 
	<menuchoice> 
	  <guimenu>Twitter</guimenu> 
	  <guimenuitem>Connect</guimenuitem> 
	</menuchoice>
	from the Menubar.
      </para>
    </sect2>     
    <!-- ================ Usage Subsection ================================ -->
    <sect2 id="twitux-disconnect"> 
      <title>Disconnect from Twitter</title>
      <para>To disconnect from Twitter, choose 
	<menuchoice> 
	  <guimenu>Twitter</guimenu> 
	  <guimenuitem>Disconnect</guimenuitem> 
	</menuchoice>
	from the Menubar.
      </para>
    </sect2>
    <!-- ================ Usage Subsection ================================ -->
    <sect2 id="twitux-new-message">
      <title>Sending A Message</title>
      <para>You can send message to Twitter, in the following ways:</para>
      <itemizedlist>
	<listitem>
	  <para>Choose 
            <menuchoice>
	      <shortcut>
		<keycombo>
		  <keycap>Ctrl</keycap>
		  <keycap>N</keycap>
		</keycombo>
	      </shortcut>
	      <guimenu>Twitter</guimenu> 
	      <guimenuitem>New Message</guimenuitem>
	    </menuchoice>.
          </para>
	</listitem>
	<listitem>
	  <para>
            Right click on &app;'s Notification Area icon, and select <guilabel>New Message</guilabel>.
          </para>
	</listitem>
      </itemizedlist>
    </sect2>
    <!-- ================ Usage Subsection ================================ -->
    <sect2 id="twitux-direct-message">
      <title>Sending A Direct Message</title>
      <para>You can send direct message to your friends on Twitter, in the following ways:</para>
      <itemizedlist>
	<listitem>
	  <para>Choose 
            <menuchoice>
	      <guimenu>Twitter</guimenu> 
	      <guimenuitem>Send Direct Message</guimenuitem>
	    </menuchoice>.
          </para>
	</listitem>
	<listitem>
	  <para>
	    Double-click on a tweet in the Tweet List to send a direct message.
	  </para>
	</listitem>
      </itemizedlist>
    </sect2> 
  </sect1>
  <!-- ============= Customization ============================= -->
  <!-- Use this section to describe how to customize the application. -->
  <sect1 id="twitux-prefs"> 
    <title>Settings</title> 
    <para>
      To configure &app;, choose
      <menuchoice> 
	<guimenu>Settings</guimenu> 
	<guimenuitem>Preferences</guimenuitem> 
      </menuchoice>.
      The <guilabel>Preferences</guilabel> dialog contains the following tabbed sections:
    </para> 
<!-- =============== Customization Subsection ================ -->
<!-- Use a new section to describe different tabbed sections on the Settings or Preferences
	     dialog. -->
    <sect2 id="twitux-prefs-general"> 
      <title>General</title> 
      <variablelist> 
	<varlistentry> 
	  <term> <guilabel>General</guilabel> </term>
	  <listitem> 
	    <itemizedlist>
	      <listitem>
	        <para>
		  Select the <guilabel>Expand Messages</guilabel> option, to show the
		  expanded message frame.
		</para>
	      </listitem> 
	      <listitem>
	        <para>
		  Select the <guilabel>Display notifications when message received</guilabel> option,
		  to be notified when new tweets are received.
		</para>		
	      </listitem>
	      <listitem>
		<para>
		  Select the <guilabel>Sound notification when message received</guilabel> option,
		  to be notified when new tweets are received.
		</para>
	      </listitem>
	      <listitem> 
		<para>
		  Select the <guilabel>Show user names instead real names</guilabel> option, to
		  show friends Twitter user names instead of their real names.
		</para> 
	      </listitem>
	      <listitem>
		<para>
		  Select <guilabel>Connect automatically</guilabel> if you
		  wish to automatically log-in to Twitter when you start
		  up &app;.
		</para>
	      </listitem>
	    </itemizedlist>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term> <guilabel>Timelines</guilabel> </term>
	    <listitem>
	      <itemizedlist>
	        <listitem> 
		  <para>
		    Select the <guilabel>Default Timeline</guilabel> you wish to use
		    from the drop-down list.
		  </para>
		</listitem>
		<listitem>
	        <para>
		  Select the time interval you wish to <guilabel>Retrieve every</guilabel>
		  from the drop-down list.
		</para>
	      </listitem>  
	      </itemizedlist>
	    </listitem>  
	</varlistentry>
      </variablelist>
    </sect2>
    <!-- ============= Customization Subsection ===================== -->
    <!-- Another tabbed section on the Preferences dialog. -->
    <sect2 id="twitux-prefs-spelling"> 
      <title>Spell Checking</title> 
      <note>
	<para>
          These setting might not be available if spell checking capabilities
          were not compiled into &app;.
        </para>
      </note>
      <variablelist> 
	<varlistentry> 
	  <term> <guilabel>Languages</guilabel> </term> 
	  <listitem> 
	    <itemizedlist> 
	      <listitem>
		<para>Select the languages you wish to enable for spell checking</para>
	      </listitem>
	    </itemizedlist>
	    <tip>
	      <para>The list of languages only reflect the languages that have a 
                dictionary installed.
              </para>
	    </tip>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><guilabel>Options</guilabel></term>
	  <listitem>
	    <itemizedlist>
	      <listitem>
	        <para>
		  Select <guilabel>Enable spell checking</guilabel>, if desired.
		</para>
	      </listitem>
	    </itemizedlist>
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect2>
  </sect1>
<!-- ============= Bugs ================================== -->
<!-- This section is optional and is commented out by default. 
     You can use it to describe known bugs and limitations of the 
	  program if there are any - please be frank and list all
     problem<orderedlist>
	<listitem>
	  <para>
            Right click a contact's nickname in the Contact List and select
            <guimenuitem>Rename Contact</guimenuitem>.
          </para>
	</listitem>
	<listitem>
	  <para>
            Enter a new name and click <guibutton>OK</guibutton> to apply, or
            <guibutton>Cancel</guibutton> to discard all changes.
          </para>
	</listitem>
      </orderedlist>s you know of. 
  
  <sect1 id="mayapp-bugs">
  <title>Known Bugs and Limitations</title>
  <para> </para>
 </sect1>
-->
<!-- ============= About ================================== -->
<!-- This section contains info about the program (not docs), such as
      author's name(s), web page, license, feedback address. This
      section is optional: primary place for this info is "About.." box of
      the program. However, if you do wish to include this info in the
      manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
  <sect1 id="twitux-about"> 
    <title>About &app;</title> 
    <para> &app; was written by Brian Pepple and Daniel Morales.
      To find more information about
      &app;, please visit the 
      <ulink url="http://twitux.sourceforge.net/" type="http">&app; Developer
	Page</ulink>.
    </para>
    <para>
      To report a bug or make a suggestion regarding this application or
      this manual, see the Feedback section of the
      <ulink url="ghelp:user-guide?feedback-bugs" type="help">GNOME User Guide</ulink>.
    </para>

    <para> This program is distributed under the terms of the GNU
      General Public license as published by the Free Software
      Foundation; either version 2 of the License, or (at your option)
      any later version. A copy of this license can be found at this
      <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
      COPYING included with the source code of this program. </para>

  </sect1> 
</article>
