Difference between revisions of "ExportToWeb"

From Jmol
Jump to navigation Jump to search
(document Export to Web for recent Jmol distributions)
 
(smaller images and text update)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
= Jmol Export to Web application =
 
= Jmol Export to Web application =
"Export to Web" (a.k.a. Jmol Web Page Maker) is a module included in the [[Jmol Application]]. Its purpose is to offer a user-friendly, basic, easy to learn way of producing simple webpages that include [[Jmol Applet]]s with molecular views that the user has prepared but still retain full-featured Jmol interactivity.
+
"Export to Web" (a.k.a. Jmol Web Page Maker) is a module included in the [[Jmol Application]]. Its purpose is to offer a user-friendly, basic, easy to learn way of producing simple webpages that include [[Jmol Applet|JSmol objects]] with molecular views that the user has prepared but still retain full-featured Jmol interactivity.
  
[[File:ExportToWeb_opening.png]][[File:ExportToWeb window.png]]
+
[[File:ExportToWeb_opening_75.png]] [[File:ExportToWeb_window_75.png]]
 +
 
 +
== Preparations ==
 +
You need to do some extra preparation before E2W will work successfully.
 +
 
 +
# Create a folder where you will work with E2W.
 +
# Download the distribution file, {{file|Jmol-14.x.x-binary.zip}} and extract its contents: a {{folder|jmol-14.x.x}} folder will be created by default.
 +
#* Transfer the {{file|Jmol.jar}} to your working folder.
 +
# Unzip the {{file|jsmol.zip}}; it will create a {{folder|jsmol}} folder with several folders inside.
 +
#* Transfer that {{folder|jsmol}} folder too to your working folder (but see note below).
 +
# Go to your working folder, launch {{file|Jmol.jar}} and then you can load models and open the Export to Web module.
 +
 
 +
''Note:'' not all contents of {{folder|jsmol}} are needed; you must keep {{file|JSmol.min.js}} and all the other {{file|.js}} files, but among the subfolders, you can keep just {{folder|idioma}}, {{folder|java}}, {{folder|j2s}} and {{folder|php}}.
 +
 
 +
[[File:File_set_minimal.png]]
 +
 
 +
Then, in the Export to Web dialog, under "Relative server path..." and "Relative local path..." you should enter the path to this {{folder|jsmol}} folder starting from the folder where you are saving your webpage (html file).
 +
 
 +
Note that the location of {{folder|jsmol}} in your '''local disk (for page testing)''' and in your '''web server (for visitors of your pages)''' need not be the same; that's why the dialog has two separate lines.
 +
 
 +
== Legacy Jmol versions ==
 +
Due to changes in the distribution file scheme that started with Jmol v. 13.2 (associated to the evolution towards [[Jmol_JavaScript_Object|Jmol-JSO and JSmol]]), the preparation procedures were different in former versions of Jmol:
 +
 
 +
Make sure to extract (unzip) the whole contents of the downloaded Jmol distribution file, and to work with the {{file|Jmol.jar}} in that folder.
  
=== Former Jmol versions ===
 
 
With Jmol versions before 13.2, the use of E2W is described in Jonathan Gutow's tutorial [http://www.uwosh.edu/faculty_staff/gutow/Jmol_Web_Page_Maker/Export_to_web_tutorial.shtml in English] (y [http://biomodel.uah.es/Jmol/exporta_a_web/ en español]).
 
With Jmol versions before 13.2, the use of E2W is described in Jonathan Gutow's tutorial [http://www.uwosh.edu/faculty_staff/gutow/Jmol_Web_Page_Maker/Export_to_web_tutorial.shtml in English] (y [http://biomodel.uah.es/Jmol/exporta_a_web/ en español]).
 
=== Newer Jmol versions ===
 
Due to changes in the distribution file scheme in Jmol v. 13.2 and later (associated to the evolution towards [[Jmol_JavaScript_Object|Jmol-JSO and JSmol]]), you need to do some extra preparation before E2W will work successfully.
 

Latest revision as of 16:06, 15 September 2018

Jmol Export to Web application

"Export to Web" (a.k.a. Jmol Web Page Maker) is a module included in the Jmol Application. Its purpose is to offer a user-friendly, basic, easy to learn way of producing simple webpages that include JSmol objects with molecular views that the user has prepared but still retain full-featured Jmol interactivity.

ExportToWeb opening 75.png ExportToWeb window 75.png

Preparations

You need to do some extra preparation before E2W will work successfully.

  1. Create a folder where you will work with E2W.
  2. Download the distribution file, File icon.gifJmol-14.x.x-binary.zip and extract its contents: a Folder icon.gifjmol-14.x.x folder will be created by default.
    • Transfer the File icon.gifJmol.jar to your working folder.
  3. Unzip the File icon.gifjsmol.zip; it will create a Folder icon.gifjsmol folder with several folders inside.
    • Transfer that Folder icon.gifjsmol folder too to your working folder (but see note below).
  4. Go to your working folder, launch File icon.gifJmol.jar and then you can load models and open the Export to Web module.

Note: not all contents of Folder icon.gifjsmol are needed; you must keep File icon.gifJSmol.min.js and all the other File icon.gif.js files, but among the subfolders, you can keep just Folder icon.gifidioma, Folder icon.gifjava, Folder icon.gifj2s and Folder icon.gifphp.

File set minimal.png

Then, in the Export to Web dialog, under "Relative server path..." and "Relative local path..." you should enter the path to this Folder icon.gifjsmol folder starting from the folder where you are saving your webpage (html file).

Note that the location of Folder icon.gifjsmol in your local disk (for page testing) and in your web server (for visitors of your pages) need not be the same; that's why the dialog has two separate lines.

Legacy Jmol versions

Due to changes in the distribution file scheme that started with Jmol v. 13.2 (associated to the evolution towards Jmol-JSO and JSmol), the preparation procedures were different in former versions of Jmol:

Make sure to extract (unzip) the whole contents of the downloaded Jmol distribution file, and to work with the File icon.gifJmol.jar in that folder.

With Jmol versions before 13.2, the use of E2W is described in Jonathan Gutow's tutorial in English (y en español).

Contributors

AngelHerraez