Scene authoring tools: Difference between revisions
Eric Martz (talk | contribs) |
|||
| (20 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
The '''Scene authoring tool''' (SAT) is used to create and edit molecular scenes. Scenes created using the ''Scene authoring tool'' can then be inserted into [[Proteopedia]] pages. This is a reference page explaining | The '''Scene authoring tool''' (SAT) is used to create and edit molecular scenes. Scenes created using the ''Scene authoring tool'' can then be inserted into [[Proteopedia]] pages. This is a reference page explaining the details once you are familiar with the basics. For a tutorial introduction, see [[Proteopedia:DIY:Scenes|Instructions for creating a molecular scene with Proteopedia's Scene Authoring Tools]], and watch the introductory videos, e.g. [https://youtu.be/P-LsB2U8rNM]. | ||
==Where are the ''Scene authoring tools''== | ==Where are the ''Scene authoring tools''?== | ||
[[Image:SAT show.JPG|350px]] | |||
The ''Scene authoring tools'' are accessible when you are editing a page. Click the tab '''edit this page''' at the top of the page where you wish to create a molecular scene. On the edit page, near the top, you'll see a big box where all the wikitext of the page lives--here you can change the text of the page. If you scroll down some, near the bottom, you'll find in bold letters '''SAT (Scene authoring tools) [show]'''. Click on '''show''' to expand and open the ''Scene authoring tools''. If, however, the page does not contain a Jmol window yet (no <Structure> or <StructureSection> tags), the page will lack access to the SAT. In this case, first edit the page to include a Jmol window (using the [[Image:Structure buttons.JPG|50px]] buttons above the text-editing area), save and then edit again to see the link to the SAT. New pages have placeholder content that includes these tags, but this page for example does not. | |||
<!-- | |||
<!--<Structure load=' | |||
---- | |||
Insert PDB code or filename here' size='350' frame='true' align='right' caption='Insert caption here' scene='Insert optional scene name here' /> | |||
A short and rough, temporary video tutorial can be viewed here: http://www.weizmann.ac.il/ISPC/Proteopedia.html. | A short and rough, temporary video tutorial can be viewed here: http://www.weizmann.ac.il/ISPC/Proteopedia.html. | ||
--> | --> | ||
| Line 34: | Line 38: | ||
To load a file that has a PDB ID, input the ID into the first input area and click the load button. The file will be fetched from the PDB database. | To load a file that has a PDB ID, input the ID into the first input area and click the load button. The file will be fetched from the PDB database. | ||
To load a file that is not part of the PDB, first upload the file to Proteopedia at [[Special:Upload]] (you can get there also by using the link called 'upload file' on the left hand column-toolbar of Proteopedia). Once a file has been uploaded, you can specify its name in the input area next to the words "From Proteopedia | To load a file that is not part of the PDB, first upload the file to Proteopedia at [[Special:Upload]] (you can get there also by using the link called 'upload file' on the left hand column-toolbar of Proteopedia). Once a file has been uploaded, you can specify its name in the input area next to the words "From Proteopedia uploaded file" and click load. | ||
Uploaded file can have various formats recognized by Jmol's "load" command. For example, you can load a .PNGJ file to load coordinates and a 3D scene in one step. | Uploaded file can have various formats recognized by Jmol's "load" command. For example, you can load a .PNGJ file to load coordinates and a 3D scene in one step. | ||
There is a checkbox to add calculated positions of '''hydrogen''' atoms to the structure as it is loaded. This allows to show the multiplicity of bonds (i.e. whether a bond is a single, double or triple bond) in the 3D scenes. | |||
Another optional field allows to enter instructions that will be used to '''filter''' which atoms of the original model will be either loaded or ignored. | |||
For example, to load just the alpha carbons, to exclude water, include or exclude other hetero groups (ligands), load a specified biomolecule (biological unit), etc. See [[Biological Unit: Showing]] for instructions. | |||
You can also check the [{{ScriptingDoc}} Jmol Scripting Documentation] for details about the syntax of such filter specifications (in that page, search for <code style="color:maroon">load "filename" FILTER</code>). | |||
=='load scene' tab== | =='load scene' tab== | ||
The first | The first box shows the '''current page name'''. First, you proceed to choose the '''scene name''' using the drop-down selector. All scenes associated with the scenes inserted in the page you edit will be listed (see [[Remixing#Remixing_3D_scenes_from_Proteopedia|remixing scenes]]) . Once a scene is selected, all of its versions are available for selection using the drop-down '''version number''' menu. When a version number is selected, that version of the scene is loaded onto the Jmol applet that is part of the ''Scene authoring tools'' and the description and caption that were given to the scene are also recalled. At the same time, the wikitext that is needed for insertion of the scene into the page is displayed. | ||
Each distinct scene has | Each distinct scene has 4 parameters to distinguish it from all other scenes: domain, pageId, scenename, and versionnumber (e.g. 77/778341/Ballstick/1). The '''domain''' are the first two digits of the pageId, and the '''pageId''' is the unique internal identifier of the Proteopedia page on which the scene was initially created. The '''scenename''' is given by the user. The '''versionnumber''' is incremental: If no scene by the given name exists for the given page, then the first version will be version 1. If there exist previous versions of the same scenename on the same pagename, then the newest saved version will not overwrite older versions of the scene, but will instead be automatically saved as the newest version (by incrementing the versionnumber by one). To find out which page is associated with a scene, create the URL of the script by prepending "proteopedia.org/wiki/scripts/" and appending ".spt". e.g. the scene called 77/778341/Ballstick/1 is stored at [https://proteopedia.org/wiki/scripts/77/778341/Ballstick/1.spt]. Inspection of the first couple of lines of the file shows, after the keyword "documentBase", that it originated from a user page. | ||
==Controls below the Jmol window== | ==Controls below the Jmol window== | ||
[[Image:SAT controls outside of tabs.JPG| | [[Image:SAT controls outside of tabs.JPG|600px]] | ||
These controls are available no matter which tab is open. | These controls are available no matter which tab is open. The first line is informational, only; the "currently loaded" text area displays the name of the currently loaded file and its datestamp. | ||
Below that, you can select "ALL" or "NONE" to quickly select all or no atoms. To see which atoms are selected, use the controls next to "Show Selected with Halos". If you have something selected, you will see your selection highlighted by yellow halos. These halos are NOT part of your scene and have no impact other than to indicate to you what atoms are currently selected. | |||
The "<-Undo" and "Redo->" controls allow you to quickly correct mistakes, or to compare before and after changing the scene. | The "<-Undo" and "Redo->" controls allow you to quickly correct mistakes, or to compare before and after changing the scene. | ||
===Advanced controls=== | ===Advanced controls=== | ||