Bug 242630 - Write online documentation sections based on Sphinx/ReStructuredText for more Post-Processing tools, as Panorama, Calendar, OCRTextConverter, etc.
Summary: Write online documentation sections based on Sphinx/ReStructuredText for more...
Status: RESOLVED FIXED
Alias: None
Product: digikam
Classification: Applications
Component: Documentation (show other bugs)
Version: 8.0.0
Platform: openSUSE Linux
: NOR wishlist
Target Milestone: ---
Assignee: Digikam Developers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-06-23 21:29 UTC by Christopher Yeleighton
Modified: 2023-02-15 18:04 UTC (History)
3 users (show)

See Also:
Latest Commit:
Version Fixed In: 8.0.0
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Christopher Yeleighton 2010-06-23 21:29:20 UTC
Version:           0.6.0 (using KDE 4.3.5) 
OS:                Linux

KHelpCenter is unable to show the manual for MetadataEdit because it is missing.

Reproducible: Always

Steps to Reproduce:
1. Tell Gwenview to open the image "P1170553.JPG".
2. Tell the metadata editor to edit XMP data.
3. Tell the metadata editor to show the manual.

Actual Results:  
3. KHelpCenter displays an error message: Manual not found.

Expected Results:  
3. A manual for MetadataEdit.

OS: Linux (x86_64) release 2.6.31.12-0.2-desktop
Compiler: gcc
Sample image: <URL:http://bugsfiles.kde.org/attachment.cgi?id=48271>
Comment 1 caulier.gilles 2010-06-23 23:26:02 UTC
Just install right kipi-plugins handbook package. It's a separate one...

Gilles Caulier
Comment 2 Burkhard Lück 2010-06-24 09:49:55 UTC
@Gilles:
The handbook says:
"The Kipi Metadata editor plugin is a tool for adding and editing GPS coordinates of the photo metadata."

Hmm, I see nothing wrt GPS in these dialogs, but a very incomplete documentation...
Comment 3 Christopher Yeleighton 2010-09-15 03:54:35 UTC
I installed the documentation package and bumped into this:

3. The Kipi plugin “Metadata Editor” currently has no documentation.

So it seems I was at least partially right.
Comment 4 Christopher Yeleighton 2010-09-15 05:06:30 UTC
Also:

The Kipi home page [1] says:
The current kipi plugins handbook from SVN can be consulted here [2].
The handbook is empty, although I found the sources at the SVN [5].
And the SVN itself [3] is nearly empty.  The code is at the SVN [4] instead.

TO DO:
1. Publish the documentation.
2. Update the home page.

Please fix.

_
[1] <URL:http://extragear.kde.org/apps/kipi/#documentation>
[2] <URL:http://docs.kde.org/development/en/extragear-libs/kipi-plugins/index.html>
[3] <URL:http://websvn.kde.org/trunk/extragear/libs/>
[4] <URL:http://websvn.kde.org/trunk/extragear/graphics/kipi-plugins/>
[5] <URL:http://websvn.kde.org/trunk/extragear/graphics/doc/kipi-plugins/>
Comment 5 caulier.gilles 2016-08-27 09:47:30 UTC
Al kipi tool handbook was migrated to digiKam handbook.

The MetadataEditor tool section was created but still empty. We need a contributor here.

For more details, see bug #238802

Gilles Caulier
Comment 6 caulier.gilles 2016-08-27 15:03:02 UTC
Git commit 5f225eca1dc2d75e8c9044b682cc10428e832b14 by Gilles Caulier.
Committed on 27/08/2016 at 15:01.
Pushed by cgilles into branch 'master'.

implement metadata editor section for digiKam and Showfoto
FIXED-IN: 5.2.0

M  +4    -3    README
M  +1    -1    TODO
A  +-    --    digikam/tool-metadataeditor-exif.png
A  +-    --    digikam/tool-metadataeditor-xmp.png
M  +35   -1    digikam/tool-metadataeditor.docbook
A  +28   -0    project/optpng.sh

http://commits.kde.org/digikam-doc/5f225eca1dc2d75e8c9044b682cc10428e832b14
Comment 7 Christopher Yeleighton 2023-01-22 09:36:07 UTC
When I tell showFoto to show handbook, it opens a Web page with the following information:

> The application showfoto could not be found.
> Please check if you entered the name correctly,
> or use the navigation on the left
>  to access the complete KDE User Documentation.
Comment 8 caulier.gilles 2023-01-22 09:53:55 UTC
This problem is fixed in next 7.10.0 pre-release available here :

https://files.kde.org/digikam/

...and accessing to online handbook point to the root page : https://docs.digikam.org/en/index.html

...which is the new version based on Sphinx/ReStructuredText. Older handbook based on DocBook do not exists anymore...

With the next major version 8.0.0, all places where documentation can be called will point on dedicated and contextual location in the manual.

For ex, when you use a plugin, a button is avaialble to open doc, and it will show the plugin help online.

