dVR Builder Lite was used as a starting point for
this Jmol Tutorial Template. It has been modified!
Below is the document that came with dVR Builder Lite.
This file was originally named readme.txt.
--------------------------------------------------------
README file for dVR Builder Lite.
file readme.txt.
#############################
RELEASE NOTES
dVR Builder Lite.
version 0.1b.
released 2005-04-19.
created 2005 by molvisions .
modified 2007 by Molecules in Motion :http://moleculesinmotion.com>
#############################
ABOUT
dVR Builder Lite is a downloadable, offline, javascript-driven template for
creating browser-based Jmol tutorials. It is a free and open-source resource
that can be modified and redistributed as desired.
dVR Builder Lite includes the Jmol applet, which is protected under the LGPL
licence (see for more information).
Any questions, comments, concerns, or suggestions can be sent to
. Please be sure to indicate dVR Builder
Lite, and which version.
#############################
FILESYSTEM
config.js
- contains global settings for the tutorial.
- loaded by every html page.
index.html
- template for a page of a tutorial.
- duplicate for multiple pages.
- contains settings for all buttons on the page.
*.pdb, *.spt
You can add structure and script files to the dvrblite folder as needed for
your tutorial.
The following files contain no user-serviceable parts and should not be opened:
- dvrblite.css
- dvrblite.js
- jmol.js
- JmolApplet.jar
#############################
GETTING STARTED
Open config.js. Follow the notes in this file to change global properties. For
tutorials with multiple pages, use setNavigationBar at the bottom of the file
to configure the format and placement of the navigation system.
Open index.html in a text editor, and find the USER-CUSTOMIZABLE SECTION near
the top. This section contains four main elements:
1. setPageTitle - Does just what it says.
2. setStart - Defines what happens when the page first loads. It takes one or
two arguments: the first is the pdb file to load; the second (optional) is the
script to run.
3. setNavigation - Defines the previous and next pages in a multi-page tutorial.
4. Buttons. Each button is defined by an array, or group, of several settings. These
settings are annotated in the html file. Each button is dilineated by comments
"start of button" and "end of button." To create additional buttons, duplicate
the entire button block.
Duplicate, rename, and edit index.html for additional pages in your tutorial.
#############################
EOF