[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdemultimedia/doc/dragonplayer
From:       Burkhard Lück <lueck () hube-lueck ! de>
Date:       2010-10-30 20:18:47
Message-ID: 20101030201847.D74A6AC89B () svn ! kde ! org
[Download RAW message or body]

SVN commit 1191377 by lueck:

doc update

 M  +66 -252   index.docbook  
 AM            playmedia.png  


--- trunk/KDE/kdemultimedia/doc/dragonplayer/index.docbook #1191376:1191377
@@ -1,22 +1,16 @@
 <?xml version="1.0" ?>
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" \
                "dtd/kdex.dtd" [
-  <!ENTITY kappname "&codeine;">
-  <!ENTITY codeine "<application>Dragon Player</application>">
+  <!ENTITY kappname "&dragonplayer;">
+  <!ENTITY dragonplayer "<application>Dragon Player</application>">
 
   <!ENTITY % addindex "IGNORE">
   <!ENTITY % English "INCLUDE"><!-- change language only here -->
 ]>
 
-
-<!-- The language must NOT be changed here. -->
-
 <book lang="&language;">
 
-<!-- This header contains all of the meta-information for the document such
-as Authors, publish date, the abstract, and Keywords -->
-
 <bookinfo>
-<title>The &codeine; Handbook</title>
+<title>The &dragonplayer; Handbook</title>
 
 <authorgroup>
 <author>
@@ -44,33 +38,18 @@
 <year>2007</year>
 <holder>Ian Monroe</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 documentation
-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 (DD/MM/YYYY) and of the version
-(V.MM.LL), it could be used by automation scripts.
-Do NOT change these in the translation. -->
+<date>2010-10-21</date>
+<releaseinfo>2.0 (&kde; 4.5)</releaseinfo>
 
-<date>28/12/2007</date>
-<releaseinfo>2</releaseinfo>
-
-<!-- Abstract about this handbook -->
-
 <abstract>
 <para>
-&codeine; is a simple video player for &kde;.
+&dragonplayer; is a simple video player for &kde;.
 </para>
 </abstract>
 
-<!-- This is a set of Keywords for indexing by search engines.
-Please at least include KDE, the KDE package it is in, the name
- of your application, and a few relevant keywords. -->
-
 <keywordset>
 <keyword>KDE</keyword>
 <keyword>Codeine</keyword>
@@ -84,20 +63,11 @@
 
 </bookinfo>
 
-<!-- The contents of the documentation begin here.  Label
-each chapter so with the id attribute. This is necessary for two reasons: it
-allows you to easily reference the chapter from other chapters of your
-document, and if there is no ID, the name of the generated HTML files will vary
-from time to time making it hard to manage for maintainers and for the CVS
-system. Any chapter labelled (OPTIONAL) may be left out at the author's
-discretion. Other chapters should not be left out in order to maintain a
-consistent documentation style across all KDE apps. -->
-
 <chapter id="introduction">
 <title>Introduction</title>
 
 <screenshot>
-<screeninfo>&codeine; Screenshot</screeninfo>
+<screeninfo>&dragonplayer; Screenshot</screeninfo>
 <mediaobject>
 <imageobject><imagedata fileref="main.png" format="PNG"/></imageobject>
 <textobject><phrase>Screenshot</phrase></textobject>
@@ -106,232 +76,109 @@
 
 
 <para>
-&codeine; is a simple media player using Phonon technology. &codeine; is a no frills \
media player that excels at playing DVDs and movie files without getting in your way. \
+&dragonplayer; is a simple media player using Phonon technology. &dragonplayer; is a \
no frills media player that excels at playing DVDs and movie files without getting in \
your way.  </para>
 
 </chapter>
 
+<chapter id="select-media">
+<title>Select a Media</title>
 
-<chapter id="commands">
-<title>Menu and Command Reference</title>
+<para>If you start &dragonplayer; from the application launcher or use \
<guibutton>Play Media</guibutton>  +(<keycombo \
action="simul">&Ctrl;<keycap>O</keycap></keycombo>) from the toolbar or from the \
<guimenu>Play</guimenu>  +menu this window is displayed:</para>
 
-<sect1 id="play_menu">
-<title>The Play Menu</title>
-<variablelist>
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo>&Ctrl;<keycap>O</keycap></keycombo>
-</shortcut>
-<guimenu>Play</guimenu>
-<guimenuitem>Play Media...</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Opens the Play Media dialog, allowing you to Play a DVD, VCD \
                or a video file.</action></para></listitem>
-</varlistentry>
+<screenshot>
+<screeninfo>Play Media</screeninfo>
+<mediaobject>
+<imageobject><imagedata fileref="playmedia.png" format="PNG"/></imageobject>
+<textobject><phrase>Play Media</phrase></textobject>
+</mediaobject>
+</screenshot>
 
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycap>Space</keycap>
-</shortcut>
-<guimenu>Play</guimenu>
-<guimenuitem>Play/Pause</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>If a movie is loaded, this option allows you to pause and \
                resume playback.</action></para></listitem>
