Proteopedia:How to Make a Page
These steps are meant to help you create an excellent, top-quality Proteopedia page. You may choose to deviate from these steps in creating your page, if you wish, but these are the standards we have adopted and recommend for top-quality page creation. If you believe we should change some of these standards, please give us feedback at . For an example of an excellent Proteopedia page, see HMG-CoA Reductase (while the HMG-CoA Reductase page could always be improved, it represents most of the points on quality page creation listed below).
Before you beginBefore you begin
Before you begin, if this is your first time editing a Proteopedia page you should begin by watching the video guide and referring to the editing help reference pages.
Creating the pageCreating the page
- choose your topic (generally: a protein, a molecule, or a concept)
- check that a page on your topic doesn't exist already by using:
- the search box
- looking in the table of contents
- choose a title that is appropriate. it should be:
- the name of the topic
- 5 words or fewer
- (you can always rename the page later if necessary)
- don't edit a PDB entry page except:
- to add links to other Proteopedia pages
- 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
- if a page on your topic already exists, you may edit that page to improve it
The basic beginnings of your pageThe basic beginnings of your page
In this section we describe the first elements every a new Proteopedia page should begin with.
Adding an introductionAdding an introduction
- 3-7 sentences
- first sentence should contain the name of the biomolecule or topic and it should be an interwiki link (so on the Hemoglobin page, you might start by writing "[[Hemoglobin]] is the protein...")
- touch on medical relevance if there is any
Add a 2D imageAdd a 2D image
- use such and such syntax
- somethign about the view it should be
- something about the size
Add a 3D appletAdd a 3D applet
- consider the STRUCTURE box
- choose a good scene
- caption
- include the PDB entry
Planning the rest of the pagePlanning the rest of the page
- good to write down on paper
Structural descriptionStructural description
- structuresection is ideal for this
Rules to live byRules to live by
- max number of applets (absolute max is 3 including the upper right one) - if you need more use structuresection
- use wikitext rather than HTML
ScenesScenes
- make a list of the most important structural features of your biomolecule (look at figures from publications about your biomolecule for inspiration)
- create a story to lead the reader through the most important structural features of your biomolecule
- minimize jumps
- use different transitions where appropriate (where appropriate?)
- choose text for the green links that relates to the scene
- try to minimize the text used for a green scene link (i.e. have a link that is You can see the structure of HMGR instead of You can see the structure of HMGR)
- make them tell a story about the structure
- use as few structures as possible
- make it obvious which structures you are using
- use morphs to illustrate conformational changes
- use a structuresection if you have a section with many green scene links
ReferencesReferences
- how to use them
Add Internal LinksAdd Internal Links
- add a "See Also" section with a list of links to other Proteopedia pages
Add External LinksAdd External Links
- add any external links in a section at the end of the page called "External Resources"
- consider adding a link to the relevant Wikipedia page
When finishedWhen finished
- read through your page again, making sure the text and the scenes have a natural flow
- check that your page illustrates the most important features of the topic of the page
- add your page to the Proteopedia:Table of Contents
- create redirects for alternative spellings or capitalizations of your page name
- link to your page from other relevant Proteopedia pages
- add categories to the bottom of your page
ImagesImages
- images should ideally be big enough to look at without having to click to enlarge
- try to use this wikitext for images [[Image...thumb etc]]
- provide a descriptive caption
- images should have proper copyrights that you can use them
Wiki OrganizationWiki Organization
- make sure the page name is appropriate (if not, use "move")
- do not make the title of your Proteopedia page more than 4 words long.
- add interwiki links to link your page up to the wiki (say how to do this)
- create redirects for alternative spellings and capitalizations of the page name
Extra stuff need to be organizedExtra stuff need to be organized
- applet on the upper right should be a representative structure
- mention all PDB ids (where?)
- use references correctly
- make sure your scenes meet these guidelines -> Proteopedia:How to Make a Scene
- upper left have a static image, preferably that shows a different view of the same protein, (i.e. if the one on the right in 3d is in cartoon, make the static image on the left in spacefill, so that it has a purpose beyond looking good)
- intro section - less than 8 sentences that describes what the protein is and why we should care. The first sentence should say the name of the protein and it should be enclosed in interwiki link brackets
- start broad and go narrow (use headlines, start with two equal signs, never use a single equal sign heading)
- use captions for your images
- if your protein has any medical relevance whatsoever, make sure to talk about it
- cite the most important references
- If page topic fits within one of the subcategories listed in the table of contents, i.e. "Diabetes" or "Lyase" add a section at bottom of page, before the references section called "Additional Resources" with the phrase "See Diabetes for more information".
- add a list of all PDB entries, organized (say, similar to XXX page)