[Jmol-commits] CVS: Jmol/doc/source JmolGuide.docbook.xml,1.11,1.12

[Michael T H. <mic...@us...>]

Update of /cvsroot/jmol/Jmol/doc/source
In directory sc8-pr-cvs1:/tmp/cvs-serv22935

Modified Files:
	JmolGuide.docbook.xml 
Log Message:
added a few Chime scripting commands to doc


Index: JmolGuide.docbook.xml
===================================================================
RCS file: /cvsroot/jmol/Jmol/doc/source/JmolGuide.docbook.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -r1.11 -r1.12
*** JmolGuide.docbook.xml	10 Feb 2003 20:23:53 -0000	1.11
--- JmolGuide.docbook.xml	10 Feb 2003 22:26:15 -0000	1.12
***************
*** 552,560 ****
      </para>
      <para>
!       Jmol currently supports many (most?) of RasMol/Chime scripting commands. 
      </para>
      <para>
!       Most movement, selection, atom expression and color commands are
!       operational.
      </para>
      <para>
--- 552,578 ----
      </para>
      <para>
!       Jmol supports the RasMol scripting language defined by RasMol. 
!       Information about RasMol can be found at www.openrasmol.org
!       The current URL for full RasMol documentation is:
!       http://www.openrasmol.org/doc/rasmol.htm
      </para>
      <para>
!       The Chime web browser plug-in was based upon the RasMol source code.
!       Various extensions were added, including additional scripting
!       commands. Information about Chime can be found at
!       http://www.mdlchime.com
!       The current URL for extended chime scripting commands is:
!       http://www.mdlchime.com/chime/chimerasmol.html
!     </para>
!     <para>
!       Jmol currently supports many of RasMol/Chime scripting commands. Our
!       goal is to eventually provide full script support. This will provide
!       a migration path for those who wish to move to an open source solution
!       that supports a larger number of file formats on a wider variety of
!       hardware platforms. 
!     </para>
!     <para>
!       In this release most movement, selection, atom expression and
!       color commands are operational. 
      </para>
      <para>
***************
*** 634,637 ****
--- 652,667 ----
        </section>
        <section>
+ 	<title>delay {&lt;delaytime&gt;}</title>
+ 	<para>
+ 	  Chime extended command.
+ 	</para>
+ 	<para>
+ 	  Causes the screen to refresh and the script to stop executing
+ 	  for 'delaytime' seconds. Decimal values can be used to
+ 	  represent fractions of seconds. If 'delaytime' is not specified
+ 	  the default delay is 1 second.
+ 	</para>
+       </section>
+       <section>
  	<title>echo &lt;string&gt;</title>
  	<para>
***************
*** 677,680 ****
--- 707,720 ----
        </section>
        <section>
+ 	<title>loop {&lt;delaytime&gt;}</title>
+ 	<para>
+ 	  Chime extended command.
+ 	</para>
+ 	<para>
+ 	  Causes the current script file to re-execute from the top after
+ 	  'delaytime' seconds. Default value for 'delaytime' is 1 second.
+ 	</para>
+       </section>
+       <section>
  	<title>monitor &lt;number&gt; &lt;number&gt; {&lt;number&gt;} {&lt;number&gt;}</title>
  	<para>
***************
*** 689,692 ****
--- 729,771 ----
  	<para>
  	  Jmol extension: Four atoms specify a dihedral angle measurement.
+ 	</para>
+       </section>
+       <section>
+ 	<title>move &lt;xRot&gt; &lt;yRot&gt; &lt;zRot; &lt;zoom&gt;
+ 	  &lt;xTrans&gt; &lt;yTrans&gt; &lt;zTrans&gt; &lt;slab&gt;
+ 	  &lt;time&gt; {&lt;FPS&gt;} {&lt;MaxAccel&gt;}
+ 	</title>
+ 	<para>
+ 	  Chime extended command.
+ 	</para>
+ 	<para>
+ 	  The move command provides powerful animation capabilities. It
+ 	  allows you to specify rotations, zooming, and translations
+ 	  to be performed in a specified period of time.
+ 	</para>
+ 	<para>
+ 	  xRot, yRot, and zRot are rotations about the cartesian axes
+ 	  in degrees.
+ 	</para>
+ 	<para>
+ 	  Zoom specifies a zoom factor (there is a good chance this
+ 	  is not currently implemented properly)
+ 	</para>
+ 	<para>
+ 	  xTrans, yTrans, and zTrans are translations in the range
+ 	  -100 to 100. 
+ 	</para>
+ 	<para>
+ 	  If you don't know what slab is, just put in a zero. see the
+ 	  'slab' command for more information.
+ 	</para>
+ 	<para>
+ 	  'time' is the total time in seconds for the movement.
+ 	</para>
+ 	<para>
+ 	  FPS and MaxAccel control the animation rate. The default
+ 	  values work fine, non-default values may not work at all.
+ 	  If you need and/or want these to work, send us an email
+ 	  and we will get it working. 
  	</para>
        </section>