Changeset 5e88e27c in sasview

Timestamp:

Sep 17, 2018 12:33:08 PM (6 years ago)

Author:

smk78

Branches:

master, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, unittest-saveload

Children:

7d3aa9a

Parents:

893d852

Message:

Create Release Notes option in Help Menu and popup box

Location:

src/sas

Files:

• sasgui/guiframe/config.py (modified) (3 diffs)
• sasgui/guiframe/gui_manager.py (modified) (4 diffs)
• sasgui/guiframe/releasebox.py (added)
• sasview/local_config.py (modified) (3 diffs)

src/sas/sasgui/guiframe/config.py

@@ -33 +33 @@
 _do_aboutbox = True
 _do_acknowledge = True
+_do_release = True
 _do_tutorial = True
 _acknowledgement_preamble =\
@@ -49 +50 @@
 _acknowledgement_citation = \
 '''M. Doucet et al. SasView Version 4.1.2, Zenodo, 10.5281/zenodo.825675'''
-
 _acknowledgement =  \
 '''This work was originally developed as part of the DANSE project funded by the US NSF under Award DMR-0520547,\n but is currently maintained by a collaboration between UTK, UMD, NIST, ORNL, ISIS, ESS, ILL, ANSTO, TU Delft, DLS, and the scattering community.\n\n SasView also contains code developed with funding from the EU Horizon 2020 programme under the SINE2020 project (Grant No 654000).\nA list of individual contributors can be found at: http://www.sasview.org/contact.html
 '''
+_release_preamble =\
+'''These Release Notes, incorporating Known Issues, can also be found at:'''
+_release_location1 =\
+'''{SasView Installation Folder}\sasview\installers\README.txt'''
+_release_location2 =\
+'''https://github.com/SasView/sasview/releases/'''
 
 _homepage = "http://www.sasview.org"
@@ -94 +100 @@
 _corner_image = os.path.join(icon_path, "angles_flat.png")
 _welcome_image = os.path.join(icon_path, "SVwelcome.png")
-_copyright = "(c) 2009 - 2017, UTK, UMD, NIST, ORNL, ISIS, ESS, ILL, ANSTO, TU Delft, and DLS"
+_copyright = "(c) 2009 - 2018, UTK, UMD, NIST, ORNL, ISIS, ESS, ILL, ANSTO, TU Delft, and DLS"
 marketplace_url = "http://marketplace.sasview.org/"
 

src/sas/sasgui/guiframe/gui_manager.py

@@ -1276 +1276 @@
 
         wx_id = wx.NewId()
-        self._help_menu.Append(wx_id, '&Documentation', '')
+        self._help_menu.Append(wx_id, '&Documentation', 'Help documentation for SasView')
         wx.EVT_MENU(self, wx_id, self._onSphinxDocs)
 
@@ -1283 +1283 @@
             # Pluralised both occurences of 'Tutorial' in the line below
             # S King, Sep 2018
-            self._help_menu.Append(wx_id, '&Tutorials', 'Software tutorials')
+            self._help_menu.Append(wx_id, '&Tutorials', 'Tutorials on how to use SasView')
             wx.EVT_MENU(self, wx_id, self._onTutorial)
+
+        if config.marketplace_url:
+            wx_id = wx.NewId()
+            self._help_menu.Append(wx_id, '&Model marketplace', 'Plug-in fitting models for SasView')
+            wx.EVT_MENU(self, wx_id, self._on_marketplace_click)
+
+        if config._do_release:
+            wx_id = wx.NewId()
+            self._help_menu.Append(wx_id, '&Release notes',
+                                   'SasView release notes and known issues')
+            wx.EVT_MENU(self, wx_id, self._onRelease)
 
         if config._do_acknowledge:
@@ -1295 +1306 @@
             logger.info("Doing help menu")
             wx_id = wx.NewId()
-            self._help_menu.Append(wx_id, '&About', 'Software information')
+            self._help_menu.Append(wx_id, '&About', 'Information about SasView')
             wx.EVT_MENU(self, wx_id, self._onAbout)
-
-        if config.marketplace_url:
-            wx_id = wx.NewId()
-            self._help_menu.Append(wx_id, '&Model marketplace', '')
-            wx.EVT_MENU(self, wx_id, self._on_marketplace_click)
 
         # Checking for updates
@@ -2137 +2143 @@
             import sas.sasgui.guiframe.aboutbox as AboutBox
             dialog = AboutBox.DialogAbout(None, -1, "")
+            dialog.ShowModal()
+
+    def _onRelease(self, evt):
+        """
+        Pop up the release notes
+
+        :param evt: menu event
+
+        """
+        if config._do_release:
+            import sas.sasgui.guiframe.releasebox as ReleaseBox
+            dialog = ReleaseBox.DialogRelease(None, -1, "")
             dialog.ShowModal()
 

src/sas/sasview/local_config.py

@@ -33 +33 @@
 _do_aboutbox = True
 _do_acknowledge = True
+_do_release = True
 _do_tutorial = True
 _acknowledgement_preamble =\
@@ -49 +50 @@
 _acknowledgement_citation = \
 '''M. Doucet et al. SasView Version 4.2, Zenodo, 10.5281/zenodo.1412041'''
-
 _acknowledgement =  \
 '''This work was originally developed as part of the DANSE project funded by the US NSF under Award DMR-0520547,\n but is currently maintained by a collaboration between UTK, UMD, NIST, ORNL, ISIS, ESS, ILL, ANSTO, TU Delft, DLS, and the scattering community.\n\n SasView also contains code developed with funding from the EU Horizon 2020 programme under the SINE2020 project (Grant No 654000).\nA list of individual contributors can be found at: http://www.sasview.org/contact.html
 '''
+_release_preamble =\
+'''These Release Notes, incorporating Known Issues, can also be found at:'''
+_release_location1 =\
+'''{SasView Installation Folder}\sasview\installers\README.txt'''
+_release_location2 =\
+'''https://github.com/SasView/sasview/releases/'''
 
 _homepage = "http://www.sasview.org"
@@ -94 +100 @@
 _corner_image = os.path.join(icon_path, "angles_flat.png")
 _welcome_image = os.path.join(icon_path, "SVwelcome.png")
-_copyright = "(c) 2009 - 2017, UTK, UMD, NIST, ORNL, ISIS, ESS, ILL, ANSTO, TU Delft, and DLS"
+_copyright = "(c) 2009 - 2018, UTK, UMD, NIST, ORNL, ISIS, ESS, ILL, ANSTO, TU Delft, and DLS"
 marketplace_url = "http://marketplace.sasview.org/"