<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!-- Define an entity for your application if it is not part of KDE
       CVS -->
  <!ENTITY kmyapplication "<application>Videocatcher</application>">
  <!ENTITY kappname "&kmyapplication;">
  <!ENTITY package "kde-module">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"> 
]>

<book lang="&language;">

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

<authorgroup>
<author>
<personname>
<firstname>Jonas</firstname>
<othername>Emanuel</othername>
<surname>Müller</surname>
</personname>
<email>zanoi AT zanoi.net</email>
</author>
</authorgroup>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

<copyright>
<!--<year>2008</year>
<holder>George N. Ugnacious</holder>-->
<year>2010</year>
<holder>Jonas Emanuel Müller</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
<!-- Put here the FDL notice.  Read the explanation in fdl-notice.docbook
     and in the FDL itself on how to use it. -->
<legalnotice>&FDLNotice;</legalnotice>

<!-- Date and version information of the application
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (YYYY-MM-DD) and of the version
(V.MM.LL), it could be used by automation scripts.
Do NOT change these in the translation. -->

<date>2010-10-22</date>
<releaseinfo>0.1.7</releaseinfo>

<abstract>
<para>
&kmyapplication; is a simple Internet TV application for &kde;
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>Videocatcher</keyword>
<keyword>Video</keyword>
<keyword>Audio</keyword>
<keyword>Feed</keyword>
<keyword>Channel</keyword>
<keyword>Episode</keyword>
<keyword>Internet</keyword>
<keyword>Television</keyword>
<keyword>TV</keyword>
<keyword>Multimedia</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>
<para>
<screenshot>
<screeninfo>Screenshot of Videocatcher downloading a video</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="snapshot1.png" format="PNG"/>
          </imageobject>
        </mediaobject>
</screenshot>
</para>
<para>
Videocatcher is an Internet television application powered by &kde;. &kmyapplication; 
makes it easy to subscribe to video feeds and download new videos. It works as 
a podcast client as well.
</para>
</chapter>

<chapter id="using-kapp">
<title>Using &kmyapplication;</title>


<sect1 id="kapp-newto">
<title>If you are new to &kmyapplication; </title>

<para>
If you are using &kmyapplication; for the first time, you will have to add a channel. 
In order to add a channel it is necessary to find the channels URL. These can be
found by surfing the World Wide Web. Any URL linked to as "feed", "RSS", "atom" 
or "RDF feed" should work in Videocatcher. When you find such a link, copy its
URL into the "add channel" dialog of Videocatcher and you are good to go.
</para>
<para>
The website <ulink url="http://www.miroguide.com"></ulink> is a good place to find channels (they call them feeds). 
In order to add one of its channels, copy the URL from the RSS button. Please note
that the "Add Feed to Miro" button only works with Miro, not with Videocatcher.
</para>
<para>
Channels are often called feeds in other programs. Currently 
&kmyapplication; supports RSS, ATOM as well as RDF feeds.
</para>
<para>
After you have downloaded an episode you can play it back with an external player. 
In case the external player does not start, please try to configure 
the player in the settings.
</para>

</sect1>
</chapter>

<chapter id="commands">
<title>Menu and Command Reference</title>

<sect1 id="kapp-mainwindow">
<title>The main &kmyapplication; window</title>

<sect2>
<title>The File Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Import from File</guimenuitem>
</menuchoice></term>
<listitem><para><action>Imports a list of channels from an external file. Currently 
only files in the OPML (Outline Processor Markup Language) format are supported</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<!--<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>-->
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quits the application. If Videocatcher is running in the notification area, it will quit
there as well</action> &kmyapplication;</para></listitem>
</varlistentry>
</variablelist>
</para>

</sect2>

