You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kipi-plugins/doc/kipi-plugins/imagesgallery.docbook

137 lines
5.5 KiB

<chapter id="imagesgallery">
<chapterinfo>
<title>Images Gallery</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 images gallery plugin is a tool for exporting a set of Albums to an HTML page.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>Kipi</keyword>
</keywordset>
</chapterinfo>
<title>Introduction</title>
<para>
This powerful plugin can export your Albums into a HTML page compliant to 4.01 version for web publication in the form of an image gallery. You can easily select the Albums to export in an HTML page and set a big parameters list for the HTML rendering. UTF-8 encoding is used for a best internationalization.
</para>
<para>
You can see some samples building with this plugin at this
<ulink url="http://digikamplugins.free.fr/ImagesGallerySamples/MultipleAlbums/index.htm"><citetitle>url.</citetitle></ulink>
</para>
<sect1 id="using-plugin-imagesgallerycollectionselection">
<title>Collections Selection Dialog</title>
<para>
The plugin has four tabs to adapt the settings.
The <guilabel>Selection</guilabel> tab allows you to select all Albums you want to export to HTML. Just check the respective Albums (they are displayed without hierarchical nesting). The three buttons to the right help to quickly select large amounts of Albums. The frame below shows the Album ID-picture with the text that will appear as a header of the HTML page.
</para>
<figure>
<title>The Collections Selection Dialog</title>
<graphic srccredit="The Collections Selection Dialog" fileref="imagegallery_collectionselection.png"/>
</figure>
</sect1>
<sect1 id="using-plugin-imagesgallerylooksettings">
<title>Look Settings Dialog</title>
<para>
The <guilabel>Look</guilabel> tab defines the general look and layout of each page. This tab is largely self-explanatory. The <guilabel>Create pages for each image</guilabel> check box will create a gallery with a HTML page per image, that is, if you click onto an image a new page will open showing the image within the web browser. If you leave this box unchecked clicking the images will directly open them with the default image viewer, e.g. Kuickshow.
</para>
<figure>
<title>The Look Settings Dialog</title>
<graphic srccredit="The Look Settings Dialog" fileref="imagegallery_looksettings.png"/>
</figure>
</sect1>
<sect1 id="using-plugin-imagesgalleryalbumsettings">
<title>Album Settings Dialog</title>
<para>
The <guilabel>Album</guilabel> tab defines the settings of where and how to store the gallery with all its associated images. Select a folder with write access where you want the gallery to be written to. A sub-folder named KIPIHTMLExport will be created containing everything.
</para>
<para>
When you check the <guilabel>Resize target images</guilabel> box you can fix the maximum target image size (in pixels) with the slider below it. Images bigger than this value will be scaled down to it, smaller images will not be modified.
The next two check boxes allow you to set specific image compression features. If disk space is of concern check the target image compression and lower the compression level from the host application default value. Then you can choose between JPEG (smallest filesize, but lossy) and PNG (lossless and free license) formats.
</para>
<note><para>
If JPEG file format is selected for target resizing images, all EXIF informations will be preserved from original JPEG files.
</para></note>
<para>
With the <guilabel>Set different color depth</guilabel> check box you can change the default color depth. This will of course influence the filesize. The rest of the setting are rather self-explanatory.
</para>
<figure>
<title>The Album Settings Dialog</title>
<graphic srccredit="The Album Settings Dialog" fileref="imagegallery_albumsettings.png"/>
</figure>
</sect1>
<sect1 id="using-plugin-imagesgallerythumbsettings">
<title>Thumbnails Settings Dialog</title>
<para>
The <guilabel>Thumbnails</guilabel> tab allows to set some of the <guilabel>Album</guilabel> tab settings for the thumbnails (that are the small images shown in the gallery).
</para>
<figure>
<title>The Thumbnails Settings Dialog</title>
<graphic srccredit="The Thumbnails Settings Dialog" fileref="imagegallery_thumbsettings.png"/>
</figure>
</sect1>
<sect1 id="using-plugin-imagesgalleryinaction">
<title>Images Gallery in Action</title>
<para>
A progress dialog giving a feedback indicate to user. Press <guilabel>Cancel</guilabel> button during this stage
if you want abort the process.
</para>
<figure>
<title>The Images Gallery Plugin in Action</title>
<graphic srccredit="The Images Gallery Plugin in Action" fileref="imagegallery_progress.png"/>
</figure>
<para>
When all jobs are completed, this dialog will not closed automaticly and user can consult the progress messages
if any errors occurs durring this stage. The web browser will be started automaticly at end to display a gallery preview. Press <guilabel>Close</guilabel> button to close dialog.
</para>
<figure>
<title>The Images Gallery Preview in Konqueror</title>
<graphic srccredit="The Images Gallery Preview in Konqueror" fileref="imagegallery_preview.png"/>
</figure>
</sect1>
</chapter>