Add Start here gramplet to sidebar in Relationship view

gramps/plugins/gramplet/gramplet.gpr.py

@@ -327,6 +327,20 @@ register(GRAMPLET,
          gramps_target_version=MODULE_VERSION,
          )
 
+register(GRAMPLET,
+         id="WelStartRelview",
+         name=_("StartRelview"),
+         description = _("Gramplet showing a welcome message"),
+         status = STABLE,
+         fname="welcomerelview.py",
+         height=300,
+         expand=True,
+         gramplet = 'WelcomeRelview',
+         gramplet_title=_("Start here - Welcome to Gramps!"),
+         version="1.0.0",
+         gramps_target_version=MODULE_VERSION,
+         )
+
 register(GRAMPLET,
          id = "What's Next",
          name =_("What's Next"),

gramps/plugins/gramplet/welcomerelview.py

@@ -0,0 +1,138 @@
+# Gramps - a GTK+/GNOME based genealogy program
+#
+# Copyright (C) 2007-2009  Douglas S. Blank <doug.blank@gmail.com>
+#
+# 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 2 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, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+#------------------------------------------------------------------------
+#
+# Gtk modules
+#
+#------------------------------------------------------------------------
+from gi.repository import Gtk
+
+#------------------------------------------------------------------------
+#
+# Gramps modules
+#
+#------------------------------------------------------------------------
+from gramps.gen.const import URL_WIKISTRING, URL_MANUAL_PAGE, URL_HOMEPAGE
+from gramps.gen.plug import Gramplet
+from gramps.gui.widgets.styledtexteditor import StyledTextEditor
+from gramps.gen.lib import StyledText, StyledTextTag, StyledTextTagType
+from gramps.gen.const import GRAMPS_LOCALE as glocale
+_ = glocale.translation.sgettext
+
+#-------------------------------------------------------------------------
+#
+# constants
+#
+#-------------------------------------------------------------------------
+WIKI_HELP_PAGE = _('%s_-_Categories') % URL_MANUAL_PAGE
+WIKI_HELP_SEC = _('Relationships_Category')
+
+#------------------------------------------------------------------------
+#
+# Functions
+#
+#------------------------------------------------------------------------
+def st(text):
+    """ Return text as styled text
+    """
+    return StyledText(text)
+
+def boldst(text):
+    """ Return text as bold styled text
+    """
+    tags = [StyledTextTag(StyledTextTagType.BOLD, True, [(0, len(text))])]
+    return StyledText(text, tags)
+
+def linkst(text, url):
+    """ Return text as link styled text
+    """
+    tags = [StyledTextTag(StyledTextTagType.LINK, url, [(0, len(text))])]
+    return StyledText(text, tags)
+
+#------------------------------------------------------------------------
+#
+# Gramplet class
+#
+#------------------------------------------------------------------------
+
+class WelcomeRelview(Gramplet):
+    """
+    Displays a welcome note on relview to the user.
+    """
+    def init(self):
+        self.gui.WIDGET = self.build_gui()
+        self.gui.get_container_widget().remove(self.gui.textview)
+        self.gui.get_container_widget().add(self.gui.WIDGET)
+        self.gui.WIDGET.show()
+
+    def build_gui(self):
+        """
+        Build the GUI interface.
+        """
+        top = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
+
+        scrolledwindow = Gtk.ScrolledWindow()
+        scrolledwindow.set_policy(Gtk.PolicyType.AUTOMATIC,
+                                  Gtk.PolicyType.AUTOMATIC)
+        self.texteditor = StyledTextEditor()
+        self.texteditor.set_editable(False)
+        self.texteditor.set_wrap_mode(Gtk.WrapMode.WORD)
+        scrolledwindow.add(self.texteditor)
+
+        self.display_text()
+
+        top.pack_start(scrolledwindow, True, True, 0)
+        top.show_all()
+        return top
+
+    def display_text(self):
+        """
+        Display the welcome text.
+        """
+        welcome = boldst(_('Getting Started')) + '\n\n' + _(
+            'To start entering your family history you will need to'
+            'create a new Family Tree (sometimes called a \'database\').'
+            'From the menu select "Family Trees" >"Manage Family Trees"'
+            'and then press the "New" button and name your Family Tree.'
+            'Visit the \'Online help link below.\' to learn more.\n\n')
+        welcome += boldst(_('Relationships Category view')) + '\n\n' + _(
+            'You are currently reading from the "Relationships" view, which'
+            'if available, displays all the relationships of the Active Person'
+            ' (the selected person). Specifically, it shows the parents,'
+            ' siblings, spouses, and children of that person.\n\n'
+            'You can click the configuration icon in the toolbar to configure'
+            ' additional options.\n\n'
+        )
+        welcome += boldst(_('Online help Link')) + '\n'
+        welcome += linkst(_('Relationships Category view'),
+                          URL_WIKISTRING + WIKI_HELP_PAGE + WIKI_HELP_SEC +
+                          _('locale_suffix|')) + '\n\n'
+
+        welcome += boldst(_('What is Gramps?')) + '\n\n'
+        welcome += _(
+            'Gramps is a software program designed for genealogical research.'
+            'Visit the Dashboard for additional information.\n\n')
+
+        self.texteditor.set_text(welcome)
+
+    def get_has_data(self, obj):
+        """
+        Return True if the gramplet has data, else return False.
+        """
+        return True

gramps/plugins/view/relview.py

@@ -1921,6 +1921,13 @@ class RelationshipView(NavigationView):
         """
         return [self.content_panel, self.config_panel]
 
+    def get_default_gramplets(self):
+        """
+        Define the default gramplets for the sidebar and bottombar.
+        """
+        return (("WelStartRelview",),
+                ())
+
 #-------------------------------------------------------------------------
 #
 # Function to return if person has children

po/POTFILES.in

@@ -643,6 +643,7 @@ gramps/plugins/gramplet/todo.py
 gramps/plugins/gramplet/todogramplet.py
 gramps/plugins/gramplet/topsurnamesgramplet.py
 gramps/plugins/gramplet/welcomegramplet.py
+gramps/plugins/gramplet/welcomerelview.py
 gramps/plugins/gramplet/whatsnext.py
 gramps/plugins/graph/graphplugins.gpr.py
 gramps/plugins/graph/gvfamilylines.py