[digikam-doc] /: more separated documentation from intro chapter
Gilles Caulier
caulier.gilles at gmail.com
Tue Aug 23 09:13:02 UTC 2016
Git commit c2f7ecb54626234dbf661e305ac41263a675388c by Gilles Caulier.
Committed on 23/08/2016 at 09:12.
Pushed by cgilles into branch 'master'.
more separated documentation from intro chapter
M +4 -128 digikam/index.docbook
M +4 -0 digikam/intro-background.docbook
R +0 -0 digikam/intro-fileformats.docbook [from: digikam/file-formats.docbook - 100% similarity]
A +131 -0 digikam/intro-firstrun.docbook
M +- -- digikam/introductionscanprogress.png
M +14 -12 showfoto/index.docbook
http://commits.kde.org/digikam-doc/c2f7ecb54626234dbf661e305ac41263a675388c
diff --git a/digikam/index.docbook b/digikam/index.docbook
index db37ff1..f5d30ea 100644
--- a/digikam/index.docbook
+++ b/digikam/index.docbook
@@ -7,10 +7,11 @@
<!ENTITY digikam '<application>digiKam</application>'>
<!-- relative path to snapshots for digikam and showfoto -->
<!ENTITY path "">
- <!ENTITY doc-file-formats SYSTEM "file-formats.docbook">
<!ENTITY doc-sidebar SYSTEM "sidebar.docbook">
<!-- introduction -->
<!ENTITY doc-intro-background SYSTEM "intro-background.docbook">
+ <!ENTITY doc-intro-firstrun SYSTEM "intro-firstrun.docbook">
+ <!ENTITY doc-intro-fileformats SYSTEM "intro-fileformats.docbook">
<!-- image editor -->
<!ENTITY doc-photo-editing SYSTEM "photo-editing.docbook">
<!ENTITY doc-editor-color SYSTEM "editor-color.docbook">
@@ -87,136 +88,11 @@
<chapter id="introduction"> <title>Introduction</title>
- <sect1 id="intro-background"> <title>Background</title>
-
&doc-intro-background;
-
-</sect1>
-
- <sect1 id="using-firstrun"> <title>Getting Started</title>
-
- <sect2> <title></title>
- <para></para>
- <sect3 id="firstrundialog"> <title>The First Run Dialog</title>
- <para>
- <!-- <imagedata fileref="&path;introductionfirstrundialog.png" format="PNG" /> -->
- <inlinemediaobject><imageobject>
- <imagedata fileref="&path;firstrunassistant_step1.png" format="PNG" /></imageobject>
- </inlinemediaobject>
- </para>
-
- <para>
- When you start &digikam; for the very first time it will ask you where you store your photographs. You can choose any local, remote or removable folder. Just type in the path name of a folder or click on the <guilabel>Browse...</guilabel> icon to select a folder from the dialog.
- </para>
-
- <para>
- Later on you can add as many locations as you like - &digikam; will add them to the album library. <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure digiKam</guimenuitem><guimenuitem>Collections</guimenuitem></menuchoice>
- </para>
-
- <para>
- <inlinemediaobject><imageobject>
- <imagedata fileref="&path;firstrunassistant_step2.png" format="PNG" /></imageobject>
- <textobject> <phrase>Choosing database path for digikam</phrase> </textobject>
- </inlinemediaobject>
- </para>
-
- <para>Then you have to specify a local folder that resides on your computer, in which the database will be stored. This path will be the same for all image folders.
- </para>
-
- <para>
- <inlinemediaobject>
- <imageobject><imagedata fileref="&path;firstrunassistant_step3.png" format="PNG" /></imageobject>
- </inlinemediaobject>
- </para>
-
- <para>Next, you will have to choose the way you would like to open RAW files : either with automatic adjustments or with the digiKam RAW import tool to adjust corrections manually.</para>
-
- <para> If you don't know what is a RAW file or if your camera don't support RAW files, you should keep the default setting and skip this step.</para>
-
- <para>
- <inlinemediaobject>
- <imageobject><imagedata fileref="&path;firstrunassistant_step4.png" format="PNG"/></imageobject>
- <textobject> <phrase>RAW import</phrase> </textobject>
- </inlinemediaobject>
- </para>
-
- <para>Metadata information storage may be important if you plan to work with another photo management program and you should choose <guilabel>Add information to files</guilabel>. But if you don't want to alter your pictures, keep the default setting: <guilabel>Do nothing</guilabel>.</para>
-
- <para>
- <inlinemediaobject>
- <imageobject><imagedata fileref="&path;firstrunassistant_step5.png" format="PNG"/></imageobject>
- <textobject> <phrase>Metadata information</phrase> </textobject>
- </inlinemediaobject>
- </para>
-
- <para>Then choose how digiKam will load images in preview mode and light table. Reduced version will load faster but at the cost of quality.</para>
-
- <para>
- <inlinemediaobject>
- <imageobject><imagedata fileref="&path;firstrunassistant_step6.png" format="PNG"/></imageobject>
- <textobject> <phrase>Preview image method</phrase> </textobject>
- </inlinemediaobject>
- </para>
-
- <para>Now decide how digiKam will open images on a right click. Previews will load faster but you won't be able to make any corrections.</para>
- <para>
- <inlinemediaobject>
- <imageobject><imagedata fileref="&path;firstrunassistant_step7.png" format="PNG"/></imageobject>
- <textobject> <phrase>Open image method</phrase> </textobject>
- </inlinemediaobject>
- </para>
-
- <para>Tooltips are a fast and easy way to display important information about a photograph, they popup as the mouse moves over a thumbnail. Select "Use tooltips" if you want to display them.</para>
-
- <para>
- <inlinemediaobject>
- <imageobject><imagedata fileref="&path;firstrunassistant_step8.png" format="PNG"/></imageobject>
- <textobject> <phrase>Tooltips</phrase> </textobject>
- </inlinemediaobject>
- </para>
-
- <para>Click on <guibutton>Finish</guibutton>. DigiKam will now start to scan for photographs...</para>
-
- <para>
- <inlinemediaobject>
- <imageobject><imagedata fileref="&path;firstrunassistant_step9.png" format="PNG"/></imageobject>
- <textobject> <phrase>Tooltips</phrase> </textobject>
- </inlinemediaobject>
- </para>
-
- </sect3>
-
- <sect3> <title>The Scan Items Dialog</title>
- <para>
- If you already have a collection of photographs on your hard disk, you can enter the top-level folder containing the photographs, this is called the Albums Library folder. &digikam; will treat each sub-folder of the folder you've entered as an Album. None of the photographs will be altered. During folders parsing you can see a progress bar in the lower right corner like this:
- </para>
- <para>
- <inlinemediaobject> <imageobject>
- <imagedata fileref="&path;introductionscanprogress.png" format="PNG" /> </imageobject></inlinemediaobject>
- </para>
- <note><para>&digikam; will recurse the library path to its full depth. You cannot exclude (prune) any sub-path unless you make that sub-path hidden. You have to do that from outside of &digikam; by putting a dot in front of the sub-path.</para></note>
-
- <para>
- As &digikam; uses your folders on your hard disk directly, other applications like file managers can remove any albums outside a &digikam; session. In this case &digikam; will tell you at the next session if all albums that have been removed from the &digikam; photographs root path shall be deleted from albums database. If you want to move folders around and do not want to do that in &digikam;, we suggest you do that while &digikam; is running, so the database will be kept in sync and you do not lose any metadata.
- </para>
-
- <para>
- When you use an existing folder of photographs, as the Album Library folder, you will notice that the Albums in the Album list do not have photographs as their icons. You can change that by dragging any photograph in the Album onto the folder icon in the left sidebar and use this as the Album icon. See the <link linkend="using-myalbumsview">Album</link> section for details of how to change the Album icon.
- </para>
-
- <para>
- If you have previously accessed your photograph collection with another application, that has created thumbnails in non-standard sub-folders, &digikam; will show these thumbnail folders as separate Albums. &digikam; follows the <ulink url="http://www.freedesktop.org/">freedesktop.org</ulink> standards for thumbnail folders. There is no way of hiding non-standard thumbnail folders from the "Albums" list. If you want to keep them you could create an Album Collection that just contains all the thumbnail Folders and then view your Albums in By Collection order. See the <link linkend="using-myalbumsview">Album</link> section for more about Album Collections.
- </para>
-
- <para>
- Once you have configured the Album Library Folder you can set up &digikam; to work with your digital camera. Then learn how to use <link linkend="using-myalbumsview">Albums</link> and <link linkend="using-mytagsview">Tags</link> to arrange your photograph Albums.
- </para>
- </sect3>
- </sect2>
- </sect1>
+ &doc-intro-firstrun;
- &doc-file-formats;
+ &doc-intro-fileformats;
<sect1 id="using-camerasupport"> <title>Supported Digital Still Cameras</title>
<anchor id="digitalstillcamera.anchor"/>
diff --git a/digikam/intro-background.docbook b/digikam/intro-background.docbook
index 3f7b1f2..faf3e4c 100644
--- a/digikam/intro-background.docbook
+++ b/digikam/intro-background.docbook
@@ -1,3 +1,5 @@
+<sect1 id="intro-background"> <title>Background</title>
+
<sect2 id="intro-about">
<title>About &digikam;</title>
@@ -63,6 +65,8 @@
</sect2>
+</sect1>
+
<!--
Local Variables:
mode: sgml
diff --git a/digikam/file-formats.docbook b/digikam/intro-fileformats.docbook
similarity index 100%
rename from digikam/file-formats.docbook
rename to digikam/intro-fileformats.docbook
diff --git a/digikam/intro-firstrun.docbook b/digikam/intro-firstrun.docbook
new file mode 100644
index 0000000..7c8e2e1
--- /dev/null
+++ b/digikam/intro-firstrun.docbook
@@ -0,0 +1,131 @@
+<sect1 id="intro-firstrun"> <title>Getting Started</title>
+
+ <sect2> <title></title>
+ <para></para>
+ <sect3 id="firstrundialog"> <title>The First Run Dialog</title>
+ <para>
+ <!-- <imagedata fileref="&path;introductionfirstrundialog.png" format="PNG" /> -->
+ <inlinemediaobject><imageobject>
+ <imagedata fileref="&path;firstrunassistant_step1.png" format="PNG" /></imageobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>
+ When you start &digikam; for the very first time it will ask you where you store your photographs. You can choose any local, remote or removable folder. Just type in the path name of a folder or click on the <guilabel>Browse...</guilabel> icon to select a folder from the dialog.
+ </para>
+
+ <para>
+ Later on you can add as many locations as you like - &digikam; will add them to the album library. <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure digiKam</guimenuitem><guimenuitem>Collections</guimenuitem></menuchoice>
+ </para>
+
+ <para>
+ <inlinemediaobject><imageobject>
+ <imagedata fileref="&path;firstrunassistant_step2.png" format="PNG" /></imageobject>
+ <textobject> <phrase>Choosing database path for digikam</phrase> </textobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>Then you have to specify a local folder that resides on your computer, in which the database will be stored. This path will be the same for all image folders.
+ </para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject><imagedata fileref="&path;firstrunassistant_step3.png" format="PNG" /></imageobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>Next, you will have to choose the way you would like to open RAW files : either with automatic adjustments or with the digiKam RAW import tool to adjust corrections manually.</para>
+
+ <para> If you don't know what is a RAW file or if your camera don't support RAW files, you should keep the default setting and skip this step.</para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject><imagedata fileref="&path;firstrunassistant_step4.png" format="PNG"/></imageobject>
+ <textobject> <phrase>RAW import</phrase> </textobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>Metadata information storage may be important if you plan to work with another photo management program and you should choose <guilabel>Add information to files</guilabel>. But if you don't want to alter your pictures, keep the default setting: <guilabel>Do nothing</guilabel>.</para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject><imagedata fileref="&path;firstrunassistant_step5.png" format="PNG"/></imageobject>
+ <textobject> <phrase>Metadata information</phrase> </textobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>Then choose how digiKam will load images in preview mode and light table. Reduced version will load faster but at the cost of quality.</para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject><imagedata fileref="&path;firstrunassistant_step6.png" format="PNG"/></imageobject>
+ <textobject> <phrase>Preview image method</phrase> </textobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>Now decide how digiKam will open images on a right click. Previews will load faster but you won't be able to make any corrections.</para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject><imagedata fileref="&path;firstrunassistant_step7.png" format="PNG"/></imageobject>
+ <textobject> <phrase>Open image method</phrase> </textobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>Tooltips are a fast and easy way to display important information about a photograph, they popup as the mouse moves over a thumbnail. Select "Use tooltips" if you want to display them.</para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject><imagedata fileref="&path;firstrunassistant_step8.png" format="PNG"/></imageobject>
+ <textobject> <phrase>Tooltips</phrase> </textobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>Click on <guibutton>Finish</guibutton>. DigiKam will now start to scan for photographs...</para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject><imagedata fileref="&path;firstrunassistant_step9.png" format="PNG"/></imageobject>
+ <textobject> <phrase>Tooltips</phrase> </textobject>
+ </inlinemediaobject>
+ </para>
+
+ </sect3>
+
+ <sect3> <title>The Scan Items Dialog</title>
+ <para>
+ If you already have a collection of photographs on your hard disk, you can enter the top-level folder containing the photographs, this is called the Albums Library folder. &digikam; will treat each sub-folder of the folder you've entered as an Album. None of the photographs will be altered. During folders parsing you can see a progress bar in the lower right corner like this:
+ </para>
+ <para>
+ <inlinemediaobject> <imageobject>
+ <imagedata fileref="&path;introductionscanprogress.png" format="PNG" /> </imageobject></inlinemediaobject>
+ </para>
+ <note><para>&digikam; will recurse the library path to its full depth. You cannot exclude (prune) any sub-path unless you make that sub-path hidden. You have to do that from outside of &digikam; by putting a dot in front of the sub-path.</para></note>
+
+ <para>
+ As &digikam; uses your folders on your hard disk directly, other applications like file managers can remove any albums outside a &digikam; session. In this case &digikam; will tell you at the next session if all albums that have been removed from the &digikam; photographs root path shall be deleted from albums database. If you want to move folders around and do not want to do that in &digikam;, we suggest you do that while &digikam; is running, so the database will be kept in sync and you do not lose any metadata.
+ </para>
+
+ <para>
+ When you use an existing folder of photographs, as the Album Library folder, you will notice that the Albums in the Album list do not have photographs as their icons. You can change that by dragging any photograph in the Album onto the folder icon in the left sidebar and use this as the Album icon. See the <link linkend="using-myalbumsview">Album</link> section for details of how to change the Album icon.
+ </para>
+
+ <para>
+ If you have previously accessed your photograph collection with another application, that has created thumbnails in non-standard sub-folders, &digikam; will show these thumbnail folders as separate Albums. &digikam; follows the <ulink url="http://www.freedesktop.org/">freedesktop.org</ulink> standards for thumbnail folders. There is no way of hiding non-standard thumbnail folders from the "Albums" list. If you want to keep them you could create an Album Collection that just contains all the thumbnail Folders and then view your Albums in By Collection order. See the <link linkend="using-myalbumsview">Album</link> section for more about Album Collections.
+ </para>
+
+ <para>
+ Once you have configured the Album Library Folder you can set up &digikam; to work with your digital camera. Then learn how to use <link linkend="using-myalbumsview">Albums</link> and <link linkend="using-mytagsview">Tags</link> to arrange your photograph Albums.
+ </para>
+ </sect3>
+ </sect2>
+
+</sect1>
+
+<!--
+Local Variables:
+mode: sgml
+sgml-omittag: nil
+sgml-shorttag: t
+End:
+-->
diff --git a/digikam/introductionscanprogress.png b/digikam/introductionscanprogress.png
index 9e39374..ccabd4e 100644
Binary files a/digikam/introductionscanprogress.png and b/digikam/introductionscanprogress.png differ
diff --git a/showfoto/index.docbook b/showfoto/index.docbook
index 8ffb9a4..28d4caa 100644
--- a/showfoto/index.docbook
+++ b/showfoto/index.docbook
@@ -8,17 +8,17 @@
<!ENTITY digikam-app '<application>digiKam</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-color-management SYSTEM "../digikam/color-management.docbook">
- <!ENTITY doc-ie-menu SYSTEM "../digikam/ie-menu.docbook">
- <!ENTITY doc-credits-annexes SYSTEM "../digikam/credits-annex.docbook">
+ <!ENTITY doc-intro-fileformats SYSTEM "../digikam/intro-fileformats.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-color-management SYSTEM "../digikam/color-management.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. -->
@@ -131,12 +131,14 @@
</sect1>
- &doc-file-formats;
+ &doc-intro-fileformats;
</chapter>
<chapter id="sidebar"> <title>The &showfoto; sidebar</title>
+
&doc-sidebar;
+
</chapter>
<chapter id="using-kapp"> <title>Using &showfoto;</title>
More information about the kde-doc-english
mailing list