-</varlistentry>
+<para>There are three ways to play a video file:</para>
+<para><guibutton>Play File</guibutton> opens the file dialog and allows you to \
select a file to play.</para> +<para><guibutton>Play Disc</guibutton> to play a CD or \
DVD.</para> +<para>Double click on an entry in the play list with recently opened \
files to start playing it.  +The context menu of the play list shows actions to \
remove a selected entry or clear the whole play list.  +Any file you played will be \
automatically added to the list.</para> +</chapter>
 
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycap>S</keycap>
-</shortcut>
-<guimenu>Play</guimenu>
-<guimenuitem>Stop</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>If a movie is loaded, this option allows you to stop \
                playback.</action></para></listitem>
-</varlistentry>
+<chapter id="features">
+<title>Features</title>
 
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo>&Ctrl;<keycap>Q</keycap></keycombo>
-</shortcut>
-<guimenu>Play</guimenu>
-<guimenuitem>Quit</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Quits &codeine;.</action></para></listitem>
-</varlistentry>
-</variablelist>
-</sect1>
-
-
-<sect1 id="settings_menu">
-<title>The Settings Menu</title>
 <variablelist>
 
 <varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycap>F</keycap>
-</shortcut>
-<guimenu>Settings</guimenu>
+<term>
 <guimenuitem>Full Screen Mode</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>
-    While playing a movie, you can enter full screen mode. This uses the entire \
                monitor to display the movie
-</action></para></listitem>
+</term>
+<listitem><para>
+While playing a movie, you can enter full screen mode. This uses the entire monitor \
to display the movie.  +Moving the mouse shows a toolbar at the top of the screen in \
full screen mode. +Toggle the full screen mode using the <guimenu>Settings</guimenu> \
menu, the action in the toolbar, double click on the video or use the shortcut  \
+<keycap>F</keycap>. +</para></listitem>
 </varlistentry>
 
 <varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guisubmenu>Aspect Ratio</guisubmenu>
-</menuchoice></term>
-<listitem><para><action>This menu lets you pick the aspect ratio of the playing \
movie. The aspect ratio is width of movie compared to the \
height.</action></para></listitem> +<term>
+<guimenuitem>Video Settings</guimenuitem>
+</term>
+<listitem><para>Select this action from the <guimenu>Settings</guimenu> menu to \
adjust <guilabel>Brightness</guilabel>, <guilabel>Contrast</guilabel>, \
<guilabel>Hue</guilabel> and <guilabel>Saturation</guilabel>. +These settings are \
stored together with the playback position for each video file. This enables you \
resume playing a video with the selected video  settings and the position where you \
stopped playing. +</para></listitem>
 </varlistentry>
 
 <varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guisubmenu>Subtitles</guisubmenu>
-</menuchoice></term>
-<listitem><para><action>
-This menu is active if there are any subtitles available from the currently playing \
movie. Note that it may take a few seconds of playback before the subtitles become \
                available.
-</action></para></listitem>
+<term>
+Navigation
+</term>
+<listitem><para>The shortcut <keycap>PgUp</keycap> brings you 10% forward, \
<keycap>PgDown</keycap> 10% backward. +Use <menuchoice><guimenu>Settings</guimenu> \
<guimenuitem>Menu Toggle</guimenuitem></menuchoice> (<keycap>R</keycap>) to switch to \
the video menu and select another chapter to play. \
+<menuchoice><guimenu>Play</guimenu><guimenuitem>Play/Pause</guimenuitem></menuchoice> \
(<keysym>Space</keysym>) allows you to pause and resume playback if a movie is \
loaded. <menuchoice><guimenu>Play</guimenu><guimenuitem>Stop</guimenuitem></menuchoice> \
(<keycap>S</keycap>) stops playback. +Go to the previous or next chapter of a video \
with <guimenuitem>Previous Chapter</guimenuitem> (<keycap>,</keycap>) or \
<guimenuitem>Next Chapter</guimenuitem> (<keycap>.</keycap>) from the \
<guimenu>Play</guimenu> menu. +</para></listitem>
 </varlistentry>
 
 <varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guisubmenu>Audio Channels</guisubmenu>
-</menuchoice></term>
-<listitem><para><action>
-This menu is active if there are any additional audio channels available. For \
instance, some DVDs have additional languages. Note that it may take a few seconds of \
                playback before the audio channels become available.
-</action></para></listitem>
+<term>
+<guimenuitem>Volume control</guimenuitem>
+</term>
+<listitem><para>If you play videos with a hidden toolbar, you can use the shortcut \
<keycap>M</keycap> to mute or unmute the sound; and the shortcut <keycap>V</keycap> \
to toggle the display of the volume slider right to the video. +</para></listitem>
 </varlistentry>
 
 <varlistentry>
 <term><menuchoice>
