deskbar-applet r1822 - in trunk: data deskbar/ui help/C help/C/figures
- From: sebp svn gnome org
- To: svn-commits-list gnome org
- Subject: deskbar-applet r1822 - in trunk: data deskbar/ui help/C help/C/figures
- Date: Tue, 8 Jan 2008 17:49:13 +0000 (GMT)
Author: sebp
Date: Tue Jan 8 17:49:12 2008
New Revision: 1822
URL: http://svn.gnome.org/viewvc/deskbar-applet?rev=1822&view=rev
Log:
Added documentation written by Phil Bull and Qing Gan
Modified:
trunk/data/Deskbar_Applet.xml
trunk/deskbar/ui/CuemiacWindowController.py
trunk/deskbar/ui/DeskbarTray.py
trunk/help/C/deskbar.xml
trunk/help/C/figures/deskbar-applet.png
Modified: trunk/data/Deskbar_Applet.xml
==============================================================================
--- trunk/data/Deskbar_Applet.xml (original)
+++ trunk/data/Deskbar_Applet.xml Tue Jan 8 17:49:12 2008
@@ -3,7 +3,8 @@
<popup name="button3">
<menuitem name="Clear" verb="Clear" _label="_Clear History" pixtype="stock" pixname="gtk-delete"/>
<menuitem name="Prefs" verb="Prefs" _label="_Preferences" pixtype="stock" pixname="gtk-properties"/>
- <menuitem name="About" verb="About" _label="_About" pixtype="stock" pixname="gtk-about"/>
+ <menuitem name="Help" verb="Help" _label="_Help" pixtype="stock" pixname="gtk-help"/>
+ <menuitem name="About" verb="About" _label="_About" pixtype="stock" pixname="gtk-about"/>
</popup>
</popups>
</Root>
Modified: trunk/deskbar/ui/CuemiacWindowController.py
==============================================================================
--- trunk/deskbar/ui/CuemiacWindowController.py (original)
+++ trunk/deskbar/ui/CuemiacWindowController.py Tue Jan 8 17:49:12 2008
@@ -1,5 +1,6 @@
import gtk
import gtk.gdk
+import gnomevfs
import logging
import deskbar.interfaces.Controller
import deskbar.core.Utils
@@ -47,6 +48,9 @@
prefs = DeskbarPreferences(self._model)
prefs.show_run_hide(self._view.get_toplevel())
+ def on_show_help(self, sender):
+ gnomevfs.url_show("ghelp:deskbar")
+
def on_query_entry_changed(self, entry):
self._view.set_clear()
self._model.stop_queries()
Modified: trunk/deskbar/ui/DeskbarTray.py
==============================================================================
--- trunk/deskbar/ui/DeskbarTray.py (original)
+++ trunk/deskbar/ui/DeskbarTray.py Tue Jan 8 17:49:12 2008
@@ -78,7 +78,8 @@
None, [
("About", lambda a,b: self.__controller.on_show_about(a)),
("Prefs", lambda a,b: self.__controller.on_show_preferences(a)),
- ("Clear", lambda a,b: self.__controller.on_clear_history(a),)
+ ("Clear", lambda a,b: self.__controller.on_clear_history(a),),
+ ("Help", lambda a,b: self.__controller.on_show_help(a),)
])
def __on_loaded(self, sender):
Modified: trunk/help/C/deskbar.xml
==============================================================================
--- trunk/help/C/deskbar.xml (original)
+++ trunk/help/C/deskbar.xml Tue Jan 8 17:49:12 2008
@@ -2,9 +2,9 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
<!ENTITY applet "Deskbar">
- <!ENTITY appletversion "2.16">
- <!ENTITY manrevision "2.0">
- <!ENTITY date "March 2002">
+ <!ENTITY appletversion "2.20">
+ <!ENTITY manrevision "2.1">
+ <!ENTITY date "January 2008">
<!-- Information about the entities.
The legal.xml file contains legal information, there is no need to edit the file.
@@ -42,7 +42,7 @@
<title>&applet; Applet Manual</title>
<copyright>
- <year>2006</year>
+ <year>2007</year>
<holder>GNOME Documentation Project</holder>
</copyright>
@@ -60,26 +60,21 @@
<para>&applet; is a quick access and search applet.</para>
</abstract>
<authorgroup>
- <author>
- <firstname>Documentation</firstname>
- <surname>Writer 2</surname>
+ <author>
+ <firstname>Qing</firstname>
+ <surname>Gan</surname>
<affiliation>
- <orgname>GNOME Documentation Project</orgname>
- <!-- The email address of the author is optional and is commented out by default.
- <address> <email>doc-writer2 gnome org</email> </address>
- -->
+ <orgname>Ubuntu Documentation Project</orgname>
</affiliation>
- </author>
+ </author>
<author>
- <firstname>Documentation</firstname>
- <surname>Writer 1</surname>
+ <firstname>Phil</firstname>
+ <surname>Bull</surname>
<affiliation>
- <orgname>GNOME Documentation Project</orgname>
- <!-- The email address of the author is optional and is commented out by default.
- <address> <email>doc-writer2 gnome org</email> </address>
- -->
+ <orgname>Ubuntu Documentation Project</orgname>
+ <address> <email>philbull gmail com</email> </address>
</affiliation>
- </author>
+ </author>
</authorgroup>
<!-- According to GNU FDL, revision history is mandatory if you are -->
@@ -98,19 +93,20 @@
<revhistory>
<revision>
<revnumber>&applet; Applet Manual V&manrevision;</revnumber>
- <date>&date;</date>
+ <date>January 2008</date>
<revdescription>
- <para role="author">Documentation Writer 2
- <email>docwriter2 gnome org</email></para>
- <para role="publisher">GNOME Documentation Project</para>
+ <para role="author">Qing Gan</para>
+ <para role="author">Phil Bull
+ <email>philbull gmail com</email></para>
+ <para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
- <revnumber>Full title of previous manual.</revnumber>
- <date>Release date of previous manual.</date>
+ <revnumber>Deskbar Applet Manual V2.0</revnumber>
+ <date>December 2006</date>
<revdescription>
- <para role="author">Documentation Writer 1
- <email>docwriter2 gnome org</email></para>
+ <para role="author">GNOME Documentation Project
+ <email>gnome-doc-list gnome org</email></para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
@@ -129,10 +125,10 @@
</articleinfo>
<indexterm zone="index">
- <primary>MY-GNOME-APPLET</primary>
+ <primary>DESKBAR-APPLET</primary>
</indexterm>
<indexterm zone="index">
- <primary>mygnomeapplet</primary>
+ <primary>deskbar-applet</primary>
</indexterm>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
@@ -140,97 +136,176 @@
the applet is and what it does. -->
<sect1 id="deskbar-introduction">
<title>Introduction</title>
-
- <!-- ==== Figure ============================================= -->
- <informalfigure id="deskbar-fig">
- <screenshot>
- <mediaobject>
- <imageobject><imagedata fileref="figures/deskbar-applet.png"
- format="PNG"/>
- </imageobject>
- <!-- EPS versions of the figures are not required at the moment. -->
- <!--
- <imageobject>
- <imagedata fileref="figures/myapplet_applet.ps" format="EPS"/>
- </imageobject>
- -->
- <textobject>
- <phrase>Shows &applet; applet. Contains default character buttons.
- </phrase>
- </textobject>
- </mediaobject>
- </screenshot>
- </informalfigure>
- <!-- ==== End of Figure ======================================= -->
-
- <para>
- Use &applet; applet to search your computer and the web. With &applet;, you can search for applications, files and folders, your emails and address book, your web bookmarks and history, and web search engines such as Google.
- </para>
-
- <para>To add &applet; to a panel:</para>
- <orderedlist>
- <listitem>
- <para>Right-click on the panel to open the panel popup menu, then choose
- <menuchoice>
- <guimenu>Add to Panel</guimenu>
- </menuchoice>.
- </para>
- </listitem>
- <listitem>
- <para>Select &applet; in the <guilabel>Add to Panel</guilabel> dialog, then click <guibutton>Add</guibutton>.</para>
- </listitem>
- </orderedlist>
- <para>
- For more information on adding &applet; to a panel, see the <ulink url="ghelp:user-guide?panels-addobject" type="help">GNOME User Guide</ulink>.
- </para>
+ <para>The &applet; Applet can be loaded with specific extensions that allow the user
+ to easily and quickly search various search engines and websites, lookup words
+ in the dictionary, search for files on the computer, or run programs, among
+ other things.</para>
</sect1>
-<!-- ================ Usage ================================ -->
-<!-- Use this section to describe how to use the applet to perform the tasks for
- which the applet is designed. -->
-<!--
- <sect1 id="deskbar-usage">
- <title>Usage</title>
- <para>When you add &applet; to a panel for the
- first time, the applet displays a default list of characters. You can select a
- character from the default list, or you can select a character from predefined
- groups of characters. Each predefined group of characters is associated with a
- standard character on your keyboard.
- </para>
--->
- <!-- ================ Usage Subsection ================================ -->
-<!--
- </sect1>
--->
+ <sect1 id="deskbar-adding">
+ <title>Adding &applet; to the panel</title>
+ <para>To add &applet; to a panel:</para>
+ <procedure>
+ <step>
+ <para>Right-click on the panel to open the panel popup menu, then choose
+ <menuchoice>
+ <guimenu>Add to Panel</guimenu>
+ </menuchoice>.
+ </para>
+ </step>
+ <step>
+ <para>Select &applet; in the <guilabel>Add to Panel</guilabel> dialog, then click <guibutton>Add</guibutton>.</para>
+ <para>Alternatively, just drag the applet from the dialog to a location on the panel.</para>
+ </step>
+ </procedure>
+ <para>
+ For more information on adding applets to a panel, see the <ulink url="ghelp:user-guide?panels-addobject" type="help">GNOME User Guide</ulink>.
+ </para>
-<!-- ============= Customization ============================= -->
-<!-- Use this section to describe how to customize the applet. -->
-<!--
- <sect1 id="deskbar-prefs">
- <title>Settings</title>
- <para>To configure &applet;, right-click on the
- applet, then choose
- <guimenuitem>Properties</guimenuitem> from the popup menu.</para>
-
--->
-<!-- =============== Customization Subsection ================ -->
-<!-- Use a new section to describe different tabbed sections on the Settings or Preferences
- dialog. -->
-<!--
</sect1>
--->
+
+ <sect1 id="deskbar-activating">
+ <title>Activating &applet;</title>
+ <para>To activate &applet;, press the &applet; icon on the panel (see the picture below).</para>
+ <!-- ==== Figure ============================================= -->
+ <informalfigure id="deskbar-fig">
+ <screenshot>
+ <mediaobject>
+ <imageobject><imagedata fileref="figures/deskbar-applet.png"
+ format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows the &applet; applet.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </informalfigure>
+ <!-- ==== End of Figure ======================================= -->
+
+ <para>Alternatively, press <keycombo><keycap>Alt</keycap><keycap>F3</keycap></keycombo> to activate &applet;.</para>
+
+ <sect2 id="deskbar-changeshortcut">
+ <title>Changing the keyboard shortcut</title>
+ <para>You can change the keyboard shortcut used to activate &applet;:</para>
+ <procedure>
+ <step>
+ <para>Right-click the &applet; icon on the panel and select <guilabel>Preferences</guilabel>.</para>
+ </step>
+ <step>
+ <para>Select the <guilabel>General</guilabel> tab.</para>
+ </step>
+ <step>
+ <para>Click the text entry labelled <guilabel>Keyboard shortcut to focus</guilabel>.
+ The text should change to say <guilabel>New accelerator...</guilabel></para>
+ </step>
+ <step>
+ <para>Type the new keyboard shortcut that you would like to use. The change will take effect immediately.</para>
+ </step>
+ </procedure>
+ <para>To cancel editing the keyboard shortcut, click anywhere outside the text entry or press <keycap>Escape</keycap>.</para>
+ </sect2>
+</sect1>
+
+<sect1 id="deskbar-searching">
+ <title>Searching for items</title>
+ <sect2 id="deskbar-searchingforsomething">
+ <title>Performing a search</title>
+ <procedure>
+ <step>
+ <para>Activate &applet; and type some search terms into the search box.</para>
+ </step>
+ <step>
+ <para>&applet; will recommend some items depending on the search terms you entered. </para>
+ </step>
+ <step>
+ <para>Click the item of your choice. &applet; will perform the appropriate action for that item; for example, clicking a web link will cause it to be opened in your web browser.</para>
+ </step>
+ </procedure>
+ <para>Some search results have more than one possible action. In this case, a <quote><guilabel>></guilabel></quote> is displayed to the right of the item. When you click on the <quote><guilabel>></guilabel></quote> you will get a list of available actions.</para>
+ </sect2>
+ <sect2 id="deskbar-enablinganddisablingsearchextensions">
+ <title>Enabling and disabling search extensions</title>
+ <para>You can enable and disable search extensions in order to change what types of search are displayed in the search results.
+For example, you might wish to enable the Dictionary extension so that you can look up word definitions using Deskbar.</para>
+ <procedure>
+ <step>
+ <para>Right-click the &applet; icon on the panel and select <guilabel>Preferences</guilabel>.</para>
+ </step>
+ <step>
+ <para>Select the <guilabel>Searches</guilabel> tab.</para>
+ </step>
+ <step>
+ <para>To enable a search extension, select it from the list. To disable a search extension, deselect it.</para>
+ </step>
+ </procedure>
+ <para>For some search extensions you can click <guibutton>More...</guibutton> to set additional settings.</para>
+ </sect2>
+ <sect2 id="deskbar-changetheorderofsearchextensions">
+ <title>Changing the order of search extensions</title>
+ <para>You can change the order of the search extensions, so that types of search which are more important to you are displayed at the start of the search results.</para>
+ <procedure>
+ <step>
+ <para>Right-click the &applet; icon on the panel and select <guilabel>Preferences</guilabel>.</para>
+ </step>
+ <step>
+ <para>Select the <guilabel>Searches</guilabel> tab.</para>
+ </step>
+ <step>
+ <para>Select the search extension, then click <guibutton>Top</guibutton>, <guibutton>Up</guibutton>, <guibutton>Down</guibutton> or <guibutton>Bottom</guibutton> to change the search extension's order. </para>
+ <para>Alternatively, drag and drop the search extensions to change their order.</para>
+ </step>
+ </procedure>
+ </sect2>
+ <sect2 id="deskbar-extensionswitherrors">
+ <title>Extensions with errors</title>
+ <para>If an extension does not appear in the search results as expected, there may be a problem with it.</para>
+ <procedure>
+ <step>
+ <para>Right-click the &applet; icon on the panel and select <guilabel>Preferences</guilabel>.</para>
+ </step>
+ <step>
+ <para>Select the <guilabel>Extensions with Errors</guilabel> tab.</para>
+ </step>
+ <step>
+ <para>To see the reason for an error, select the affected extension from the list. Information on the error will be shown below the list.</para>
+ </step>
+ </procedure>
+ </sect2>
+</sect1>
+
+<sect1 id="deskbar-history">
+ <title>Search history</title>
+ <sect2 id="deskbar-usingthehistory">
+ <title>Using the history</title>
+ <para>The search history is a list of searches which you have made before. Instead of inputting the same search terms again, you can select a previous search from the history.</para>
+ <procedure>
+ <step>
+ <para>Activate &applet;.</para>
+ </step>
+ <step>
+ <para>Click <guibutton>Choose action</guibutton> and select a previous search from the list.</para>
+ </step>
+ <step>
+ <para>The search you selected will be performed again.</para>
+ </step>
+ </procedure>
+ </sect2>
+ <sect2 id="deskbar-clearhistory">
+ <title>Clearing the history</title>
+ <para>Sometimes you may want to clear your search history. There are two ways of achieving this:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Activate &applet; and click the <guilabel>Clear</guilabel> button to the right of the <guibutton>Choose action</guibutton> drop-down list.</para>
+ </listitem>
+ <listitem>
+ <para>Right-click the &applet; icon on the panel and select <guilabel>Clear History</guilabel>.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+</sect1>
+
-<!-- ============= Bugs ================================== -->
-<!-- This section is optional and is commented out by default.
- You can use it to describe known bugs and limitations of the
- program if there are any - please be frank and list all
- problems you know of.
-
- <sect1 id="deskbar-bugs">
- <title>Known Bugs and Limitations</title>
- <para> </para>
- </sect1>
--->
<!-- ============= About ================================== -->
<!-- This section contains info about the program (not docs), such as
author's name(s), web page, license, feedback address. This
@@ -240,9 +315,10 @@
information in the title page.-->
<sect1 id="deskbar-about">
- <title>About &applet;</title>
+ <title>About &applet;</title>
<para>
- &applet; was written by Nigel Tao (<email>nigel tao myrealbox com</email>), Raphael Slinckx (<email>raphael slinckx net</email>), Mikkel Kamstrup Erlandsen (<email>kamstrup daimi au dk</email>). To find more information about
+ &applet; was written by Nigel Tao (<email>nigel tao myrealbox com</email>), Raphael Slinckx (<email>raphael slinckx net</email>), Mikkel Kamstrup Erlandsen (<email>kamstrup daimi au dk</email>),
+ Sebastian PÃlsterl (<email>marduk k-d-w org</email>). To find more information about
&applet;, please visit the <ulink
url="http://raphael.slinckx.net/deskbar"; type="http">&applet; Web page</ulink>.
</para>
Modified: trunk/help/C/figures/deskbar-applet.png
==============================================================================
Binary files. No diff available.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
