[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: [kaffeine] doc: add draft for kaffeine docbook
From: Burkhard_Lück <lueck () hube-lueck ! de>
Date: 2016-06-28 18:29:23
Message-ID: E1bHxlD-0006op-P5 () code ! kde ! org
[Download RAW message or body]
Git commit 2a81d20d4f59f91ea019a5188561766397d60438 by Burkhard Lück.
Committed on 28/06/2016 at 18:27.
Pushed by lueck into branch 'master'.
add draft for kaffeine docbook
CCMAIL:mchehab@infradead.org
D +- -- doc/discwindow.png
A +- -- doc/document-save.png
D +- -- doc/dvbbroadcast.png
D +- -- doc/dvbclient.png
D +- -- doc/dvbconfig.png
D +- -- doc/dvbepg.png
D +- -- doc/dvblive.jpg
D +- -- doc/dvbscan.png
D +- -- doc/dvbtimers.png
D +- -- doc/dvbwin.png
D +- -- doc/gstpart.png
M +182 -560 doc/index.docbook
A +- -- doc/kaffeine_configure_tv_dvbc_dvbt2_device.png
A +- -- doc/kaffeine_configure_tv_isdb_device.png
A +- -- doc/kaffeine_initial.png
A +- -- doc/kaffeine_live_tv.png
A +- -- doc/kaffeine_play_file.png
A +- -- doc/kaffeine_program_guide.png
A +- -- doc/kaffeine_recording_schedule_enabled.png
A +- -- doc/kaffeine_scan_channel_edit.png
A +- -- doc/kaffeine_scan_finished_channels_added.png
D +- -- doc/kaffeinepart.png
A +- -- doc/media-playback-pause.png
A +- -- doc/media-playback-start.png
A +- -- doc/media-record.png
D +- -- doc/playlistwin.png
A +- -- doc/playlistwindow.png
M +- -- doc/startwindow.png
http://commits.kde.org/kaffeine/2a81d20d4f59f91ea019a5188561766397d60438
diff --git a/doc/discwindow.png b/doc/discwindow.png
deleted file mode 100644
index 3690fc0..0000000
Binary files a/doc/discwindow.png and /dev/null differ
diff --git a/doc/document-save.png b/doc/document-save.png
new file mode 100644
index 0000000..5e813d1
Binary files /dev/null and b/doc/document-save.png differ
diff --git a/doc/dvbbroadcast.png b/doc/dvbbroadcast.png
deleted file mode 100644
index 92f1181..0000000
Binary files a/doc/dvbbroadcast.png and /dev/null differ
diff --git a/doc/dvbclient.png b/doc/dvbclient.png
deleted file mode 100644
index c780765..0000000
Binary files a/doc/dvbclient.png and /dev/null differ
diff --git a/doc/dvbconfig.png b/doc/dvbconfig.png
deleted file mode 100644
index 66cd07a..0000000
Binary files a/doc/dvbconfig.png and /dev/null differ
diff --git a/doc/dvbepg.png b/doc/dvbepg.png
deleted file mode 100644
index ab16367..0000000
Binary files a/doc/dvbepg.png and /dev/null differ
diff --git a/doc/dvblive.jpg b/doc/dvblive.jpg
deleted file mode 100644
index 0d6948f..0000000
Binary files a/doc/dvblive.jpg and /dev/null differ
diff --git a/doc/dvbscan.png b/doc/dvbscan.png
deleted file mode 100644
index 5143f19..0000000
Binary files a/doc/dvbscan.png and /dev/null differ
diff --git a/doc/dvbtimers.png b/doc/dvbtimers.png
deleted file mode 100644
index dbfa976..0000000
Binary files a/doc/dvbtimers.png and /dev/null differ
diff --git a/doc/dvbwin.png b/doc/dvbwin.png
deleted file mode 100644
index 2150238..0000000
Binary files a/doc/dvbwin.png and /dev/null differ
diff --git a/doc/gstpart.png b/doc/gstpart.png
deleted file mode 100644
index d3f60ca..0000000
Binary files a/doc/gstpart.png and /dev/null differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 3f069a7..b3d7c6f 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -8,7 +8,7 @@
<book id="kaffeine" lang="&language;">
<bookinfo>
-<title>&kaffeine; 2.0.1 Handbook</title>
+<title>The &kaffeine; Handbook</title>
<authorgroup>
<author>
@@ -27,668 +27,289 @@
<address><email>hftom@free.fr</email></address>
</affiliation>
</author>
+<author>
+<firstname>Mauro</firstname>
+<othername>Carvalho</othername>
+<surname>Chehab</surname>
+<affiliation>
+<address><email>mchehab@infradead.org</email></address>
+</affiliation>
+</author>
</authorgroup>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
<copyright>
<year>2004</year>
-<year>2006</year>
+<year>2016</year>
<holder>The &kaffeine; Authors</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>13/03/2006</date><!--FIXME change to 2016-xx-yy-->
-<releaseinfo>0.08.00</releaseinfo><!--FIXME change to &kaffeine; 2.01-->
+<date>2016-06-26</date>
+<releaseinfo>&kaffeine; 2.0.4</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
-A Media Player by KDE. <ulink \
url="http://kaffeine.sourceforge.net">http://kaffeine.sourceforge.net</ulink><!--FIXME \
change to ??--> +<ulink \
url="https://www.kde.org/applications/multimedia/kaffeine/">Kaffeine</ulink> is a \
Media Player by &kde;. </para>
</abstract>
<keywordset>
<keyword>kaffeine</keyword>
-<keyword>xine</keyword>
+<keyword>vlc</keyword>
<keyword>video</keyword>
<keyword>audio</keyword>
<keyword>mp3</keyword>
+<keyword>dvd</keyword>
+<keyword>dvbt</keyword>
</keywordset>
</bookinfo>
-<chapter id="kaffeine-app">
-<title>&kaffeine; Shell</title>
+<chapter id="kaffeine-player">
+<title>&kaffeine; Player</title>
<sect1 id="startwindow">
<title>The Start Window</title>
+<para>Like many other media players, &kaffeine; supports a wide range of video and \
audio formats +as well as playing audio and video from DVD and &CD;. Additionally, it \
supports live +Digital TV playback if your machine has a Digital Video Broadcast \
(DVB) +device plugged into it.
+</para>
+<para>Once &kaffeine; starts, it presents a screen with the main functions in the \
middle, +and it's possible to switch to other functions via either the pop up menu or \
the lateral menu: +</para>
+
<screenshot>
<screeninfo>Start Window</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="startwindow.png" format="PNG"/>
- </imageobject>
-
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_initial.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Start Window</phrase>
+</textobject>
+</mediaobject>
</screenshot>
-<para>Provides fast access to the most important media sources.
+</sect1>
+
+<sect1 id="playfile">
+<title>Play a File</title>
+<para>Playing a video or audio file is as simple as clicking on the <guibutton>Play \
File</guibutton> +button. It will ask you to select the file to be played, and wil \
begin playing it. Since &kaffeine; +uses LibVLC for the backend it supports all the \
same file formats as VLC. +It also supports opening a list of files to create and \
manage playlists. </para>
+<screenshot>
+<screeninfo>Play a File</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_play_file.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Play a File</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
+
</sect1>
<sect1 id="playlistwindow">
<title>The Playlist Window</title>
-
+<para>&kaffeine; supports multiple playlists. Choose the active one with the \
<guilabel>Playlist</guilabel> selector. +You can easily drag some files or folders \
from the file browser and drop it on the playlist to enqueue or drop it +on the \
player window to create a new playlist. To change a playlist name edit it and confirm \
with <keycap>Return</keycap>. +</para>
<screenshot>
-<screeninfo>&kaffeine; Playlist Window</screeninfo>
+<screeninfo>Playlist Window</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="playlistwin.png" format="PNG"/>
+ <imagedata fileref="playlistwindow.png" format="PNG"/>
</imageobject>
-
<textobject>
- <phrase>Screenshot</phrase>
+ <phrase>Playlist Window</phrase>
</textobject>
</mediaobject>
</screenshot>
-<para>&kaffeine; supports multiple playlists. Choose the active one with the \
"Playlist" selector. You can easily drag some files or folders from the file browser \
and drop it on the playlist to enqueue or drop it on the player window to create a \
new playlist. To change playlist name edit it and confirm with \
<keycap>Return</keycap>.
-</para>
<para>You can find all playlist related functions in the \
<guimenu>Playlist</guimenu>-Menu and the context-menu (right-click on playlist). \
</para>
-
</sect1>
+</chapter>
-<sect1 id="disctwindow">
-<title>The Discs Window</title>
+<chapter id="kaffeine-digital-tv">
+<title>Digital TV Player</title>
+<!-- https://blogs.s-osg.org/watching-digital-tv-via-kaffeine/-->
-<screenshot>
-<screeninfo>&kaffeine; Discs Window</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="discwindow.png" format="PNG"/>
- </imageobject>
-
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
+<sect1 id="digital-tv">
+<title>Graphical User Interface for Digital TV</title>
-<para>Here you can start Audio CD, DVD or VCD. You can even rip and encode audio \
tracks to be stored on your hard disk. +<para>While the basic functionality is useful \
enough for someone who wants a simple, yet powerful +media player, the best feature \
in &kaffeine; is to use it as a &GUI; frontend to watch and record digital TV. \
</para>
-</sect1>
-
-<sect1 id="dvbwindow">
-<title>The DVB Window</title>
-<!--FIXME https://userbase.kde.org/Special:MyLanguage/Kaffeine-TV -->
-<screenshot>
-<screeninfo>DVB Window</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="dvbwin.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
-
-<para>&kaffeine; supports Digital Video Broadcasting devices supported by linuxtv \
drivers. This window is only visible if &kaffeine; find a DVB device at startup. If \
you have a DVB device and &kaffeine; doesn't find it, make sure the driver is loaded \
and your device recognized. (Further information can be found at www.linuxtv.org) \
+<para>In &kaffeine; version 2.0 the digital TV support was extended to support \
DVB-T2 and ISDB-T. +Since it now uses libdvbv5, extending support for other digital \
TV standards is simple. +Also, since it uses the &Linux; DVB version 5 API, it \
supports frontends capable of implementing multiple TVs at once. </para>
-<remark>You can arrange your channels in categories. To create a new category, right \
click in the icon view to get a popup menu. Now, drag a channel name and drop it on \
the desired category' icon. To remove a channel from a category, drop it on the "All" \
icon. Right click on an icon to delete that category or change \
icon.</remark>
-<para>You can find all DVB related functions in the <guimenu>DVB</guimenu>-Menu.
-</para>
-
-<sect2 id="dvbconfig">
-<title>Configuration</title>
-
-<screenshot>
-<screeninfo>Configuration</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="dvbconfig.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
-<para>Select <guimenu>Menu->DVB->Configure DVB...</guimenu> to open the DVB config \
dialog. In order to get your device(s) working in &kaffeine;, you have to choose a \
"source" in the list. If you have a DISEqC switch, choose a source for each \
satellite.
-</para>
-<para>The <guilabel>Recording</guilabel> page allow you to choose where programs are \
saved to disk. +<para>Setting the TV configuration on &kaffeine; is as simple as \
clicking on the <guimenu>Television</guimenu> pop up menu, +and selecting the \
<guimenuitem>Configure Television</guimenuitem> option. A pop up window will open \
that requests the parameters to be used: </para>
-</sect2>
-
-<sect2 id="dvbscan">
-<title>Getting channels</title>
<screenshot>
-<screeninfo>Channels</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="dvbscan.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
+<screeninfo>TV Configuration</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_configure_tv_isdb_device.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>TV Configuration</phrase>
+</textobject>
+</mediaobject>
</screenshot>
-<para>Open the <guilabel>Channels</guilabel> dialog from the \
<guimenu>DVB</guimenu>-Menu. There, click the <guilabel>Start scan</guilabel> button \
to start scanning the network for available channels. This can take a while, so be \
patient ... When done, select the channels you want to add to your channels list and \
click <guilabel>Add selected</guilabel> or use the filters and click <guilabel>Add \
filtered</guilabel> (e.g. check "Free to air" and "TV" to add all fta \
TV).
-</para>
-<para>When added to channels list, channels are automatically assigned a number. To \
change this number, right click on the channel name and choose <guilabel>Edit \
...</guilabel> from the popup menu. This number will allow you to zap using keypad. \
+<para> +The <guimenu>Device</guimenu> menus have the per-device setup. Usually \
selecting the country and the city in the <guilabel>Source</guilabel> +combo box (or \
using one of the Autoscan sources) is enough for non-satellite configurations. +The \
same happens for devices that support multiple TV standards: </para>
-<remark>Note that you can also change the channel number in the DVB window. Select \
the channel then click on the number to edit.</remark>
-</sect2>
-
-<sect2 id="live">
-<title>Viewing live</title>
<screenshot>
-<screeninfo>Live TV</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="dvblive.jpg" format="JPEG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
+<screeninfo>Channel Configuration</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_configure_tv_dvbc_dvbt2_device.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Channel Configuration</phrase>
+</textobject>
+</mediaobject>
</screenshot>
-<para>To zap to a channel, you can either double-click on a channel name in the DVB \
window or use keypad (or remote control with kdelirc) to enter the channel number. \
Entered digit are displayed in the top left corner of the Player window. You can also \
hit pageUp/pageDown to zap to previous/next.
-</para>
-<para>You can now see your favorite program. &kaffeine; also displays some \
informations about this channel using OSD. You can later hit "O" to see it again. \
(Hit "O" twice to display current program description).
-</para>
-<para>Now, what if your phone suddenly ring and you absolutely don't want to miss \
this crucial moment of the movie ? Don't worry. Just hit <guilabel>pause</guilabel>. \
&kaffeine; will pause and immediately start to save the stream to your harddisk. \
Later, hit <guilabel>play</guilabel> and the program will continue from where you \
left it. To return to live, just rezap to this channel. +<para>
+After clicking on the <guibutton>Ok</guibutton> button, the next step is to scan for \
the digital channels, using +the Television pop up menu, option \
<guimenuitem>Channels</guimenuitem>: </para>
-<remark>Note that live DVB only works with the xine engine (called "&kaffeine;"). \
<guimenu>Menu->Settings->Engine->&kaffeine;</guimenu>.</remark>
-</sect2>
-
-<sect2 id="epg">
-<title>Electronic Program Guide</title>
<screenshot>
-<screeninfo>EPG</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="dvbepg.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
+<screeninfo>Scanning Channels</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_scan_finished_channels_added.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Scanning Channels</phrase>
+</textobject>
+</mediaobject>
</screenshot>
-<para><guimenu>Menu->DVB->EPG...</guimenu> brings up the Electronic Program Guide \
window, displaying current/next programs. Left click on an entry to display the \
detailed description of the program. Scheduled events for a given channel are \
displayed when you right click on one of the channel entry and select <guimenu>View \
all programs</guimenu> from the context menu.
-</para>
-<para>Double click on an entry to zap to that channel.
+<para>
+If more then one standard is supported, the <guilabel>Source</guilabel> combo box \
will allow you to select the +one that will be used to scan. Don't forget to connect \
the device's antenna cable to match +the standard that will be used. Then, click \
<guibutton>Start Scan</guibutton> to start scanning for channels. +Once finished, the \
discovered channels will appear on the left. These channels can be copied +to the \
left side by clicking <guibutton>Add Filtered</guibutton>. It is possible to check \
the tuning parameters +for the channel in the left side by clicking on the \
<guibutton>Edit</guibutton> button. +Some parameters are adjustable in the window \
that pops up. </para>
-<remark>Note that you have first to zap to some channels in order to get \
EPG.</remark>
-</sect2>
-
-<sect2 id="recording">
-<title>Recording</title>
<screenshot>
-<screeninfo>Recording</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="dvbtimers.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
+<screeninfo>Edit Channel Settings</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_scan_channel_edit.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Edit Channel Settings</phrase>
+</textobject>
+</mediaobject>
</screenshot>
-<para>&kaffeine; offers you several way of recording.
-</para>
-<para>When you are viewing a live program, you can simply choose \
<guimenu>Menu->DVB->Instant record</guimenu> to immediately start recording this \
program. The duration is defined in the <guilabel>Recording</guilabel> page of the \
DVB config dialog, but you can modify it on the fly from the Timers dialog \
(<guimenu>Menu->DVB->Timers...</guimenu>). Just select the program and click \
<guilabel>Edit</guilabel> button to change the duration.
-</para>
-<para>You can also create a timer from the EPG window. Right click on a program \
entry and select <guimenu>Add to timers</guimenu> from the context menu. In this \
case, the timer is created using <guilabel>Begin margin</guilabel> and <guilabel>End \
margin</guilabel> defined in the <guilabel>Recording</guilabel> page of the DVB \
config dialog. So, start time is set to [start time given by EPG]-[begin margin] and \
duration is set to [duration given by EPG]+[begin margin]+[end \
margin].
-</para>
-<para>Finally, you can create a new timer by hand. Open the Timers dialog, click on \
the <guilabel>New</guilabel> button and fill in required \
informations.
-</para>
-<para>Note that all timers can be deleted, even if running. Open the Timers dialog, \
select the program and click the <guilabel>Delete</guilabel> button. Of course, \
deleting a running timer doesn't delete the file on the disk.
-</para>
-<remark>You can view and/or record several channels at the same time on the same \
multiplex. Note that the priority is always given to timers, so if you are viewing a \
live show and a timer is to be started on a different multiplex, live will be stopped \
to allow recording.</remark>
-<para></para>
-<remark>Be aware that a DVB stream is about 1.5GB/hour.</remark>
-</sect2>
-
-<sect2 id="replay">
-<title>Playing a record</title>
-
-<para>Simply open the file and &kaffeine; will start playing. That's all !
+<para>
+Once the channels are saved, watching TV is as simple as clicking on the \
<guibutton>Digital TV</guibutton> button in the main window: </para>
-</sect2>
-
-<sect2 id="broadcasting">
-<title>Broadcasting</title>
<screenshot>
-<screeninfo>Broadcasting</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="dvbbroadcast.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
+<screeninfo>Watching TV</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_live_tv.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Watching TV</phrase>
+</textobject>
+</mediaobject>
</screenshot>
-
-<para>&kaffeine; can broadcast several DVB channels (being on the same multiplex) on \
a lan.
-</para>
-<para>Open the DVB config dialog and go to the <guilabel>Broadcasting</guilabel> \
page to set address and ports.
-</para>
-<para><guimenu>Menu->DVB->Broadcasting...</guimenu> opens the broadcasting editor. \
Select a channel in the <guilabel>Available channels</guilabel> list, and click the \
<guilabel>Add</guilabel> button to add it to the <guilabel>Broadcasting \
list</guilabel>. The <guilabel>Available channels</guilabel> list is now filled with \
channels on the same multiplex. You can now use multi-selection to add channels. \
Click <guilabel>OK</guilabel> button to start broadcasting.
-</para>
-<para>To stop broadcasting, open the dialog and click <guilabel>OK</guilabel> with \
an empty list. +<para>
+&kaffeine; also allows you to click on the
+<inlinemediaobject><imageobject><imagedata fileref="media-playback-pause.png" \
format="PNG"/></imageobject></inlinemediaobject> +to pause it.
+When the button is clicked, &kaffeine; will record the program and once the
+<inlinemediaobject><imageobject><imagedata fileref="media-playback-start.png" \
format="PNG"/></imageobject></inlinemediaobject> +button is pressed it will start the \
program from +the point it was paused. There is also a
+<inlinemediaobject><imageobject><imagedata fileref="document-save.png" \
format="PNG"/></imageobject></inlinemediaobject> button +that allows you to quick \
record and save the program to disk. </para>
-<remark>Note that the priority is always given to timers, so if you are broadcasting \
and a timer is to be started on a different multiplex, broadcasting will be stopped \
to allow recording. And broadcasting has a higher priority than \
live.</remark>
-</sect2>
</sect1>
-<sect1 id="dvbclientwindow">
-<title>The DVB Client Window</title>
+<sect1 id="recording-programs">
+<title>Recording Programs</title>
-<screenshot>
-<screeninfo>DVB Client Window</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="dvbclient.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
-
-<para>To enable DVB client, you have to check the box in the &kaffeine; \
configuration dialog. There you must also set address and ports. It will create a new \
tab labeled <guilabel>Dvb client</guilabel> showing a list of actually broadcasted \
channels (if any). Double click on a channel name to start playing it. DVB client \
also support time shifting (just hit pause).
-</para>
-</sect1>
-
-</chapter>
-
-<chapter id="player-parts">
-<title>Player Parts</title><!--FIXME no kparts?-->
-
-<para>You'll find all available player parts in \
<guimenu>Settings</guimenu>-<guimenuitem>Player Engine</guimenuitem>. +<para>Besides \
clicking on the record button +<inlinemediaobject><imageobject><imagedata \
fileref="document-save.png" format="PNG"/></imageobject></inlinemediaobject> +when \
the live view is opened, &kaffeine; has other ways to record a program. +One method \
is to select the program to be recorded using the <guimenu>Television</guimenu> pop \
up menu +and selecting the <guimenuitem>Program Guide</guimenuitem> option.
+It will present a list of programs that were identified on a previously played \
program: </para>
-<sect1 id="kaffeine-part">
-<title>The &kaffeine; Part</title>
-
<screenshot>
-<screeninfo>&kaffeine;-Part</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="kaffeinepart.png" format="PNG"/>
- </imageobject>
-
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
+<screeninfo>Program Guide</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_program_guide.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Program Guide</phrase>
+</textobject>
+</mediaobject>
</screenshot>
-<para>This is the default, xine based, full featured player part for &kaffeine;. \
Plays almost everything...</para>
-
-<sect2 id="about-xine">
-<title>About xine</title><!-- based on vlc now? what about backend-mplayer in the \
code, is it used?-->
-
<para>
- xine is a free multimedia player. It plays back CDs, DVDs, and VCDs.
- It also decodes multimedia files like AVI, MOV, WMV, and MP3 from local disk \
drives, and displays multimedia streamed over the Internet.
- It interprets many of the most common multimedia formats available - and some of \
the most uncommon formats, too.
- Detailed info about xine features: <ulink url="http://www.xinehq.de">
-http://www.xinehq.de</ulink>
+Clicking on the
+<inlinemediaobject><imageobject><imagedata fileref="media-record.png" \
format="PNG"/></imageobject></inlinemediaobject> +<guibutton>Record Show</guibutton> \
button will mark the program to be recorded. The record needs to be enabled +via the \
<guilabel>Recording Schedule</guilabel> option, also located in the \
<guimenu>Television</guimenu> menu: </para>
-</sect2>
-
-</sect1>
-
-<sect1 id="gstreamer-part">
-<title>The GStreamer Part</title><!-- no gstreamer part remove this sect?-->
-
<screenshot>
-<screeninfo>GStreamer-Part</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="gstpart.png" format="PNG"/>
- </imageobject>
-
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
+<screeninfo>Recording Schedule</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="kaffeine_recording_schedule_enabled.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Recording Schedule</phrase>
+</textobject>
+</mediaobject>
</screenshot>
-<para>A simple player part based on GStreamer. GStreamer homepage: <ulink \
url="http://gstreamer.freedesktop.org">
-http://gstreamer.freedesktop.org</ulink>
-</para>
-
-</sect1>
-
-</chapter>
-
-<chapter id="cmdline-options">
-<title>Command Line Options</title>
-
-<para>Usage:</para>
-<cmdsynopsis>
-<command>kaffeine</command>
-<group choice="opt">
-<option>f</option>
-<option>p</option><option>w</option>
-<option>a</option><option>x</option>
-<option>d</option>
-</group>
-<arg>--fullscreen</arg>
-<arg>--play</arg>
-<arg>--audiodriver</arg>
-<arg>--videodriver</arg>
-<arg>--device</arg>
-<arg>--verbose</arg>
-<arg>--wizard</arg>
-<arg rep="repeat"><replaceable>file</replaceable></arg>
-</cmdsynopsis>
-<!--FIXME update + add kf5options + qt5options-->
-<para></para>
-
-<informaltable>
-<tgroup cols="2">
-<tbody>
-
-<row><entry><para><option>-f,--fullscreen</option></para></entry>
-<entry><para>Starts &kaffeine; in fullscreen mode.
-</para></entry>
-</row>
-<row>
-<entry><para><option>-p,--play</option></para></entry>
-<entry><para>Starts with last played track.
-</para></entry>
-</row>
-<row>
-<entry><para><option>-a,--audiodriver (argument)</option></para></entry>
-<entry><para>Sets the audio driver. Arguments can be: alsa, arts, oss, ...
-</para></entry>
-</row>
-<row>
-<entry><para><option>-x,--videodriver (argument)</option></para></entry>
-<entry><para>Sets the video driver. Arguments can be: xv, xshm, dxr3 ,...
-</para></entry>
-</row>
-<row>
-<entry><para><option>-d,--device (argument)</option></para></entry>
-<entry><para>Sets the Audio-CD/VCD/DVD path to (argument).
-</para></entry>
-</row>
-<row>
-<entry><para><option>--verbose</option></para></entry>
-<entry><para>Outputs more debug messages.
-</para></entry>
-</row>
-<row><entry><para><option>-w,--wizard</option></para></entry>
-<entry><para>Runs installation wizard.
-</para></entry>
-</row>
-<row>
-<entry><para><option>file...</option></para></entry>
-<entry><para>Files to play. Can be local files, a directory, an URL or "AudioCD", \
"VCD", "DVD".
-</para></entry>
-</row>
-</tbody>
-</tgroup>
-</informaltable>
-
-</chapter>
-
-<chapter id="dbus-interface">
-<title>The &DBus; Interface</title>
-<!--FIXME proofread + update-->
-<sect1 id="dbus-overview">
-<title>Overview</title>
-<para>You can use the &DBus; interface in two kinds: From inside another application \
with <function>KApplication::dcopClient()->send( "kaffeine", "KaffeineIface", \
"pause()" )</function><!--FIXME still valid in kf5-->
-or from command line with <command>dcop kaffeine KaffeineIface openURL \
best_song_of_the_world.mp3</command>. +<para>
+By clicking one the <guibutton>New</guibutton> button, it is also possible to \
directly define a time and duration for a program to be recorded. </para>
</sect1>
-<sect1 id="dcop-functions">
-<title>Functions</title>
-
-<sect2 id="kaffeineiface">
-<title>KaffeineIface Object</title>
-
-<informaltable>
-<tgroup cols="2">
-<tbody>
-
-<row>
-<entry><para><function>void openURL(QString URL)</function></para></entry>
-<entry><para>Opens and plays the given URL.</para></entry>
-</row>
-<row>
-<entry><para><function>void appendURL(QString URL)</function></para></entry>
-<entry><para>Appends the URL to current playlist.</para></entry>
-</row>
-<row>
-<entry><para><function>void playAudioCD()</function></para></entry>
-<entry><para>Starts playing Audio CD.</para></entry>
-</row>
-<row>
-<entry><para><function>void playVCD()</function></para></entry>
-<entry><para>Starts playing Video CD.</para></entry>
-</row>
-<row>
-<entry><para><function>void playDVD()</function></para></entry>
-<entry><para>Starts playing DVD.</para></entry>
-</row>
-<row><entry><para><function>void play()</function></para></entry>
-<entry><para>(Re)Starts playback.</para></entry>
-</row>
-<row><entry><para><function>bool isPlaying()</function></para></entry>
-<entry><para>Returns "true" or "false" on command line.</para></entry>
-</row>
-<row><entry><para><function>void pause()</function></para></entry>
-<entry><para>Toggles pause/playback.</para></entry>
-</row>
-<row><entry><para><function>void next()</function></para></entry>
-<entry><para>Plays next playlist entry/chapter/DVB channel.</para></entry>
-</row>
-<row><entry><para><function>void previous()</function></para></entry>
-<entry><para>Plays previous playlist entry/chapter/DVB channel.</para></entry>
-</row>
-<row><entry><para><function>void stop()</function></para></entry>
-<entry><para>Stops playback.</para></entry>
-</row>
-<row><entry><para><function>QString title()</function></para></entry>
-<entry><para>Returns the title of the current track.</para></entry>
-</row>
-<row><entry><para><function>QString getFileName()</function></para></entry>
-<entry><para>Returns filename of current track.</para></entry>
-</row>
-<row><entry><para><function>int getLength()</function></para></entry>
-<entry><para>Returns length of current track in seconds.</para></entry>
-</row>
-<row><entry><para><function>int getTimePos()</function></para></entry>
-<entry><para>Returns current stream position in seconds.</para></entry>
-</row>
-<row><entry><para><function>void quit()</function></para></entry>
-<entry><para>Quits Kaffeine.</para></entry>
-</row>
-<row><entry><para><function>void random()</function></para></entry>
-<entry><para>Toggles between random and normal play.</para></entry>
-</row>
-<row><entry><para><function>void fullscreen()</function></para></entry>
-<entry><para>Toggles between fullscreen and windowed mode.</para></entry>
-</row>
-<row><entry><para><function>void posPlus()</function></para></entry>
-<entry><para>Increases stream position.</para></entry>
-</row>
-<row><entry><para><function>void posMinus()</function></para></entry>
-<entry><para>Decreases stream position.</para></entry>
-</row>
-<row><entry><para><function>void volUp()</function></para></entry>
-<entry><para>Increases volume.</para></entry>
-</row>
-<row><entry><para><function>void volDown()</function></para></entry>
-<entry><para>Decreases volume.</para></entry>
-</row>
-<row><entry><para><function>void mute()</function></para></entry>
-<entry><para>Toggles mute on/off.</para></entry>
-</row>
-<row><entry><para><function>void setNumber(int number)</function></para></entry>
-<entry><para>Select DVB channel/playlist entry by number.</para></entry>
-</row>
-<row><entry><para><function>void dvbOSD()</function></para></entry>
-<entry><para>Toggles DVB-OSD on/off.</para></entry>
-</row>
-
-</tbody>
-</tgroup>
-</informaltable>
-
-</sect2>
-<!--FIXME proofread + update-->
-<sect2 id="kaffeinepartiface">
-<title>KaffeinePartIface Object</title>
-
-<informaltable>
-<tgroup cols="2">
-<tbody>
-
-<row>
-<entry><para><function>int getContrast()</function></para></entry>
-<entry><para>Returns current contrast.</para></entry>
-</row>
-<row>
-<entry><para><function>void setContrast(int contrast)</function></para></entry>
-<entry><para>Sets contrast (0..65535).</para></entry>
-</row>
-<row>
-<entry><para><function>int getBrightness()</function></para></entry>
-<entry><para>Returns current brightness.</para></entry>
-</row>
-<row>
-<entry><para><function>void setBrightness(int brightness)</function></para></entry>
-<entry><para>Sets brightness (0..65535).</para></entry>
-</row>
-<row>
-<entry><para><function>void dvdMenuUp()</function></para></entry>
-<entry><para>DVD Menu: Cursor up.</para></entry>
-</row>
-<row>
-<entry><para><function>void dvdMenuDown()</function></para></entry>
-<entry><para>DVD Menu: Cursor down.</para></entry>
-</row>
-<row>
-<entry><para><function>void dvdMenuLeft()</function></para></entry>
-<entry><para>DVD Menu: Cursor left.</para></entry>
-</row>
-<row>
-<entry><para><function>void dvdMenuRight()</function></para></entry>
-<entry><para>DVD Menu: Cursor right.</para></entry>
-</row>
-<row>
-<entry><para><function>void dvdMenuSelect()</function></para></entry>
-<entry><para>DVD Menu: Selects the menu item pointed by the cursor.</para></entry>
-</row>
-<row>
-<entry><para><function>void dvdMenuToggle()</function></para></entry>
-<entry><para>Toggles DVD menu on/off.</para></entry>
-</row>
-<row>
-<entry><para><function>void aspectRatioAuto()</function></para></entry>
-<entry><para>Automatic aspect ratio.</para></entry>
-</row>
-<row>
-<entry><para><function>void aspectRatio4_3()</function></para></entry>
-<entry><para>Sets aspect ratio to 4:3.</para></entry>
-</row>
-<row>
-<entry><para><function>void aspectRatioAnamorphic()</function></para></entry>
-<entry><para>Sets aspect ratio to 16:9.</para></entry>
-</row>
-<row>
-<entry><para><function>void aspectRatioSquare()</function></para></entry>
-<entry><para>Sets aspect ratio to 1:1.</para></entry>
-</row>
-<row>
-<entry><para><function>void aspectRatioDVB()</function></para></entry>
-<entry><para>Sets aspect ratio to 2.11:1.</para></entry>
-</row>
-<row>
-<entry><para><function>void zoomIn()</function></para></entry>
-<entry><para>Zooms picture in.</para></entry>
-</row>
-<row>
-<entry><para><function>void zoomOut()</function></para></entry>
-<entry><para>Zooms picture out.</para></entry>
-</row>
-<row>
-<entry><para><function>void zoomOff()</function></para></entry>
-<entry><para>Disables zoom.</para></entry>
-</row>
-
-</tbody>
-</tgroup>
-</informaltable>
-
-</sect2>
-</sect1>
</chapter>
-<chapter id="keybindings">
-<title>Keybindings</title>
-
-<para>You can configure shortcuts using \
<guimenu>Settings</guimenu>-<guimenuitem>Configure Shortcuts</guimenuitem>.<!--FIXME \
add link to sect in fundamentals?-->
-</para>
-
-</chapter>
-
-<!--FIXME noting special for kaffeine here, applies to all applications, so let's \
remove it (dead links etc)
-<chapter id="bug">
-<title>Reporting BUGS</title>
-
-<para>
-Before you report a bug, please first make sure the bug has not been reported
-yet in the bug tracking system at <ulink \
url="http://www.sourceforge.net/projects/kaffeine">http://www.sourceforge.net/projects/kaffeine</ulink>.
-Also have a look into the mailinglist <ulink \
url="http://sourceforge.net/mailarchive/forum.php?forum_id=34875">archive</ulink>.
-</para>
-
-<para>
-Please use only the tracking system on sourceforge for reporting bugs and log in \
before
-submitting (if you've a sourceforge account).
-</para>
-
-<para>
-When you submit a bug, please include all of the following information:
-
-<itemizedlist>
-<listitem><para>versions of &kaffeine;, xine, KDE, X11</para></listitem>
-<listitem><para>the backtrace from KDE's Crash Manager</para></listitem>
-<listitem><para>console output (you can use verbose to get more)</para></listitem>
-</itemizedlist>
-
-</para>
-
-</chapter>
--->
<chapter id="credits">
<title>Copyright and License</title>
@@ -697,9 +318,10 @@ Program copyright 2007-2016, The &kaffeine; Authors
</para>
<para>
-Documentation copyright 2003-2005, Jürgen Kofler <email>kaffeine@gmx.net</email>, \
Christophe Thommeret <email>hftom@free.fr</email> +Documentation copyright 2003-2005, \
Jürgen Kofler <email>kaffeine@gmx.net</email>, +Christophe Thommeret \
<email>hftom@free.fr</email>, Mauro Carvalho Chehab \
<email>mchehab@infradead.org</email> </para>
-
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
diff --git a/doc/kaffeine_configure_tv_dvbc_dvbt2_device.png \
b/doc/kaffeine_configure_tv_dvbc_dvbt2_device.png new file mode 100644
index 0000000..17ba448
Binary files /dev/null and b/doc/kaffeine_configure_tv_dvbc_dvbt2_device.png differ
diff --git a/doc/kaffeine_configure_tv_isdb_device.png \
b/doc/kaffeine_configure_tv_isdb_device.png new file mode 100644
index 0000000..047f03c
Binary files /dev/null and b/doc/kaffeine_configure_tv_isdb_device.png differ
diff --git a/doc/kaffeine_initial.png b/doc/kaffeine_initial.png
new file mode 100644
index 0000000..9bd0f72
Binary files /dev/null and b/doc/kaffeine_initial.png differ
diff --git a/doc/kaffeine_live_tv.png b/doc/kaffeine_live_tv.png
new file mode 100644
index 0000000..3fd9621
Binary files /dev/null and b/doc/kaffeine_live_tv.png differ
diff --git a/doc/kaffeine_play_file.png b/doc/kaffeine_play_file.png
new file mode 100644
index 0000000..da73bba
Binary files /dev/null and b/doc/kaffeine_play_file.png differ
diff --git a/doc/kaffeine_program_guide.png b/doc/kaffeine_program_guide.png
new file mode 100644
index 0000000..6d416f6
Binary files /dev/null and b/doc/kaffeine_program_guide.png differ
diff --git a/doc/kaffeine_recording_schedule_enabled.png \
b/doc/kaffeine_recording_schedule_enabled.png new file mode 100644
index 0000000..7cab3d4
Binary files /dev/null and b/doc/kaffeine_recording_schedule_enabled.png differ
diff --git a/doc/kaffeine_scan_channel_edit.png b/doc/kaffeine_scan_channel_edit.png
new file mode 100644
index 0000000..1776528
Binary files /dev/null and b/doc/kaffeine_scan_channel_edit.png differ
diff --git a/doc/kaffeine_scan_finished_channels_added.png \
b/doc/kaffeine_scan_finished_channels_added.png new file mode 100644
index 0000000..a1141d8
Binary files /dev/null and b/doc/kaffeine_scan_finished_channels_added.png differ
diff --git a/doc/kaffeinepart.png b/doc/kaffeinepart.png
deleted file mode 100644
index fe108b7..0000000
Binary files a/doc/kaffeinepart.png and /dev/null differ
diff --git a/doc/media-playback-pause.png b/doc/media-playback-pause.png
new file mode 100644
index 0000000..2377717
Binary files /dev/null and b/doc/media-playback-pause.png differ
diff --git a/doc/media-playback-start.png b/doc/media-playback-start.png
new file mode 100644
index 0000000..1113056
Binary files /dev/null and b/doc/media-playback-start.png differ
diff --git a/doc/media-record.png b/doc/media-record.png
new file mode 100644
index 0000000..8bc8573
Binary files /dev/null and b/doc/media-record.png differ
diff --git a/doc/playlistwin.png b/doc/playlistwin.png
deleted file mode 100644
index 9c6a283..0000000
Binary files a/doc/playlistwin.png and /dev/null differ
diff --git a/doc/playlistwindow.png b/doc/playlistwindow.png
new file mode 100644
index 0000000..2e151c5
Binary files /dev/null and b/doc/playlistwindow.png differ
diff --git a/doc/startwindow.png b/doc/startwindow.png
index bfdfa83..dd63ee7 100644
Binary files a/doc/startwindow.png and b/doc/startwindow.png differ
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic