Merge lp:~sara.ribeiro/gtg/userdoc into lp:~gtg/gtg/old-trunk

[Sara Ribeiro]

Fix for bug #1027604: Deeper integeration of userdoc

[Nimit Shah (nimit-svnit)]

Hi Sara,
You need to make some small fixes:

=== modified file 'CHANGELOG'

> --- CHANGELOG 2014-03-05 19:25:18 +0000
> +++ CHANGELOG 2014-03-09 03:03:28 +0000
> @@ -19,6 +19,7 @@
> * Fix for bug #1286493 : GTG cannot connect to RTM, by Pawan Hegde
> * Fix for bug #1288011 : More intuitive title label for tasks, by
> Sara Ribeiro
> * Fix for bug #316922 : Have a link to the parent(s) in the task
> editor, by Parth Panchal
> + * Fix for bug #1027604: Deeper integeration of userdoc, by Sara
> Ribeiro
>
> 2013-11-24 Getting Things GNOME! 0.3.1
> * Fix for bug #1024473: Have 'Show Main Window' in notification area,
> by Antonio Roquentin
>
> === modified file 'GTG/gtk/backends_dialog.ui'
> --- GTG/gtk/backends_dialog.ui 2013-09-04 17:48:19 +0000
> +++ GTG/gtk/backends_dialog.ui 2014-03-09 03:03:28 +0000
> @@ -151,7 +151,7 @@
> <property name="can_focus">False</property>
> <property name="layout_style">edge</property>
> <child>
> - <object class="GtkButton" id="button1">
> + <object class="GtkButton" id="sync_help">
> <property name="label">gtk-help</property>
> <property name="visible">True</property>
> <property name="can_focus">True</property>
>
> === modified file 'GTG/gtk/backends_dialog/__init__.py'
> --- GTG/gtk/backends_dialog/__init__.py 2013-11-25 02:37:46 +0000
> +++ GTG/gtk/backends_dialog/__init__.py 2014-03-09 03:03:28 +0000
> @@ -72,6 +72,7 @@
> self._load_widgets_from_builder(builder)
> # Load and setup other widgets
> self.dialog.set_title(_("Synchronization Services - %s" %
> info.NAME))
> +
>
Remove this extra line

> self._create_widgets_for_add_panel()
> self._create_widgets_for_conf_panel()
> self._setup_signal_connections(builder)
> @@ -199,6 +200,13 @@
> }
> builder.connect_signals(signals)
>
> + # adding F1 as a shortcut for Help
> + agr = Gtk.AccelGroup()
> + self.dialog.add_accel_group(agr)
> + widget = builder.get_object("sync_help")
> + key, modifier = Gtk.accelerator_parse('F1')
> + widget.add_accelerator("activate", agr, key, modifier,
> Gtk.AccelFlags.VISIBLE)
> +
> def _configure_icon_theme(self):
> '''
> Inform gtk on the location of the backends icons (which is in
>
> === modified file 'GTG/gtk/editor/editor.py'
> --- GTG/gtk/editor/editor.py 2014-03-05 19:25:18 +0000
> +++ GTG/gtk/editor/editor.py 2014-03-09 03:03:28 +0000
> @@ -24,10 +24,12 @@
> The rest is the logic of the widget: date changing widgets, buttons, ...
> """
> import time
> +from webbrowser import open as openurl
>
> from gi.repository import Gtk, Gdk, Pango
>
> from GTG import _, ngettext
> +from GTG import info
> from GTG.gtk.editor import GnomeConfig
> from GTG.gtk.editor.taskview import TaskView
> from GTG.core.plugins.engine import PluginEngine
> @@ -201,6 +203,10 @@
> key, modifier = Gtk.accelerator_parse('<Control>w')
> agr.connect(key, modifier, Gtk.AccelFlags.VISIBLE, self.close)
>
> + # F...

[Nimit Shah (nimit-svnit)]

Hi Sara,
Please check my mail for the small readability related issues that you need to rectify.

review: Needs Fixing

[Izidor Matušov (izidor)]

I like the change and have a proposal to make it even better! What about extracting the code you added into a separate module, something like GTG.gtk.help?

Why?

 - less duplicated code
 - add more abstraction: I want the documentation for this dialog be this URI
 - it would be easy to modify way how to open/display help

The use can be as easy as this:

<code>
from GTG.gtk.help import register_help
register_help(self.dialog, 'preferences')
</code>

Implementation will be the code you copy pasted (pseudo code):

<code>
def show_help(help_url, *args):
   openurl(help_url)
   return True

def register_help(widget, help_addr):
   full_help_addr = construct_help_addr(help_addr)

   # Code for adding accel group here
</code>

review: Needs Fixing

[lp:~sara.ribeiro/gtg/userdoc]

1366. By Sara Ribeiro on 2014-03-09

Removed blank lines

1367. By Sara Ribeiro on 2014-03-09

Solve merge conflict

1368. By Sara Ribeiro on 2014-03-11

Created a separate Help module for better abstraction

1369. By Sara Ribeiro on 2014-03-11

Solve merge conflict

1370. By Sara Ribeiro on 2014-03-11

Removed blank lines

[Sara Ribeiro (sara.ribeiro)]

I made the modifications you guys suggested. Can you please review again? Thanks!

=== modified file 'CHANGELOG'
--- CHANGELOG	2014-03-10 03:37:32 +0000
+++ CHANGELOG	2014-03-11 04:25:45 +0000
@@ -21,6 +21,7 @@
     * Fix for bug #316922 : Have a link to the parent(s) in the task editor, by Parth Panchal
     * Fix for bug #1287259 : pep8ify the codebase, by Izidor Matušov
     * Rework of test-suite, by Izidor Matušov
+    * Fix for bug #1027604: Deeper integeration of userdoc, by Sara Ribeiro
 
 2013-11-24 Getting Things GNOME! 0.3.1
     * Fix for bug #1024473: Have 'Show Main Window' in notification area, by Antonio Roquentin

=== modified file 'GTG/gtk/backends_dialog.ui'
--- GTG/gtk/backends_dialog.ui	2013-09-04 17:48:19 +0000
+++ GTG/gtk/backends_dialog.ui	2014-03-11 04:25:45 +0000
@@ -151,7 +151,7 @@
                 <property name="can_focus">False</property>
                 <property name="layout_style">edge</property>
                 <child>
-                  <object class="GtkButton" id="button1">
+                  <object class="GtkButton" id="sync_help">
                     <property name="label">gtk-help</property>
                     <property name="visible">True</property>
                     <property name="can_focus">True</property>

=== modified file 'GTG/gtk/backends_dialog/__init__.py'
--- GTG/gtk/backends_dialog/__init__.py	2013-11-25 02:37:46 +0000
+++ GTG/gtk/backends_dialog/__init__.py	2014-03-11 04:25:45 +0000
@@ -28,8 +28,6 @@
 
 from gi.repository import Gtk
 
-from webbrowser import open as openurl
-
 from GTG.gtk import ViewConfig
 from GTG.core import CoreConfig
 from GTG.gtk.backends_dialog.backendstree import BackendsTree
@@ -40,6 +38,7 @@
 from GTG import _
 from GTG.backends.genericbackend import GenericBackend
 from GTG import info
+from GTG.gtk import help
 
 
 class BackendsDialog(object):
@@ -76,6 +75,7 @@
         self._create_widgets_for_conf_panel()
         self._setup_signal_connections(builder)
         self._create_widgets_for_treeview()
+        help.add_help_shortcut(self.dialog, "sync")
 
 ########################################
 ### INTERFACE WITH THE VIEWMANAGER #####
@@ -194,8 +194,7 @@
             'on_BackendsDialog_delete_event': self.on_close,
             'on_close_button_clicked': self.on_close,
             'on_remove_button_clicked': self.on_remove_button,
-            'on_help_button_clicked': lambda w:
-            openurl("help:gtg/gtg-add-sync"),
+            'on_help_button_clicked': self.on_help,
         }
         builder.connect_signals(signals)
 
@@ -227,6 +226,11 @@
 ########################################
 ### EVENT HANDLING #####################
 ########################################
+    def on_help(cls, widget):
+        """ Open help for syncronization services """
+        help.show_help("sync")
+        return True
+
     def on_backend_selected(self, backend_id):
         '''
         When a backend in the treeview gets selected, show

=== modified file 'GTG/gtk/editor/editor.py'
--- GTG/gtk/editor/editor.py	2014-03-09 12:59:59 +0000
+++ GTG/gtk/editor/editor.py	2014-03-11 04:25:45 +0000
@@ -35,6 +35,7 @@
 from GTG.core.task import Task
 from GTG.tools.dates import Date
 from GTG.gtk.editor.calendar import GTGCalendar
+from GTG.gtk.help import add_help_shortcut
 
 
 class TaskEditor(object):
@@ -201,6 +202,9 @@
         key, modifier = Gtk.accelerator_parse('<Control>w')
         agr.connect(key, modifier, Gtk.AccelFlags.VISIBLE, self.close)
 
+        # F1 shows help
+        add_help_shortcut(self.window, "editor")
+
         # Ctrl-N creates a new task
         key, modifier = Gtk.accelerator_parse('<Control>n')
         agr.connect(key, modifier, Gtk.AccelFlags.VISIBLE, self.new_task)

