Jump to content

KPhotoAlbum: Difference between revisions

From KDE UserBase Wiki
← Older edit
fix link
Remove mentions of different Neon versions - kphotoalbum is delivered as snap to Neon, which is always built from the git master branch
 
(92 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<languages />
<languages />
<translate>
 
<!--T:73-->
{{GrafBreadCrumbs|1=KPhotoAlbum}}
 
</translate>
[[File:Kphotoalbum_splash.png|500px|center]]<br />
<translate>
 
<!--T:1-->
'''Use KPhotoAlbum to catalogue, select, view and share images and videos.'''<br /><br />
'''KPhotoAlbum''' is software to catalogue images and videos, supporting customizable and extensive annotation.<br /> Within annotated collections '''KPhotoAlbum''' helps you to swiftly select individual images or subsets of images to view or share them.<br />
</translate>


{|class="tablecenter vertical-centered"
|[[Image:Kphotoalbum_splash.png]] ||<translate> <!--T:1-->
'''KPhotoAlbum is a tool which you can use to easily sort your images. It provides many capabilities to make sorting and viewing images easy'''.<br /> </translate>
|}
<translate>
<translate>
<!--T:2-->
== Main features == <!--T:77-->
Earlier versions of '''KPhotoAlbum''' were released under the name "KimDaBa". Stable releases are always announced on our [https://www.kphotoalbum.org/news/ news page].


<!--T:62-->
<!--T:62-->
[[File:KPhotoAlbum_main_windows.png]]
[[File:KPhotoAlbum_main_windows.png|500px|center]]
</translate>
 
<translate>
<!--T:78-->
* ''Catalogue'': annotate images and videos with any combination of labels, categories, date ranges and tokens
 
<!--T:79-->
* ''Select and view'': select images by any combination of labels, categories, date ranges and tokens and view the resulting subset


<!--T:3-->
<!--T:80-->
__TOC__
* ''Show and share'': show selected images in a slideshow, create HTML pages with them, or export them for others to import them
For an introduction, take the [http://kphotoalbum.org/index.php?page=3-minute-tour 3 minute KPhotoAlbum tour] or see the [http://kphotoalbum.org/index.php?page=videos Videos] at [http://kphotoalbum.org/ KPhotoAlbum's Homepage].  To learn more and view some screenshots read the [[Special:myLanguage/KPhotoAlbum FAQ|FAQ]].


<!--T:4-->
<!--T:4-->
'''KPhotoAlbum''' supports all the normal image formats including raw
KPhotoAlbum supports all the normal image and video formats including raw formats produced by most digital cameras and scanners. It is also possible to use the thumbnails embedded in raw images.
formats produced by most digital cameras and scanners (using dcraw to do the
</translate>
decoding). It is also possible to use the thumbnails embedded in raw images
<translate>
(that are usually of decent size and quality) for fast viewing so there is
== Get and install == <!--T:81-->
no need to decode the whole raw image.


== Using KPhotoAlbum == <!--T:5-->
<!--T:82-->
Source packages, binaries for various distributions, and snapshots are available at [https://www.kphotoalbum.org/download/ the project Download page].
</translate>


<!--T:6-->
<translate>
There is a [https://www.kphotoalbum.org/documentation/3minutetour/ 3-minute Tour] and a set of [https://www.kphotoalbum.org/documentation/videos/ How-To videos] on the project site. A '''KPhotoAlbum''' handbook is also available as a [https://docs.kde.org/development/en/extragear-graphics/kphotoalbum/kphotoalbum.pdf PDF] and [https://docs.kde.org/development/en/extragear-graphics/kphotoalbum/index.html on-line version].
<!--T:83-->
{{Install|KPhotoAlbum}}


== Getting KPhotoAlbum == <!--T:7-->
<!--T:84-->
Use [https://neon.kde.org/download KDE Neon] to try out the newest version of KPhotoAlbum. Neon contains the latest development version of KPhotoAlbum, built fresh from the source.


<!--T:8-->
</translate>
Source packages, binaries for various distros, and snapshots are available from [https://www.kphotoalbum.org/download/ the project Download page].


=== KPhotoAlbum on Live systems === <!--T:9-->
<translate>


<!--T:10-->
== Explore == <!--T:69-->
KPhotoAlbum is available in [https://neon.kde.org/download Neon]:
* User Edition has the latest release
* Developer Edition (stable branch) has the ''5.x'' branch.<br/>Most of the time, this should be the same as unstable, but when new features are developed they only arrive in stable after the roughest edges have been smoothed out.
* Developer Edition (unstable branch) has the ''master'' branch of kphotoalbum.


=== Building KPhotoAlbum === <!--T:31-->
<!--T:3-->
Explore KPhotoAlbum by reading the ''documentation'' or by starting KPhotoAlbum in ''demo-mode''.


<!--T:32-->
===== Documentation ===== <!--T:88-->
Step-by-step guide to build KPhotoAlbum from source code on Debian or Ubuntu are available on page [[Special:myLanguage/Building KPhotoAlbum|Building KPhotoAlbum]].


== Extending KPhotoAlbum == <!--T:11-->
<!--T:89-->
Several types of documentation exist:


<!--T:12-->
<!--T:90-->
* '''Image::Kimdaba''' is a perl module available on [http://cpan.org CPAN] which parses the ''index.xml'' database.
* [https://www.kphotoalbum.org/user-support/3minutetour/ 3 minute tour]
**  [http://search.cpan.org/~jmfayard/Image-Kimdaba/lib/Image/Kimdaba.pm Write your own extensions] to '''KPhotoAlbum'''
** Read [[Special:myLanguage/Image_Kimdaba|Image::Kimdaba]] to download it and to see available scripts
* Another way to extend '''KPhotoAlbum''' is to write [[Special:myLanguage/KIPI|KIPI plugins]] (that are used also by other KDE photo applications). These plugins provide functions like exporting images to websites like Flickr, Picasa, Facebook, ... correcting exif date stamps or doing some other image manipulations. ('''KPhotoAlbum''' by itself does not touch the original files at all but preserves them intact).
* Other useful scripts are available from [http://www.hardakers.net/kphotoalbum/#sec-5 Wes Hardaker's site]
* With [http://wersdoerfer.com/wicked/Kimdaba2Mysql Kimdaba2Mysql] it's possible to:
** insert your index.xml metadata into a mysql-database
** generate a search-formular on your website  with your kimdaba-keywords, example [http://wersdoerfer.com/bilder here]<br />


<!--T:30-->
<!--T:91-->
* Patches and features awaiting approval or implementation - Please use [https://bugs.kde.org/ bugs.kde.org] for that.
* [https://docs.kde.org/development/en/extragear-graphics/kphotoalbum/index.html on-line] handbook


<!--T:92-->
* [https://docs.kde.org/development/en/extragear-graphics/kphotoalbum/kphotoalbum.pdf PDF] handbook


<!--T:93-->
* [[Special:myLanguage/KPhotoAlbum FAQ| Frequently Asked Questions]]


<!--T:13-->
</translate>
With [http://www.gowdy.us/pse3/ pse3tokimdaba.pl] it's possible to extract information from your Photoshop Elements 3 database to create an index.xml file. There are quite a few limitations, see the above page for more details.


<!--T:14-->
<translate>
[http://d200.vmrt.homelinux.com/|djKPA djKPA] is a [http://www.djangoproject.org Django] web site designed to be the web interface of your [http://www.kphotoalbum.org KPhotoAlbum] photo repository.
===== Demo-mode ===== <!--T:94-->
The philosophy of djKPA is be as far as possible fully automatic: labels, tags, descriptions, ... of photo come from '''KPhotoAlbum'''. Nevertheless, djKPA is a real interactive application that allows your visitors to vote, post comments, show exif, ... and visit your photos by browsing the your Tags.


=== Help develop KPhotoAlbum === <!--T:15-->
<!--T:95-->
''Demo-mode'' loads a number of already annotated stock images for you to browse and view, and to annotate yourself. All KPhotoAlbum functionalities are working. Shutting down KPhotoAlbum you may retain or discard any changes you've made during ''demo-mode''.


<!--T:16-->
<!--T:96-->
If you are interested in helping the '''KPhotoAlbum''' development or related projects, please look at  [http://www.kphotoalbum.org/index.php?page=getting-involved this project page]. Or, if you have an idea for a feature, please see the Feature Requests section, below.
Start ''demo-mode'':


== Developer documentation == <!--T:33-->
<!--T:97-->
=== KPA Release Steps ===
* At first start accept KPhotoAlbum's offer to run in ''demo-mode''.


<!--T:45-->
<!--T:98-->
* Update CMakeLists.txt with the new version number you are just about to tag (alas, our automatic versionning doesn't work anymore {{Smiley}})
* In KPhotoAlbum click ''Help'', then ''Run KPhotoAlbum demo''


<!--T:49-->
<!--T:99-->
* Update the ChangeLog to mark the new release and add the key improvements to the list of changes, if they are not already mentioned in the ChangeLog
* Start KPhotoAlbum with the ''--demo'' switch on the commandline.
</translate>


<!--T:50-->
<translate>
* Update doc/index.docbook to reflect the new release (if the documentation has been updated)<br />{{Input|1=<nowiki><releaseinfo>4.5</releaseinfo></nowiki>}}
==== ''Note'' ==== <!--T:100-->


<!--T:51-->
<!--T:101-->
* Commit the last changes<br />{{Input|1=<nowiki>git commit -v -a</nowiki>}}
If you choose to explore KPhotoAlbum using your own images, KPhotoAlbum will ask for the folder containing your images. Please note that KPhotoAlbum currently supports only '''one root folder''': it will find the images in this folder and any sub-folders it may contain.<br />
See [[Special:myLanguage/KPhotoAlbum_FAQ#Can_I_organize_my_images_in_multiple_directories?|FAQ]] for more information.
</translate>


<!--T:52-->
<translate>
* Tag the new release and push it out<br />{{Input|1=<nowiki>git tag -a -m "kpa 4.5 released" v4.5
== Requirements == <!--T:102-->
git push
git push --tags</nowiki>}}


<!--T:53-->
<!--T:103-->
* Create a tar ball of the released sources using the instructions on the following section (''kphotoalbum.rb --version 4.5'')
KPhotoAlbum will run conveniently on most computers:


<!--T:54-->
<!--T:104-->
* Upload the created tar ball to the <tt>incoming</tt> directory of upload.kde.org using an FTP client. The current instructions of notifying administrators of the upload are shown when logging in to the FTP server. You create a ticket and provide SHA sums and some other information of the upload.
* PC's from 2015 or newer, with


<!--T:55-->
<!--T:105-->
* Add a new version to Bugzilla (bugs.kde.org, you have to have administrator rights to do this): ''Edit Products → KPhotoAlbum → Add version''
* 8 Gb of RAM


<!--T:56-->
<!--T:106-->
* Update the KPA web pages to point to proper source file, you get a link to the mirroring system as when the uploaded tar to KDE FTP server has been processed. The sources of the web page can be checked out from <tt>svn+ssh://[email protected]/home/kde/trunk/www/sites/kphotoalbum</tt> via svn.
KPhotoAlbum will run on most 64-bit Linux distributions and desktop environments, like:


<!--T:57-->
<!--T:107-->
* Publish the release information (KPA's web site, mailing lists, distributor's bugtracking system, social media etc.).</translate>
* KDE Plasma (on QT6)
 
<!--T:108-->
* XFCE
 
<!--T:109-->
* Gnome
 
<!--T:110-->
<br />
Required dependencies will normally be installed by the package manager during installation:
 
<!--T:128-->
* libkdcraw
* marble-common
* exiv2
* purpose
* perl
* ktextwidgets
</translate>
<translate>
<translate>
<!--T:58-->
 
** Don't forget to post on the kde-distro-packagers mailing list, and make sure to mention any changes in dependencies.</translate>
== News about releases, fixes, improvements == <!--T:111-->
 
<!--T:112-->
The team publish news about development at the KPhotoAlbum [https://www.kphotoalbum.org/news/ news blog].
</translate>
 
<translate>
<translate>
<!--T:59-->
<!--T:129-->
** Update the latest version on top of this page.</translate>
== Contribute ==
KPhotoAlbum is a KDE-project run by volunteers. A lot of diverse skills are needed to run a software project like this. If you would like to help out, you are very welcome.
</translate>
<translate>
<translate>
<!--T:60-->
* Create a video of the cool new features and publish it on Youtube. A nice tool for doing so is [http://recordmydesktop.sourceforge.net/ recordmydesktop]. If you uploaded such a video, don't forget to add it to the Videos page on the homepage (cf. the <tt>README_new_video.txt</tt> file).


<!--T:61-->
<!--T:130-->
* Notify people building the binary packages for different distributions
'''General info'''<br />
Please have a look at KDE's [https://community.kde.org/Get_Involved general information] about getting involved first.


=== Building a Release === <!--T:26-->
</translate>
<translate>
<!--T:131-->
'''Coding'''<br />
If you'd like to help coding have a look at our [https://www.kphotoalbum.org/get-involved/get-started/ "Get involved"] site, and our [https://phabricator.kde.org/project/view/255/ our phabricator site] to get started.
</translate>
<translate>


<!--T:27-->
<!--T:132-->
Building a snapshot tar ball is rather straight forward. Install the releaseme building tool and run a command to generate the source package.
'''Maintain documentation'''<br />
If you'd like to help maintain our webpages the [https://wiki.kde.org/ KDE Wiki site] is a good place to start.<br />


<!--T:28-->
<!--T:133-->
{{Input|1=<nowiki>git clone git://anongit.kde.org/releaseme
Start [https://l10n.kde.org/docs/doc-primer/index.html here] to learn about maintaining manuals and other documents.
cd releaseme</nowiki>}}
</translate>
To create the source package, run e. g.:
<translate>
{{Input|1=<nowiki>./tarme.rb --origin trunk --version 5.1 kphotoalbum</nowiki>}}


=== GIT Branches === <!--T:47-->
<!--T:134-->
If you feel uncertain about getting involved, please [https://www.kphotoalbum.org/user-support/communication/ ask] any questions you may have.
</translate>
<translate>


<!--T:48-->
<!--T:135-->
* ''master'' ([https://build.kde.org/job/kphotoalbum%20master%20kf5-qt5/PLATFORM=Linux,compiler=gcc build status])<br />Current development branch
'''Suggest improvements and ideas'''<br />
* ''4.7''<br />Old stable (Qt4/Plasma4) branch. Only gets fixes for serious bugs on a case-by-case basis.
Please [https://bugs.kde.org report] your suggestions.<br />
* ''5.x''<br />Branch tracked by [https://community.kde.org/Neon/Builder#The_Packaging Neon/stable].<br />When ''master'' is in stable condition, it should be synced to ''5.x'': {{Input|1=<nowiki>git checkout 5.x ; git merge master</nowiki>}}
You're also welcome to discuss your ideas with the team on one of the [https://www.kphotoalbum.org/user-support/communication/ communication channels].
* Feature branches are used in a very ad-hoc manner. If you are not a developer, don't bother with them.<br />If you are a developer, try using descriptive names that are not likely to interfere with future branches.
</translate>


== Known Bugs and feature requests == <!--T:17-->
<translate>
<!--T:71-->
== Directions ==
Sources with more info on KPhotoAlbum, its license, KDE and much more:
</translate>
<translate>


<!--T:18-->
<!--T:136-->
See the list of [https://bugs.kde.org/enter_bug.cgi?product=kphotoalbum|Known Bugs] and workarounds in KPhotoAlbum.
* [https://kde.org/ KDE Community]
 
* [https://docs.kde.org/trunk5/en/extragear-graphics/kphotoalbum/index.html KDE official documentation]
<!--T:20-->
* [https://www.kphotoalbum.org/ KPhotoAlbum homepage]
Please use [https://bugs.kde.org/enter_bug.cgi?product=kphotoalbum|bugs.kde.org] marking the report as a "Wish".
* [https://www.kphotoalbum.org/news KPhotoAlbum news]
* [https://apps.kde.org/kphotoalbum/ KPhotoAlbum on apps.kde.org]
* [https://en.wikipedia.org/wiki/KPhotoAlbum Wikipedia article]
* [https://phabricator.kde.org/project/view/255/ KPhotoAlbum phabricator project]
* [https://phabricator.kde.org/source/kphotoalbum/ KPhotoAlbum git repository]
</translate>
<translate>


=== New Ideas for Future Versions === <!--T:23-->
== How it started == <!--T:137-->


<!--T:24-->
<!--T:113-->
If you have a new idea for KPhotoAlbum and think that [https://bugs.kde.org/ bugs.kde.org] is not the right place for it, use one of the [https://www.kphotoalbum.org/communication/ communication channels] listed on the pages.
In 2003 Jesper Pedersen entered the [https://commits.kde.org/kphotoalbum/d42ff3603a292741758024f58774585caef12e27 first commit] of KimDaBa ('''K''' '''im'''age '''Da'''ta '''Ba'''se) which he had started as a personal project.<br />
By version 2 KimDaBa was renamed to KPhotoAlbum.<br />
Throughout the years KPhotoAlbum has evolved into a modern photo-management application, through a steady series of releases introducing new features, improvements and bug fixes.<br />
Find more details on KPhotoAlbum's backstory on the KPhotoAlbum [https://www.kphotoalbum.org/news/ news page].


<!--T:25-->
<!--T:25-->
[[Category:Graphics]]
[[Category:Graphics]]
</translate>
</translate>

Latest revision as of 17:29, 26 August 2025

Other languages:


Home » Applications » Graphics » KPhotoAlbum


Use KPhotoAlbum to catalogue, select, view and share images and videos.

KPhotoAlbum is software to catalogue images and videos, supporting customizable and extensive annotation.
Within annotated collections KPhotoAlbum helps you to swiftly select individual images or subsets of images to view or share them.

Main features

  • Catalogue: annotate images and videos with any combination of labels, categories, date ranges and tokens
  • Select and view: select images by any combination of labels, categories, date ranges and tokens and view the resulting subset
  • Show and share: show selected images in a slideshow, create HTML pages with them, or export them for others to import them

KPhotoAlbum supports all the normal image and video formats including raw formats produced by most digital cameras and scanners. It is also possible to use the thumbnails embedded in raw images.

Get and install

Source packages, binaries for various distributions, and snapshots are available at the project Download page.

Installation Instructions

If you need help to install KPhotoAlbum, look at this tutorial about how to install KDE software.


Use KDE Neon to try out the newest version of KPhotoAlbum. Neon contains the latest development version of KPhotoAlbum, built fresh from the source.


Explore

Explore KPhotoAlbum by reading the documentation or by starting KPhotoAlbum in demo-mode.

Documentation

Several types of documentation exist:


Demo-mode

Demo-mode loads a number of already annotated stock images for you to browse and view, and to annotate yourself. All KPhotoAlbum functionalities are working. Shutting down KPhotoAlbum you may retain or discard any changes you've made during demo-mode.

Start demo-mode:

  • At first start accept KPhotoAlbum's offer to run in demo-mode.
  • In KPhotoAlbum click Help, then Run KPhotoAlbum demo
  • Start KPhotoAlbum with the --demo switch on the commandline.

Note

If you choose to explore KPhotoAlbum using your own images, KPhotoAlbum will ask for the folder containing your images. Please note that KPhotoAlbum currently supports only one root folder: it will find the images in this folder and any sub-folders it may contain.
See FAQ for more information.

Requirements

KPhotoAlbum will run conveniently on most computers:

  • PC's from 2015 or newer, with
  • 8 Gb of RAM

KPhotoAlbum will run on most 64-bit Linux distributions and desktop environments, like:

  • KDE Plasma (on QT6)
  • XFCE
  • Gnome


Required dependencies will normally be installed by the package manager during installation:

  • libkdcraw
  • marble-common
  • exiv2
  • purpose
  • perl
  • ktextwidgets

News about releases, fixes, improvements

The team publish news about development at the KPhotoAlbum news blog.

Contribute

KPhotoAlbum is a KDE-project run by volunteers. A lot of diverse skills are needed to run a software project like this. If you would like to help out, you are very welcome.

General info
Please have a look at KDE's general information about getting involved first.

Coding
If you'd like to help coding have a look at our "Get involved" site, and our our phabricator site to get started.

Maintain documentation
If you'd like to help maintain our webpages the KDE Wiki site is a good place to start.

Start here to learn about maintaining manuals and other documents.

If you feel uncertain about getting involved, please ask any questions you may have.

Suggest improvements and ideas
Please report your suggestions.
You're also welcome to discuss your ideas with the team on one of the communication channels.

Directions

Sources with more info on KPhotoAlbum, its license, KDE and much more:

How it started

In 2003 Jesper Pedersen entered the first commit of KimDaBa (K image Data Base) which he had started as a personal project.
By version 2 KimDaBa was renamed to KPhotoAlbum.
Throughout the years KPhotoAlbum has evolved into a modern photo-management application, through a steady series of releases introducing new features, improvements and bug fixes.
Find more details on KPhotoAlbum's backstory on the KPhotoAlbum news page.

Retrieved from "https://userbase.kde.org/index.php?title=KPhotoAlbum&oldid=498214"