Import abandoned KDE3 version of kipi plugins

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/libraries/kipi-plugins@1077221 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 106 insertions, 0 deletions

diff --git a/doc/kipi-plugins/slideshow.docbook b/doc/kipi-plugins/slideshow.docbook
new file mode 100644
index 0000000..90c14c2
--- /dev/null
+++ b/doc/kipi-plugins/slideshow.docbook
@@ -0,0 +1,106 @@
+<chapter id="slideshow">
+<chapterinfo>
+
+<title>The Advanced Slide Show</title>
+
+<authorgroup>
+    <author>
+        <firstname>Gilles</firstname><surname>Caulier</surname>
+        <affiliation><address><email>caulier_dot_gilles_at_free.fr</email></address></affiliation>
+    </author>
+    
+    <author>
+        <firstname>Gerhard</firstname><surname>Kulzer</surname>
+        <affiliation><address><email>gerhard_at_kulzer.net</email></address></affiliation>
+    </author>
+</authorgroup>
+
+<abstract>
+<para>
+The Kipi <quote>Advanced Slide Show</quote> plugin creates a configurable full screen slideshow of your images.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>Kipi</keyword>
+</keywordset>
+</chapterinfo>
+
+<title>Introduction</title>
+
+<para>
+With this Kipi-plugin you create a perfect slide show with 3 mouse clicks.
+</para>
+
+<sect1 id="using-plugin-slideshowsettings">
+<title>The Settings Dialog</title>
+
+<para>
+Upon opening of the plugin from the host application the <emphasis>Advanced Slide Show</emphasis> window will appear asking questions as to how you want to stage your slideshow. You can choose between the selected images and all images in the same album.
+</para>
+
+<para>
+The <guilabel>Use OpenGL Slideshow Transitions</guilabel> checkbox enables very smooth image transitions using the OpenGL display mode. Be sure to have OpenGL enabled on your graphics card, since otherwise the slideshow will be very slow.
+</para>
+
+<para>
+The <guilabel>Print Filename</guilabel> checkbox enables the image filename to be displayed in the lower left corner.
+</para>
+
+<para>
+The <guilabel>Loop</guilabel> checkbox enabled will run the whole show in an endless loop (until manually stopped with 
+<keycombo><keycap>Esc</keycap></keycombo>). 
+</para>
+
+<para>
+The <guilabel>Shuffle Image</guilabel> checkbox enables to display randomly the images (not using the current images collection order). 
+</para>
+
+<para>
+The <guilabel>Delay Between Images</guilabel> may be set in millisecond steps. 1500 milliseconds correspond to 1.5 seconds and are a good default value. The best timing depends also a bit on your computer power and the transition effect. Try it out before you show it to your friends!
+</para>
+
+<para>
+There are more than a dozen <guilabel>Transition Effects</guilabel> available which you can choose from. 
+The <emphasis>Random</emphasis> selection will change the transition effect with every image.
+</para>
+
+<figure>
+    <title>The Slideshow Dialog</title>
+    <graphic srccredit="The Slideshow Dialog" fileref="slideshow_dialog.png"/>
+</figure>
+
+</sect1>
+
+<sect1 id="using-plugin-slideshowinaction">
+<title>Slide Show in Action</title>
+
+<para>
+During slideshow, user can access to a tool bar on the upper left screen corner. Move the mouse cursor to the top left of the screen for enable it.
+</para>
+
+<para>
+With this tool bar, user can drive the progress, for pausing/playing slidesow, back to the preview image, go to the next image, and stoping slideshow.
+</para>
+
+<para>
+On the lower left screen corner you can see the current image file name, the current image id on the slideshow, and the total number of images include in.
+</para>
+
+<figure>
+    <title>The Advanced Slideshow Plugin in Action</title>
+    <graphic srccredit="The Slideshow Plugin in Action" fileref="slideshow.png"/>
+</figure>
+
+</sect1>
+
+</chapter>
+
+<!--
+Local Variables:
+mode: sgml
+sgml-omittag: nil
+sgml-shorttag: t
+End:
+-->
\ No newline at end of file