=== added file 'GTG/gtk/help.py'
--- GTG/gtk/help.py	1970-01-01 00:00:00 +0000
+++ GTG/gtk/help.py	2014-03-11 04:25:45 +0000
@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# -----------------------------------------------------------------------------
+# Getting Things GNOME! - a personal organizer for the GNOME desktop
+# Copyright (c) 2008-2013 - Lionel Dricot & Bertrand Rousseau
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------
+
+""" This file contains Help related funcions for displaying user documentation.
+It allows you to:
+    - setup F1 as a help shortcut 
+    - display the documentation help for a given subject (plugins, sync, ...)
+"""
+
+from gi.repository import Gtk
+from webbrowser import open as openurl
+
+from GTG import info
+
+
+def construct_help_addr(help_addr=None):
+    """ Return the url help address for a specific subject 
+    (default: general help) """
+    return info.HELP_URI + {
+        "plugins": "/gtg-plugins",
+        "sync": "/gtg-add-sync",
+    }.get(help_addr, "")
+
+def show_help(help_addr):
+    """ Open a specif help page for a given subject """
+    help_url = construct_help_addr(help_addr)
+    openurl(help_url)
+    return True
+
+def add_help_shortcut(widget, help_addr):
+    """ Add F1 as a shortcut for help """
+    agr = Gtk.AccelGroup()
+    widget.add_accel_group(agr)
+    key, modifier = Gtk.accelerator_parse('F1')
+    # use dummy variables for lambda
+    agr.connect(key, modifier, Gtk.AccelFlags.VISIBLE,
+                lambda a,b,c,d: show_help(help_addr))

=== modified file 'GTG/gtk/plugins.py'
--- GTG/gtk/plugins.py	2014-03-09 12:59:59 +0000
+++ GTG/gtk/plugins.py	2014-03-11 04:25:45 +0000
@@ -26,6 +26,7 @@
 from GTG.core.plugins import GnomeConfig
 from GTG.core.plugins.engine import PluginEngine
 from GTG.gtk import ViewConfig
+from GTG.gtk import help
 
 # columns in PluginsDialog.plugin_store
 PLUGINS_COL_ID = 0
@@ -144,6 +145,8 @@
         self.plugin_about = builder.get_object("PluginAboutDialog")
         self.plugin_depends = builder.get_object('PluginDepends')
 
+        help.add_help_shortcut(self.dialog, "plugins")
+
         self.pengine = PluginEngine()
         # plugin config initiation
         if self.pengine.get_plugins():
@@ -241,7 +244,8 @@
 
     @classmethod
     def on_help(cls, widget):
-        """ In future, this will open help for plugins """
+        """ Open help for plugins """
+        help.show_help("plugins")
         return True
 
     def on_plugin_toggle(self, widget, path):

=== modified file 'GTG/gtk/plugins.ui'
--- GTG/gtk/plugins.ui	2013-09-04 17:48:19 +0000
+++ GTG/gtk/plugins.ui	2014-03-11 04:25:45 +0000
@@ -83,16 +83,16 @@
           <object class="GtkButtonBox" id="dialog-action_area5">
             <property name="visible">True</property>
             <property name="can_focus">False</property>
-            <property name="layout_style">end</property>
+            <property name="layout_style">edge</property>
             <child>
               <object class="GtkButton" id="plugins_help">
                 <property name="label">gtk-help</property>
                 <property name="can_focus">True</property>
                 <property name="receives_default">True</property>
-                <property name="no_show_all">True</property>
+                <property name="visible">True</property>
                 <property name="use_action_appearance">False</property>
                 <property name="use_stock">True</property>
-                <signal name="released" handler="on_plugins_help" swapped="no"/>
+                <signal name="clicked" handler="on_plugins_help" swapped="no"/>
               </object>
               <packing>
                 <property name="expand">False</property>

=== modified file 'GTG/gtk/preferences.py'
--- GTG/gtk/preferences.py	2014-01-14 16:36:35 +0000
+++ GTG/gtk/preferences.py	2014-03-11 04:25:45 +0000
@@ -29,6 +29,7 @@
 from GTG import _
 from GTG import info
 from GTG.gtk import ViewConfig
+from GTG.gtk import help
 
 AUTOSTART_DIRECTORY = os.path.join(xdg_config_home, "autostart")
 AUTOSTART_FILE = "gtg.desktop"
@@ -91,6 +92,7 @@
         self.shortcut_button = builder.get_object("shortcut_button")
 
         self.shortcut = ShortcutWidget(builder)
+        help.add_help_shortcut(self.dialog, "preferences")
 
         self.fontbutton = builder.get_object("fontbutton")
         editor_font = self.config.get("font_name")
@@ -149,7 +151,8 @@
 
     @classmethod
     def on_help(cls, widget):
-        """ In future, this will open help for preferences """
+        """ Open help for preferences """
+        help.show_help("preferences")
         return True
 
     @classmethod