<!DOCTYPE book PUBLIC  "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [
  <!ENTITY kappname "&kscore;" -- replace kapp here. This only *seems* redundant -->
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE" -- change language only here -->
  <!ENTITY % ents PUBLIC "-//KDE//ENTITIES Documentation V1.0//EN">
  %ents;
]>

<book lang="&language;">

<bookinfo>
<title>The &kscore; Handbook</title>

<authorgroup>
<author>
<firstname>Jonathan</firstname>
<surname>Singer</surname>
<affiliation>
<address><email>jsinger@leeta.net</email></address>
</affiliation>
</author>
</authorgroup>

<copyright>
<year>2000</year>
<holder>Jonathan Singer</holder>
</copyright>

<date>07/12/2000</date>
<releaseinfo>0.01.00</releaseinfo>

<abstract><para>&kscore; is an applet for the KDE 2.0 panel to track sports
scores.</para></abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>KScore</keyword>
<keyword>Sports</keyword>
<keyword>score</keyword>
<keyword>applet</keyword>
</keywordset>
</bookinfo>

<chapter id="introduction">

<title>Introduction</title>

<screenshot>
<screeninfo>&kscore; at work</screeninfo>
      <mediaobject>
	<imageobject>
	  <imagedata fileref="ncaaf.png" format="PNG">
	</imageobject>
	<textobject>
	  <phrase>&kscore; at work</phrase>
	</textobject>
      </mediaobject>
    </screenshot>
<screenshot>
<screeninfo>&kscore; at work</screeninfo>
      <mediaobject>
	<imageobject>
	  <imagedata fileref="nhl.png" format="PNG">
	</imageobject>
	<textobject>
	  <phrase>&kscore; at work</phrase>
	</textobject>
      </mediaobject>
    </screenshot>
<screenshot>
<screeninfo>&kscore; at work</screeninfo>
      <mediaobject>
	<imageobject>
	  <imagedata fileref="premr.png" format="PNG">
	</imageobject>
	<textobject>
	  <phrase>&kscore; at work</phrase>
	</textobject>
      </mediaobject>
    </screenshot>

<para>Nowadays, there's a lot of people telling you what stereotypes free
software users should conform to. <quote>Geeks like Lego.</quote> <quote>Hackers
like guns.</quote> Well, I like hockey. And on the rare occasions when my
beloved Islanders win a game, I want to know about it immediately.</para>

<para>&kscore; is an applet for the KDE 2.0 panel to track sports scores. It
downloads scores from Excite, including all major American pro and college
sports, as well as many minor leagues and the top European soccer
leagues.</para>

<para>&kscore; was written by Jonathan Singer <email>jsinger@leeta.net</email>,
and is based on the <application><ulink
url="http://home.att.net/~takuper/wmscoreboard/">wmScoreboard</ulink></application>
dockapp for WindowMaker, by Todd Kuper.</para>

<sect1 id="kscore-revhistory">
<title>&kscore; Revision History</title>

<variablelist>
<varlistentry>
<term>0.1</term>
<listitem>
<itemizedlist>
<listitem><para>First Release</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>

<chapter id="installation">
<title>Installation</title>

<sect1 id="obtain-kscore">
<title>How to obtain &kscore;</title>

<para>&kscore; is part of the kdetoys package and should be compiled and
installed as indicated in the package's main directory. New versions of kdetoys
can be obtained at <ulink
url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>.</para>

</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>&kscore; was written with Qt 2.2.x and KDE 2 on a PowerCenter 150 running
LinuxPPC 1999. It should work on anything KDE runs on. Should you run into
problems please report them to the author
<email>jsinger@leeta.net</email>.</para>

</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>

<para>In order to compile and install &kscore; on your system, type the
following in the base directory of the kdetoys distribution:</para>
<screen width="40">
<prompt>%</prompt> <userinput>./configure</userinput>
<prompt>%</prompt> <userinput>make</userinput>
<prompt>%</prompt> <userinput>make install</userinput>
</screen>

<para>Since &kscore; uses <application>autoconf</application> and
<application>automake</application> you should not have trouble compiling
it. Should you run into problems please report them to the KDE mailing
lists.</para>

</sect1>
</chapter>

<chapter id="using-kscore">
<title>Usage</title>

<sect1 id="starting-kscore">
<title>Starting &kscore;</title>

<para>To start &kscore;, click with the <mousebutton>right</mousebutton> mouse
button on an empty spot on the KDE panel and select
<menuchoice><guisubmenu>Add</guisubmenu> <guisubmenu>Applet</guisubmenu>
<guimenuitem>Sports Ticker</guimenuitem></menuchoice>. Alternatively, from the
<guimenu>K</guimenu> menu, select <menuchoice><guisubmenu>Panel
Menu</guisubmenu> <guisubmenu>Add</guisubmenu> <guisubmenu>Applet</guisubmenu>
<guimenuitem>Sports Ticker</guimenuitem></menuchoice></para>

</sect1>

<sect1 id="command-ref">
<title>Controlling &kscore;</title>

<sect2 id="menu-ref">
<title>Menu Commands</title>

<para>When &kscore; is started, an applet should appear in the panel. (If the
panel is full, you may need to scroll to see it.) To move or remove it,
<mousebutton>right</mousebutton> click on the bar to the left or top of the
applet and select <guimenuitem>Move</guimenuitem> or
<guimenuitem>Remove</guimenuitem>.</para>