<sect2>
<title>The <guimenu>Channel</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycap>F5</keycap>
</shortcut>
<guimenu>Channel</guimenu>
<guimenuitem>Refresh Channel</guimenuitem>
</menuchoice></term>
<listitem><para><action>Refreshes the currently selected channel. This means &kmyapplication; 
will check whether there are any new episodes available in the channel</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo>
</shortcut>
<guimenu>Channel</guimenu>
<guimenuitem>Refresh All Channels</guimenuitem>
</menuchoice></term>
<listitem><para><action>Refreshes all channels. This means &kmyapplication; 
will check whether there are any new episodes available in any of the channels</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycap>Insert</keycap>
</shortcut>
<guimenu>Channel</guimenu>
<guimenuitem>Add Channel</guimenuitem>
</menuchoice></term>
<listitem><para><action>Adds a new channel. This will ask for an URL which has to be copied and pasted into
the box. Currently &kmyapplication; supports RSS, ATOM and RDF urls.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;<keycap>Delete</keycap></keycombo>
</shortcut>
<guimenu>Channel</guimenu>
<guimenuitem>Remove Channel</guimenuitem>
</menuchoice></term>
<listitem><para><action>Removes the currently selected channel. &kmyapplication; will ask whether or not the downloaded
episodes of this channel should be deleted together with the channel. If you select to keep the episodes you should
delete them manually later at some point</action></para></listitem>
</varlistentry>
</variablelist>
</para>

</sect2>

<sect2>
<title>The <guimenu>Episode</guimenu> Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<!-- <shortcut> -->
<!-- <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> -->
<!-- </shortcut> -->
<guimenu>Episode</guimenu>
<guimenuitem>Download Episode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Begins downloading the currently selected episode. Episodes have to be downloaded
in order to be played properly. It is sometimes also possible to stream an episode with the stream command.
However, this depends on the type of media the channel is using for the episodes as well as the external player
used</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<!-- <shortcut> -->
<!-- <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> -->
<!-- </shortcut> -->
<guimenu>Episode</guimenu>
<guimenuitem>Cancel Download</guimenuitem>
</menuchoice></term>
<listitem><para><action>Cancels the download of the currently selected episode. This is only possible if 
a download is currently in progress.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<!-- <shortcut> -->
<!-- <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> -->
<!-- </shortcut> -->
<guimenu>Episode</guimenu>
<guimenuitem>Play Episode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Plays the currently selected episode with an external player. This is only possible
if the episode has already been downloaded. In case the external player does not start, please try to configure 
the player in the settings.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<!-- <shortcut> -->
<!-- <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> -->
<!-- </shortcut> -->
<guimenu>Episode</guimenu>
<guimenuitem>Delete Episode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Adds a new channel. This will ask for an URL which has to be copied and pasted into
the box. Currently &kmyapplication; supports RSS, ATOM and RDF URLs.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<!-- <shortcut> -->
<!-- <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> -->
<!-- </shortcut> -->
<guimenu>Episode</guimenu>
<guimenuitem>Stream Episode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Lets the external play back the episode directly, without downloading it first.
Whether the streaming works depends on the type of media the channel is using as well as the external player
used. In case the external player does not start, please try to configure 
the player in the settings.</action></para></listitem>
</varlistentry>
</variablelist>
</para>

</sect2>

<sect2>
<title>The <guimenu>Help</guimenu> Menu</title>

&help.menu.documentation;

</sect2>

</sect1>
</chapter>

<chapter id="credits">

<title>Credits and License</title>

<para>
&kmyapplication;
</para>
<para>
Program copyright &copy; 2010 Jonas Emanuel Müller <email>zanoi AT zanoi.net</email>
</para>
<para>
Program copyright &copy; 2010 Omar Plummer <email>rkoder AT gmail.com</email>
</para>


<para>
Documentation copyright &copy; 2010 Jonas Emanuel Müller <email>zanoi AT zanoi.net</email>
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;               <!-- FDL: do not remove -->

&underGPL;               <!-- GPL License -->

</chapter>

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

<sect1 id="getting-kapp">
<title>How to obtain &kmyapplication;</title>

<!-- &install.intro.documentation; -->
<para>
You can obtain &kmyapplication; from its official website at 
<ulink url="http://zanoi.net/videocatcher.html"></ulink></para>
</sect1>

<sect1 id="requirements">
<title>Requirements</title>
<para>
&kmyapplication; requires the installation of the qt4-sql-sqlite package, which should
be available at <ulink url="http://qt.nokia.com"></ulink> or in your package management system.
</para>

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

<!-- &install.compile.documentation; -->

<!-- </sect1> -->

</sect1>

</appendix>

&documentation.index;
</book>

<!--
Local Variables:
mode: xml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

vim:tabstop=2:shiftwidth=2:expandtab
kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
-->