Best

Gilles Caulier
Comment 9 caulier.gilles 2023-01-22 09:54:48 UTC
Not all is already implemented. It listed in TODO file here :

https://invent.kde.org/documentation/digikam-doc/-/blob/master/TODO

Gilles Caulier
Comment 10 Christopher Yeleighton 2023-01-23 12:19:49 UTC
(In reply to caulier.gilles from comment #8)
> This problem is fixed in next 7.10.0 pre-release available here :
> 
> https://files.kde.org/digikam/

It crashes for me.

Starting program: /tmp/squashfs-root/usr/bin/digikam 
Thread 1 "digikam" received signal SIGSEGV, Segmentation fault.
__strlen_sse2 () at ../sysdeps/x86_64/multiarch/strlen-sse2.S:142
#1  0x00007ffff25354f0 in QByteArray::QByteArray(char const*, int) () from /tmp/squashfs-root/usr/lib/libQt5Core.so.5
#5  0x00007fffbec3ea22 in QXcbIntegration::createPlatformOpenGLContext(QOpenGLContext*) const () from /tmp/squashfs-root/usr/lib/libQt5XcbQpa.so.5
Comment 11 caulier.gilles 2023-01-23 13:06:11 UTC
Did you run the AppImage ? Which host operating system ? Can you run appimage with "debug" argument from command line ?

Gilles Caulier
Comment 12 Christopher Yeleighton 2023-01-23 13:33:29 UTC
(In reply to caulier.gilles from comment #11)
> Did you run the AppImage ?
Yes, I did.

> Which host operating system ?
openSUSE Tumbleweed 20230119

> Can you run appimage with "debug" argument from command line ?
Yes, I can.
Comment 13 caulier.gilles 2023-01-23 13:41:24 UTC
> Can you run appimage with "debug" argument from command line ?
Yes, I can.

==> and what's the result ??? Follow instructions here :

https://www.digikam.org/contribute/

Gilles Caulier
Comment 14 Christopher Yeleighton 2023-01-23 14:00:02 UTC
(In reply to caulier.gilles from comment #13)
> > Can you run appimage with "debug" argument from command line ?
> Yes, I can.
> 
> ==> and what's the result ???

#0  __strlen_sse2 () at ../sysdeps/x86_64/multiarch/strlen-sse2.S:142
#1  0x00007ffff25354f0 in QByteArray::QByteArray(char const*, int) () from /tmp/.mount_digiKaijs3Y1/usr/lib/libQt5Core.so.5
#2  0x00007fffbac09175 in ?? () from /tmp/.mount_digiKaijs3Y1/usr/plugins/xcbglintegrations/libqxcb-glx-integration.so
#3  0x00007fffbac0a654 in ?? () from /tmp/.mount_digiKaijs3Y1/usr/plugins/xcbglintegrations/libqxcb-glx-integration.so
#4  0x00007fffbac07ee7 in ?? () from /tmp/.mount_digiKaijs3Y1/usr/plugins/xcbglintegrations/libqxcb-glx-integration.so
#5  0x00007fffbec3ea22 in QXcbIntegration::createPlatformOpenGLContext(QOpenGLContext*) const () from /tmp/.mount_digiKaijs3Y1/usr/lib/libQt5XcbQpa.so.5
#6  0x00007ffff2f67b8f in QOpenGLContext::create() () from /tmp/.mount_digiKaijs3Y1/usr/lib/libQt5Gui.so.5
#7  0x00007fffe2720f1e in QtWebEngineCore::initialize() () from /tmp/.mount_digiKaijs3Y1/usr/lib/libQt5WebEngineCore.so.5
#8  0x00007ffff26d96a7 in QCoreApplicationPrivate::init() () from /tmp/.mount_digiKaijs3Y1/usr/lib/libQt5Core.so.5
#9  0x00007ffff2f1bb0f in QGuiApplicationPrivate::init() () from /tmp/.mount_digiKaijs3Y1/usr/lib/libQt5Gui.so.5
#10 0x00007ffff3963849 in QApplicationPrivate::init() () from /tmp/.mount_digiKaijs3Y1/usr/lib/libQt5Widgets.so.5
#11 0x0000555555404683 in main (argc=<optimized out>, argv=0x7fffffffc908) at /b/qt5-maintenance/dktemp/digikam-qt5-maintenance/core/app/main/main.cpp:136
Comment 15 caulier.gilles 2023-01-23 14:11:42 UTC
It crash in Qt plugin to handle XCB X11 extension. Did you use X11 or Wayland ? Do you have XCB extension enabled ?
Comment 16 Christopher Yeleighton 2023-01-23 14:40:12 UTC
(In reply to caulier.gilles from comment #15)
> It crash in Qt plugin to handle XCB X11 extension. Did you use X11 or
> Wayland ?

X11

> Do you have XCB extension enabled ?

I do not think so.
Comment 17 caulier.gilles 2023-01-23 14:49:04 UTC
From a command line xdpyinfo can help to know which X11 extension are present.
Look on start of this command report.
Comment 18 Christopher Yeleighton 2023-01-23 15:45:21 UTC
(In reply to caulier.gilles from comment #17)
> From a command line xdpyinfo can help to know which X11 extension are
> present.
> Look on start of this command report.

I have had a look at the System Information Centre.
Comment 19 caulier.gilles 2023-01-23 15:54:15 UTC
MAik,

You use openSUSE ? If yes, can you reproduce the problem ?

Gilles
Comment 20 Maik Qualmann 2023-01-23 18:35:55 UTC
Yes, I can reproduce with the AppImage digiKam-7.10.0
The AppImage digiKam-8.0.0-Beta1, on the other hand, starts without any problems.
digiKam-7.10.0 crashes in QWebEngine when initializing OpenGL context.

#0  0x00007ffff1eb678a in __strlen_sse2 () from /lib64/libc.so.6
#1  0x00007ffff25354f0 in QByteArray::QByteArray(char const*, int) () from /tmp/.mount_digiKaz5ZVgy/usr/lib/libQt5Core.so.5
#2  0x00007fffbac09175 in ?? () from /tmp/.mount_digiKaz5ZVgy/usr/plugins/xcbglintegrations/libqxcb-glx-integration.so
#3  0x00007fffbac0a654 in ?? () from /tmp/.mount_digiKaz5ZVgy/usr/plugins/xcbglintegrations/libqxcb-glx-integration.so
#4  0x00007fffbac07ee7 in ?? () from /tmp/.mount_digiKaz5ZVgy/usr/plugins/xcbglintegrations/libqxcb-glx-integration.so
#5  0x00007fffbec3ea22 in QXcbIntegration::createPlatformOpenGLContext(QOpenGLContext*) const () from /tmp/.mount_digiKaz5ZVgy/usr/lib/libQt5XcbQpa.so.5
#6  0x00007ffff2f67b8f in QOpenGLContext::create() () from /tmp/.mount_digiKaz5ZVgy/usr/lib/libQt5Gui.so.5
#7  0x00007fffe2720f1e in QtWebEngineCore::initialize() () from /tmp/.mount_digiKaz5ZVgy/usr/lib/libQt5WebEngineCore.so.5
#8  0x00007ffff26d96a7 in QCoreApplicationPrivate::init() () from /tmp/.mount_digiKaz5ZVgy/usr/lib/libQt5Core.so.5
#9  0x00007ffff2f1bb0f in QGuiApplicationPrivate::init() () from /tmp/.mount_digiKaz5ZVgy/usr/lib/libQt5Gui.so.5
#10 0x00007ffff3963849 in QApplicationPrivate::init() () from /tmp/.mount_digiKaz5ZVgy/usr/lib/libQt5Widgets.so.5

Maik
Comment 21 Maik Qualmann 2023-01-23 18:39:31 UTC
You have to keep in mind that openSUSE Tumbleweed is a rolling release and very up to date. That can change at any time. I know that a few weeks ago digiKam-7.10.0 started here. I also think that the AppImage is not really the target for this platform, when digiKam-7.10.0 comes out it will be available here few days later.

Maik
Comment 22 caulier.gilles 2023-01-24 09:59:43 UTC
Maik,

Please take a look to the Time Adjust section from the document to see if all is fine for you and if i don't forget something :

https://docs.digikam.org/en/post_processing/time_adjust.html

Gilles
Comment 23 Maik Qualmann 2023-01-24 11:33:25 UTC
Hi Gilles,

The Time Adjust doc is very fine, everything is documented.

Maik
Comment 24 caulier.gilles 2023-01-31 04:10:03 UTC
Git commit 36f38d3efd152622c094ebdc10687ee8bab97099 by Gilles Caulier.
Committed on 31/01/2023 at 04:06.
Pushed by cgilles into branch 'master'.

Review Print Creator

M  +1    -1    TODO
M  +160  -8    post_processing/print_creator.rst

https://invent.kde.org/documentation/digikam-doc/commit/36f38d3efd152622c094ebdc10687ee8bab97099
Comment 25 caulier.gilles 2023-01-31 10:58:44 UTC
HTML Gallery online documentation is done:

https://docs.digikam.org/en/post_processing/html_gallery.html#creating-a-new-theme

Gilles Caulier
Comment 26 caulier.gilles 2023-02-15 18:04:52 UTC
Git commit 4ac8dd9f89de669f2807d10f9524c69f74cba620 by Gilles Caulier.
Committed on 15/02/2023 at 18:03.
Pushed by cgilles into branch 'master'.

All post processing tools are now documented online: https://docs.digikam.org/en/post_processing.html
FIXED-IN: 8.0.0

M  +1    -1    TODO

https://invent.kde.org/documentation/digikam-doc/commit/4ac8dd9f89de669f2807d10f9524c69f74cba620