[digikam-doc] digikam: add flickr
Gilles Caulier
caulier.gilles at gmail.com
Thu Aug 25 11:05:57 UTC 2016
Git commit 3fb3e9b6903db6d4521948a8da1e4259173c2b4d by Gilles Caulier.
Committed on 25/08/2016 at 11:05.
Pushed by cgilles into branch 'master'.
add flickr
M +5 -0 digikam/index.docbook
A +154 -0 digikam/tool-flickrexport.docbook
A +- -- digikam/tool-flickrexportauthenticated.png
A +- -- digikam/tool-flickrexportcontinue.png
A +- -- digikam/tool-flickrexportsignup.png
A +- -- digikam/tool-flickrexportuploaddialog.png
A +- -- digikam/tool-flickrexportuploading.png
http://commits.kde.org/digikam-doc/3fb3e9b6903db6d4521948a8da1e4259173c2b4d
diff --git a/digikam/index.docbook b/digikam/index.docbook
index c4e8a1d..2377549 100644
--- a/digikam/index.docbook
+++ b/digikam/index.docbook
@@ -44,6 +44,7 @@
<!ENTITY doc-tool-maintenance SYSTEM "tool-maintenance.docbook">
<!ENTITY doc-tool-printwizard SYSTEM "tool-printwizard.docbook">
<!ENTITY doc-tool-sendimages SYSTEM "tool-sendimages.docbook">
+ <!ENTITY doc-tool-flickrexport SYSTEM "tool-flickrexport.docbook">
<!-- Menus Chapter -->
<!ENTITY doc-menu-mainwindow SYSTEM "menu-mainwindow.docbook">
<!ENTITY doc-menu-editor SYSTEM "menu-editor.docbook">
@@ -143,6 +144,7 @@
<!-- ******** MISC TOOLS *************************************************** -->
+<!-- native -->
&doc-tool-acquireimages;
&doc-tool-geolocationeditor;
&doc-tool-presentation;
@@ -153,8 +155,11 @@
&doc-tool-calendar;
&doc-tool-maintenance;
+<!-- plugins -->
&doc-tool-printwizard;
&doc-tool-sendimages;
+&doc-tool-sendimages;
+&doc-tool-flickrexport;
<!-- ******** MENUS ******************************************************** -->
diff --git a/digikam/tool-flickrexport.docbook b/digikam/tool-flickrexport.docbook
new file mode 100644
index 0000000..72b1233
--- /dev/null
+++ b/digikam/tool-flickrexport.docbook
@@ -0,0 +1,154 @@
+<chapter id="tool-flickrexport">
+<chapterinfo>
+
+<abstract>
+ <para>
+ FlickrExport tool allows the user to upload photos to the <ulink url="http://www.flickr.com">Flickr</ulink> web service.
+ </para>
+</abstract>
+
+</chapterinfo>
+
+<title>Flickr Export</title>
+
+ <para>
+ Flickr is an online photo management application. Flickr is a way
+ to get your photos to the people who matter to you. With Flickr you can show off
+ your favorite photos to the world, blog the photos you take with a cameraphone,
+ and securely and privately show photos to your friends and family around the world.
+ </para>
+
+ <para>
+ The FlickrExport plugin can be used to upload an image collection from your
+ computer to the remote flickr server using the Internet.
+ </para>
+
+<sect1 id="using-tool-flickrexport">
+ <title>Tool initialization on first access</title>
+
+ <para>
+ When accessing the plugin for the first time the user you are taken through the process
+ of obtaining a token which is used for authentication purposes.
+ The following dialog will popup and a browser window will be launched you
+ will log in to <ulink url="http://www.flickr.com">Flickr</ulink>:
+ </para>
+
+ <figure id="flickrexport-first-signup-dialog">
+ <title>The First Sign Up Dialog Preview</title>
+ <mediaobject><imageobject>
+ <imagedata srccredit="The First Sign Up Dialog Preview" fileref="tool-flickrexportsignup.png"/>
+ </imageobject></mediaobject>
+ </figure>
+
+ <para>
+ After successful signup FlickrUploadr will be allowed to send photos to the flickr
+ website. You will be presented with the following page on
+ successful signup:
+ </para>
+
+ <figure id="flickrexport-successful-signup">
+ <title>The Successful Signup Flickr page</title>
+ <mediaobject><imageobject>
+ <imagedata srccredit="The Successful Signup Flickr page" fileref="tool-flickrexportauthenticated.png"/>
+ </imageobject></mediaobject>
+ </figure>
+
+ <para>
+ Then, simply close the browser windows and return to the host application dialog.
+ After clicking <guilabel>Yes</guilabel>, you will see the interface used to upload
+ photos to Flickr, described in the next section.
+ </para>
+
+</sect1>
+
+<sect1 id="uploading-using-tool-flickrexport">
+<title>Regular Tool Usage</title>
+
+ <para>
+ When the flickrexport plugin is invoked for second time or later you are
+ greeted with the following dialog, which shows the current access permissions
+ the Flickr Export plugin has. The uploading process requires <quote>write</quote>
+ permissions. The plugin doesn't allow any other permissions as of now. You
+ are then asked if they want to proceed with their current permissions.
+ </para>
+ <figure id="flickrexport-current-permissions-dialog">
+ <title>Current Permissions Dialog preview</title>
+ <mediaobject><imageobject>
+ <imagedata srccredit="Current Permission Dialog preview" fileref="tool-flickrexportcontinue.png"/>
+ </imageobject></mediaobject>
+ </figure>
+
+ <para>
+ After clicking <guibutton>Yes</guibutton>, you will see the interface to upload
+ photos to Flickr.
+ </para>
+ <para>
+ After clicking <guibutton>No</guibutton>, the authentication process is repeated.
+ </para>
+
+ <para>
+ The Main upload dialog is shown below:
+ </para>
+
+ <figure id="flickrexport-main-uploading-dialog">
+ <title>The Main Uploading Dialog Preview</title>
+ <mediaobject><imageobject>
+ <imagedata srccredit="The Main Uploading Dialog Preview" fileref="tool-flickrexportuploaddialog.png"/>
+ </imageobject></mediaobject>
+ </figure>
+
+ <para>
+ The <guibutton>Add Photos</guibutton> button should be clicked once user has set
+ the other options in the dialog. After clicking this button an image selector dialog
+ opens up where you can select the photos you want to upload and click
+ <guibutton>OK</guibutton>, whereupon the image uploading starts.
+ </para>
+
+ <para>
+ The <guilabel>Tags</guilabel> field can be filled with a series of words (comma
+ separated) which will be assigned as tags to the images uploaded.
+ </para>
+
+ <para>
+ The <guilabel>Public</guilabel>, <guilabel>Friends</guilabel>, and <guilabel>Family</guilabel>
+ checkboxes can be checked to assign appropriate access permissions to the images
+ you upload. By default the images uploaded are private.
+ </para>
+
+ <para>
+ If the <guilabel>Resize photos before uploading</guilabel> option is selected,
+ the photos will be resized before uploading. The values will be read from the
+ <guilabel>Maximum dimension</guilabel> combobox.
+ </para>
+
+ <para>
+ The <guilabel>Maximum Dimension</guilabel> combobox can be used to adjust the
+ maximum height to which the photos will be resized before uploading. The width
+ calculation will be done so as to have the aspect ratio conserved.
+ </para>
+
+ <figure id="flickrexport-uploading-progress-dialog">
+ <title>The Uploading Progress Dialog Preview</title>
+ <mediaobject><imageobject>
+ <imagedata srccredit="The Uploading Progress Dialog Preview" fileref="tool-flickrexportuploading.png"/>
+ </imageobject></mediaobject>
+ </figure>
+ <para>
+ You can click <guilabel>Cancel</guilabel> button to abort the uploading of photos.
+</para>
+
+<para>
+Finally, you can view the uploaded photos by visting the
+<ulink url="http://www.flickr.com">Flickr</ulink> website.
+</para>
+</sect1>
+
+</chapter>
+
+<!--
+Local Variables:
+mode: sgml
+sgml-omittag: nil
+sgml-shorttag: ts
+End:
+-->
diff --git a/digikam/tool-flickrexportauthenticated.png b/digikam/tool-flickrexportauthenticated.png
new file mode 100644
index 0000000..a88ab22
Binary files /dev/null and b/digikam/tool-flickrexportauthenticated.png differ
diff --git a/digikam/tool-flickrexportcontinue.png b/digikam/tool-flickrexportcontinue.png
new file mode 100644
index 0000000..fc72da0
Binary files /dev/null and b/digikam/tool-flickrexportcontinue.png differ
diff --git a/digikam/tool-flickrexportsignup.png b/digikam/tool-flickrexportsignup.png
new file mode 100644
index 0000000..a782ff4
Binary files /dev/null and b/digikam/tool-flickrexportsignup.png differ
diff --git a/digikam/tool-flickrexportuploaddialog.png b/digikam/tool-flickrexportuploaddialog.png
new file mode 100644
index 0000000..83d5e36
Binary files /dev/null and b/digikam/tool-flickrexportuploaddialog.png differ
diff --git a/digikam/tool-flickrexportuploading.png b/digikam/tool-flickrexportuploading.png
new file mode 100644
index 0000000..0d92cb2
Binary files /dev/null and b/digikam/tool-flickrexportuploading.png differ
More information about the kde-doc-english
mailing list