Molecular Playground/Procedures: Difference between revisions
Eric Martz (talk | contribs) |
Eric Martz (talk | contribs) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This page details procedures for authoring content modules for [http://molecularplayground.org Molecular Playground]. It is a supplement to the main article on authoring modules, [[Molecular Playground/Authoring]]. | This page details procedures for authoring content modules for [http://molecularplayground.org Molecular Playground]. It is a supplement to the main article on authoring modules, [[Molecular Playground/Authoring]]. | ||
This page describes procedures step by step. Modules at [[Molecular_Playground/Authoring#Three_Levels|Levels II and III]] use utility functions in MPSupportVersion01.spt. A list of these function is provided at [[Molecular_Playground/Support_Script_Help]]. | |||
==Help Is Available!== | ==Help Is Available!== | ||
| Line 10: | Line 12: | ||
<ol> | <ol> | ||
<li> | <li> | ||
'''Create a page in Proteopedia''' where you will create your customized molecular scene. A good place to do this is in a protected Sandbox in your User namespace, such as '''User:Your Name/Sandbox 1'''. Step by step instructions for creating and using such a Sandbox are available in [[Help:Sandboxes#Protected_Sandbox_Pages]]. | |||
</li><li> | </li><li> | ||
Normally, in Proteopedia, while editing a page, you insert Jmol by clicking a button labeled '''3D''' at the top of the wikitext box. This Jmol is square. However, for Molecular Playground, you need a '''rectangular Jmol''' the same shape as the projection. Instead of clicking the 3D button, paste this into your page | Normally, in Proteopedia, while editing a page, you insert Jmol by clicking a button labeled '''3D''' at the top of the wikitext box. This Jmol is square. However, for Molecular Playground, you need a '''rectangular Jmol''' the same shape as the projection. Instead of clicking the 3D button, paste this into your page | ||
<pre> | <pre> | ||
<applet size='[450,338]' frame='true' align='right' caption='YYY' /> | <applet size='[450,338]' frame='true' align='right' | ||
caption='YYY' /> | |||
</pre> | </pre> | ||
and then save the page. Jmol will be empty, but that's OK, we are going to add a molecule next. | and then save the page. Jmol will be empty, but that's OK, we are going to add a molecule next. | ||
| Line 58: | Line 61: | ||
This procedure applies to [[Molecular_Playground/Authoring#Three_Levels|Levels I and II]]. | This procedure applies to [[Molecular_Playground/Authoring#Three_Levels|Levels I and II]]. | ||
<ol start=' | <ol start='5'> | ||
<li> | <li> | ||
'''Capture the [[Jmol#State_Scripts|state script]]''' for your scene. In order to project your scene in MP, you will need to capture the state script into a file on your computer. When completed, the script file will be submitted to the MP team. Having a local copy on your computer also has the advantage that you can display the scene in the Jmol application, in a 1024 x 768 pixel window, just as it will appear when projected in MP. | '''Capture the [[Jmol#State_Scripts|state script]]''' for your scene. In order to project your scene in MP, you will need to capture the state script into a file on your computer. When completed, the script file will be submitted to the MP team. Having a local copy on your computer also has the advantage that you can display the scene in the Jmol application, in a 1024 x 768 pixel window, just as it will appear when projected in MP. | ||
| Line 115: | Line 118: | ||
:*[[Image:MP_relenza03.spt]] | :*[[Image:MP_relenza03.spt]] | ||
:*[[Image:MPSceneVersion01.spt]] | :*[[Image:MPSceneVersion01.spt]] | ||
:*[[Image:MPSupportVersion01.spt]] | :*[[Image:MPSupportVersion01.spt]] (see description of what is in this at [[Molecular_Playground/Support_Script_Help]]) | ||
</li><li><!-- sublist --> | </li><li><!-- sublist --> | ||
'''Rename''' MP_relenza.spt to yourMolecule.spt. | '''Rename''' MP_relenza.spt to yourMolecule.spt. | ||
| Line 172: | Line 175: | ||
Make sure there are no spaces before any of the lines you pasted in. | Make sure there are no spaces before any of the lines you pasted in. | ||
Save the page. (If you click the button now, your Jmol will display the Relenza scene.) | Save the page. (If you click the button now, your Jmol will display the Relenza scene.) | ||
Note: Alternatively you may use a green link to play your script instead of a button. See the demonstration at [[Demonstration of a complex animation playing from a green link]]. | |||
</li><li> | </li><li> | ||
'''Upload your script:''' At Proteopedia, click on ''Upload file'' in the toolbox on the left side of every page. Use the ''Choose File'' button to select MP_yourMolecule.spt. You don't need to change anything else on the page. (Optionally, in the Summary box, enter the title of the permanent page in Proteopedia where you will display the scene.) Click the button ''Upload file''. | '''Upload your script:''' At Proteopedia, click on ''Upload file'' in the toolbox on the left side of every page. Use the ''Choose File'' button to select MP_yourMolecule.spt. You don't need to change anything else on the page. (Optionally, in the Summary box, enter the title of the permanent page in Proteopedia where you will display the scene.) Click the button ''Upload file''. | ||
| Line 186: | Line 191: | ||
Now, resume building your web page at [[Molecular_Playground/Authoring#Procedure_for_using_Proteopedia]]. | Now, resume building your web page at [[Molecular_Playground/Authoring#Procedure_for_using_Proteopedia]]. | ||
== Advanced Authoring == | |||
If you are editing your own script manually (e.g. for a Level III module), you may still make profit of the utilitites included in the support script. | |||
See [[Molecular Playground/Support Script Help]]. | |||
==Notes== | ==Notes== | ||
<references /> | <references /> | ||
[[Category:Molecular Playground]] | [[Category:Molecular Playground]] | ||