Changeset 652


Ignore:
Timestamp:
Dec 4, 2009 5:09:45 PM (11 years ago)
Author:
toby
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/gsas2cif.html

    • Property rcs:date changed from 2002/07/31 00:33:41 to 2002/09/05 21:18:57
    • Property rcs:lines changed from +73 -11 to +87 -51
    • Property rcs:rev changed from 1.3 to 1.4
    r635 r652  
    234234</BLOCKQUOTE>
    235235<a name="filltemplate">
    236 <H3>The FillTemplate program</H3>
     236<H2>The FillTemplate program</H2>
    237237<BLOCKQUOTE>
    238238</a>
     
    249249opens a window, as is shown below:
    250250</BLOCKQUOTE>
     251</BLOCKQUOTE>
    251252<img src="ciffill1.gif" alt="View of FillTemplate window">
    252253<BLOCKQUOTE>
    253 The box on the left side of the window displays the datanames in the CIF
     254<BLOCKQUOTE>
     255The box on the left side of the window displays the data names in the CIF
    254256as a hierarchical tree. Note that subentries can be displayed or hidden
    255 by clicking on the +/- sign to the right of a group. For example,
    256 by default the datanames contained in each loop are not shown, but
    257 clicking on the + sign to the right of the "loop_0" listing (shown below),
    258 allows the three data items included in this loop to be displayed.
    259 <P>
    260 Clicking on an individual dataname causes the
    261 associated value to be displayed on the right. This value can be edited by
    262 clicking on the entry box. Note these edits are not performed until
    263 the "Save Changes" button is pressed, unless the
    264 "<a href="#autoaccept">Auto-Accept</a>" is turned on.
    265 <P>
    266 In the case above, the dataname
    267 _pd_prep_temperature is defined in the CIF dictionary as a number
    268 between 0 and infinity and
    269 the units are defined as Kelvins, so the input will be validated to ensure
    270 that only numbers in the allowed range are input and the units are displayed.
    271 If the CIF dictionary defines a enumerated list of values
    272 for a dataname, these are the only valid choices, so a menu button offers
    273 a list of these options, in place of a box where text can be typed.
    274 <P>
    275 CIF loops allow multiple values to be associated with one or more data items,
    276 in effect defining a table of data.
    277 Clicking on a loop, causes all the datanames in the loop to be displayed,
    278 as is shown below.
    279 </BLOCKQUOTE>
    280 <img src="ciffill.gif" alt="View of FillTemplate window">
    281 <BLOCKQUOTE>
    282 When a loop is displayed, extra controls appear. The "spinbox" to the right
    283 of the "Loop element #" label is used to select
    284 which "row" from the loop is displayed. A new row can be added to the end of a
    285 loop using the "Add to loop" button and the displayed
    286 row can be deleted from a loop
    287 using the "Delete loop entry" button.
    288 It is also possible to click on the dataname for a item inside a loop, in this
    289 case, all entries for that data item in the loop
    290 are displayed (a column).
     257by clicking on the +/- sign to the right of each grouping. For example,
     258by default the data names contained in each loop are not shown.
     259However, clicking on the + sign to the right of the "loop_0" listing
     260causes the data names in the loop to be shown (as in
     261the <a href="#loopfig">example below</a>.)
     262<P>
     263Clicking on an individual data name causes the
     264associated value to be displayed on the right. The value associated
     265with the data name can be edited by
     266clicking on the entry box. The information you enter is copied into the
     267in-memory copy of the CIF when you click on another
     268data name, etc.
     269<P>
     270In the example shown above, the data name
     271<tt>_cell_measurement_temperature</tt> has been selected.
     272This is defined in the
     273CIF dictionary as a number
     274between 0 and infinity with
     275units of Kelvins. These units (K) are displayed adjacent to the entry box.
     276When appropriate input is validated to require
     277that valid numbers in the allowed range are input or that
     278standard uncertainties (esd's) are entered only where allowed.
     279Likewise, if the CIF dictionary defines a enumerated list of values
     280for a data name, a menu button is offered in place of an entry box. In
     281this way, only a valid entry from the list can be selected.
    291282<P>
    292283The controls on the bottom of the window have the following effects:
     
    294285<BLOCKQUOTE>
    295286<DL>
    296 <DT><B>Save Changes</B><DD>
    297287<P><DT><B>Template file</B><DD>
    298288The menu button labeled "Template file" offers a list of template files. This
     
    312302made to a data item or the CIF has been changed, but have not been saved,
    313303a chance is offered to save these items.
    314 <P><DT><a name="cifcontents"><B>Show/Hide CIF contents</B></A><DD>
     304<P><DT><a name="cifcontents"><B>Show (Hide) CIF contents</B></A><DD>
    315305The "Show CIF contents" button causes a window to be displayed
    316306that shows the text of the CIF, as shown below. As CIF data items
     
    322312have been made to the CIF
    323313so another section of the file must be changed, before the edits can be
    324 saved to disk (see the <a href="#saveedits">Save Edits</a> button).
     314saved to disk (see the <a href="#saveedits">Save</a> button).
    325315<P>
    326316After the "Show CIF contents" button is pressed, the label changes to
     
    328318<BR>
    329319<img src="cif_contents.gif" alt="View of CIF text window">
    330 <P><DT><B>Show/Hide CIF definitions</B><DD>
    331 As CIF datanames are selected, their definitions are shown in the
     320<P><DT><B>Show (Hide) CIF definitions</B><DD>
     321As CIF data names are selected, their definitions are shown in the
    332322CIF Definitions window, as shown below.
    333323After the "Show CIF definitions" button is pressed, the label changes to
     
    336326<BR>
    337327<img src="cifdef.gif" alt="View of CIF definitions window">
    338 <P><DT><a name="saveedits"><B>Save Edits</B></a><DD>
     328
     329<P><DT><a name="undo"><B>Undo</B></a><DD>
     330As changes are made to the CIF template, they are recorded and can be
     331reversed using the "Undo" button. There is no limit to the number of changes
     332that are recorded. However, changes cannot be undone after the CIF has been
     333saved to disk.
     334<P><DT><a name="redo"><B>Redo</B></a><DD>
     335If changes have been reversed with the <a href="#undo">"Undo"</a> button,
     336the changes can be
     337reapplied using the "Redo" button. The list of changes available for "Redo"
     338is cleared when a new edit is made or when the CIF is saved.
     339
     340<P><DT><a name="saveedits"><B>Save</B></a><DD>
    339341Changes made to the CIF are not saved to the disk file automatically,
    340342unless the <a href="#autosave">Auto-Save</a> checkbutton is set. When changes
    341343have been made, but not saved to disk, this button is made active.
    342 <P><DT><a name="autoaccept"><B>Auto-Accept</B></a><DD>
    343 When the Auto-Accept mode is not selected,
    344 as information is added to the edit boxes for CIF items, these changes are
    345 not made to the in-memory copy of the CIF that is displayed in the
    346 <a href="#cifcontents">CIF Contents window</a>. The "Save Changes"
    347 button causes these changes to be applied. If the
    348 Auto-Accept mode is selected, these changes are made automatically.
    349344<P><DT><a name="autosave"><B>Auto-Save</B></a><DD>
    350345When the Auto-Save mode is not selected,
    351346changes made to the in-memory copy of the CIF that is displayed in the
    352347<a href="#cifcontents">CIF Contents window</a> are not written to
    353 the disk file until the "<a href="#saveedits">Save Changes</a>"
     348the disk file until the "<a href="#saveedits">Save</a>"
    354349button is pressed. If the
    355350Auto-Save mode is selected, these changes are saved to disk automatically.
    356351</DL>
    357352</BLOCKQUOTE>
     353<H3>CIF loops</H3>
     354<P>
     355CIF loops allow multiple values to be associated with one or more data items,
     356in effect defining a table of data.
     357Clicking on a loop, causes all the data names in the loop to be displayed,
     358as is shown below.
     359</BLOCKQUOTE>
     360</BLOCKQUOTE>
     361<a name="loopfig"></a>
     362<img src="ciffill.gif" alt="View of FillTemplate window">
     363<BLOCKQUOTE>
     364<BLOCKQUOTE>
     365When a loop is displayed, extra controls appear, as are defined below.
     366<BLOCKQUOTE>
     367<DL>
     368<P><DT><a name="loopspinbox"><B>Loop element #</B></a><DD>
     369The Loop element #" spinbox" is used to select
     370which "row" from the loop is displayed. The up arrow advances to the next
     371row, while the down arrow reverses by one entry. Numbers can also be typed into
     372the entry box; the number is accepted when Enter is pressed.
     373The keyboard up and down arrows can also
     374be used to advance between entries. Other keys such as Page Up, Home, etc.
     375advance in large increments.
     376<P><DT><B>Add to loop</B><DD>
     377A new row can be added to the end of a
     378loop using the "Add to loop" button. The value for each new entry
     379is initialized as "?" (meaning value unknown or unspecified.)
     380<P><DT><B>Delete loop entry</B><DD>
     381This deletes the current row from the loop.
     382First select the row to delete with the
     383"<a href="#loopspinbox">Loop element #</A>"
     384spinbox. Note that the values are displayed for confirmation before the
     385delete operation is performed.
     386It is not possible to delete all entries from a loop, so
     387this button is disabled when a loop has only a single row defined.
     388</DL>
     389</BLOCKQUOTE>
     390It is also possible to click on the data name for a item inside a loop, in this
     391case, all entries for that data item in the loop
     392are displayed (a column).
     393
    358394
    359395</BLOCKQUOTE>
    360396<a name="cifselect">
    361 <H3>The CIFSelect utility</H3>
     397<H2>The CIFSelect utility</H2>
    362398<BLOCKQUOTE>
    363399</a>
Note: See TracChangeset for help on using the changeset viewer.