biojs-vis-pdbviewer
Version:
A BioJS 2.0 component to view protein structures
282 lines (212 loc) • 12.7 kB
Plain Text
==============================================================================
=== Jmol ===
==============================================================================
Jmol: un visor Java de c�digo abierto para estructuras qu�micas en
tres dimensiones, con prestaciones para compuestos qu�micos,
cristales, materiales y biomol�culas.
==============================================================================
Jmol es un visor de mol�culas y un editor; es de c�digo abierto y est�
escrito en Java.
Toda la informaci�n est� disponible en http://www.jmol.org/
Las preguntas o comentarios relativos a su uso deben enviarse a
jmol-users.sourceforge.net (en ingl�s)
Las preguntas, comentarios y sugerencias relativos a su desarrollo deben
enviarse a jmol-developers.sf.net (en ingl�s)
Lista de archivos incluidos:
--------------------
1 == Archivos con informaci�n ==
1.1 === LEAME.txt ===
Este archivo.
1.2 === README.txt ===
La versi�n en ingl�s de LEAME.txt
1.3 === COPYRIGHT.txt ===
Informaci�n sobre los derechos de copia relativos a Jmol y a sus componentes de
terceros.
1.4 === LICENSE.txt ===
Los t�rminos de uso y distribuci�n de Jmol (licencia GNU LGPL).
1.5 === CHANGES.txt ===
Una lista hist�rica con las prestaciones a�adidas en cada versi�n de Jmol.
1.6 === README-CHEMDOODLE.txt ===
Instrucciones sobre el uso de ChemDoodle junto con miniaplicaciones Jmol,
y sobre la licencia de ChemDoodle (que es diferente de la de Jmol).
2 == Archivos por lotes ==
Estos archivos pueden usarse para iniciar la aplicaci�n Jmol desde una consola
de instrucciones ("l�nea de comandos") y, en particular, para forzar una cierta
combinaci�n de par�metros
(v�ase http://wiki.jmol.org/index.php/Jmol_Application#Command_line_options).
2.1 === jmol ===
(Un tipo de archivo por lotes para iniciar la aplicaci�n Jmol.)
2.2 === jmol.bat ===
Archivo por lotes para iniciar la aplicaci�n Jmol en Windows.
2.3 === jmol.mac ===
(Un tipo de archivo por lotes para iniciar la aplicaci�n Jmol.)
2.4 === jmol.sh ===
Un archivo de instrucciones para iniciar la aplicaci�n Jmol en sistemas de tipo
Unix, por ejemplo Linux, BSD, Solaris o Cygwin para Windows.
3 == Archivos de la aplicaci�n Jmol ==
�sta se usa como un programa aut�nomo.
3.1 === Jmol.jar ===
El archivo ejecutable de la aplicaci�n Jmol (un programa escrito en Java).
Funciona como cualquier otro programa: se abre en su propia ventana, se puede
redimensionar o minimizar, se puede arrastrar y soltar archivos sobre �l, tiene
una barra superior de men�, puede abrir y grabar archivos, etc. Puede ejecutarse
desde la l�nea de comandos (particularmente, usando los archivos por lotes que
se describen m�s arriba) pero, si Java est� correctamente configurado en tu
sistema, normalmente basta con hacer doble clic en este archivo.
(Para obtener m�s informaci�n, consulte
http://wiki.jmol.org/index.php/Jmol_Application#Starting_Jmol_Application ).
3.2 === JmolData.jar ===
Esta es una versi�n reducida de Jmol.jar que carece de las capacidades de
visualizaci�n. De alg�n modo, contradice as� el concepto (cl�sico) de lo que es
jmol, pero con JmolData y algunas instrucciones bien dise�adas es posible
obtener casi cualquier informaci�n de un modelo y exponerla del modo que se
quiera.
Funciona s�lo desde la "l�nea de comandos" y est� dise�ada para extraer datos de
un modelo o grupo de ellos. S�lo pueden usarse instrucciones que no tengan
relaci�n con la visualizaci�n: hay enlaces pero no "varillas", �tomos pero no
"esferas de puntos", h�lices pero no "esquem�ticos".
4 == Archivos de la miniaplicaci�n Jmol ==
�stos se usan como parte de p�ginas web, e incluyen:
Archivos de miniaplicaci�n | Bibliotecas Javascript principales
| Bibliotecas Javascript opcionales
4.1 === Archivos de miniaplicaci�n ===
4.1.1 ==== JmolApplet0.jar y JmolApplet0(diversosSufijos).jar ====
�sta es la miniaplicaci�n, es decir, una versi�n del programa que s�lo funciona
cuando se incluye dentro de una p�gina web.
La miniaplicaci�n se divide en varios trozos de acuerdo con su funcionalidad, de
modo que si una p�gina no precisa determinado componente, �ste no se descargar�
desde el servidor. Aun as�, se recomienda que pongas todos los archivos
JmolApplet0*.jar en el servidor, incluso si tus p�ginas no usan sus
prestaciones, pues tanto el men� emergente como la consola permiten a los
usuarios acceder a funciones de Jmol que t� no hayas previsto.
Esta versi�n subdividida es la que se usa de forma predeterminada si utilizas
Jmol.js (que es el m�todo recomendado). Para ello, basta usar la forma m�s
simple de jmolInitialize(), indicando s�lo la carpeta que contiene el conjunto
de archivos jar:
jmolInitialize("carpeta-que-contiene-los-archivos-jar")
por ejemplo,
jmolInitialize(".")
(si los archivos jar est�n en la misma carpeta que la p�gina web)
jmolInitialize("../jmol")
(si los archivos jar est�n en una carpeta paralela, llamada 'jmol')
4.1.2 ==== JmolAppletSigned0.jar y JmolAppletSigned0(diversosSufijos).jar ====
Una versi�n equivalente de la miniaplicaci�n, pero en este caso "firmada" (un
t�rmino de seguridad en Java). Esto significa que el visitante de la p�gina web
debe autorizarla para que se ejecute, pero al hacerlo conseguir� un acceso a
archivos con menos restricciones. Por ejemplo, podr� acceder a archivos en
cualquier parte de su ordenador y en cualquier servidor web.
Habitualmente, los usuarios recibir�n un aviso pidi�ndoles que acepten el
"certificado" o que "conf�en" en la miniaplicaci�n (vea las observaciones a
continuaci�n). Debes tener esto en cuenta si decides usar JmolAppletSigned.jar.
Aparte de leer archivos, Jmol no usa actualmente otras posibilidades de las
miniaplicaciones firmadas, tales como acceso al portapapeles del sistema o
escritura de archivos. Utiliza esta versi�n s�lo si sabes lo que est�s haciendo
y has considerado las cuestiones de seguridad.
Para llamar a esta versi�n desde Jmol.js, utiliza la forma:
jmolInitialize("carpeta-que-contiene-los-archivos-jar", true)
o bien
jmolInitialize("carpeta-que-contiene-los-archivos-jar", "JmolAppletSigned0.jar")
Observaciones:
* La pol�tica de seguridad que solicita que se conf�e en la miniaplicaci�n
podr�a no estar siempre activa en los sistemas de los usuarios.
* El mensaje solicitando permiso se mostrar� para cada uno de los 14 o m�s
archivos jar que se pueden cargar.
* El usuario puede tener la posibilidad de confiar en la miniaplicaci�n de
forma permanente y as� evitar dar permiso cada vez que visite una p�gina que
utiliza Jmol.
4.1.3 ==== JmolApplet.jar ====
Se trata en este caso de la miniaplicaci�n en forma de un archivo "todo en uno"
o "monol�tico", que se mantiene principalmente por compatibilidad con p�ginas
antiguas que lo invoquen expl�citamente.
Este archivo �nico es equivalente al conjunto de todos los archivos
JmolApplet0*.jar, explicados m�s arriba.
El m�todo recomendado es el uso de la versi�n subdividida (JmolApplet0.jar etc.).
En particular, Jmol.js utiliza de forma predeterminada la versi�n subdividida.
Te puede interesar utilizar este archivo si quieres mantener sencillo tu sitio
web, o si s�lo quieres actualizar un archivo jar cuando lleguen versiones nuevas
de Jmol. Sin embargo, este Jmol se cargar� algo m�s lentamente que las versiones
subdivididas (descritas arriba), puesto que es preciso que se descarguen al
equipo del usuario todos los m�dulos (2,4 MB en total), sean o no necesarios,
antes de que se pueda mostrar una estructura.
Para llamar a JmolApplet.jar desde Jmol.js:
a) ponlo en la misma carpeta que contiene la p�gina HTML que lo
requiere y no uses jmolInitialize()
o bien
b) identif�calo expl�citamente en jmolInitialize(), por ejemplo:
jmolInitialize("carpeta-que-contiene-los-archivos-jar", "JmolApplet.jar")
4.1.4 ==== JmolAppletSigned.jar ====
Una versi�n equivalente de la miniaplicaci�n monol�tica, pero en este caso es
una miniaplicaci�n "firmada" (terminolog�a de seguridad en el lenguaje Java).
Esto significa que para ejecutarse debe previamente ser autorizada por el
usuario visitante de la p�gina web y, de ser as�, habr� menos restricciones de
seguridad para el acceso a archivos. Por ejemplo, podr� acceder a archivos en
cualquier parte del ordenador del usuario y en cualquier otro servidor web.
Habitualmente, los usuarios recibir�n un aviso pregunt�ndoles si quieren
"aceptar el certificado" o si "conf�an" en la miniaplicaci�n; sin embargo, esta
prestaci�n de seguridad no siempre est� activada. Si decides usar
JmolAppletSigned.jar, debes tener esto en cuenta. Aparte de la lectura de
archivos, Jmol no utiliza ninguna otra capacidad propia de las miniaplicaciones
firmadas, como acceder al portapapeles del sistema o grabar archivos. Utiliza la
miniaplicaci�n firmada s�lo si sabes lo que est�s haciendo y has tenido en
cuenta las cuestiones de seguridad.
Para llamar a JmolAppletSigned.jar desde Jmol.js:
jmolInitialize("carpeta-que-contiene-los-archivos-jar", "JmolAppletSigned.jar")
4.1.5 ==== Notas ====
Teniendo en cuenta las descripciones anteriores, observar�s que el paquete
de distribuci�n de Jmol contiene 4 copias completas de la miniaplicaci�n
(firmada o no, subdividida o no).
4.2 === Bibliotecas Javascript principales ===
4.2.1 === Jmol.js ===
�sta es la biblioteca de funciones cl�sica, escrita en el lenguaje JavaScript, que ayuda
en la preparaci�n de p�ginas web que usen la miniaplicaci�n Jmol sin necesidad
de conocer y escribir c�digo detallado espec�fico para la miniaplicaci�n.
Esta biblioteca usa por defecto la versi�n subdividida de la miniaplicaci�n
(firmada o no).
Est� documentada en detalle en http://jmol.org/jslibrary/
Jmol.js ir� siendo sustituida, a partir de Jmol v13, por el nuevo conjunto de
archivos .js del m�todo orientado a objetos (descritos a continuaci�n).
4.2.2 ==== JmolApplet.js ====
Crea el objeto para una miniaplicaci�n Jmol.
4.2.3 ==== JmolCore.js ====
Contiene las funciones necesarias para las miniaplicaciones Jmol pero
que no debe usar el autor de p�ginas web (funciones privadas).
4.2.4 ==== JmolControls.js ====
Apoyo para controles de la interfaz de usuario, como botones, enlaces, casillas
de verificaci�n, etc.
4.2.5 ==== JmolApi.js ====
Contiene la 'interfaz de programaci�n de la aplicaci�n', es decir, las
funciones que puede usar el autor de la p�gina web para interaccionar con las
miniaplicaciones Jmol.
4.3 === Bibliotecas Javascript opcionales ===
4.3.1 ==== JmolCD.js ====
La extensi�n ChemDoodle: proporciona los medios para usar ChemDoodle Web Components
(que emplea JavaScript + HTML5 canvas o WebGL) en lugar de las miniaplicaciones
Jmol, para sistemas en los que Java no est� disponible.
4.3.2 ==== JmolGLmol.js ====
La extensi�n GLmol: proporciona los medios para usar GLmol (que emplea WebGL +
JavaScript) en lugar de las miniaplicaciones Jmol, para sistemas en los que
Java no est� disponible
4.3.3 ==== JmolJME.js ====
Proporciona los medios para a�adir una miniaplicaci�n JME a la p�gina web
(dibujo de f�rmulas en 2D) y para su comunicaci�n con miniaplicaciones Jmol.
4.3.4 ==== JmolJSV.js ====
Proporciona los medios para a�adir una miniaplicaci�n JSpecView a la p�gina web
(visor de datos de espectros) y para su comunicaci�n con miniaplicaciones Jmol.
5 == Aplicaciones y miniaplicaciones accesorias ==
5.1 === ChimeToJmol.jar ===
No documentada y experimental.
Una aplicaci�n para convertir p�ginas html que usan Chime en p�ginas con
miniaplicaciones Jmol.
5.2 === JSpecViewApplet, JSpecViewAppletSigned ===
Las versiones firmada y no firmada de la miniaplicaci�n JSpecView, un visor
de datos de espectros que puede intercomunicarse con miniaplicaciones Jmol.
(V�ase m�s arriba el archivo de soporte .js)
5.3 === JmolSmilesApplet.jar ===
Este archivo no se incluye actualmente en el paquete de distribuci�n, pero
puede obtenerse del sitio de desarrollo.
Se trata de una miniaplicaci�n liviana, sin una interfaz visible, que permite
verificar c�digos SMILES. Esto es especialmente �til para comparar
estereoqu�mica, por ejemplo con estructuras dibujadas usando la miniaplicaci�n
JME.
La misma funcionalidad est� incluida en la miniaplicaci�n normal JmolApplet.
---------------------------