Changeset 2609


Ignore:
Timestamp:
Jan 3, 2017 12:19:38 PM (5 years ago)
Author:
toby
Message:

add index at top of help

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/help/gsasII.html

    r2607 r2609  
    31683168that can be selected, cut &amp; pasted into a document. <o:p></o:p></span></p>
    31693169
    3170 <h3><a name="Mac"><strong>Macintosh
    3171 notes</strong></a><strong>:<o:p></o:p></strong></h3>
    3172 
    3173 GSAS-II can be run on Windows, Linux and Macintosh/OS X computers, but
    3174 due to the different nature of the Mac, the program behaves slightly
    3175 differently. On Windows and Linux, there are two menu bars: (A) found
    3176 at the top of the GSAS-II data tree and (B) on GSAS-II data editing
    3177 window. The latter changes, based on which data item is selected in
    3178 the data tree. On the Mac, these menus are combined located on the
    3179 location that has been configured for menus (usually at the top of the
    3180 screen). The main manu and the data editing menu (if present) are
    3181 separated by a vertical bar.
    3182 <P>
    3183 GSAS-II uses both the left and right buttons on a two-button mouse. If
    3184 a mac has a two or three-button mouse attached, these mouse buttons will be
    3185 used on the other platforms. If using a Mac touchpad or single-button
    3186 mouse, the control-key should be held down to simulate use of the
    3187 right mouse button. The left button click is generated otherwise. 
    3188 
    3189 <h3><a name="Preferences"><strong>Configuration Variables</strong></a><strong>:<o:p></o:p></strong></h3>
    3190 
    3191 <p class=MsoNormal><span style='mso-fareast-font-family:"Times New
    3192 Roman"'>GSAS-II provides a number of configuration settings that can
    3193 be changed via variables that can be set and saved. These are
    3194 controlled in the File/Preferences menu item (on Mac the Preferences
    3195 menu is found in the usual place, in the main application menu). These
    3196 settings are optionally saved from for subsequent runs in a file named
    3197 <tt>config.py</tt>. More information about this can be found in the
    3198 <a
    3199 href="https://subversion.xray.aps.anl.gov/pyGSAS/sphinxdocs/build/html/GSASIIutil.html#module-config_example">
    3200 appropriate section of the Programmer's documentation</a>.
    3201 
    3202 <h3><a name="Programmers"><strong>Programmers documentation</strong></a></h3>
    3203 
    3204 <p class=MsoNormal><span style='mso-fareast-font-family:"Times New Roman"'>The
    3205 routines and classes used within GSAS-II are documented in a set of <a
    3206 href="https://subversion.xray.aps.anl.gov/pyGSAS/sphinxdocs/build/html/index.html">web
    3207 pages</a> and in a <a
    3208 href="https://subversion.xray.aps.anl.gov/pyGSAS/sphinxdocs/build/latex/GSASIIdoc.pdf">PDF
    3209 document</a>. This documentation is created from the Python source code files
    3210 using Sphinx. </span></p>
    3211 
    3212 <p class=MsoNormal><span style='mso-fareast-font-family:"Times New Roman"'><o:p>&nbsp;</o:p></span></p>
     3170<h2><a name="Index">Help Index</a></h2>
     3171<OL>
     3172  <LI><a href="#Tutorials">Learning GSAS-II: tutorials</a></LI>
     3173  <LI><a href="#Data_tree">Application windows</a></LI>
     3174  <LI><a href="#main_menu">Main menu commands</a></LI>
     3175  <LI>Data Tree headings, graphics windows and menu commands</LI>
     3176  <OL type="A">
     3177  <LI><a href="#Data_tree_items">Top-level </a>Data Tree headings</LI>
     3178  <LI><a href="#Phase">Phase </a>Data Tree headings</LI>
     3179  <LI><a href="#IMG">Image (IMG) </a>Data Tree headings</LI>
     3180  <LI><a href="#PWDR">Powder histogram (PWDR) </a>Data Tree headings</LI>
     3181  <LI><a href="#HKLF">Single Crystal histogram (HKLF)</a> Data Tree
     3182  headings</LI>
     3183 
     3184  <LI><a href="#PDF">Pair Distribution Functions (PDF) </a>Data Tree headings</LI>
     3185  <LI><a href="#PKS">Powder Peaks (PKS) </a>Data Tree headings</LI>
     3186  <LI><a href="#SASD">Small Angle Scattering (SASD) </a>Data Tree
     3187  headings</LI>
     3188  </OL>
     3189  <LI>Other: <a href="#Mac">Macintosh notes</a>,
     3190  <a href="#Preferences">Configuration options</a>
     3191  and <a href="#Programmers">Programmers documentation</a>
     3192</OL>
     3193
    32133194
    32143195<h2><a name="Tutorials"><strong>GSAS-II tutorials</strong></a><strong>:<o:p></o:p></strong></h2>
     
    34503431<h2><a name="Data_tree">
    345134321. Main GSAS-II data tree items</a></h2>
    3452 
    34533433<p class=MsoNormal style='margin-left:.5in'><span style='mso-fareast-font-family:
    34543434"Times New Roman"'>The data tree shows contents of a GSAS-II project
     
    35493529<hr size=2 width="100%" align=center>
    35503530
    3551 <h2><a name="main_menu"></a><span style='mso-fareast-font-family:
    3552 "Times New Roman"'>4. Main GSAS-II menu commands<o:p></o:p></span></h2>
     3531<h2><a name="main_menu">4. Main GSAS-II menu commands</a></h2>
    35533532<OL style='margin-left:.5in'>
    35543533  <LI>Menu <B>File</B>
     
    71767155<hr size=2 width="100%" align=center>
    71777156
    7178 <!-- hhmts start -->Last modified: Sun Jan  1 17:06:30 CST 2017 <!-- hhmts end -->
     7157<h3><a name="Mac"><strong>Macintosh
     7158notes</strong></a><strong>:<o:p></o:p></strong></h3>
     7159
     7160GSAS-II can be run on Windows, Linux and Macintosh/OS X computers, but
     7161due to the different nature of the Mac, the program behaves slightly
     7162differently. On Windows and Linux, there are two menu bars: (A) found
     7163at the top of the GSAS-II data tree and (B) on GSAS-II data editing
     7164window. The latter changes, based on which data item is selected in
     7165the data tree. On the Mac, these menus are combined located on the
     7166location that has been configured for menus (usually at the top of the
     7167screen). The main manu and the data editing menu (if present) are
     7168separated by a vertical bar.
     7169<P>
     7170GSAS-II uses both the left and right buttons on a two-button mouse. If
     7171a mac has a two or three-button mouse attached, these mouse buttons will be
     7172used on the other platforms. If using a Mac touchpad or single-button
     7173mouse, the control-key should be held down to simulate use of the
     7174right mouse button. The left button click is generated otherwise. 
     7175
     7176<h3><a name="Preferences"><strong>Configuration Variables</strong></a><strong>:<o:p></o:p></strong></h3>
     7177
     7178<p class=MsoNormal><span style='mso-fareast-font-family:"Times New
     7179Roman"'>GSAS-II provides a number of configuration settings that can
     7180be changed via variables that can be set and saved. These are
     7181controlled in the File/Preferences menu item (on Mac the Preferences
     7182menu is found in the usual place, in the main application menu). These
     7183settings are optionally saved from for subsequent runs in a file named
     7184<tt>config.py</tt>. More information about this can be found in the
     7185<a
     7186href="https://subversion.xray.aps.anl.gov/pyGSAS/sphinxdocs/build/html/GSASIIutil.html#module-config_example">
     7187appropriate section of the Programmer's documentation</a>.
     7188
     7189<h3><a name="Programmers"><strong>Programmers documentation</strong></a></h3>
     7190
     7191<p class=MsoNormal><span style='mso-fareast-font-family:"Times New Roman"'>The
     7192routines and classes used within GSAS-II are documented in a set of <a
     7193href="https://subversion.xray.aps.anl.gov/pyGSAS/sphinxdocs/build/html/index.html">web
     7194pages</a> and in a <a
     7195href="https://subversion.xray.aps.anl.gov/pyGSAS/sphinxdocs/build/latex/GSASIIdoc.pdf">PDF
     7196document</a>. This documentation is created from the Python source code files
     7197using Sphinx. </span></p>
     7198
     7199<P>&nbsp;</P>
     7200
     7201<hr size=2 width="100%" align=center>
     7202<hr size=2 width="100%" align=center>
     7203
     7204<!-- hhmts start -->Last modified: Tue Jan  3 12:18:13 CST 2017 <!-- hhmts end -->
    71797205
    71807206</div>
Note: See TracChangeset for help on using the changeset viewer.