-<shortcut>
-<keycombo><keycap>R</keycap></keycombo>
-</shortcut>
 <guimenu>Settings</guimenu>
-<guimenuitem>Menu Toggle</guimenuitem>
+<guisubmenu>Aspect Ratio</guisubmenu>
 </menuchoice></term>
-<listitem><para><action>
-    To be written</action></para></listitem>
+<listitem><para><action>This menu lets you pick the aspect ratio of the playing \
movie. The aspect ratio is width of movie compared to the \
height.</action></para></listitem>  </varlistentry>
 
 <varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Videosettings</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>
-    To be written
-</action></para></listitem>
+<term>
+<guisubmenu>Subtitles</guisubmenu> and <guisubmenu>Audio Channels</guisubmenu>
+</term>
+<listitem><para>
+These menu items from the <guimenu>Settings</guimenu> menu are active if there are \
any subtitles or additional audio channels (&eg; with different languages) available \
from the currently playing movie. Note that it may take a few seconds of playback \
before the subtitles or audio channels become available. +</para></listitem>
 </varlistentry>
 
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Configure Shortcuts...</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Allows you to configure the &codeine; \
                shortcuts.</action></para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Configure Toolbars...</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Allows you to configure what buttons are available on the \
                toolbar.</action></para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Show Toolbar</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Enables or disable the main application \
                toolbar.</action></para></listitem>
-</varlistentry>
-
 </variablelist>
-</sect1>
 
-<sect1 id="help_menu">
-<title>The Help Menu</title>
-
-&help.menu.documentation;
-
-</sect1>
-
-
 </chapter>
 
-<!--
-<chapter id="faq">
-<title>Questions and Answers</title>
-
-(OPTIONAL but recommended) This chapter should include all of the silly
-(and not-so-silly) newbie questions that fill up your mailbox. This chapter
-should be reserved for BRIEF questions and answers! If one question uses more
-than a page or so then it should probably be part of the
-"Using this Application" chapter instead. You should use links to
-cross-reference questions to the parts of your documentation that answer them.
-This is also a great place to provide pointers to other FAQ's if your users
-must do some complicated configuration on other programs in order for your
-application work.
-
-&reporting.bugs;
-&updating.documentation;
-
-<qandaset id="faqlist">
-<qandaentry>
-<question>
-<para>My Mouse doesn't work. How do I quit &filelight;?</para>
-</question>
-<answer>
-<para>You silly goose! Check out the <link linkend="commands">Commands
-Section</link> for the answer.</para>
-</answer>
-</qandaentry>
-<qandaentry>
-<question>
-<para>Why can't I twiddle my documents?</para>
-</question>
-<answer>
-<para>You can only twiddle your documents if you have the foobar.lib
-installed.</para>
-</answer>
-</qandaentry>
-</qandaset>
-</chapter>
--->
-
-
-
 <chapter id="credits">
 
-<!-- Include credits for the programmers, documentation writers, and
-contributors here. The license for your software should then be included below
-the credits with a reference to the appropriate license file included in the KDE
-distribution. -->
-
 <title>Credits and License</title>
 
-<sect1 id="kapp">
-<title>&codeine;</title>
+<para>&dragonplayer;</para>
 <para>Program copyright 2004 Max B. Howell \
<email>max.howell@methylblue.com</email></para>  <para>Program copyright 2007 Ian A. \
Monroe <email>imonroe@kde.org</email></para>  &underGPL;
 
-</sect1>
-<sect1 id="Documentation">
-
-<title>Documentation</title>
-
 <para>
 Documentation copyright 2004 Mike Diehl <email>madpenguin8@yahoo.com</email>
 </para>
@@ -339,44 +186,11 @@
 Documentation copyright 2007 Ian Monroe <email>imonroe@kde.org</email>
 </para>
 
-
 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 &underFDL;
 
-</sect1>
-
 </chapter>
 
-<chapter id="requirements">
-<title>Requirements</title>
-
-<para>&codeine; requires the installation of some software packages. The required \
                packages are listed below.</para>
-
-
-<itemizedlist>
-<title>Required:</title>
-<listitem><para>Kdelibs 4.0 <ulink \
                url="http://www.kde.org"></ulink></para></listitem>
-<listitem><para>Kdebase 4.0 <ulink \
                url="http://www.kde.org"></ulink></para></listitem>
-<listitem><para>xine-lib 1.1 <ulink \
                url="http://xinehq.de"></ulink></para></listitem>
-</itemizedlist>
-
-</chapter>
-
-
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="getting-codeine">
-<title>How to obtain &codeine;</title>
-
-<para>
-&codeine; is part of the &kde; multimedia module, it can be found at:
-<ulink url="http://multimedia.kde.org">http://multimedia.kde.org</ulink>.
-</para>
-</sect1>
-
-</appendix>
-
 &documentation.index;
 </book>
 <!--


[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic