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.
Slávek Banko b95b665c78
Add CMakeL10n rules.
5 months ago
..
htmlsearch Add CMakeL10n rules. Update TIMEZONES list. 5 months ago
pics Fix invalid headers in PNG files and optimize for size 2 years ago
plugins fix issue #10 6 months ago
searchhandlers Fix FTBFS on freebsd 4 years ago
CMakeL10n.txt Add CMakeL10n rules. Update TIMEZONES list. 5 months ago
CMakeLists.txt Removed unnecessary dependency on dbus-tqt and dbus-1-tqt 5 years ago
COPYING Revert automated changes Sorry guys, they are just not ready for prime time Work will continue as always 8 years ago
DESIGN Additional k => tde renaming and fixes 5 years ago
Help.desktop Fix ServiceTypes, ExcludeServiceTypes, and DocPath desktop file entries to match XDG specifications 4 years ago
Makefile.am LIB_QT -> LIB_TQT conversion to align to updated admin module 8 months ago
README.htdig Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 9 years ago
README.metadata Fixed wrong DocPath strings. This relates to bug 2319. 4 years ago
application.cpp Fix khelpcenter service group entry appearing when no child service items have documentation This relates to Bug 1968 Fix khelpcenter services showing tree expansion hints 4 years ago
application.h Update tdebase cmake files with STARTKDE->STARTTDE. Fix tdebase entities, text strings for future maintenance of handbook files. This partially resolves bug report 694. Update konqueror user agent strings. This partially resolves bug report 774. 7 years ago
configure.in.in Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 9 years ago
docentry.cpp Read from X-DocPath only 4 years ago
docentry.h Trinity Qt initial conversion 8 years ago
docentrytraverser.cpp Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 9 years ago
docentrytraverser.h Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 9 years ago
docmetainfo.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
docmetainfo.h Trinity Qt initial conversion 8 years ago
fontdialog.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
fontdialog.h Rename a number of classes to enhance compatibility with KDE4 6 years ago
formatter.cpp Change message "Main template file name is empty." from warning to debug level. If the template file is not specified, there is no need to alert the user. This resolves bug 1818. 5 years ago
formatter.h Trinity Qt initial conversion 8 years ago
glossary.cpp this relates to bug 2618 6 months ago
glossary.h Rename many classes and header files to avoid conflicts with KDE4 6 years ago
glossary.html.in Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 9 years ago
glossary.xslt Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 9 years ago
history.cpp Rename common header files for consistency with class renaming 6 years ago
history.h Rename a number of classes to enhance compatibility with KDE4 6 years ago
htmlsearch.cpp Rename a number of libraries and executables to avoid conflicts with KDE4 6 years ago
htmlsearch.h Rename KCModule, KConfig, KIO, KServer, and KSocket to avoid conflicts with KDE4 6 years ago
htmlsearchconfig.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
htmlsearchconfig.h Rename KCModule, KConfig, KIO, KServer, and KSocket to avoid conflicts with KDE4 6 years ago
index.html.in Update files and references in support of bug report 1446. 6 years ago
infotree.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
infotree.h Update tdebase cmake files with STARTKDE->STARTTDE. Fix tdebase entities, text strings for future maintenance of handbook files. This partially resolves bug report 694. Update konqueror user agent strings. This partially resolves bug report 774. 7 years ago
intro.html.in Update help handbooks. 6 years ago
kcmhelpcenter.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
kcmhelpcenter.desktop Fix remaining missing semicolons at end of Keywords strings 4 years ago
kcmhelpcenter.h Rename a number of classes to enhance compatibility with KDE4 6 years ago
khc_indexbuilder.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
khc_indexbuilder.h Rename KGlobal, KProcess, and KClipboard to avoid conflicts with KDE4 6 years ago
khelpcenter.desktop Fix ServiceTypes, ExcludeServiceTypes, and DocPath desktop file entries to match XDG specifications 4 years ago
khelpcenter.kcfg Rename KGlobal, KProcess, and KClipboard to avoid conflicts with KDE4 6 years ago
khelpcenterui.rc Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 9 years ago
mainwindow.cpp Revert remaining part of commit 687b146. This resolves bug 1850 and reopens bug 2188. 4 years ago
mainwindow.h Rename many classes and header files to avoid conflicts with KDE4 6 years ago
navigator.cpp Bring most mimetypes in line with XDG specifications. The following are not fully verified in source as of this commit due to ubiquity: html, empty, info, make, man, misc, source, unknown 4 years ago
navigator.h Rename many classes and header files to avoid conflicts with KDE4 6 years ago
navigatorappitem.cpp Read from X-DocPath only 4 years ago
navigatorappitem.h Sort non-root entries in KHelpCenter Make KHelpCenter entry sorting case-insensitive This resolves Bug 1849 4 years ago
navigatoritem.cpp Sort non-root entries in KHelpCenter Make KHelpCenter entry sorting case-insensitive This resolves Bug 1849 4 years ago
navigatoritem.h Sort non-root entries in KHelpCenter Make KHelpCenter entry sorting case-insensitive This resolves Bug 1849 4 years ago
plugintraverser.cpp Finish moving kinfocenter files to kcontrol. This partially resolves bug report 289. 5 years ago
plugintraverser.h Update tdebase cmake files with STARTKDE->STARTTDE. Fix tdebase entities, text strings for future maintenance of handbook files. This partially resolves bug report 694. Update konqueror user agent strings. This partially resolves bug report 774. 7 years ago
prefs.kcfgc Rename a number of libraries and executables to avoid conflicts with KDE4 6 years ago
scopeitem.h Enable compilation with TQt for Qt4 3.4.0 TP2 This should not break compatibility with TQt for Qt3; if it does please fix it ASAP! 8 years ago
scrollkeepertreebuilder.cpp Bring most mimetypes in line with XDG specifications. The following are not fully verified in source as of this commit due to ubiquity: html, empty, info, make, man, misc, source, unknown 4 years ago
scrollkeepertreebuilder.h Update tdebase cmake files with STARTKDE->STARTTDE. Fix tdebase entities, text strings for future maintenance of handbook files. This partially resolves bug report 694. Update konqueror user agent strings. This partially resolves bug report 774. 7 years ago
searchengine.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
searchengine.h Rename KHTML and kiobuffer 6 years ago
searchhandler.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
searchhandler.h Rename KCModule, KConfig, KIO, KServer, and KSocket to avoid conflicts with KDE4 6 years ago
searchwidget.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
searchwidget.h Rename KCModule, KConfig, KIO, KServer, and KSocket to avoid conflicts with KDE4 6 years ago
table-of-contents.xslt Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 9 years ago
testmetainfo.cpp Rename additional header files to avoid conflicts with KDE4 6 years ago
toc.cpp Bring most mimetypes in line with XDG specifications. The following are not fully verified in source as of this commit due to ubiquity: html, empty, info, make, man, misc, source, unknown 4 years ago
toc.h Rename KGlobal, KProcess, and KClipboard to avoid conflicts with KDE4 6 years ago
treebuilder.cpp Update tdebase cmake files with STARTKDE->STARTTDE. Fix tdebase entities, text strings for future maintenance of handbook files. This partially resolves bug report 694. Update konqueror user agent strings. This partially resolves bug report 774. 7 years ago
treebuilder.h Update tdebase cmake files with STARTKDE->STARTTDE. Fix tdebase entities, text strings for future maintenance of handbook files. This partially resolves bug report 694. Update konqueror user agent strings. This partially resolves bug report 774. 7 years ago
version.h Rename KDE_VERSION to TDE_VERSION 7 years ago
view.cpp this relates to bug 2618 6 months ago
view.h Rename a number of classes to enhance compatibility with KDE4 6 years 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.