[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-core-devel
Subject:    Review of KTips database
From:       Philip Rodrigues <philip.rodrigues () christ-church ! oxford ! ac ! uk>
Date:       2005-04-28 17:50:54
Message-ID: 200504281851.12723.philip.rodrigues () chch ! ox ! ac ! uk
[Download RAW message or body]

[Attachment #2 (multipart/mixed)]


Attached is my first set of changes to the KTips database
(kdebase/ktip/tips). Any comments are welcome. For now, I just want to know
whether anyone objects to the general idea of adding links to appropriate
documentation to many of the tips. 

i've added comments as well - if any of these are wrong or suggest something
that's a bad idea, please tell me.

If there's general approval, I'll finish off reviewing the existing tips,
and commit, then move on to adding new tips. Any offers of help welcome :-)

Regards,
Philip
-- 
KDE Documentation Team: http://i18n.kde.org/doc
KDE Documentation Online: http://docs.kde.org

["tips.diff" (text/x-diff)]

Index: tips
===================================================================
RCS file: /home/kde/kdebase/ktip/tips,v
retrieving revision 1.83
diff -u -3 -p -u -r1.83 tips
--- tips	17 Mar 2005 12:55:09 -0000	1.83
+++ tips	28 Apr 2005 17:38:54 -0000
@@ -18,12 +18,18 @@ which can be put to its full usage even 
 </html>
 </tip>
 
+<!-- I don't have such a K menu entry. Check.
+Link to i18n.kde.org? -->
 <tip category="General|I18N">
 <html>
 <p>
 KDE is translated into many languages. You can change the country and
-language with the Control Center or in
-K-Menu->Preferences->Personalization->Country & Language.
+language with the Control Center in "Regional &amp; Accessibility"
+->."Country/Region &amp; Language".
+</p>
+
+<p>For more information about KDE translations and translators, see <a
+href="http://i18n.kde.org/">http://i18n.kde.org</a>.
 </p>
 <br>
 <center>
@@ -45,6 +51,7 @@ panel.</p><br>
 </html>
 </tip>
 
+<!-- Link to Kicker doc -->
 <tip category="KDE|Win2Unix">
 <html>
 <p>
@@ -53,16 +60,25 @@ in" the panel</strong> by clicking on on
 the panel. Alternatively, make it hide automatically by changing the
 settings in the Control Center (Desktop->Panels, Hiding tab).
 </p>
+
+<p>For more information about Kicker, the KDE Panel, see <a
+href="help:/kicker">the Kicker Handbook</a>.
+</p>
 </html>
 </tip>
 
+
 <tip category="KDE|Win2Unix">
 <html>
 <p>
 The program Klipper, which is started by default and resides in the
 system tray at the right end of the panel, keeps a number of text
 selections around. These can be retrieved or even (in the case of
-URLs, for example) be executed.</p><br>
+URLs, for example) be executed.</p>
+
+<p>You can find more information about using Klipper in <a
+href="help:/klipper">the Klipper Handbook</a></p>
+<br>
 <center>
 <img src="crystalsvg/48x48/apps/klipper.png">
 </center>
@@ -73,7 +89,8 @@ URLs, for example) be executed.</p><br>
 <html>
 <p>
 The window list, which is accessible via an icon on the panel, provides a
-quick overview of all windows on all virtual desktops.</p><br>
+quick overview of all windows on all virtual desktops. Alternatively,
+press Alt+F5 to display the window list.</p><br>
 <center>
 <img src="crystalsvg/48x48/apps/window_list.png">
 </center>
@@ -107,7 +124,6 @@ displayed in Konqueror).</p>
 </html>
 </tip>
 
-
 <tip category="KDE2|Desktop">
 <html>
 <p>
@@ -116,6 +132,8 @@ that only the titlebar stays visible. Do
 second time will make the window visible again.<br>
 Of course, you can change this behavior within the Control Center.
 </p>
+<p>For more information about ways to manipulate windows in KDE, take
+a look at <a href="help:/khelpcenter/userguide/windows-how-to-work.html">the KDE User Guide</a>.</p>
 </html>
 </tip>
 
@@ -125,6 +143,10 @@ Of course, you can change this behavior 
 You can cycle through the windows on a virtual desktop by holding the
 Alt key and pressing Tab or Shift+Tab.</p><br>
 <center><img src="crystalsvg/48x48/apps/kcmkwm.png"></center></p>
+
+<p>For more information, see <a
+href="help:/khelpcenter/userguide/windows-how-to-work.html">the KDE
+User Guide</a>.</p>
 </html>
 </tip>
 
@@ -132,9 +154,9 @@ Alt key and pressing Tab or Shift+Tab.</
 <html>
 <p>
 You can assign <b>keyboard shortcuts</b> to your favorite applications in the
-KDE menu editor (Right mouse button on K-menu->Menu Editor). Select the application
-(e.g. Konsole), then the tab "Advanced" and enter e.g. "Ctrl+Alt+K"
-(or use the "Change" button).</p>
+KDE menu editor (K-menu->Settings->Menu Editor). Select the application
+(e.g. Konsole), then click on the image next to "Current shortcut
+key:". Press the key combination you want (say, Ctrl+Alt+K).
 <p>That is it: now you can fire up Konsoles with Ctrl+Alt+K.</p>
 </html>
 </tip>
