Changeset 74f6c7e in sasview for src/sas/perspectives/fitting/basepage.py

Timestamp:

Feb 18, 2015 4:27:19 AM (9 years ago)

Author:

butler

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

0d9401e

Parents:

e4d4de2

Message:

Update basepage so that polydispersity help now pulls from the new
documentation

File:

• src/sas/perspectives/fitting/basepage.py (modified) (3 diffs)

src/sas/perspectives/fitting/basepage.py

@@ -3043 +3043 @@
     def on_model_help_clicked(self, event):
         """
-        on 'More details' button
+        Function called when 'Details' button is pressed next to model
+        of interest.  As of Feb 2015 this function follows two paths:
+        For regular models that ship with the release, it calls the Sphinx
+        generated html documentation.  For plugin models it still uses the
+        old pop up window reading the description provided in the model.
+        
+        This will presumably be deprecated when the sas mdels team decides
+        on how to discover new models and grab their documentation from the
+        file.
+        
+        PDB 18 Feb 2015
+        
+        :param evt: on Details Button pressed event
         """
         from sas.perspectives.fitting.help_panel import  HelpWindow
@@ -3052 +3064 @@
         model_path = os.path.join(path, "model_functions.html")
         if self.model == None:
-            name = 'FuncHelp'
+            name = 'index.html'
         else:
             name = self.formfactorbox.GetValue()
         frame = HelpWindow(None, -1, pageToOpen=model_path)
-        # If model name exists and model is not a custom model
+        #If model name exists and model is not a custom model
         #mod_cat = self.categorybox.GetStringSelection()
         if frame.rhelp.HasAnchor(name):
@@ -3131 +3143 @@
     def on_pd_help_clicked(self, event):
         """
-        Button event for PD help
-        """
-        from help_panel import  HelpWindow
-        import sas.models as models
-        
-        # Get models help model_function path
-        path = models.get_data_path(media='media')
-        pd_path = os.path.join(path, "pd_help.html")
-
-        frame = HelpWindow(None, -1, pageToOpen=pd_path)
-        frame.Show(True)
+        Bring up Polydispersit Documentation whenever the ? button is clicked. 
+        Calls DocumentationWindow with the path of the location within the
+        documentation tree (after /doc/ ...."
+        
+        :param evt: Triggers on clicking ? in polydispersity box
+        """
+        
+        from sas.guiframe.documentation_window import DocumentationWindow
+        
+        _TreeLocation = "user/perspectives/fitting/fitting_help.html"
+        _TreeLocation += "#polydispersity-distributions"
+        _doc_viewer = DocumentationWindow(self, -1, \
+             _TreeLocation,"Polydispersity Help")
         
     def on_left_down(self, event):