Proteopedia:How to Make a Page: Difference between revisions
Eric Martz (talk | contribs) →References: corrected typo that failed to close nowiki tags |
Undo revision 4304985 by Pooja Rajak (Talk) Tag: Manual revert |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 11: | Line 11: | ||
## the search box | ## the search box | ||
## looking in the [[Proteopedia:Table of Contents|table of contents]] | ## looking in the [[Proteopedia:Table of Contents|table of contents]] | ||
# choose a title that is appropriate | # choose a title that is appropriate following rules at [[Proteopedia:Page name]]. You can always rename the page later if necessary. | ||
#if a page on your topic already exists, you may edit that page to improve it | #if a page on your topic already exists, you may edit that page to improve it | ||
# | # you don't have permission to edit [[1h88|PDB entry pages]]. Please contact {{Template:Contact}} if you need | ||
## to add links to other Proteopedia pages | ## to add links to other Proteopedia pages | ||
## to correct wrong information about the PDB entry | ## to correct wrong information about the PDB entry | ||
## to add information relevant to the PDB entry but not to the protein or molecule in general | ## to add information relevant to the PDB entry but not to the protein or molecule in general | ||
#if you need to create a new page, search for the exact title of the new page, then in the "not found" results, click on the <font color='red'>red link</font> to the non-existent page. Now you can edit it, and after the first save, you have created the page. | |||
==The new page template== | |||
[[Image:Proteopedia New Page Annotated.JPG|right|thumb|New page template with highlighted code: 3D Jmol window, yellow; green links, green; references, tan.]]When you start a new page, it opens with a template to get you started. The elements highlighted in yellow place a 3D Jmol browser window on the right side of the page, with scrolling text on the left. The initial scene that shows in the 3D window is specified in the code as well, either by providing the PDB ID of a structure (here: 1STP) or by specifying a 3D scene (left blank in this example). The elements highlighted in green are the code that create green links on your page. The elements in tan show how to cite literature and show the references at the end of the page. You should modify these elements to fit your page. You could also delete the entire template and start from scratch if that is easier. | |||
==The basic beginnings of your page== | ==The basic beginnings of your page== | ||
| Line 34: | Line 36: | ||
#PyMOL is good for producing high-quality raytraced images for this purpose and you can use the [http://polyview.cchmc.org/polyview3d.html POLYVIEW-3D] webserver as a facile interface to rendering images with PyMol. Save the file to your computer. | #PyMOL is good for producing high-quality raytraced images for this purpose and you can use the [http://polyview.cchmc.org/polyview3d.html POLYVIEW-3D] webserver as a facile interface to rendering images with PyMol. Save the file to your computer. | ||
#[[Special:Upload|Upload]] the image file to Proteopedia using the '[[Special:Upload|Upload File]]' function under the toolbox section in the lower left hand side panel of each Proteopedia page. It will get a name such as 'Image:YourImageName.png'. | #[[Special:Upload|Upload]] the image file to Proteopedia using the '[[Special:Upload|Upload File]]' function under the toolbox section in the lower left hand side panel of each Proteopedia page. It will get a name such as 'Image:YourImageName.png'. | ||
#Build a reference to the uploaded image into your page. Example syntax: <nowiki>[[Image:YourImageName|300px|left|thumb| Your Caption Text]]</nowiki> | #Build a reference to the uploaded image into your page. Example syntax: <nowiki>[[Image:YourImageName|300px|left|thumb| Your Caption Text]]</nowiki>::Example syntax if your image is derived from a PDB entry: <nowiki>[[Image:1dqa opening.png|300px|left|thumb| Human HMG-CoA Reductase Catalytic Domain, [[1dqa]]]]</nowiki> | ||
::Example syntax if your image is derived from a PDB entry: <nowiki>[[Image:1dqa opening.png|300px|left|thumb| Human HMG-CoA Reductase Catalytic Domain, [[1dqa]]]]</nowiki> | |||
#around 200 or 300 px is a good size | #around 200 or 300 px is a good size | ||
#the custom is to align the 2D image to the left | #the custom is to align the 2D image to the left | ||
| Line 41: | Line 42: | ||
===Add a 3D structure=== | ===Add a 3D structure=== | ||
#standard practice is to use a | #standard practice is to use a "StructureSection", i.e. a window on the right with scrollable text on the left. | ||
## | ##new pages contain the code for this already | ||
##example wikitext: <nowiki> | ##example wikitext: <nowiki><StructureSection load='1stp' size='340' side='right' caption='Caption for this structure' scene=''> ... </StructureSection> | ||
</nowiki> | </nowiki> | ||
#the | #if your page lacks a StructureSection and you need one, click on the "green window" icon in the editing tools | ||
#use an initial scene (by | #use an initial scene (by setting "load=''" and inserting the scene in the "scene=" parameter) | ||
#have | #make sure all your scenes have captions | ||
#include an interwiki link to the PDB entry in the | #include an interwiki link to the PDB entry in the captions | ||
#preferably | #preferably show a different view of the protein compared to the 2D structure in the introduction, (i.e. if the introductory 2D image is in cartoon, make the 3D structure in spacefill) | ||
==Planning the rest of the page== | ==Planning the rest of the page== | ||
| Line 56: | Line 57: | ||
# think about bringing the reader through a tour of the most interesting and important features of your structure | # think about bringing the reader through a tour of the most interesting and important features of your structure | ||
# plan for 1 or 2 sections that will feature a structural description with a 3D structure and green scene links | # plan for 1 or 2 sections that will feature a structural description with a 3D structure and green scene links | ||
# | # in exceptional cases, you might have more than one 3D applet on the page but this makes loading slower | ||
# plan for a section about how your topic is related to disease, if relevant | # plan for a section about how your topic is related to disease, if relevant | ||
| Line 106: | Line 107: | ||
==Add Internal Links== | ==Add Internal Links== | ||
# if there are topics mentioned in your page that have their own Proteopedia article, make them into interwiki links | # do a google search on your topic prepending it with "site:proteopedia.org" to discover which other pages are relevant to your topic.# if there are topics mentioned in your page that have their own Proteopedia article, make them into interwiki links | ||
## example wikitext: <nowiki>[[Hemoglobin]]</nowiki> | ## example wikitext: <nowiki>[[Hemoglobin]]</nowiki> | ||
# add a "See Also" section directly before the "References" section with a list of links to other Proteopedia pages (use the wikitext syntax for lists) | # add a "See Also" section directly before the "References" section with a list of links to other Proteopedia pages (use the wikitext syntax for lists) | ||
# consider editing the pages you linked to, adding a link to the new page. This way, Proteopedia becomes a web of linked pages, and it becomes easier to navigate. You can quickly find out about links from the "What links here" item in the toolbox on the left side panel. | |||
==List of all related PDB ids== | ==List of all related PDB ids== | ||