Help:Editing

From Proteopedia

Revision as of 15:36, 17 March 2008

Use the Sandbox for practice editing

The Sandbox is a special page for practice editing. Changes you make there are not permanent. Feel free to try out the methods explained below in the Sandbox before saving permanent edits on other pages.

For edits of text, not involving Proteopedia Scenes

Please visit http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet and http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page, as they have a much more complete help reference dealing with wikitext, and Proteopedia uses the same wiki software.

To create or edit Proteopedia Scenes

"Proteopedia Scenes" are customized molecular views displayed in the Jmol applet. Before you can create or edit a scene, there must be a Jmol applet already on the current page. Instructions for inserting a new applet are in the next section below. When there is a Jmol applet present in the page, you create new scenes (green links) by using the Scene Authoring Tools. After you create a scene, you must insert it using the appropriate wikitext that the Scene Authoring Tools will generate for you.

SCENE TUTORIAL MOVIE: There is also a rough and brief, temporary video tutorial available at http://www.weizmann.ac.il/ISPC/Proteopedia.html.

When there is more than one Jmol applet on a page, scenes automatically go to the applet above the <scene ...>...</scene> tag in the wikitext.

Proteopedia Jmol Applets

Displaying a Proteopedia Scene requires an instance of the Jmol applet on the page, in order to display the molecular scene. The wikitext for inserting a Jmol applet must be typed into the page by hand following the format below. But the simplest way to get the wikitext for an applet is by clicking the "3D" button just above the wikitext area when editing a page. (Or you could copy and paste the applet wikitext from a different page, and then edit the parameters.)

<applet load='X' size='X' frame='X' align='X' caption='X' scene='X'/>

Each X represents a parameter that you enter (and many of them are Optional). For example, this generates the Jmol applet on this page:

<applet load='1ea5' size='300' color='white' frame='true' align='right' caption='testcaption' />

The order of the parameters does not matter. Explanations of each parameter follow:

load='X'

Specify a PDB code (ex: load='2ace') to have the applet load the protein with the matching PDB code from the PDB database. Specify a file name (ex: load='2ace.pdb') to have the applet load the file from Proteopedia's uploaded files. If your desired file is not in the PDB database and not yet uploaded to Proteopedia, you may upload it here Special:Upload.

size='X'

Optional (default value is 400 pixels).

This is the size in pixels of the applet's height and width. It will be square.

frame='X'

Optional (default value is 'true').

If this value is not 'false' then the Jmol applet will appear on the page surrounded by a frame similar to inserting in image in wikitext and using its "frame" parameter like so: [[Image:someImageName.jpg|frame|someCaption]]. If frame is set to false than no caption can be displayed.

align='X'

Optional and only relevant if the frame parameter is set to true.

Determines where on the page the Jmol applet should appear. align='right' would have it right-aligned. Options include 'left' and 'center'.

caption='X'

Optional and only relevant if the frame parameter is set to true.

This is what will appear under the Jmol applet if frame is not set to 'false'.

scene='X'

Optional.

The scene specified here uses the same format used to specify the "name" parameter when typing the wikitext to insert a scene: Pagename/Scriptname/Versionnumber (ex: scene='Hemoglobin/Cavity/14').

name='X'

Optional.

This sets the name of the applet. This is useful if you wish to have a green scene link act on a specific applet that is not the applet directly above the green scene link. See section entitled "More than one Jmol applet on a page" below for more information.

Proteopedia Scenes

To insert a scene, type <scene name='PageName/SceneName/Version#'>Text Displayed On Page</scene>

This wikitext for inserting a scene will be automatically generated for you to copy and paste into place when you save a scene using the authoring tools. It will also be automatically generated for you to copy and paste into place when you load a scene using the authoring tools.

Do not put blank spaces in front of the wikitext for a scene if you are putting the wikitext for a scene as the first text on a new line. If you do this, the error will generate boxes with dashed lines on the page.

More than one Jmol applet on a page

When there is more than one Jmol applet on a page, scenes automatically go to the applet above the <scene ...>...</scene> tag in the wikitext.

If you wish to have a green scene link act on a specific applet that is not the applet directly above the green scene link, then you must set the "target" parameter inside the wikitext for a scene link like so: <scene name='PageName/SceneName/Version#' target='AppletName'>Text Displayed On Page</scene> where " target='AppletName' " tells this scene link to act on the applet with the name 'AppletName' on the page (set by using the applet's "name" parameter in the applet's wikitext). If the applet you wish to target has not been given a name using the name parameter, you may instead set target to the applet's number. For instance setting target='2' would have the green scene link act on the 3rd applet on the page, because by default, if applets are not given names, they take the sequential names 0, 1, 2, ... in the order in which they appear on a page.

Jmol extension

The Jmol extension is part of Proteopedia, so all use of the Jmol extension is allowed. Usage and syntax of the Jmol extension.

Including One Page in Another Page

Suppose you want to include an entire existing "donor" page in another "recipient" page. For example, suppose there is a page with scenes of a molecule you would like to include in a page you are editing. There are two ways to do this.

1. Copy and Paste: You can copy all or part of the donor page (from its editing box) and paste it into the editing box of the recipient page. This has two advantages. First, you can copy only a portion of the donor page. Second, the copy in the recipient page can be edited or adapted. Thus, it may diverge from the donor content.
2. Inclusion: Suppose the donor page title is "Serine Protease". Then you can include it in a recipient page by inserting this in the editing box of the recipient page: {{:Serine_Protease}} (note the colon!). This method includes the entire donor page, and when the donor page is edited, the changes will appear automatically in the recipient page.