This forum has been archived. All content is frozen. Please use KDE Discuss instead.

Questions About Adding Documentation to KDE Help

Tags: None
(comma "," separated)
User avatar
FrankW
Registered Member
Posts
11
Karma
0
OS
Good morning to all,

I believe this is the correct location for my post. If it is not, I'm certain one of the moderators will be kind enough to place it where it is better suited.

I am using Kubuntu 17.04 with no modifications to the distribution that I downloaded from KDE.

This morning, I had questions about Amarok, so I referred to KDE's Help utility only to find there was no documentation for Amarok there. I was able to find documentation online, albeit for a slightly older version of Amarok, but very satisfactory for my purposes. I was able to download the documentation as a PDF file and now I would like to incorporate it into KDE Help, but just on my computer (for now, anyway).

Either documentation for adding to KDE Help is very sparse or my ability to choose good search parameters this morning need help! So far, I get that the file must be in .xml format, which I can accomplish, but the nitty-gritty about integrating the information into KDE help escapes me at present. Thus, I am asking the community for some guidance and instruction on how to proceed. I tried to reason out where the documentation used by KDE Help is stored locally, but I was not successful (granted, I did not spend a large amount of time trying either). I began looking in the usr/share directory of root, although it is conceivable that it might be found in /usr/local. On the other hand, my suppositions could be completely off and they may be elsewhere. Long story short, I do not know and I am still new enough that I have not learned the heirarchical conventions for files in Umbuntu/Kumbuntu.

Surely there are some people well versed in the intracacies of KDE/Plasma and Umbuntu/Kumbuntu who would be willing to teach an eager pupil what they know! 8-)

Thanks!


Precision T-5400 -- 2 - Quad Core Xeon @ 3.16GHz 20 GB RAM NVIDIA GeForce 210 1GB DRAM - Using X.org X server Nouveau driver

Kubuntu 17.04 - KDE Plasma 5.94
lueck
Mentor
Posts
225
Karma
2
https://docs.kde.org/trunk5/en/framewor ... index.html

"If the application is KDE software, start by searching the KDE Documentation site for the requested documentation. If you find the documentation on that site, your distribution might ship a separate package for documentation (e.g. called plasma-doc for documentation related to Plasma™). Please use the package manager of your distribution to find and install the missing documentation."

$ apt-cache search amarok
amarok - easy to use media player based on the KDE Platform
amarok-common - architecture independent files for Amarok
amarok-dbg - debugging symbols for Amarok
amarok-doc - Amarok documentation (Handbook)
amarok-utils - utilities for Amarok media player

$sudo apt install amarok-doc
User avatar
FrankW
Registered Member
Posts
11
Karma
0
OS
Thank you very much lueck! ;D

While that was not the information I was seeking, it did solve the issue I am having very nicely! 8)

Frank


Precision T-5400 -- 2 - Quad Core Xeon @ 3.16GHz 20 GB RAM NVIDIA GeForce 210 1GB DRAM - Using X.org X server Nouveau driver

Kubuntu 17.04 - KDE Plasma 5.94


Bookmarks



Who is online

Registered users: bartoloni, Bing [Bot], Google [Bot], Yahoo [Bot]