[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-pim
Subject: [Kde-pim] documentation for systemsettings module kresources
From: Burkhard =?iso-8859-1?q?L=FCck?= <lueck () hube-lueck ! de>
Date: 2008-09-25 13:14:01
Message-ID: 200809251514.02253.lueck () hube-lueck ! de
[Download RAW message or body]
Hello,
Kdepimlibs is the only kde main module without a documentation for our
translators, time to change this ;-)
Kdepimlibs has a system settings module kresources, but without any
documentation so far.
Attached a patch with an outline of this documentation including all necessary
patches to the build system.
The main part of this documentation is a table with all available resources,
the applications using them and a link to their settings documentation.
Table 1. Available Resources
Resource Type Used by Additional Information
Alarms KAlarm?
Alarms ?
Calendar ?
Notes ?
Contacts KAddressBook KAddressBook's settings dialog
Contacts ?
I have added the data for Contacts + kaddressbook, but to finish the doc I
need your help.
Please give me all informations about the applications using a specific
resource.
--
Burkhard Lck
["kresources-doc.diff" (text/x-diff)]
Index: kdepimlibs/kresources/kresources.desktop
===================================================================
--- kdepimlibs/kresources/kresources.desktop (Revision 864578)
+++ kdepimlibs/kresources/kresources.desktop (Arbeitskopie)
@@ -6,6 +6,7 @@
X-KDE-Library=kcm_kresources
X-KDE-FactoryName=kcm_kresources
X-KDE-System-Settings-Parent-Category=advanced-user-settings
+X-DocPath=kcontrol/kresources/index.html
Name=KDE Resources
Name[be]= эсурсы KDE
Index: kdepimlibs/doc/kcontrol/kresources/index.docbook
===================================================================
--- kdepimlibs/doc/kcontrol/kresources/index.docbook (Revision 0)
+++ kdepimlibs/doc/kcontrol/kresources/index.docbook (Revision 0)
@@ -0,0 +1,83 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
+"dtd/kdex.dtd" [
+<!ENTITY % addindex "IGNORE">
+<!ENTITY % English "INCLUDE" > <!-- change language only here -->
+]>
+
+<article lang="&language;">
+<articleinfo>
+
+<authorgroup>
+<author><personname><firstname>Burkhard</firstname><surname>Lück</surname></personname></author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2009-09-24</date>
+<releaseinfo>4.1.3</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>System Settings</keyword>
+<keyword>resources</keyword>
+</keywordset>
+</articleinfo>
+<sect1 id="kde-resources">
+<title>&kde; Resources</title>
+
+<para>This module is a configuration tool for managing the resources used by &kde; \
applications. +It allows you to add, deleted or modify the resources for \
<guilabel>Alarms</guilabel>, +<guilabel>Calendar</guilabel>, \
<guilabel>Notes</guilabel> and <guilabel>Contacts</guilabel>.</para> +
+<para>Select a resource type from the drop down box at the top of the \
<guilabel>Resources</guilabel> section. +The list box now displays names and types of \
avalable resources of this type. +One of these resources is marked as the standard \
resource.</para> +
+<para>Use the buttons on the right side of the listbox to add, remove or delete \
resources; +and change the default resource by clicking the <guibutton>Use as \
Standard</guibutton> button.</para> +
+<para>
+<table>
+<title>Available Resources</title>
+<tgroup cols="3">
+<tbody>
+<row>
+<entry>Resource Type</entry>
+<entry>Used by</entry>
+<entry>Additional Information</entry>
+</row>
+<row>
+<entry>Alarms</entry>
+<entry>&kalarm;</entry>
+<entry>???</entry>
+</row>
+<row>
+<entry>Calendar</entry>
+<entry>???</entry>
+<entry>???</entry>
+</row>
+<row>
+<entry>Notes</entry>
+<entry>???</entry>
+<entry>???</entry>
+</row>
+<row>
+<entry>Contacs</entry>
+<entry>&kaddressbook;</entry>
+<entry><ulink url="help:/kaddressbook/index.html#configure-resources">&kaddressbook;'s \
settings dialog</ulink></entry> +</row>
+</tbody>
+</tgroup>
+</table>
+</para>
+
+<para>Every resource type needs a standard resource, where all data should be
+saved if no other resource is specified. If you want to change the standard \
resource, use the +<guibutton>Use as Standard</guibutton> button to select it. You \
must have +both read and write access to the new standard resource, otherwise you
+will not be able to select it.
+</para>
+
+</sect1>
+
+</article>
Index: kdepimlibs/doc/kcontrol/kresources/CMakeLists.txt
===================================================================
--- kdepimlibs/doc/kcontrol/kresources/CMakeLists.txt (Revision 0)
+++ kdepimlibs/doc/kcontrol/kresources/CMakeLists.txt (Revision 0)
@@ -0,0 +1,2 @@
+########### install files ###############
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR \
kcontrol/kresources)
Index: kdepimlibs/doc/kcontrol/CMakeLists.txt
===================================================================
--- kdepimlibs/doc/kcontrol/CMakeLists.txt (Revision 0)
+++ kdepimlibs/doc/kcontrol/CMakeLists.txt (Revision 0)
@@ -0,0 +1,2 @@
+add_subdirectory(kresources)
+
Index: kdepimlibs/doc/CMakeLists.txt
===================================================================
--- kdepimlibs/doc/CMakeLists.txt (Revision 0)
+++ kdepimlibs/doc/CMakeLists.txt (Revision 0)
@@ -0,0 +1,2 @@
+add_subdirectory(kcontrol)
+
Index: kdepimlibs/CMakeLists.txt
===================================================================
--- kdepimlibs/CMakeLists.txt (Revision 864578)
+++ kdepimlibs/CMakeLists.txt (Arbeitskopie)
@@ -32,6 +32,7 @@
add_subdirectory(gpgme-qt)
endif (EXISTS ${CMAKE_SOURCE_DIR}/gpgme-qt)
+add_subdirectory(doc)
add_subdirectory(gpgme++)
add_subdirectory(qgpgme)
add_subdirectory(kmime)
_______________________________________________
KDE PIM mailing list kde-pim@kde.org
https://mail.kde.org/mailman/listinfo/kde-pim
KDE PIM home page at http://pim.kde.org/
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic