Changeset 5480

Timestamp:

Jan 25, 2023 7:25:06 PM (10 months ago)

Author:

toby

Message:

grey out update menu items w/o write access to installation directory; document help menu in help file.

Location:

trunk

Files:

• GSASIIctrlGUI.py (modified) (2 diffs)
• help/gsasII.html (modified) (3 diffs)

trunk/GSASIIctrlGUI.py

@@ -5418 +5418 @@
             helpobj = self.Append(wx.ID_ANY,'&Check for updates\tCtrl+U',
                     'Updates to latest GSAS-II version')
-            frame.Bind(wx.EVT_MENU, self.OnCheckUpdates, helpobj)
+            if os.access(GSASIIpath.path2GSAS2, os.W_OK):
+                frame.Bind(wx.EVT_MENU, self.OnCheckUpdates, helpobj)
+            else:
+                helpobj.Enable(False)
             helpobj = self.Append(wx.ID_ANY,'&Regress to old GSAS-II version',
                     'Installs previous GSAS-II version')
-            frame.Bind(wx.EVT_MENU, self.OnSelectVersion, helpobj)
-            # if GSASIIpath.svnTestBranch():
-            #     msg = "&Switch back to standard GSAS-II version"
-            # else:
-            #     msg = "&Switch to test (2frame) GSAS-II version"
-            # helpobj = self.Append(
-            #     help='', id=wx.ID_ANY, kind=wx.ITEM_NORMAL,text=msg)
-            # frame.Bind(wx.EVT_MENU, self.OnSelectBranch, helpobj)
+            if os.access(GSASIIpath.path2GSAS2, os.W_OK):
+                frame.Bind(wx.EVT_MENU, self.OnSelectVersion, helpobj)
+            else:
+                helpobj.Enable(False)
         # provide special help topic names for extra items in help menu
         for lbl,indx in morehelpitems:
@@ -5437 +5436 @@
         self.AppendSeparator()
         if includeTree:
-            helpobj = self.Append(wx.ID_ANY,'Help on Data tree',
-                'Web page on GSAS-II data structure')
+            helpobj = self.Append(wx.ID_ANY,'Help on GSAS-II',
+                'Access web page with information on GSAS-II')
             frame.Bind(wx.EVT_MENU, self.OnHelpById, id=helpobj.GetId())
             self.HelpById[helpobj.GetId()] = 'Data tree'
         helpobj = self.Append(wx.ID_ANY,'Help on current data tree item\tF1',
-                'Web page on selected item in tree')
+                'Access web page on selected item in tree')
         frame.Bind(wx.EVT_MENU, self.OnHelpById, id=helpobj.GetId())
        

trunk/help/gsasII.html

@@ -6798 +6798 @@
 </div>
 
-<p class=MsoNormal style='margin-left:.75in'><span style='color:white;
-mso-color-alt:windowtext'>If you use this, please cite M.H. Mendenhall, K.
+<p class=MsoNormal style='margin-left:.75in'>
+If you use this, please cite M.H. Mendenhall, K.
 Mullen &amp; J.P. Cline (2015), </span><i>J. Res. of NIST</i>, <b>120</b>,
-p223. DOI: 10.6028/jres.120.014. If the incident beam monochromator model is
+p223.
+<A HREF="https://doi.org/10.6028/jres.120.014">
+DOI: 10.6028/jres.120.014.</A>
+If the incident beam monochromator model is
 used, please also cite: M.H. Mendenhall, D. Black &amp; J.P. Cline (2019), <i>J.
-Appl. Cryst.</i>, <b>52</b>, p1087. DOI: 10.1107/S1600576719010951. </p>
+Appl. Cryst.</i>, <b>52</b>, p1087.
+<A HREF="https://doi.org/10.1107/S1600576719010951"> 
+DOI: 10.1107/S1600576719010951.</A> </p>
 
 <p class=MsoNormal style='margin-left:.75in'><span style='mso-fareast-font-family:
@@ -7004 +7009 @@
 data; a header on each indicated the source file name and the column headings.
 The file name comes from the PDF entry in the GSAS-II data tree. </p>
+
+<p class=MsoListParagraphCxSpMiddle style='margin-left:.25in;mso-add-space:
+auto;text-indent:-.25in;mso-list:l16 level1 lfo2;tab-stops:list .25in'><![if !supportLists]><span
+style='mso-list:Ignore'>6.<span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+</span></span><![endif]><b>Help</b> Menu<span style='mso-fareast-font-family:
+"Times New Roman";mso-fareast-theme-font:minor-fareast'><o:p></o:p></span></p>
+
+<p class=MsoListParagraphCxSpMiddle style='margin-left:.25in;mso-add-space:
+auto'>The help menu allows for updating or selecting a GSAS-II
+version, access to GSAS-II tutorials, or access to documentation on
+GSAS-II. 
+<UL>
+<LI>
+  <b>Check for updates</b>
+  This accesses the internet to see if a newer version of GSAS-II is
+  available for download. This will appear as inactive (greyed out) if
+  you do not have write access to the directory where GSAS-II is
+  installed and will not appear in the menu if the subversion (svn)
+  program needed to make updates is not found. 
+  
+<LI>
+  <b>Regress to old GSAS-II version</b>
+  This allows the GSAS-II version to be set to an older version. One
+  might want to do this to confirm that the result obtained previously
+  is reproduced in the latest code or to avoid a bug that has
+  inadvertently been introduced. Please note that if there is a reason
+  why you feel that an older GSAS-II version does something better than
+  the latest version, please get in touch with the software authors
+  (use of the mailing list, see
+  <A href="https://subversion.xray.aps.anl.gov/trac/pyGSAS#MailingList">
+  https://subversion.xray.aps.anl.gov/trac/pyGSAS#MailingList</A>) is
+  a good way to do this.) Bugs are usually not addressed unless
+  reported and if "improvements" are problematic we want to know this.  
+  This will appear as inactive (greyed out) if
+  you do not have write access to the directory where GSAS-II is
+  installed and will not appear in the menu if the subversion (svn)
+  program needed to make updates is not found.   
+
+<LI>
+  <b>Tutorials</b>
+  GSAS-II offers more than 50 tutorials on different aspects of the
+  program. If this menu command is used, one can view a tutorial,
+  optionally downloading it and the input files needed to run the
+  tutorial. 
+
+<LI>
+  <b>Help on GSAS-II</b> Opens this file, with GSAS-II documentation,
+  in a browser. 
+  
+<LI>
+  <b>Help on current data tree item</b>
+  Opens the GSAS-II documentation to the code section describing the
+  last selected item in the Data Tree. 
+</UL>
 
 <div class=MsoNormal align=center style='text-align:center'><span
@@ -11738 +11797 @@
 </span></div>
 
-<p class=MsoNormal style='tab-stops:45.8pt 91.6pt 137.4pt 183.2pt 229.0pt 274.8pt 320.6pt 366.4pt 412.2pt 458.0pt 503.8pt 549.6pt 595.4pt 641.2pt 687.0pt 732.8pt'><!-- hhmts start --><span
-style='color:#4A4A4A'>Last modified: Wed Jul 27 14:40:38 CDT 2022 <o:p></o:p></span></p>
-
-</div>
-
-<!-- hhmts end -->
+<p class=MsoNormal style='tab-stops:45.8pt 91.6pt 137.4pt 183.2pt 229.0pt 274.8pt 320.6pt 366.4pt 412.2pt 458.0pt 503.8pt 549.6pt 595.4pt 641.2pt 687.0pt 732.8pt'><!-- hhmts start -->Last modified: Wed Jan 25 20:20:57 CST 2023 <!-- hhmts end -->
 </body>