Changeset d20eb45 in sasview

Timestamp:

Jun 21, 2015 1:00:18 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:

c8d22ec

Parents:

e8af9b1

Message:

Final fix to documentationwindow (I hope) mac docs should work and
removed a couple more pylint warnings.

File:

• src/sas/guiframe/documentation_window.py (modified) (6 diffs)

src/sas/guiframe/documentation_window.py

@@ -1 +1 @@
 """
-documentation module provides a simple means to add help throughout the 
+documentation module provides a simple means to add help throughout the
 application. It checks for the existence of html2 package needed to support
 fully html panel which supports css.  The class defined here takes a title for
@@ -12 +12 @@
 class brings up the default browser and passes the file:/// string to it.  In
 this case however the instruction portion is usually not passed for security
-reasons. 
+reasons.
 """
-import sys
 import os
 import logging
@@ -27 +26 @@
 except:
     WX_SUPPORTS_HTML2 = False
-if sys.platform.count("win32") > 0:
-    #this is a PC
-    WX_SUPPORTS_HTML2 = True
-else:
-    #this is a MAC
-    WX_SUPPORTS_HTML2 = False
+
 
 from gui_manager import get_app_dir
@@ -38 +32 @@
 
 class DocumentationWindow(wx.Frame):
+    """
+    DocumentationWindow inherits from wx.Frame and provides a centralized
+    coherent framework for all help documentation.  Help files must be html
+    files stored in an properly organized tree below the top 'doc' folder.  In
+    order to display the appropriate help file from anywhere in the gui, the
+    code simply needs to know the location below the top level where the
+    help file resides along with the name of the help file.
+    called
+    (self, parent, dummy_id, path, url_instruction, title, size=(850, 540))
+    
+    :param path: path to html file beginning AFTER /doc/ and ending in the 
+    file.html
+    :param url_instructions: anchor string or other query e.g. '#MyAnchor
+    :param title - text to place in the title bar of the help panel
+    """
     def __init__(self, parent, dummy_id, path, url_instruction, title, size=(850, 540)):
         wx.Frame.__init__(self, parent, dummy_id, title, size=size)
@@ -49 +58 @@
             docs_path = os.path.join(get_app_dir(), "doc")
 
+        #note that filepath for mac OS, at least in bundle starts with a
+        #forward slash as /Application, while the PC string begins C:\
+        #It seems that mac OS is happy with four slashes as in file:////App...
+        #Two slashes is not sufficient to indicate path from root.  Thus for now
+        #we use "file:///" +... If the mac behavior changes may need to make the
+        #file:/// be another constant at the beginning that yields // for Mac
+        #and /// for PC.
+        #Note added June 21, 2015     PDB 
         file_path = os.path.join(docs_path, path)
-        url = "file:///" + urllib.quote(file_path, '/\:')+ url_instruction
+        url = "file:///" + urllib.quote(file_path, r'/\:')+ url_instruction
 
         if not os.path.exists(file_path):
@@ -69 +86 @@
 
 def main():
+    """
+    main loop function if running alone for testing.
+    """
     app = wx.App()
     DocumentationWindow(None, -1, "index.html", "", "Documentation",)