@@ -145,9 +167,16 @@ KDE menu editor (Right mouse button on K
 You can configure the number of virtual desktops by adjusting the "Number
 of desktops" slider in the Control Center (Desktop->Multiple Desktops).
 </p>
+
+<p>For more information about using virtual desktops, look at <a
+href="help:/khelpcenter/userguide/windows-how-to-work.html#using-multiple-desktops">the
+KDE User Guide</a>.</p>
 </html>
 </tip>
 
+<!-- Write the 'Contributing' chapter in the UG, and link to it:
+kde-quality is the place to write to in order to help. eV for -->
+<!-- donations -->
 <tip category="KDE|General">
 <html>
 <p>The KDE project was founded in October 1996 and had its first release,
@@ -156,20 +185,24 @@ of desktops" slider in the Control Cente
 documenting, proof-reading, translating, etc.) and financial or
 hardware donations. Please contact <a
  href="mailto:kde-ev@kde.org">kde-ev@kde.org</a>
-if you are interested.</p>
+if you are interested in donating, or <a
+href="mailto:kde-quality@kde.org">kde-quality@kde.org</a> if you would
+like to contribute in other ways.</p>
 </html>
 </tip>
 
+<!-- Add some more words here -->
 <tip category="KDE|Win2Unix">
 <html>
+<p>KDE provides some shortcuts to change the size of a window:</p>
 <table><tr>
-<th>Maximize a window</th>	<th>Click the maximize button</th>
+<th>To maximize a window...</th>	<th>Click the maximize button...</th>
 </tr><tr>
-<td>full-screen</td>		<td>with the left mouse button</td>
+<td>...full-screen</td>		<td>...with the left mouse button</td>
 </tr><tr>
-<td>vertically only</td>	<td>with the middle mouse button</td>
+<td>...vertically only</td>	<td>...with the middle mouse button</td>
 </tr><tr>
-<td>horizontally only</td>	<td>with the right mouse button</td>
+<td>...horizontally only</td>	<td>...with the right mouse button</td>
 </tr></table>
 </html>
 </tip>
@@ -184,6 +217,8 @@ by regularly checking the web site <A
 </html>
 </tip>
 
+<!-- I suppose it's not 'new' any more. Maybe Kurt would like to -->
+<!-- update some of these tips -->
 <tip category="General">
 <html>
 <p align="center"><strong>KDEPrinting (I)</strong></p>
@@ -222,7 +257,9 @@ as well as for large networks.
 </tip>
 
 
-
+<!-- Is this in keeping with the other tips? Perhaps more of a reason -->
+<!-- why it's here: "If you're interested in writing apps using the
+KDE framework...". Link to UofKDE when it materializes -->
 <tip category="General">
 <html>
 <p>
@@ -235,6 +272,7 @@ for details.</p><br>
 </html>
 </tip>
 
+<!-- We should probably put something like this in the UG -->
 <tip category="Konqueror">
 <html>
 <p>
@@ -244,11 +282,15 @@ to another place, e.g. another Konqueror
 </html>
 </tip>
 
+<!-- Link to virtual desktops in the UG -->
 <tip category="Keyboard">
 <html>
 <p>
 You can cycle through the virtual desktops by holding the Ctrl key and
 pressing Tab or Shift+Tab.</p>
+<p>For more information about using virtual desktops, look at <a
+href="help:/khelpcenter/userguide/windows-how-to-work.html#using-multiple-desktops">the
+KDE User Guide</a>.</p>
 </html>
 </tip>
 