<para><mousebutton>Left</mousebutton> click on the applet to update the
displayed score. <mousebutton>Right</mousebutton> click to bring up a menu with
the following options:</para>

<variablelist>
<varlistentry>
<term><guimenuitem>Settings</guimenuitem></term>
<listitem><para><action>Opens</action> the settings dialog
box.</para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>Online</guimenuitem></term>
<listitem><para><action>Toggles score downloads</action> on and off. Turn off
when you do not have an active network connection.</para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>Help</guimenuitem></term>
<listitem><para><action>Displays these help pages.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>About</guimenuitem></term>
<listitem><para><action>Displays information</action> about
&kscore;</para></listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2 id="settings-dialog">
<title><guilabel>Settings</guilabel></title>

	<screenshot>
	  <screeninfo>The &kscore; settings dialog box</screeninfo>
	  <mediaobject>
	    <imageobject>
	      <imagedata fileref="settings.png" format="PNG">
	    </imageobject>
	    <textobject><phrase>The &kscore; settings dialog box</phrase>
	    </textobject>
	  </mediaobject>
	</screenshot>

<para>The settings dialog box allows you to set the following options:</para>

<variablelist>
<varlistentry>
<term><guilabel>League</guilabel></term>
<listitem><para>Choose the desired league from the drop-down
list.</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Team</guilabel></term>
<listitem><para>Enter the three letter code for the team you want to
follow. Press the <guibutton>Browse teams</guibutton> button to connect to
Excite and see the available codes for the selected league.</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Text color</guilabel></term>
<listitem><para>Select the color of the displayed text. This is useful when the
panel has a background image.</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Update every x minutes</guilabel></term>
<listitem><para>Set the interval between score updates. (The minimum interval is
10 minutes; the maximum 300 minutes.)</para></listitem>
</varlistentry>
</variablelist>

</sect2>
</sect1>
</chapter>

<chapter id="q-and-a">
<title>Questions and Answers</title>

<sect1 id="error-messages">
<title>Error Messages</title>

<para>There are two error messages you may see. Here's what to do about
them.</para>

<variablelist>
<varlistentry>
	  <term><inlinemediaobject>
	      <imageobject>
		<imagedata fileref="no_score.png" format="PNG">
	      </imageobject>
	    </inlinemediaobject> <errorname>No Score Available</errorname></term>
<listitem><para>The most likely causes are:</para>
<variablelist>
<varlistentry>
<term>An incorrect team code</term> 
<listitem><para> Press the <guibutton>Browse teams</guibutton> button in the
settings dialog box to see the available team codes for the selected
league.</para></listitem>
</varlistentry>
<varlistentry>
<term>No score available for the selected team</term>
<listitem><para>Unfortunately, this usually means your team has been eliminated
from the playoffs. Again, try the <guibutton>Browse teams</guibutton> button in
the settings dialog box to see the available team codes for the selected
league.</para></listitem>
</varlistentry>
</variablelist>

<para>The scores are downloaded from <ulink
url="http://sports.excite.com">http://sports.excite.com</ulink>. If they change
something in their format, &kscore; will break. Please let me know at
<email>jsinger@leeta.net</email> if there's a problem.</para></listitem>
</varlistentry>

<varlistentry>
<term><inlinemediaobject><imageobject><imagedata fileref="dl_fail.png"
format="PNG"></imageobject></inlinemediaobject> <errorname>Download
Failed</errorname></term>
<listitem><para>The most likely causes are:</para>
<variablelist>
<varlistentry>
<term>No active network connection.</term>
<listitem><para>If you have a dial-up connection, you probably want to take
&kscore; offline when your connection is inactive. (Uncheck
<guimenuitem>Online</guimenuitem> in the pop-up menu.)</para></listitem>
</varlistentry>
</variablelist>
<para>If Excite changes their <acronym>URL</acronym>s, &kscore; will be unable
to download the correct page. Again, please let me know at
<email>jsinger@leeta.net</email> if there's a problem.</para></listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="faq">
<title>Other Questions</title>

<qandaset>
<qandaentry>
<question><para>Can you add another league, or scores from a different
site?</para></question>
<answer><para>I'd love to add more non-North American coverage. Let me know at
<email>jsinger@leeta.net</email> what sites you're interested in and I'll try to
add them. (I'd also be eager to hear from anyone with
<application>Perl</application> skills who can help me create scripts to parse
new sites.)</para></answer>
</qandaentry>

<qandaentry>
<question><para>How do I get &kscore; to work in a vertical panel with size set
to <quote>Tiny</quote>?</para></question>
<answer><para>Unfortunately, even a normal panel doesn't have as much space as
&kscore; could really use. A <quote>Normal</quote> size vertical panel is the
smallest I could get to look decent.</para></answer>
</qandaentry>
</qandaset>

</sect1>

</chapter>

<chapter id="credits-and-licenses">
<title>Credits and Licenses</title>

<para>&kscore;</para>

&underFDL;

<para>The Perl script that processes scores is copyright Todd Kuper, under the
terms of the GNU General Public License.</para>


<para>Other files copyright (c) 2000, Jonathan Singer and made available under
the below BSD-style license. All rights reserved.</para>
<para>Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:</para>
<para>* Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
 copyright notice, this list of conditions and the following
 disclaimer in the documentation and/or other materials provided
 with the distribution.</para>
<para>* Neither the name of the author nor the names of other contributors may be used to endorse or promote products derived
 from this software without specific prior written permission.
</para>
<para>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.</para>


</chapter>
</book>