Re: New generation of digiKam user manual is online...

Please see in-line comments.

Don

On 1/4/2023 2:06 AM, Gilles Caulier
wrote:

Le mer. 4 janv. 2023 à 08:03, Gilles Caulier
<[email protected]> a écrit :

Le mer. 4 janv. 2023 à 02:30, 7mgte <[email protected]> a écrit :

Gilles,

Two comments:

The first note on the Database Settings page ( » Setup Application » Database Settings ; https://docs.digikam.org/en/setup_application/database_settings.html ) refers the user to the section "Introduction of digiKam Databases" for information regarding internal storage.

Is the a way to put a hot link to take the user to the page?

To put a hot link between what and what ?

The reference to "Introduction of digiKam Databases" is in the
"Note" block located at the top of
https://docs.digikam.org/en/setup_application/database_settings.html .
The note refers the reader to "Introduction of digiKam
Databases". If the section "Introduction of digiKam Databases"
exists, a link in the note block would be helpful. If the
section "Introduction of digiKam Databases" does not exist, then
the note block at the top of
https://docs.digikam.org/en/setup_application/database_settings.html
should be reviewed and reworded or deleted.

Looking through the document, the only sections I found related to databases were '» Getting started » Database' and '» Maintenance Tools » Database Cleaning'. Neither provided much in the way of details about the structure of internal storage. Did I miss something?

Well, with this one:

https://docs.digikam.org/en/setup_application/database_settings.html

... all is explained in detail.

In all cases, the documentation will be improved. Now as the
ReStructuredText is so far more simpler than the DocBook dinosaur, it
will be faster to provide mature documentation.

https://docs.digikam.org/en/setup_application/database_settings.html
is the page with the note referring to "Introduction of digiKam
Databases". If the note does indeed refer to the page on which
the note itself is located, then it is not needed.

Does Sphinx/RestructuredText/DocUtils have any provision for directly generating an Adobe PDF file? If so, that would be a nice option for downloading.

yes, it can but not natively. In fact, in background, to convert to
another format, Latex is used somewhere...

By default EPUB is proposed de facto, not PDF. It's in my TODO list to
add PDF target in the CI/CD

Fantastic!

The Sphinx way to generate PDF is very limited. It's due to use Latex
in background. you can use Calibre to convert EPUB to PDF. I add a
section in at end of README file:

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

Best

Gilles Caulier