Image Kimdaba: Difference between revisions

From KDE UserBase Wiki
m (fix typos)
(Marked this version for translation)
Line 2: Line 2:
<translate>
<translate>


==General Description==
==General Description== <!--T:1-->


<!--T:2-->
'''Image::Kimdaba''' is a Perl module available on [http://cpan.org CPAN] for parsing the [[KPhotoAlbum|KPhotoAlbum]] database
'''Image::Kimdaba''' is a Perl module available on [http://cpan.org CPAN] for parsing the [[KPhotoAlbum|KPhotoAlbum]] database


==Installation==
==Installation== <!--T:3-->


<!--T:4-->
Here we will assume that you want to install the module as a user, say in ''$HOME/local'';
Here we will assume that you want to install the module as a user, say in ''$HOME/local'';


<!--T:5-->
{{Input|1=$''' mkdir -p ~/local/bin'''
{{Input|1=$''' mkdir -p ~/local/bin'''
$''' perl -MCPAN -e shell'''}}
$''' perl -MCPAN -e shell'''}}


<!--T:6-->
Answer a bunch of question the first time. At some point, you have to enter:
Answer a bunch of question the first time. At some point, you have to enter:
{{Input|1='''PREFIX=~/local'''}}
{{Input|1='''PREFIX=~/local'''}}


<!--T:7-->
Then, in the CPAN shell, type
Then, in the CPAN shell, type
{{Input|1=>''' install Image::Kimdaba}}
{{Input|1=>''' install Image::Kimdaba}}


<!--T:8-->
You need to modify two environment variables:
You need to modify two environment variables:


<!--T:9-->
{{Input|1=export PERL5LIB=~/local/lib/perl5/site_perl/5.8.3:~/local/lib/perl5/5.8.3
{{Input|1=export PERL5LIB=~/local/lib/perl5/site_perl/5.8.3:~/local/lib/perl5/5.8.3
export PATH="$HOME/local/bin:$PATH"}}
export PATH="$HOME/local/bin:$PATH"}}


<!--T:10-->
If everything is OK, it's now time to test if it works. Launch '''Kimdaba's''' demo (in the <menuchoice>Help</menuchoice> menu) and run:
If everything is OK, it's now time to test if it works. Launch '''Kimdaba's''' demo (in the <menuchoice>Help</menuchoice> menu) and run:


<!--T:11-->
{{Input|1=$ kim_example.pl  /tmp/kimdaba-demo-$USER}}
{{Input|1=$ kim_example.pl  /tmp/kimdaba-demo-$USER}}




== Upgrade ==
== Upgrade == <!--T:12-->


<!--T:13-->
Thanks to the CPAN infrastructure, you only need to type:
Thanks to the CPAN infrastructure, you only need to type:


<!--T:14-->
{{Input|1=$ perl -MCPAN -e 'install Image::Kimdaba' }}
{{Input|1=$ perl -MCPAN -e 'install Image::Kimdaba' }}


== Installation on Debian ==
== Installation on Debian == <!--T:15-->


<!--T:16-->
On Debian it's possible to automagically install Image::Kimdaba . Install first '''dh-make-perl''', and then (as root) :
On Debian it's possible to automagically install Image::Kimdaba . Install first '''dh-make-perl''', and then (as root) :


<!--T:17-->
{{Input|1=# dh-make-perl  --build --install --cpan Image::Kimdaba}}
{{Input|1=# dh-make-perl  --build --install --cpan Image::Kimdaba}}


== Scripts coming with Image::Kimdaba ==
== Scripts coming with Image::Kimdaba == <!--T:18-->


<!--T:19-->
{{Note|1=The [http://search.cpan.org/src/JMFAYARD/Image-Kimdaba-0.4/README README] file on CPAN may be more up to date.}}
{{Note|1=The [http://search.cpan.org/src/JMFAYARD/Image-Kimdaba-0.4/README README] file on CPAN may be more up to date.}}


<!--T:20-->
Here we describe scripts already made that you may find useful.
Here we describe scripts already made that you may find useful.


== Synchronize comments between Kimdaba and digiKam ==
== Synchronize comments between Kimdaba and digiKam == <!--T:21-->


<!--T:22-->
The first time, do:
The first time, do:
{{Input|1=$ ./kim_2_digikam <rootfolder>}}which will create the digikam.db database used by digiKam (>= 0.7 and < 0.8 )
{{Input|1=$ ./kim_2_digikam <rootfolder>}}which will create the digikam.db database used by digiKam (>= 0.7 and < 0.8 )


<!--T:23-->
Launch kimdaba, do some changes, relaunch the script
Launch kimdaba, do some changes, relaunch the script
{{Input|1=$ ./kim_2_digikam <rootfolder>}}which will update the digikam.db database (you have to restart digiKam to see the changes, though).
{{Input|1=$ ./kim_2_digikam <rootfolder>}}which will update the digikam.db database (you have to restart digiKam to see the changes, though).


<!--T:24-->
Add some categories in digiKam to some pictures and relaunch the script
Add some categories in digiKam to some pictures and relaunch the script
{{Input|1=$ ./kim_2_digikam <rootfolder> }}Then you can import the modifications you made with digiKam by doing in Kimdaba:  <menuchoice>File -> Import: /tmp/digikam_export.kim</menuchoice>
{{Input|1=$ ./kim_2_digikam <rootfolder> }}Then you can import the modifications you made with digiKam by doing in Kimdaba:  <menuchoice>File -> Import: /tmp/digikam_export.kim</menuchoice>


<!--T:25-->
The good thing with synchronizing with digikam.db is that you can then use the ''digikamtags:/'' KIOSlave to browse by Persons or Keywords or Locations in every KDE app. (And add a tab "Kimdaba" -> url=digikamtags:/ in '''Konqueror''' sidebar
The good thing with synchronizing with digikam.db is that you can then use the ''digikamtags:/'' KIOSlave to browse by Persons or Keywords or Locations in every KDE app. (And add a tab "Kimdaba" -> url=digikamtags:/ in '''Konqueror''' sidebar
for example).
for example).


== JAlbum gallery export ==
== JAlbum gallery export == <!--T:26-->


<!--T:27-->
If you really like the [http://jalbum.net/samples.jsp many beautiful ways] that [http://jalbum.net JAlbum] will let you display the images, but you are not willing to abandon '''KPhotoAlbum''', use this script to duct tape your Kimdaba's comments to '''JAlbum'''.
If you really like the [http://jalbum.net/samples.jsp many beautiful ways] that [http://jalbum.net JAlbum] will let you display the images, but you are not willing to abandon '''KPhotoAlbum''', use this script to duct tape your Kimdaba's comments to '''JAlbum'''.


<!--T:28-->
* Download '''kim_jalbum.pl''' from http://thread.gmane.org/gmane.comp.kde.kimdaba/919 here] , and do:
* Download '''kim_jalbum.pl''' from http://thread.gmane.org/gmane.comp.kde.kimdaba/919 here] , and do:
{{Input|1=$ ./kim_jalbum.pl <rootfolder> }}
{{Input|1=$ ./kim_jalbum.pl <rootfolder> }}


<!--T:29-->
Then  [http://jalbum.net/install.htm download JAlbum] and install it (Java required). You need to do some setup first:
Then  [http://jalbum.net/install.htm download JAlbum] and install it (Java required). You need to do some setup first:


<!--T:30-->
* Tab main:
* Tab main:
: Image directory: Kimdaba's root folder
: Image directory: Kimdaba's root folder
: Output directory: Your album folder
: Output directory: Your album folder


<!--T:31-->
* Tab advanced:
* Tab advanced:
: Ignore pattern: \..*|ThumbNails|CategoryImages|index.xml
: Ignore pattern: \..*|ThumbNails|CategoryImages|index.xml


<!--T:32-->
* Menu File -> Save as default
* Menu File -> Save as default


<!--T:33-->
'''JAlbum''' only allows you to make a gallery from one folder (and its subfolders) while '''KPhotoAlbum''' does not have this restriction.  Here is a solution:
'''JAlbum''' only allows you to make a gallery from one folder (and its subfolders) while '''KPhotoAlbum''' does not have this restriction.  Here is a solution:


<!--T:34-->
''In Kimdaba''
''In Kimdaba''


<!--T:35-->
* Eventually delete the "jalbum" keyword to restart from scratch.
* Eventually delete the "jalbum" keyword to restart from scratch.


<!--T:36-->
* Set the "jalbum" keyword for each pictures you want to export.
* Set the "jalbum" keyword for each pictures you want to export.


<!--T:37-->
* Save your changes
* Save your changes


<!--T:38-->
''In Konsole''
''In Konsole''


<!--T:39-->
Create a directory with symlinks to your tagged pictures :
Create a directory with symlinks to your tagged pictures :
{{Input|1=$ kim_jalbum.pl ~/Images --exportdir ~/Syms/patou/}}
{{Input|1=$ kim_jalbum.pl ~/Images --exportdir ~/Syms/patou/}}


<!--T:40-->
That's it, now use ''~/Syms/patou/'' as Image Directory
That's it, now use ''~/Syms/patou/'' as Image Directory


==Auto-assign categoryimages ==
==Auto-assign categoryimages == <!--T:41-->


<!--T:42-->
In Kimdaba's browser, you can see the list of the persons on your pictures by name, or by icons. In the viewer, you can assign an icon for a person of the pictures by Right click -> <menuchoice>Show category editor</menuchoice>, but it's a bit long if you have 500 persons. So this script will choose it for you.
In Kimdaba's browser, you can see the list of the persons on your pictures by name, or by icons. In the viewer, you can assign an icon for a person of the pictures by Right click -> <menuchoice>Show category editor</menuchoice>, but it's a bit long if you have 500 persons. So this script will choose it for you.


<!--T:43-->
{{Input|1=$ mkdir -p &lt;rootfolder&gt;/CategoryImages
{{Input|1=$ mkdir -p &lt;rootfolder&gt;/CategoryImages
$ ./kim_category_images  <rootfolder>}}
$ ./kim_category_images  <rootfolder>}}


<!--T:44-->
It's faster than to set the 500 pictures by hand, isn't it?
It's faster than to set the 500 pictures by hand, isn't it?
You can still use the category editor to choose a better picture for this person or that keyword, the script will not overwrite it.
You can still use the category editor to choose a better picture for this person or that keyword, the script will not overwrite it.


== Really rotate your pictures ==
== Really rotate your pictures == <!--T:45-->


<!--T:46-->
In '''KPhotoAlbum''', you can rotate pictures, but the pictures will not be really rotated, the rotation will only be stored in the index.xml database. To improve interoperability with other software, it's useful to really rotate. Quit Kimdaba and use this script ''(you need the '''jpegtran''' tool)''
In '''KPhotoAlbum''', you can rotate pictures, but the pictures will not be really rotated, the rotation will only be stored in the index.xml database. To improve interoperability with other software, it's useful to really rotate. Quit Kimdaba and use this script ''(you need the '''jpegtran''' tool)''


<!--T:47-->
{{Input|1=$ ./kim_rotate.pl <rootfolder> }}
{{Input|1=$ ./kim_rotate.pl <rootfolder> }}




== Export a hierarchy of symbolic links ==
== Export a hierarchy of symbolic links == <!--T:48-->


<!--T:49-->
(This is a bit proof-of-concept for Kimdaba.pm, but could be useful when using non kde apps (see kim_2_digikam ))
(This is a bit proof-of-concept for Kimdaba.pm, but could be useful when using non kde apps (see kim_2_digikam ))


<!--T:50-->
Edit the first line of the script, then
Edit the first line of the script, then
{{Input|1=$ ./kim_2_filesystem <rootfolder> }}
{{Input|1=$ ./kim_2_filesystem <rootfolder> }}


== Write your own ==
== Write your own == <!--T:51-->


<!--T:52-->
If you need to export your comments in another format, or you want to do some fun thing not available with '''Kimdaba''' and you know a bit of Perl, you can [http://search.cpan.org/~jmfayard/Image-Kimdaba/lib/Image/Kimdaba.pm Write your own extension] , it's very easy.
If you need to export your comments in another format, or you want to do some fun thing not available with '''Kimdaba''' and you know a bit of Perl, you can [http://search.cpan.org/~jmfayard/Image-Kimdaba/lib/Image/Kimdaba.pm Write your own extension] , it's very easy.


<!--T:53-->
If you feel the need, you can share your script with other people by editing this page and sending an email to the [http://ktown.kde.org/kimdaba/misc.htm KPhotoAlbum mailing-list].
If you feel the need, you can share your script with other people by editing this page and sending an email to the [http://ktown.kde.org/kimdaba/misc.htm KPhotoAlbum mailing-list].


<!--T:54-->
[[Category:Graphics]]
[[Category:Graphics]]
[[Category:Advanced Users]]
[[Category:Advanced Users]]
</translate>
</translate>

Revision as of 16:12, 10 October 2010

General Description

Image::Kimdaba is a Perl module available on CPAN for parsing the KPhotoAlbum database

Installation

Here we will assume that you want to install the module as a user, say in $HOME/local;

$ mkdir -p ~/local/bin
$ perl -MCPAN -e shell

Answer a bunch of question the first time. At some point, you have to enter:

PREFIX=~/local

Then, in the CPAN shell, type

> install Image::Kimdaba

You need to modify two environment variables:

export PERL5LIB=~/local/lib/perl5/site_perl/5.8.3:~/local/lib/perl5/5.8.3
export PATH="$HOME/local/bin:$PATH"

If everything is OK, it's now time to test if it works. Launch Kimdaba's demo (in the Help menu) and run:

$ kim_example.pl  /tmp/kimdaba-demo-$USER


Upgrade

Thanks to the CPAN infrastructure, you only need to type:

$ perl -MCPAN -e 'install Image::Kimdaba'

Installation on Debian

On Debian it's possible to automagically install Image::Kimdaba . Install first dh-make-perl, and then (as root) :

# dh-make-perl  --build --install --cpan Image::Kimdaba

Scripts coming with Image::Kimdaba

Note

The README file on CPAN may be more up to date.


Here we describe scripts already made that you may find useful.

Synchronize comments between Kimdaba and digiKam

The first time, do:

$ ./kim_2_digikam <rootfolder>

which will create the digikam.db database used by digiKam (>= 0.7 and < 0.8 )

Launch kimdaba, do some changes, relaunch the script

$ ./kim_2_digikam <rootfolder>

which will update the digikam.db database (you have to restart digiKam to see the changes, though).

Add some categories in digiKam to some pictures and relaunch the script

$ ./kim_2_digikam <rootfolder>

Then you can import the modifications you made with digiKam by doing in Kimdaba: File -> Import: /tmp/digikam_export.kim

The good thing with synchronizing with digikam.db is that you can then use the digikamtags:/ KIOSlave to browse by Persons or Keywords or Locations in every KDE app. (And add a tab "Kimdaba" -> url=digikamtags:/ in Konqueror sidebar for example).

JAlbum gallery export

If you really like the many beautiful ways that JAlbum will let you display the images, but you are not willing to abandon KPhotoAlbum, use this script to duct tape your Kimdaba's comments to JAlbum.

$ ./kim_jalbum.pl <rootfolder>

Then download JAlbum and install it (Java required). You need to do some setup first:

  • Tab main:
Image directory: Kimdaba's root folder
Output directory: Your album folder
  • Tab advanced:
Ignore pattern: \..*|ThumbNails|CategoryImages|index.xml
  • Menu File -> Save as default

JAlbum only allows you to make a gallery from one folder (and its subfolders) while KPhotoAlbum does not have this restriction. Here is a solution:

In Kimdaba

  • Eventually delete the "jalbum" keyword to restart from scratch.
  • Set the "jalbum" keyword for each pictures you want to export.
  • Save your changes

In Konsole

Create a directory with symlinks to your tagged pictures :

$ kim_jalbum.pl ~/Images --exportdir ~/Syms/patou/

That's it, now use ~/Syms/patou/ as Image Directory

Auto-assign categoryimages

In Kimdaba's browser, you can see the list of the persons on your pictures by name, or by icons. In the viewer, you can assign an icon for a person of the pictures by Right click -> Show category editor, but it's a bit long if you have 500 persons. So this script will choose it for you.

$ mkdir -p <rootfolder>/CategoryImages
$ ./kim_category_images  <rootfolder>

It's faster than to set the 500 pictures by hand, isn't it? You can still use the category editor to choose a better picture for this person or that keyword, the script will not overwrite it.

Really rotate your pictures

In KPhotoAlbum, you can rotate pictures, but the pictures will not be really rotated, the rotation will only be stored in the index.xml database. To improve interoperability with other software, it's useful to really rotate. Quit Kimdaba and use this script (you need the jpegtran tool)

$ ./kim_rotate.pl <rootfolder>


Export a hierarchy of symbolic links

(This is a bit proof-of-concept for Kimdaba.pm, but could be useful when using non kde apps (see kim_2_digikam ))

Edit the first line of the script, then

$ ./kim_2_filesystem <rootfolder>

Write your own

If you need to export your comments in another format, or you want to do some fun thing not available with Kimdaba and you know a bit of Perl, you can Write your own extension , it's very easy.

If you feel the need, you can share your script with other people by editing this page and sending an email to the KPhotoAlbum mailing-list.