Add digikam and showfoto help handbook files.

1 files changed, 255 insertions, 0 deletions

diff --git a/doc/showfoto/index.docbook b/doc/showfoto/index.docbook
new file mode 100644
index 00000000..d8b201be
--- /dev/null
+++ b/doc/showfoto/index.docbook
@@ -0,0 +1,255 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+  <!ENTITY kappname "&showfoto;"><!-- replace kapp here, do *not* replace kappname-->
+  <!ENTITY % addindex "IGNORE">
+  <!ENTITY % English "INCLUDE"><!-- change language only here -->
+  <!ENTITY showfoto '<application>Showfoto</application>'>
+  <!ENTITY digikam '<application>Showfoto</application>'>
+  <!-- relative path to snapshots for showfoto -->
+  <!ENTITY path "../digikam/">
+  <!ENTITY doc-file-formats     SYSTEM "../digikam/file-formats.docbook">
+  <!ENTITY doc-sidebar          SYSTEM "../digikam/sidebar.docbook">
+  <!ENTITY doc-photo-editing    SYSTEM "../digikam/photo-editing.docbook">
+  <!ENTITY doc-editor-color     SYSTEM "../digikam/editor-color.docbook">
+  <!ENTITY doc-editor-enhance   SYSTEM "../digikam/editor-enhance.docbook">
+  <!ENTITY doc-editor-transform SYSTEM "../digikam/editor-transform.docbook">
+  <!ENTITY doc-editor-filters   SYSTEM "../digikam/editor-filters.docbook">
+  <!ENTITY doc-editor-decorate  SYSTEM "../digikam/editor-decorate.docbook">
+  <!ENTITY doc-ie-menu          SYSTEM "../digikam/ie-menu.docbook">
+  <!ENTITY doc-credits-annexes  SYSTEM "../digikam/credits-annex.docbook">
+
+  <!-- Do not define any other entities; instead, use the entities
+       from kde-genent.entities and $LANG/user.entities. -->
+]>
+
+<book lang="&language;">
+
+<bookinfo>
+
+<title>The &showfoto; Handbook</title>
+
+<authorgroup>
+
+    <author>
+        <firstname>Gilles</firstname><surname>Caulier</surname>
+        <affiliation><address><email>caulier_dot_gilles_at_gmail_dot_com</email></address></affiliation>
+    </author>
+
+    <author>
+        <firstname>Gerhard</firstname><surname>Kulzer</surname>
+        <affiliation><address><email>gerhard at kulzer.net</email></address></affiliation>
+    </author>
+
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+
+<copyright>
+    <year>2004</year>
+    <year>2008</year>
+    <holder>The &showfoto; developers team</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>2008-01-05</date>
+<releaseinfo>0.9.3</releaseinfo>
+
+<abstract>
+
+    <para>
+        <inlinemediaobject>
+            <imageobject><imagedata fileref="&path;digikamlogo.png" format="PNG"/></imageobject>
+            <textobject> <phrase>&digikam; logo</phrase> </textobject>
+        </inlinemediaobject>
+    </para>
+
+    <para>
+    &showfoto; is a &kde; stand alone Photo Editor based on &digikam; Image Editor. &showfoto; is a part of &digikam; project.
+    </para>
+
+</abstract>
+
+<keywordset>
+    <keyword>KDE</keyword>
+    <keyword>digikam</keyword>
+    <keyword>showfoto</keyword>
+    <keyword>Graphics</keyword>
+    <keyword>Color Management</keyword>
+    <keyword>exiv2</keyword>
+    <keyword>dcraw</keyword>
+</keywordset>
+
+</bookinfo>
+
+<!-- *********************************************************************** -->
+
+<chapter id="introduction">
+  <title>Introduction</title>
+
+    <sect1 id="using-kapp-background">    <title>Background</title>
+
+       <sect2 id="using-kapp-about">
+       <title>About &showfoto;</title>
+
+       <para>
+       &showfoto; is a fast Image Editor with powerful image editing tools. You can use it to view your photographs and improve them.
+       </para>
+
+       </sect2>
+
+       <sect2>
+       <title>Reporting Bugs</title>
+
+       <para>
+       Like the rest of &kde;, &showfoto; is an Open Source project. This means that it relies on its users to play their part by, at least, reporting problems and suggesting possible improvements.
+       </para>
+
+       <para>
+       &showfoto; makes it as easy as possible for you to report bugs or suggest improvements. Wherever you are in the application the Help menu will include a Report Bugs option. This will display a message box with a highlighted link. Click on the link and your web browser will open the page for the reporting system. All the information required will already be filled in, just follow the instructions for completing your report.
+       </para>
+       </sect2>
+
+       <sect2>
+       <title>Support</title>
+
+       <para>
+       &showfoto; is a community supported project, which means that users and developers support one another. If you become a regular user of &showfoto; you are encouraged to join the &showfoto; Users Mailing List. You can start off by asking questions of other &showfoto; users and hopefully soon you will be answering the support questions of others.
+       </para>
+
+       <para>
+       <ulink url="https://mail.kde.org/mailman/listinfo/digikam-users">&showfoto; Users Mailing
+       List joining instructions.</ulink>
+       </para>
+
+       <para>
+       You can also visit the <ulink url="http://www.digikam.org">&digikam; Home Page.</ulink> for news of new releases and other &showfoto; related information.
+       </para>
+       </sect2>
+
+       <sect2>
+       <title>Getting Involved</title>
+
+       <para>
+       There are many ways that you can get involved with the continued development of &showfoto;. You do not need to be a software developer. You can help with documentation, translation and user interface design or just contribute really good ideas to the wish-list. You can also get involved by testing early development code as it is being developed and providing feedback to the developers. Of course, if you are a software developer then you can help to make &showfoto; the best digital photograph application there is.
+       </para>
+
+       <para>
+       The best way to start getting involved with &showfoto; is to join the Developers Mailing List.
+       <ulink url="https://mail.kde.org/mailman/listinfo/digikam-devel">&showfoto; Developer Mailing
+       List joining instructions.</ulink>
+       </para>
+       </sect2>
+
+    </sect1>
+
+    &doc-file-formats;
+
+</chapter>
+
+<chapter>  <title>The &showfoto; sidebar</title>
+ <sect1 id="using-sidebar">            <title>&digikam; sidebar</title>
+    <anchor id="sidebar.anchor"/>
+
+        <sect2>
+        <title>Introduction to the right sidebar</title>
+           <para>
+               The &showfoto; main window has a sidebar at the right border providing important information and actions of the selected images. This same sidebar is also available in the <ulink url="help:/digikam/image-editor.html#using-imageeditor">Image Editor</ulink> view. It can be displayed by respectively clicking on one of the five tabs:
+           </para>
+
+           <para>
+            <itemizedlist>
+
+                <listitem><para><link linkend="using-sidebarfileproperties">Properties</link> : File and image properties, key shooting parameters (EXIF tags)</para></listitem>
+
+                <listitem><para><link linkend="using-sidebarmetadata">Metadata</link> : EXIF, Makernotes, IPTC and GPS data (these properties can be edited by two kipi-plugins</para></listitem>
+
+                <listitem><para><link linkend="using-sidebarcolors">Colors</link> : Histograms and embedded ICC profiles</para></listitem>
+
+            </itemizedlist>
+            Clicking successively onto the same tab will make the sidebar pop up or fold back into the border.
+            </para>
+        </sect2>
+
+        &doc-sidebar;
+  </sect1>
+
+</chapter>
+
+<chapter id="using-kapp">        <title>Using &showfoto;</title>
+
+  &doc-photo-editing;
+
+  <sect1 id="using-setup">        <title>&showfoto; Configuration</title>
+
+        <anchor id="setupdialog.anchor"/>
+
+        <para>
+        &showfoto; tries to give you as much control on how it works as possible. There are many options that change the behavior of &showfoto;. To access these settings select
+        <menuchoice><guimenu>Setting</guimenu>
+        <guimenuitem>Configure &showfoto;</guimenuitem></menuchoice> from the Menu Bar. The configuration dialog is separated into eight pages. You can change between these pages by clicking on the icons on the left-hand side of the dialog.
+        </para>
+
+    <sect2 id="setupgeneral">        <title>The Configuration Dialog</title>
+
+       <para>
+         The <guilabel>Interface Options</guilabel> section is rather self-explanatory.
+       </para>
+
+       <para>
+         The <guilabel>Exposure Indicators</guilabel> lets one choose the color to use when the under- respectively over-exposure indicators are selected. Preferentially the colors should be contrasting with what they indicate, that is, under-exposure should have a light color and over-exposure areas should show dark colors.
+       </para>
+
+       <para>
+        <inlinemediaobject>
+            <imageobject><imagedata fileref="setupgeneral.png" format="PNG"/></imageobject>
+            <textobject> <phrase>General Settings</phrase> </textobject>
+        </inlinemediaobject>
+       </para>
+
+       <itemizedlist>
+         <listitem><para>Tooltip settings, these are self-explanatory</para>
+        </listitem>
+       <listitem><para>
+         <ulink url="help:/digikam/using-setup.html#setup-raw-decoder">RAW file decoding settings</ulink></para>
+        </listitem>
+        <listitem><para>
+         <ulink url="help:/digikam/using-setup.html#setup-iccprofiles">ICC profiles settings</ulink></para>
+        </listitem>
+        <listitem><para>
+         <ulink url="help:/digikam/using-setup.html#setup-saveimages">Save images settings</ulink></para>
+        </listitem>
+        <listitem><para>
+         <ulink url="help:/digikam/using-setup.html#setup-slideshow">The native slideshow settings</ulink></para>
+        </listitem>
+       </itemizedlist>
+
+     </sect2>
+
+
+    </sect1>
+
+</chapter>
+
+
+<chapter id="menudescriptions">  <title>Menu Descriptions</title>
+
+&doc-ie-menu;
+
+</chapter>
+
+&doc-credits-annexes;
+
+</book>
+<!--
+Local Variables:
+mode: sgml
+sgml-minimize-attributes:nil
+sgml-general-insert-case:lower
+sgml-indent-step:0
+sgml-indent-data:nil
+End:
+-->