@@ -280,11 +322,18 @@ print subsystem "on the fly" (and you do
 </html>
 </tip>
 
+<!-- Link to UG. Write about man:/ and info:/ there if it isn't there -->
+<!-- already. -->
 <tip category="General|Help">
 <html>
 <P>
 KDE's help system can display not only KDE's own HTML-based help, but
-also info and man pages.</P><br>
+also info and man pages.</P>
+<p>For more ways of getting help, see <a
+href="help:/khelpcenter/userguide/getting-help.html">the KDE User
+Guide</a>.</p>
+
+<br>
 <center><img src="crystalsvg/48x48/apps/khelpcenter.png"></center>
 </html>
 </tip>
@@ -338,6 +387,8 @@ them into the menu.</P>
 <html>
 <p>You can quickly move the panel to another screen edge by "grabbing" it with
 the left mouse button and moving it to where you want it.</p>
+<p>For more information about personalizing Kicker, the KDE Panel,
+take a look at <a href="help:/kicker">the Kicker Handbook</a>.</p>
 </html>
 </tip>
 
@@ -371,11 +422,13 @@ from a color selector in any application
 <html>
 <p>
 A fast way to get your favorite application onto your panel is to
-right-click the panel (Panel Menu) and select Add->Button->whatever.
+right-click the panel (Panel Menu) and select Add to Panel->Application->whatever.
 </p>
 </html>
 </tip>
 
+<!-- Without explaining the distinction between applications and -->
+<!-- applets, is it worth having a second one of these? -->
 <tip category="Panel">
 <html>
 <p>
@@ -389,8 +442,10 @@ Menu->Add->Applet from the K menu.
 <html>
 <p>
 You can add a little command line to your panel by selecting Panel
-Menu->Add->Applet->Application Launcher from the K menu.
+Menu->Add to Panel->Applet->Run Command from the K menu.
 </p>
+<p>For information about other applets available for the KDE Panel,
+take a look at <a href="help:/kicker">the Kicker Handbook</a>.</p>
 </html>
 </tip>
 
@@ -407,6 +462,8 @@ business partners <b>around the world</b
 <p>Your <b>panel clock</b> can be configured to display the time
 in <b>plain</b>, <b>digital</b>, <b>analog</b> or <b>fuzzy-style</b>
 mode.</p>
+<p>See <a href="help:/kicker/clock-applet.html">the Kicker
+Handbook</a> for more information.</p>
 </html>
 </tip>
 
@@ -440,7 +497,8 @@ command-line window provided.
 the location field below the toolbar to get there, you can clear the
 whole field very quickly with the black button with a white cross
 to the left of the "Location" label and start typing.</p>
-<p>You can also press Ctrl+O to open a dialog to enter another location.</p>
+<p>You can also press Ctrl+L to clear the location field and place the
+text cursor there.</p>
 </html>
 </tip>
 
@@ -504,6 +562,7 @@ right-clicking anywhere into the window 
 </html>
 </tip>
 
+<!-- Link to KMail Handbook on how to set this up -->
 <tip category="General">
 <html>
 <p>
@@ -513,6 +572,7 @@ for encrypting and signing your email me
 </html>
 </tip>
 
+<!-- Fix punctuation. Link to worldwide.kde.org -->
 <tip category="General">
 <html>
 <p>
@@ -522,6 +582,7 @@ Norway!</p>
 </html>
 </tip>
 
+<!-- Does the KsCD handbook say this? -->
 <tip category="General">
 <html>
 <p>
@@ -531,6 +592,7 @@ with title/track information.
 </html>
 </tip>
 
+<!-- This can probably be rephrased -->
 <tip category="Keyboard|Konsole">
 <html>
 <p>
@@ -543,6 +605,7 @@ command.</p>
 </html>
 </tip>
 
+<!-- Note that you can change lots of other colours too -->
 <tip category="LookNFeel">
 <html>
 <p>
@@ -586,6 +649,7 @@ kprinter -d infotec \
 </html>
 </tip>
 
+<!-- Update this to match the new KDE themes -->
 <tip category="LookNFeel">
 <html>
 <p>
@@ -616,6 +680,7 @@ intensive development left before the ne
 </html>
 </tip>
 
+<!-- Check that this is still correct -->
 <tip category="Desktop">
 <html>
 <p>
@@ -626,6 +691,8 @@ selecting "Configure...".</p>
 </html>
 </tip>
 
+<!-- Correct 'similar' to 'similarly'. Link to some doc that explains -->
+<!-- these completion modes explicitly -->
 <tip category="Keyboard">
 <html>
 <p>If you don't like the default completion mode, e.g. in Konqueror, you
@@ -636,6 +703,7 @@ completion in a UNIX shell. Use Ctrl+E t
 </html>
 </tip>
 
+<!-- Check against current GUI text -->
 <tip category="Panel">
 <html>
 <p>If you want another panel, to make more space for your applets and
@@ -646,6 +714,7 @@ so on.)</p>
 </html>
 </tip>
 
+<!-- I guess there's somewhere else to send these to nowadays -->
 <tip category="General">
 <html>
 <p>If you want to contribute your own "tip of the day", please send it to
@@ -667,6 +736,7 @@ in the terminal window.</p>
 </html>
 </tip>
 
+<!-- Is there a KMix handbook? -->
 <tip category="General">
 <html>
 <p>
@@ -678,7 +748,8 @@ on one of the sliders.
 </html>
 </tip>
 
-
+<!-- The instructions are outdated. The Konq handbook has full -->
+<!-- instructions -->
 <tip category="Konqueror">
 <html>
 <p>
@@ -718,6 +789,7 @@ in Konqueror. In the Konsole window, the
 </html>
 </tip>
 
+<!-- Does this link still exist? kde-look.org is probably more relevant -->
 <tip category="KDE|Win2Unix|General">
 <html>
 <p>
@@ -786,7 +858,7 @@ Sound->Sound Server.
 </html>
 </tip>
 
-
+<!-- Can probably do more than just sounds. Link to UG -->
 <tip category="Multimedia">
 <html>
 <p>
@@ -814,7 +886,7 @@ The command format is:<br>
 </html>
 </tip>
 
-
+<!-- Seems that the current default behaviour is the opposite! -->
 <tip category="Panel">
 <html>
 <p>

[Attachment #6 (application/pgp-signature)]

[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic