TDE base libraries and programs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Michele Calgaro 08d0bb03c0
Removed code formatting modelines.
2 months ago
..
htmlsearch Desktop file translations: 5 months ago
pics Fix invalid headers in PNG files and optimize for size 4 years ago
plugins Desktop file translations: 5 months ago
searchhandlers Desktop file translations: 5 months ago
CMakeL10n.txt Desktop file translations: 5 months ago
CMakeLists.txt Desktop file translations: 5 months ago
COPYING Revert automated changes 10 years ago
DESIGN Removed code formatting modelines. 2 months ago
Help.desktop Desktop file translations: 5 months ago
Makefile.am LIB_QT -> LIB_TQT conversion to align to updated admin module 2 years ago
README.htdig Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. 11 years ago
README.metadata Fixed wrong DocPath strings. This relates to bug 2319. 5 years ago
application.cpp Removed code formatting modelines. 2 months ago
application.h Removed code formatting modelines. 2 months ago
configure.in.in Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. 11 years ago
docentry.cpp Removed code formatting modelines. 2 months ago
docentry.h Removed code formatting modelines. 2 months ago
docentrytraverser.cpp Removed code formatting modelines. 2 months ago
docentrytraverser.h Removed code formatting modelines. 2 months ago
docmetainfo.cpp Removed code formatting modelines. 2 months ago
docmetainfo.h Removed code formatting modelines. 2 months ago
fontdialog.cpp Removed code formatting modelines. 2 months ago
fontdialog.h Removed code formatting modelines. 2 months ago
formatter.cpp Removed code formatting modelines. 2 months ago
formatter.h Removed code formatting modelines. 2 months ago
glossary.cpp Removed code formatting modelines. 2 months ago
glossary.h Removed code formatting modelines. 2 months ago
glossary.html.in Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. 11 years ago
glossary.xslt Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. 11 years ago
history.cpp Removed code formatting modelines. 2 months ago
history.h Removed code formatting modelines. 2 months ago
htmlsearch.cpp Removed code formatting modelines. 2 months ago
htmlsearch.h Removed code formatting modelines. 2 months ago
htmlsearchconfig.cpp Removed code formatting modelines. 2 months ago
htmlsearchconfig.h Removed code formatting modelines. 2 months ago
index.html.in Update files and references in support of bug report 1446. 7 years ago
infotree.cpp Removed code formatting modelines. 2 months ago
infotree.h Removed code formatting modelines. 2 months ago
intro.html.in Update help handbooks. 8 years ago
kcmhelpcenter.cpp Removed code formatting modelines. 2 months ago
kcmhelpcenter.desktop Desktop file translations: 5 months ago
kcmhelpcenter.h Removed code formatting modelines. 2 months ago
khc_indexbuilder.cpp Removed code formatting modelines. 2 months ago
khc_indexbuilder.h Removed code formatting modelines. 2 months ago
khelpcenter.desktop Desktop file translations: 5 months ago
khelpcenter.kcfg Rename KGlobal, KProcess, and KClipboard to avoid conflicts with KDE4 7 years ago
khelpcenterui.rc Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. 11 years ago
mainwindow.cpp Removed code formatting modelines. 2 months ago
mainwindow.h Removed code formatting modelines. 2 months ago
navigator.cpp Removed code formatting modelines. 2 months ago
navigator.h Removed code formatting modelines. 2 months ago
navigatorappitem.cpp Removed code formatting modelines. 2 months ago
navigatorappitem.h Removed code formatting modelines. 2 months ago
navigatoritem.cpp Removed code formatting modelines. 2 months ago
navigatoritem.h Removed code formatting modelines. 2 months ago
plugintraverser.cpp Removed code formatting modelines. 2 months ago
plugintraverser.h Removed code formatting modelines. 2 months ago
prefs.kcfgc Rename a number of libraries and executables to avoid conflicts with KDE4 7 years ago
scopeitem.h Removed code formatting modelines. 2 months ago
scrollkeepertreebuilder.cpp Removed code formatting modelines. 2 months ago
scrollkeepertreebuilder.h Removed code formatting modelines. 2 months ago
searchengine.cpp Removed code formatting modelines. 2 months ago
searchengine.h Removed code formatting modelines. 2 months ago
searchhandler.cpp Rename additional header files to avoid conflicts with KDE4 7 years ago
searchhandler.h Rename KCModule, KConfig, KIO, KServer, and KSocket to avoid conflicts with KDE4 7 years ago
searchwidget.cpp Removed code formatting modelines. 2 months ago
searchwidget.h Removed code formatting modelines. 2 months ago
table-of-contents.xslt Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. 11 years ago
testmetainfo.cpp Removed code formatting modelines. 2 months ago
toc.cpp Removed code formatting modelines. 2 months ago
toc.h Removed code formatting modelines. 2 months ago
treebuilder.cpp Removed code formatting modelines. 2 months ago
treebuilder.h Removed code formatting modelines. 2 months ago
version.h Removed code formatting modelines. 2 months ago
view.cpp Removed code formatting modelines. 2 months ago
view.h Removed code formatting modelines. 2 months ago

README.metadata

KHelpCenter documentation meta data structure
=============================================

KHelpCenter uses meta data files which describe the documentation available in
the system. Each document is represented by a meta data file and shown as an
entry in the KHelpCenter navigation tree view. The meta data contains
information about title and short description of the document, the location of
the document and some more information like how to search the document and
translations of title and description. Document hierarchy is represented as
hierarchy of the meta data files. Directories are also described by a meta data
file which contains the same information as a document meta data file.

Format of the meta data files
-----------------------------

The meta files adhere to the Desktop Entry Standard
(http://www.freedesktop.org/Standards/desktop-entry-spec). Documentation
specific extensions are covered by an own namespace using the prefix "X-DOC-".
The following table describes all keys which are currently used by
KHelpCenter:

Key Value Description

Name string Title of document
Name[xx] string Translated title for language xx
Comment string Short description of document
Comment[xx] string Translated short description for
Language xx
Icon string Name of icon for document
X-DocPath URI Location of document. In addition to the
standard URI schemes like http: and file:
all schemes which are supported through
tdeioslaves can be used. In particular the
following non-standard URI schemes are
supported:
help: KDE manual identified by app name
ghelp: GNOME manual identified by app name
man: man page
info: info page
cgi: output of CGI script
X-DocPath[xx] URI Language specific location for
language xx
Lang langcode Language of document
X-DOC-Identifier string Unique identifier for document, if this
entry is not present the base name of the
file is used as identifier
X-DOC-Indexer command Command used for creating a search index
for the document.
The following symbols are replaced by the
corresponding values:
%f - Filename
X-DOC-IndexTestFile filename Name of file whose existence indicates
the existence of a usable search index
X-DOC-Search command Command used for searching, the output
of the command should be HTML which is
shown in KHelpCenter.
The following symbols in the command are
replaced by the corresponding values:
%k - Words to be searched for
%n - Maximum number of results
%m - Method for combining search words,
can be 'and' or 'or'
%l - Language of documents to be searched
%s - Scope of search. This is a list of
identifiers as given by the
X-DOC-Identifier entry or the bas
name of the desktop file if not
present.
X-DOC-SearchMethod string If this entry is 'htdig' htdig is used to
index and search the document. The
Indexer, IndexTestFile and Search entries
aren't required in this case.
X-DOC-SearchEnabledDefault bool If set to 'true' the document is searched
by default, if set to 'false' it is not.
This setting is overridden by user
selected search scopes.
X-DOC-Weight int A number indicating the position of the
document within the list of siblings. A
greater weight indicates that the document
is 'heavier', thus shown below 'lighter'
documents. The default weight is 0.
X-TDE-KHelpcenter string If this entry is set to one of the
following values a set of documents
generated by other means than desktop file
meta info is inserted at the place
specified by the desktop file:
'apps' manuals of applications
from the start menu
'scrollkeeper' scrollkeeper docs
'applets' panel applet docs
'kcontrol' kcontrol module docs
'konqueror' konqueror plugin docs
'tdeioslave' tdeioslave docs
'info' info pages
X-DOC-DocumentType string Type of document. The type is used to look
up corresponding search handlers.

Meta File Location
------------------

A list of directories given by the config entry "MetaInfoDirs" in the "General"
group of the help center configuration file "khelpcenterrc" (at
$TDEDIRS/share/config) is scanned for desktop files. They are merged to a common
hierarchy. If the "MetaInfoDirs" entry is empty the directory at
$TDEDIRS/share/apps/khelpcenter/plugins is used.

Document Hierarchy
------------------

The hierarchy of the documents shown in the help center is reflected by the
hierarchy of the desktop files in the filesystem. Directories can have an
associated desktop file with the name ".directory". It can contain all the
keys described above.

Language handling
-----------------

In addition to translation of meta information like title and short description
of documents which is contained in the meta file, translations of whole
documents are handled. Each translation of a document has an own desktop file.
The language of the document is indicated by adding the language code as
additional suffix to the the filename of the desktop file. The language suffix
is added before the ".desktop" suffix (Example: 'apache.de.desktop' would be the
file name for the german translation of the apache documentation).

KHelpCenter shows only the documents whose language is contained in the list of
used languages configured for the desktop in the control center. A document
corresponding to a desktop file without language suffix is always shown.