Restructure doc/man folders

Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>

12 files changed, 337 insertions, 0 deletions

diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
new file mode 100644
index 0000000..26d239d
--- /dev/null
+++ b/doc/en/Makefile.am
@@ -0,0 +1,2 @@
+KDE_LANG = en
+KDE_DOCS = gwenview
diff --git a/doc/en/browse_mode.png b/doc/en/browse_mode.png
new file mode 100644
index 0000000..9020b24
--- /dev/null
+++ b/doc/en/browse_mode.png
diff --git a/doc/en/dock_grip.png b/doc/en/dock_grip.png
new file mode 100644
index 0000000..04c090d
--- /dev/null
+++ b/doc/en/dock_grip.png
diff --git a/doc/en/docked_windows.docbook b/doc/en/docked_windows.docbook
new file mode 100644
index 0000000..8363310
--- /dev/null
+++ b/doc/en/docked_windows.docbook
@@ -0,0 +1,69 @@
+<sect1 id='docked_windows'><title>Docked windows</title>
+<para>The &kappname; interface is composed of a number of smaller docked windows.
+Manipulating these windows can be difficult at first. To focus a particular
+window in the &kappname; interface, simply click within it.</para>
+
+<para>Each docked window has a small grip bar along the top. It contains a dock/undock button
+resembling an arrow at its right end and a close button resembling the
+letter X. It looks like this:
+
+<screenshot>
+  <screeninfo>Grip bar of a docked window</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="dock_grip.png" format="PNG" />
+    </imageobject>
+    <textobject>
+      <phrase>Grip bar of a docked window</phrase>
+    </textobject>
+  </mediaobject>
+</screenshot>
+</para>
+
+<itemizedlist>
+  <listitem><para>Clicking the close button on a docked window will remove it from the interface.
+To bring it back, select its name in the <guimenu>Window</guimenu>
+menu.</para></listitem>
+
+  <listitem>
+    <para>To resize docked windows, drag the border between the
+      windows.
+    </para>
+  </listitem>
+  <listitem>
+    <para>To re-arrange the docked windows, drag a window by its grip bar
+      over to the desired position. While dragging, a small box
+      outline will appear to indicate the position the window
+      will take when you end the drag.
+    </para>
+    <para>If you wish to stack two windows and use tabs to choose between them,
+    drag the window to the very center of the other window with which you wish
+    to stack.
+    </para>
+  </listitem>
+  <listitem>
+    <para>To undock a window, either click the dock/undock button in its top right corner, or
+      double-click on the window's grip bar.</para>
+    <para>Double-clicking again or clicking on the dock/undock button, should return the window to its original
+      position.</para>
+    <para>You can also dock an undocked window by dragging its grip bar back to a
+point within the general interface, just as if you were rearranging an already
+docked window.</para>
+  </listitem>
+
+  <listitem>
+    <para>The file view window cannot be undocked or moved, but by moving other windows
+      around, it can itself be shifted about.</para> 
+  </listitem>
+
+  <listitem>
+    <para>While dragging a window, press the <keycap>Escape</keycap> key to cancel the operation. To reset
+  the docked windows to the default &kappname; layout, use 
+      <menuchoice>
+        <guimenu>Window</guimenu>
+        <guimenuitem>Reset</guimenuitem>
+      </menuchoice>.
+    </para>
+  </listitem>
+</itemizedlist>
+</sect1>
diff --git a/doc/en/external_tools.docbook b/doc/en/external_tools.docbook
new file mode 100644
index 0000000..61722cc
--- /dev/null
+++ b/doc/en/external_tools.docbook
@@ -0,0 +1,68 @@
+<chapter id="external_tools">
+<title>External tools</title>
+
+<para>You can easily extend &kappname; by defining external tools. These tools
+  are accessible from the contextual popup menu which appears when
+  right-clicking on a thumbnail or in the image view. Look in the
+  <menuchoice><guimenu>External Tools</guimenu></menuchoice> entry.</para>
+
+<para>&kappname; comes with a few predefined external tools, but it's very
+  easy to add more through the <guilabel>Configure External Tools</guilabel> dialog. You can open
+  it from <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
+      External Tools...</guimenuitem></menuchoice>.
+</para>
+  
+<para>Here is how it looks:
+
+<screenshot>
+  <screeninfo>External tools dialog</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="external_tools_dialog.png" format="PNG" />
+    </imageobject>
+  </mediaobject>
+</screenshot>
+</para>
+
+<para>In this example, I defined an external tool which will call Exiftran to
+  regenerate the EXIF tags for JPEG images. Here is a more detailed description
+  of its definition:</para>
+
+<itemizedlist>
+  <listitem>
+    <para>The <guilabel>Name:</guilabel> field contains the description of your
+      tool, has it will appear in the menu.
+    </para>
+  </listitem>
+  <listitem>
+    <para>The <guilabel>Command:</guilabel> field contains the command which
+      will be run when this tool is invoked.
+      Click on the little question mark on the right of the field to get a list
+      of the keywords you can use in this field. These keywords will get
+      expanded to the image files.
+    </para>
+  </listitem>
+  <listitem>
+    <para>
+      The button on the right lets you associate an icon with your tool.
+    </para>
+  </listitem>
+  <listitem>
+    <para>
+      The <guilabel>File Associations</guilabel> group indicates what type of
+      files this tool can work with. Your tool will only appear in the 
+      <menuchoice><guimenu>External Tools</guimenu></menuchoice> menu if the
+      selected files are of the correct type. In my example, this tool is only
+      valid with JPEG images, so I choose <guilabel>Custom:</guilabel>, then
+      <guilabel>image/jpeg</guilabel> and <guilabel>image/pjpeg</guilabel>.
+    </para>
+  </listitem>
+</itemizedlist>
+
+<tip>
+  <para>You can find other external tool examples from
+    <ulink url="http://gwenview.sourceforge.net/tools">&kappname; web site</ulink>.
+  </para>
+</tip>
+
+</chapter>
diff --git a/doc/en/external_tools_dialog.png b/doc/en/external_tools_dialog.png
new file mode 100644
index 0000000..72e6723
--- /dev/null
+++ b/doc/en/external_tools_dialog.png
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
new file mode 100644
index 0000000..bbeeb09
--- /dev/null
+++ b/doc/en/index.docbook
@@ -0,0 +1,63 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+  <!ENTITY kappname "Gwenview">
+  <!ENTITY package "gwenview">
+  <!ENTITY introduction SYSTEM "introduction.docbook">
+  <!ENTITY interface SYSTEM "interface.docbook">
+  <!ENTITY mouse SYSTEM "mouse.docbook">
+  <!ENTITY keybindings SYSTEM "keybindings.docbook">
+  <!ENTITY docked_windows SYSTEM "docked_windows.docbook">
+  <!ENTITY external_tools SYSTEM "external_tools.docbook">
+  <!ENTITY % addindex "IGNORE">
+  <!ENTITY % English "INCLUDE"><!-- change language only here -->
+]>
+
+<book lang="&language;">
+<title>Gwenview User Manual</title>
+
+<bookinfo>
+<authorgroup>
+<author>
+<firstname>Aurélien</firstname>
+<surname>Gâteau</surname>
+<affiliation><address><email>aurelien.gateau@free.fr</email></address></affiliation>
+</author>
+<author>
+<firstname>Christopher</firstname><surname>Martin</surname>
+<affiliation><address><email>chrsmrtn@debian.org</email></address></affiliation>
+</author>
+</authorgroup>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+<copyright>
+<year>2005</year>
+<holder>Aurélien Gâteau</holder>
+</copyright>
+<!-- <legalnotice>&FDLNotice;</legalnotice> -->
+
+<date>2005-08-21</date>
+<releaseinfo>1.2.92</releaseinfo>
+<abstract>
+<para>&kappname; is an image viewer for TDE.</para>
+</abstract>
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>image</keyword>
+<keyword>viewer</keyword>
+<keyword>artist</keyword>
+<keyword>photo</keyword>
+<keyword>picture</keyword>
+</keywordset>
+</bookinfo>
+&introduction;
+&interface;
+
+&external_tools;
+
+<chapter id="tips">
+<title>Tips</title>
+&mouse;
+&keybindings;
+&docked_windows;
+</chapter>
+
+</book>
diff --git a/doc/en/interface.docbook b/doc/en/interface.docbook
new file mode 100644
index 0000000..3ac0780
--- /dev/null
+++ b/doc/en/interface.docbook
@@ -0,0 +1,49 @@
+<chapter id="interface">
+<title>The interface</title>
+
+<sect1 id='browse_and_view_modes'><title>Browse and View modes</title>
+  
+<para>By default, &kappname; opens in Browse mode.</para>
+
+<para>In this mode you can easily navigate through your files and folders. As
+  you can see on the screenshot, the preview window shows the current image as
+  well as any embedded image comment.</para>
+
+<screenshot>
+  <screeninfo>Browse Mode Screenshot</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="browse_mode.png" format="PNG" />
+    </imageobject>
+  </mediaobject>
+</screenshot>
+
+ 
+<para>From the Browse mode, 
+  unchecking
+  <menuchoice>
+    <shortcut>
+      <keycombo action="simul">&Ctrl;<keycap>Return</keycap></keycombo>
+    </shortcut>
+    <guimenu>View</guimenu>
+    <guimenuitem>Browse</guimenuitem>
+  </menuchoice>
+  will put you in View mode, where the image takes all the
+  space of the window.</para>
+
+<screenshot>
+  <screeninfo>View Mode Screenshot</screeninfo>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="view_mode.png" format="PNG" />
+    </imageobject>
+  </mediaobject>
+</screenshot>
+
+<tip><para>You can start directly in View mode by starting &kappname; with an image
+    as an argument.</para>
+</tip>
+
+</sect1>
+
+</chapter>
diff --git a/doc/en/introduction.docbook b/doc/en/introduction.docbook
new file mode 100644
index 0000000..1501dc0
--- /dev/null
+++ b/doc/en/introduction.docbook
@@ -0,0 +1,26 @@
+<chapter id="introduction">
+<title>Introduction</title>
+
+<sect1 id="what-is-gwenview">
+<title>What is &kappname;</title>
+
+<para>
+&kappname; is a fast and easy to use image viewer for TDE.
+</para>
+
+<para>
+It features a folder tree window and a file list window to provide easy
+navigation of your file hierarchy.  &kappname; uses docked windows, so you can
+alter its layout any way you wish. You can also browse your images in
+full-screen mode, or embedded within &konqueror; using the Image View and Kpart.</para>
+
+<para>Image loading is handled by the TQt library, so &kappname; supports all
+image formats your TQt installation supports. &kappname; correctly displays images
+with an alpha channel as well as animations.</para>
+
+<para>&kappname; supports the displaying and editing of EXIF comments in JPEG
+images. Lossless JPEG transforms such as rotations and mirroring are also supported.</para>
+
+</sect1>
+
+</chapter>
diff --git a/doc/en/keybindings.docbook b/doc/en/keybindings.docbook
new file mode 100644
index 0000000..3156400
--- /dev/null
+++ b/doc/en/keybindings.docbook
@@ -0,0 +1,20 @@
+<sect1 id="keybindings">
+<title>Key bindings</title>
+
+<para>&kappname; comes with a range of keyboard shortcuts, all of which can be viewed and remapped by
+  selecting <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
+      Shortcuts...</guimenuitem></menuchoice>. Note that in the Files and Folders windows,
+all the normal TDE shortcuts are functional, unless otherwise remapped.</para>
+
+<para>A few of the most useful default bindings are:</para>
+
+<itemizedlist>
+  <listitem><para><keycap>Space</keycap>: Displays the next image in the directory.</para></listitem>
+  <listitem><para><keycap>Backspace</keycap>: Displays the previous image in the directory.</para></listitem>
+  <listitem><para><keycombo
+        action="simul">&Ctrl;<keycap>Return</keycap></keycombo>: Toggles between Browse and View modes.</para></listitem>
+  <listitem><para><keycombo action="simul">&Ctrl;
+        &Shift;<keycap>F</keycap></keycombo>: Activates Full Screen mode.</para></listitem>
+  <listitem><para><keycap>Escape</keycap>: Exits from Full Screen mode.</para></listitem>
+</itemizedlist>
+</sect1>
diff --git a/doc/en/mouse.docbook b/doc/en/mouse.docbook
new file mode 100644
index 0000000..0792b3a
--- /dev/null
+++ b/doc/en/mouse.docbook
@@ -0,0 +1,40 @@
+<sect1 id='mouse'><title>Using the mouse</title>
+  
+<sect2 id='mouse_panning'><title>Panning with the mouse</title>
+<itemizedlist>
+  <listitem><para>Holding down the left mouse button on an image allows you to
+      scroll the image.</para></listitem>
+  <listitem><para>The mouse wheel will scroll the image up and
+      down.</para></listitem>
+</itemizedlist>
+</sect2>
+
+
+<sect2 id='mouse_zooming'><title>Zooming with the mouse</title>
+<itemizedlist>
+  <listitem><para>Clicking the middle mouse button will toggle the auto zoom
+      on/off.</para></listitem>
+  <listitem><para>Hold down the Control key, then either use the mouse wheel to
+      zoom in and out or left click to zoom in and right click to zoom
+      out.</para></listitem>
+
+  <listitem><para>The mouse wheel, used while holding down the Alt key, will
+      scroll the image horizontally.</para></listitem>
+</itemizedlist>
+</sect2>
+
+
+<sect2 id='mouse_browsing'><title>Browsing with the mouse</title>
+<itemizedlist>
+  <listitem><para>Double-clicking on an image toggles Browse
+      mode.</para></listitem>
+  <listitem><para>By default, the mouse wheel will scroll the image up and down. But,
+  this can be configured to browse the images in the current directory
+  instead.</para></listitem>
+  <listitem><para>Hold down the left mouse button over an image, then click the right
+      button to go to the next image.</para>
+    <para>Hold down the right button, then click the
+      left button to load the previous image.</para></listitem>
+</itemizedlist>
+</sect2>
+</sect1>
diff --git a/doc/en/view_mode.png b/doc/en/view_mode.png
new file mode 100644
index 0000000..801ad23
--- /dev/null
+++ b/doc/en/view_mode.png