annotate doc/docbook/GuideReferenceManagement.xml @ 1774:a7f7b9c0050c

build documentation with gnome-doc-tool in makefile
author nadvornik
date Fri, 27 Nov 2009 23:27:35 +0000
parents 2ae81598b254
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1773
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
2 <section id="GuideReferenceManagement">
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
3 <title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
4 Cache and Data Maintenance
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
5 </title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
6 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
7 Thumbnails and other cached data can be maintained from the dialog accessible by selecting Thumbnail maintenance from the Edit menu of the main window.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
8 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
9 <para/><section id="Geeqiethumbnailcache"><title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
10 Geeqie thumbnail cache
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
11 </title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
12 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
13 The utilities listed here operate on the Geeqie caching mechanism. This also includes the data cached for the <link linkend="GuideImageSearchSearch">search</link> and <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link> utilities.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
14 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
15 <variablelist><varlistentry><term>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
16 Clean up
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
17 </term><listitem><para/></listitem></varlistentry></variablelist>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
18 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
19 Removes thumbnails and data for which the source image is no longer present, or has been modified since the thumbnail was generated.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
20 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
21 <variablelist><varlistentry><term>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
22 Clear cache
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
23 </term><listitem><para/></listitem></varlistentry></variablelist>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
24 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
25 Removes all thumbnails and data stored in the user's home folder: $HOME/.geeqie/thumbnails.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
26 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
27 <para/></section><section id="Sharedthumbnailcache"><title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
28 Shared thumbnail cache
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
29 </title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
30 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
31 The utilities listed here operate on the shared thumbnail mechanism.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
32 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
33 <variablelist><varlistentry><term>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
34 Clean up
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
35 </term><listitem><para/></listitem></varlistentry></variablelist>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
36 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
37 Removes thumbnails for which the source image is no longer present, or has been modified since the thumbnail was generated.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
38 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
39 <variablelist><varlistentry><term>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
40 Clear cache
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
41 </term><listitem><para/></listitem></varlistentry></variablelist>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
42 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
43 Removes all thumbnails stored in the user's home folder: $HOME/.thumbnails.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
44 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
45 <para/></section><section id="Createthumbnails"><title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
46 Create thumbnails
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
47 </title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
48 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
49 This utility will render thumbnails using the current thumbnail caching mechanism, as determined in <link linkend="GuideOptionsGeneral">preferences</link>.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
50 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
51 <variablelist><varlistentry><term>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
52 Render
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
53 </term><listitem><para/></listitem></varlistentry></variablelist>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
54 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
55 Pre-render thumbnails for a specific folder, the utility has the following options:
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
56 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
57 <variablelist><varlistentry><term>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
58 Include subfolders
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
59 </term><listitem><para/></listitem></varlistentry></variablelist>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
60 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
61 Enable to include all images contained in the subfolders of folder.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
62 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
63 <variablelist><varlistentry><term>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
64 Store thumbnails local to source images
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
65 </term><listitem><para/></listitem></varlistentry></variablelist>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
66 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
67 The generated thumbnails will be stored local to the source images, if you have the permissions to write to the folder containing the images.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
68 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
69 <para/></section><section id="Metadata"><title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
70 Metadata
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
71 </title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
72 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
73 This utility operates on the data store for <link linkend="GuideSidebarsKeywords">keywords and comments?</link> located in the user's home folder: $HOME/.geeqie/metadata.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
74 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
75 <variablelist><varlistentry><term>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
76 Clean up
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
77 </term><listitem><para/></listitem></varlistentry></variablelist>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
78 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
79 Removes keywords and comments for which the source image is no longer present.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
80 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
81 <para/></section><section id="Filelocations"><title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
82 File locations
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
83 </title>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
84 <para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
85 The various file locations and their use are listed below. <emphasis role="i">&amp;lt;HOME&amp;gt;</emphasis> refers to your home folder and <emphasis role="i">&amp;lt;SOURCE&amp;gt;</emphasis> refers to the folder containing the image.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
86 </para>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
87 <informaltable><tgroup cols="2"><tbody><row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
88 Folder or File name
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
89 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
90 Description
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
91 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
92 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
93 Thumbnails
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
94 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
95 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
96 <emphasis role="i">&lt;HOME&gt;</emphasis>/.thumbnails
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
97 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
98 Shared thumbnail cache folder.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
99 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
100 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
101 <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/thumbnails
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
102 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
103 Classic Geeqie thumbnail cache folder. Also used to cache data used for the search and find duplicates utilities to increase the speed for subsequent searches.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
104 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
105 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
106 <emphasis role="i">&lt;SOURCE&gt;/.</emphasis>thumbnails
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
107 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
108 Local thumbnail cache folder.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
109 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
110 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
111 Metadata (keywords and comments)
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
112 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
113 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
114 <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/metadata
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
115 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
116 Metadata stored in user's home folder.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
117 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
118 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
119 <emphasis role="i">&lt;SOURCE&gt;</emphasis>/.metadata
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
120 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
121 Metadata stored local to source image. Requires option to be enabled in advanced preferences.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
122 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
123 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
124 Collections
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
125 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
126 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
127 <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/collections
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
128 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
129 Default location for Geeqie collections, collections in this folder will appear in the <link linkend="GuideSidebarsSortManager">sort manager</link> sidebar.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
130 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
131 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
132 Preferences
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
133 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
134 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
135 <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
136 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
137 Geeqie preferences folder.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
138 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
139 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
140 <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/geeqierc
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
141 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
142 Geeqie preferences rc file.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
143 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
144 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
145 <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/history
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
146 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
147 Historic data such as last several folders visited, bookmarks, and recently used collections. Also contains default print settings.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
148 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
149 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
150 <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/accels
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
151 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
152 Keyboard shortcut mapping.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
153 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
154 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
155 Safe Delete
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
156 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
157 <row><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
158 <emphasis role="i">&lt;HOME&gt;</emphasis>/.geeqie/trash
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
159 </entry><entry>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
160 Default location of the safe delete folder.
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
161 </entry></row>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
162 </tbody></tgroup></informaltable>
2ae81598b254 scripts for converting wiki documentation to docbook
nadvornik
parents:
diff changeset
163 <para/></section></section>