[kde-doc-english] system settings in khelpcenters navigation tree
Burkhard Lück
lueck at hube-lueck.de
Fri Oct 3 13:30:11 CEST 2008
Hi,
please have a look at our systemsettings documentation in khelpcenter and how
it is displayed in the navigation tree.
I think it is necessary to cleanup this.
We have 92 settings modules in trunk:
kdedev at rebutia:~/svn$ kcmshell4 --list|wc -l
93-1 = 92
1. On the top level in the navigation tree is an item "Control Center Modules"
with 58 subitems.
Why is it called "Control Center", this is from 3.5, but in kde4 there is no
Control Center any more.
The list with 58 (why only 58 and not 92?) items is unusable because:
Unordered list
Strange/confusing names like "General" (what is it? Konqui settings)
or "Fonts" twice (one is system fonts, the other Konqui fonts)
Most of these items are also in other places in the navigation tree.
Proposal: remove it.
2. In "Application Manuals" there is "Control Center" with the obsolete
documentation for kcontrol.
Proposal: remove it.
3. In "Application Manuals" there is "Settings" with:
Dgital Camera, KWalletManager, Menu Editor, Network Settings, Wallet
Management Tool (=same documentation as KWalletManager)
Why this separate group?
Proposal: remove the item "Settings" and move the subitems to an appropriate
place.
4. In "Application Manuals" there is "Settings-Modules" with 9 groups of items
in the structure from kcontrol 3.5.
Proposal: remove it.
5. In "Application Manuals" there is "System Settings" -> the Handbook.
Rename it to "System Settings Manual", then it is ok.
6. In "Application Manuals" there is "System Settings" with items in two
subgroups "General" + "Advanced". This is the same layout as in the
application systemsettings. There are only some documentations missing, all
docs have to be added here in an appropriate subgroup.
Proposal:
This should be the only item in the navigation tree with documentation for all
settings in kde4. It should have the same layout in the navigation tree as in
the application systemsettings.
Move it up to a top level item in khelpcenters navigation tree.
Attached a file with the layout of the application systemsettings with all
items, the available and missing documentation and other bugs regarding the
help.
There are 54 items, what is the difference to the 92 items reported by
kcmshell4 --list and where is the documentation for these items in
khelpcenter?
In the kcmshell4 list are additional:
Browser setting for Konqui - khtml_general, cookies, cache, ebrowsing,
khtml_filter, khtml_fonts, khtml_plugins, khtml_behavior, khtml_java_js,
kcmcss, useragent. 11 items.
These items are listed in No 1 the "Control Center Modules" I want to remove.
So where should they go in the navigation tree?
To "Application Manuals"->"Internet"->"Konqueror Settings"?
Next group of documentations not in System Settings is the KInfocenter stuff:
kcmview1394, nic, xserver, interrupts, devices, dma, scsi, opengl, kcm_pci,
sound, kcm_partition, kcm_memory, kcmusb, kcmsolidproc, ioports, smbstatus.
These 16 docs are in "KInfoCenter Modules" in the navigation tree.
Some moduls are not listed in the application systemsettings, like bookmarks,
kcm_knetworkconfmodule, kcmdolphin etc.
Launching kcmshell "modul" the window caption is "name of modul - KDE Control
Module", shoudn't this be changed to "KDE System Settings Module"?
--
Burkhard Lück
-------------- next part --------------
General
Look & Feel
Appearance
Style (Tabs: Style, Fine Tunig) help:/kcontrol/kcmstyle/index.html, docs ok
Colors (Tabs: Scheme, Options, Colors, Inactive, Disabled) help:/kcontrol/colors/index.html, docs outdated
Icons (Tabs: Theme, Advanced) help:/kcontrol/icons/index.html, docs ok
Fonts help:/kcontrol/fonts/index.html, docs ok
Windows (Tabs: Window Decoration, Buttons) help:/kcontrol/kwindecoration/index.html, docs ok
Splash Screen help:/kcontrol/splashscreen/index.html, docs ok
Emoticons help:/kcontrol/emoticons/index.html, docs ok
Desktop
Desktop Effects (Tabs: General, All Effects) help:/kcontrol/kwincompositing/index.html, docs incomplete
Multiple Desktops help:/kcontrol/desktop/index.html#desktop-number, docs outdated
Screen Saver help:/kcontrol/screensaver/index.html, docs outdated
Launch Feedback help:/kcontrol/kcmlaunch/index.html, docs outdated
Notifications
System Notifications (Tabs: Applications, Player Settings) help:/kcontrol/kcmnotify/index.html, docs outdated
System Bell help:/kcontrol/bell/index.html, docs outdated
Window Behaviour
Window Behaviour
(Tabs: Focus, Title Bar, Windows Actions, Moving, Advanced) help:/kcontrol/windowbehaviour/index.html, docs outdated
Window Specific help:/kcontrol/windowspecific/index.html
Personal
About Me
Password & User Account help:/kdepasswd/index.html
Paths help:/kcontrol/paths/index.html
Accessibility
Text-to-Speech (Tabs: General, Talkers, Filters, Interruption, Audio) help:/kttsd/index.html
Accessibility (Tabs: Bell, Modifier Keys, Keybord Filters, Activation Gestures) help:/kcontrol/kcmaccess/index.html, docs outdated
Default Applications help button disabled
Regional & Language
Country/Region & Language (Tabs: Locale, Numbers, Money, Times & Date, Other) help:/kcontrol/language/index.html, docs outdated
Keyboard Layout (Tabs: Layout, Switching Options, Advanced) help:/kcontrol/kxkb/index.html
(There is no documentation available for /kcontrol/kxkb/index.html, doc is in kxkb/index.html, wrong X-DocPath
Spellchecker help:/kcontrol/spellchecking/index.html, docs outdated
Network & Connectivity
Network Settings
(missing: Network Settings (Tabs: Network Interfaces, Routes, Domain Name System, Network Profiles), why? help:/kcontrol/knetworkconf/index.html broken #163578)
Proxy (Tabs: Proxy, SOCKS) help:/kcontrol/proxy/index.html
Connection Preferences help:/kcontrol/netpref/index.html
Service Discovery help button disabled
Sharing
Windows Shares help button enabled, does nothing
Computer Administration
Date & Time help:/kcontrol/clock/index.html
Display help:/kcontrol/energy/index.html, docs outdated
Font Installer help:/kcontrol/fontinst/index.html
Input Actions
Mouse Gestures ?
Input Actions help button disabled
Keyboard & Mouse
Keyboard help:/kcontrol/keyboard/index.html
Mouse (Tab: General, Cursor Theme, Advanced, Mouse Navigation) help:/kcontrol/mouse/index.html, docs outdated
Joystick help:/kcontrol/joystick/index.html
Standard Keyboard Shortcuts help button disabled, but in khelpcenter kcontrol/keys/index.html
Global Keyboard Shortcuts help button disabled, but in khelpcenter kcontrol/keys/index.html
Multimedia
Tabs Device Preference + Backend both help buttons disabled
Advanced
Advanced User Settings
Aconadi configuration help button enablede, no documentation
Audio CDs (Tabs: General. Names. Ogg Vorbis Encoder) help:/kioslave/audiocd/index.html, kcontrol/audiocd/index.html missing
Autostart help:/kcontrol/autostart/index.html
CDDB Retrievial (Tabs: Lookup, Submit) help:/kscd/index.html#cddb-page
Desktop Search (tabs Basic Settings + Advanced Settings) help button disabled
Digital Camera help:/kamera/introduction.html (stubb, no content)
File Associations help:/kcontrol/filetypes/index.html, docs outdated
Hardware There is no documentation available for /kcontrol/solid/index.htm
KDE Resources help:/kcontrol/kresources/index.html
KDE Wallet (Tabs: Wallet Preferences, Acces Control) help:/kwallet/index.html needs anchors to kwallet-kcontrol-module
Service Manager help button disabled
Session Manager help:/kcontrol/kcmsmserver/index.html
System
Login Manager (Tabs: General (1), Dialog (2), Background (3), Theme (4), Shutdoen (5), Users (6), Convenience (7) help:/kdm/index.html#configuring-kdm
Power Management help:/kcontrol/powerdevilconfig/index.html
Samba (Tabs: Base Settings, Shares, Printers, Users, Advanced) There is no documentation available for /kcontrol/kcmsambaconf/index.html
Task Scheduler help:/kcron/index.html
More information about the kde-doc-english
mailing list