Changeset 652

Timestamp:

Dec 4, 2009 5:09:45 PM (14 years ago)

Author:

toby

Message:

# on 2002/09/05 21:18:57, toby did:
more updates

File:

• trunk/doc/gsas2cif.html (modified) (7 diffs, 3 props)

trunk/doc/gsas2cif.html

@@ -234 +234 @@
 </BLOCKQUOTE>
 <a name="filltemplate">
-<H3>The FillTemplate program</H3>
+<H2>The FillTemplate program</H2>
 <BLOCKQUOTE>
 </a>
@@ -249 +249 @@
 opens a window, as is shown below:
 </BLOCKQUOTE>
+</BLOCKQUOTE>
 <img src="ciffill1.gif" alt="View of FillTemplate window">
 <BLOCKQUOTE>
-The box on the left side of the window displays the datanames in the CIF
+<BLOCKQUOTE>
+The box on the left side of the window displays the data names in the CIF
 as a hierarchical tree. Note that subentries can be displayed or hidden 
-by clicking on the +/- sign to the right of a group. For example,
-by default the datanames contained in each loop are not shown, but 
-clicking on the + sign to the right of the "loop_0" listing (shown below),
-allows the three data items included in this loop to be displayed.
-<P>
-Clicking on an individual dataname causes the 
-associated value to be displayed on the right. This value can be edited by
-clicking on the entry box. Note these edits are not performed until 
-the "Save Changes" button is pressed, unless the 
-"<a href="#autoaccept">Auto-Accept</a>" is turned on.
-<P>
-In the case above, the dataname
-_pd_prep_temperature is defined in the CIF dictionary as a number 
-between 0 and infinity and 
-the units are defined as Kelvins, so the input will be validated to ensure
-that only numbers in the allowed range are input and the units are displayed.
-If the CIF dictionary defines a enumerated list of values
-for a dataname, these are the only valid choices, so a menu button offers
-a list of these options, in place of a box where text can be typed.
-<P>
-CIF loops allow multiple values to be associated with one or more data items,
-in effect defining a table of data.
-Clicking on a loop, causes all the datanames in the loop to be displayed, 
-as is shown below.
-</BLOCKQUOTE>
-<img src="ciffill.gif" alt="View of FillTemplate window">
-<BLOCKQUOTE>
-When a loop is displayed, extra controls appear. The "spinbox" to the right 
-of the "Loop element #" label is used to select
-which "row" from the loop is displayed. A new row can be added to the end of a 
-loop using the "Add to loop" button and the displayed 
-row can be deleted from a loop 
-using the "Delete loop entry" button.
-It is also possible to click on the dataname for a item inside a loop, in this
-case, all entries for that data item in the loop 
-are displayed (a column).
+by clicking on the +/- sign to the right of each grouping. For example,
+by default the data names contained in each loop are not shown. 
+However, clicking on the + sign to the right of the "loop_0" listing 
+causes the data names in the loop to be shown (as in 
+the <a href="#loopfig">example below</a>.)
+<P>
+Clicking on an individual data name causes the 
+associated value to be displayed on the right. The value associated 
+with the data name can be edited by
+clicking on the entry box. The information you enter is copied into the 
+in-memory copy of the CIF when you click on another 
+data name, etc.
+<P>
+In the example shown above, the data name
+<tt>_cell_measurement_temperature</tt> has been selected. 
+This is defined in the
+CIF dictionary as a number 
+between 0 and infinity with 
+units of Kelvins. These units (K) are displayed adjacent to the entry box. 
+When appropriate input is validated to require
+that valid numbers in the allowed range are input or that 
+standard uncertainties (esd's) are entered only where allowed.
+Likewise, if the CIF dictionary defines a enumerated list of values
+for a data name, a menu button is offered in place of an entry box. In 
+this way, only a valid entry from the list can be selected.
 <P>
 The controls on the bottom of the window have the following effects:
@@ -294 +285 @@
 <BLOCKQUOTE>
 <DL>
-<DT><B>Save Changes</B><DD>
 <P><DT><B>Template file</B><DD>
 The menu button labeled "Template file" offers a list of template files. This
@@ -312 +302 @@
 made to a data item or the CIF has been changed, but have not been saved,
 a chance is offered to save these items.
-<P><DT><a name="cifcontents"><B>Show/Hide CIF contents</B></A><DD>
+<P><DT><a name="cifcontents"><B>Show (Hide) CIF contents</B></A><DD>
 The "Show CIF contents" button causes a window to be displayed
 that shows the text of the CIF, as shown below. As CIF data items 
@@ -322 +312 @@
 have been made to the CIF
 so another section of the file must be changed, before the edits can be 
-saved to disk (see the <a href="#saveedits">Save Edits</a> button).
+saved to disk (see the <a href="#saveedits">Save</a> button).
 <P>
 After the "Show CIF contents" button is pressed, the label changes to 
@@ -328 +318 @@
 <BR>
 <img src="cif_contents.gif" alt="View of CIF text window">
-<P><DT><B>Show/Hide CIF definitions</B><DD>
-As CIF datanames are selected, their definitions are shown in the 
+<P><DT><B>Show (Hide) CIF definitions</B><DD>
+As CIF data names are selected, their definitions are shown in the 
 CIF Definitions window, as shown below. 
 After the "Show CIF definitions" button is pressed, the label changes to 
@@ -336 +326 @@
 <BR>
 <img src="cifdef.gif" alt="View of CIF definitions window">
-<P><DT><a name="saveedits"><B>Save Edits</B></a><DD>
+
+<P><DT><a name="undo"><B>Undo</B></a><DD>
+As changes are made to the CIF template, they are recorded and can be 
+reversed using the "Undo" button. There is no limit to the number of changes
+that are recorded. However, changes cannot be undone after the CIF has been
+saved to disk.
+<P><DT><a name="redo"><B>Redo</B></a><DD>
+If changes have been reversed with the <a href="#undo">"Undo"</a> button, 
+the changes can be 
+reapplied using the "Redo" button. The list of changes available for "Redo"
+is cleared when a new edit is made or when the CIF is saved.
+
+<P><DT><a name="saveedits"><B>Save</B></a><DD>
 Changes made to the CIF are not saved to the disk file automatically, 
 unless the <a href="#autosave">Auto-Save</a> checkbutton is set. When changes
 have been made, but not saved to disk, this button is made active.
-<P><DT><a name="autoaccept"><B>Auto-Accept</B></a><DD>
-When the Auto-Accept mode is not selected, 
-as information is added to the edit boxes for CIF items, these changes are
-not made to the in-memory copy of the CIF that is displayed in the 
-<a href="#cifcontents">CIF Contents window</a>. The "Save Changes" 
-button causes these changes to be applied. If the 
-Auto-Accept mode is selected, these changes are made automatically.
 <P><DT><a name="autosave"><B>Auto-Save</B></a><DD>
 When the Auto-Save mode is not selected, 
 changes made to the in-memory copy of the CIF that is displayed in the 
 <a href="#cifcontents">CIF Contents window</a> are not written to 
-the disk file until the "<a href="#saveedits">Save Changes</a>" 
+the disk file until the "<a href="#saveedits">Save</a>" 
 button is pressed. If the 
 Auto-Save mode is selected, these changes are saved to disk automatically.
 </DL>
 </BLOCKQUOTE>
+<H3>CIF loops</H3>
+<P>
+CIF loops allow multiple values to be associated with one or more data items,
+in effect defining a table of data.
+Clicking on a loop, causes all the data names in the loop to be displayed, 
+as is shown below.
+</BLOCKQUOTE>
+</BLOCKQUOTE>
+<a name="loopfig"></a>
+<img src="ciffill.gif" alt="View of FillTemplate window">
+<BLOCKQUOTE>
+<BLOCKQUOTE>
+When a loop is displayed, extra controls appear, as are defined below.
+<BLOCKQUOTE>
+<DL>
+<P><DT><a name="loopspinbox"><B>Loop element #</B></a><DD> 
+The Loop element #" spinbox" is used to select
+which "row" from the loop is displayed. The up arrow advances to the next 
+row, while the down arrow reverses by one entry. Numbers can also be typed into
+the entry box; the number is accepted when Enter is pressed.
+The keyboard up and down arrows can also 
+be used to advance between entries. Other keys such as Page Up, Home, etc. 
+advance in large increments.
+<P><DT><B>Add to loop</B><DD> 
+A new row can be added to the end of a 
+loop using the "Add to loop" button. The value for each new entry 
+is initialized as "?" (meaning value unknown or unspecified.)
+<P><DT><B>Delete loop entry</B><DD> 
+This deletes the current row from the loop.
+First select the row to delete with the 
+"<a href="#loopspinbox">Loop element #</A>"
+spinbox. Note that the values are displayed for confirmation before the 
+delete operation is performed. 
+It is not possible to delete all entries from a loop, so 
+this button is disabled when a loop has only a single row defined.
+</DL>
+</BLOCKQUOTE>
+It is also possible to click on the data name for a item inside a loop, in this
+case, all entries for that data item in the loop 
+are displayed (a column).
+
 
 </BLOCKQUOTE>
 <a name="cifselect">
-<H3>The CIFSelect utility</H3>
+<H2>The CIFSelect utility</H2>
 <BLOCKQUOTE>
 </a>