Help:Contents: Difference between revisions

From Proteopedia
Jump to navigation Jump to search
Eric Martz (talk | contribs)
Eric Martz (talk | contribs)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==For users: browsing and displaying==
__NOTOC__
Proteopedia (see [[Proteopedia:Overview|Overview]]) is the 3D encyclopedia of proteins and other biological molecules. This is the directory of help pages for visitors and for registered users.


You can use Proteopedia as a reference resource, without authoring any content yourself.
{|
*Overview of Proteopedia's [[Proteopedia:Users_Modes_Areas|Users, Modes and Areas]]
|-
|style="width: 50%;" |


===Generic help in using Proteopedia===
===<i class="fas fa-directions"></i> Navigating Proteopedia===
*For assistance with '''searching''' for something in Proteopedia, try [[Help:Searching]].
Proteopedia is organized like an encyclopedia, with entries (also called pages or articles) on different topics. If you already know the topic you are interested in, you can search for relevant entries using the '''search box on the left''' side of the page. For help, go to [[Help:Searching]]. You can also browse the entries, starting with the suggestions on the [[Main Page]] or the table of contents or the structure index available in the navigation box on the left. Entries have links to other entries (if you right-click them, the current entry will stay available and the linked entry will open in a new tab). This is a way to browse entries on related topics.
*Browse Proteopedia's [[Proteopedia:Table_of_Contents|Table of Contents]].
*Check out the [[Proteopedia:Structure_Index|Structure Index]].
* Each of the ~150,000 macromolecular models in the [[Protein Data Bank]] has a page in Proteopedia. To see some examples, click on ''Random'' in the navigation box on the left side of this page.
**To keep this page visible, right-click on ''Random'' (Ctrl-click on Macs) and then click on ''Open Link in New Tab''.
*For definitions of terms, and explanations of concepts in structural biology, see [[About Macromolecular Structure]]. Many articles are listed there, for example [[Amino Acids]] and [[Resolution]].


===Proteopedia Speed===
|valign="top" |
* '''Render faster''': If you have Java available on your computer, molecular models in Proteopedia pages will be rendered faster:
** If you are a registered user you can set the use of Java as a default, in one of the preferences in your personal profile. (Visit the <code>my preferences</code> link at top-right.)
** To use Java occasionally on a one-page basis, add <code>?use=java</code> to the page URL, like this: [http://proteopedia.org/w/G_protein-coupled_receptor?use=java http://proteopedia.org/w/G_protein-coupled_receptor?use=java].
** For a complete description see [[Using_Java_for_Rendering_Structures|Using Java for Rendering Structures]].


===Teaching and Education===
===<i class="fas fa-glasses"></i> Reading and viewing entries===
*For Teaching with Proteopedia, see [[Teaching_Strategies_Using_Proteopedia|Teaching Strategies Using Proteopedia]] and [[Teaching_Scenes%2C_Tutorials%2C_and_Educators'_Pages|Teaching_Scenes, Tutorials, and Educators' Pages]].
The special feature of Proteopedia entries are the interactive 3D representations of molecules viewable on most pages. They appear in a window integrated into the page (often called "Jmol window"). As you read through the text of an entry, you will find "green links". When you click on them, you stay on the same page but the interactive 3D scene changes to match the green-linked text. To learn how to get the most out of the interactive 3D scenes, reference the [[Help:Viewing pages|Viewing guide]] and the cheat sheet that comes with it. If you encounter technical terms you are unfamiliar with, try searching for them to learn more about them. The [[About Macromolecular Structure]] page is a good place to start.
*[[High school teachers' resources]]
*[[Proteopedia:News#Adoptions in College and University Classes|Adoptions in College and University Classes]]
*[[Molecular Workbench]]
*New educational pages may be announced to subscribers to the [[Proteopedia:Email list]].


===Software for use with Proteopedia===
|-
*[[Java]] can be used to improve performance of molecular scenes in Proteopedia. Please see [[Installing and enabling Java]].
|valign="top" |
*Java may be a security risk. Please see [[Java#How_to_be_as_safe_as_possible_with_Java|How to be as safe as possible with Java]].
[[Image:1ijw-150px-48c.gif|right]]
*Any molecule that you see in Proteopedia can be explored further using [[FirstGlance in Jmol]]. Every page titled with a [[PDB identification code]] has a link to explore that model in [[FirstGlance]].
**Molecular views obtained in FirstGlance can become green links in Proteopedia ([[Help:Copying FirstGlance Scenes into Proteopedia|Instructions]]).
*You can make presentation-ready animations that can be dropped into Powerpoint slides from any scene in Proteopedia or FirstGlance. See [[Help:Making animations for Powerpoint]]. (At right: [[1ijw]])


==For authors: contributing content==
===<i class="fas fa-user-clock"></i> Who wrote the entry when?===
The sections below concern authoring new content, or improving existing content, in Proteopedia.
The section headed "Proteopedia Page Contributors and Editors" (on the bottom of the entry) lists all authors of the entry. If you are interested to learn who wrote what and when the entry was last updated, go to the history tab. Occasionally, the discussion tab contains information about how the entry was created or suggestions for improvement.
|valign="top"|


===Getting Started Authoring (including Beginners Primer)===
===<i class="fas fa-id-card"></i> Becoming a registered user on Proteopedia===
* First time here? Learn the basics by either watching the narrated videos in the [[Proteopedia:Video_Guide|Proteopedia Video Guide]] or follow [[Proteopedia:Getting Started|Getting Started in Proteopedia]].  
To edit pages or create new ones, you need an account. At the top right of each page, there is a link to login in or request an account. With an account, you can edit pages and create new ones. You will also have a user page to introduce yourself, and access to sandboxes where you can try out creating content.
* The [[Proteopedia:Primer|Primer]] guides you step-by-step through creating your first molecular scene. There is also a detailed, step-by-step [[Media:Proteopedia tutorial step by step 4.pdf| walkthrough of a Proteopedia workshop with 4 slides per page]], or same file [[Media:Proteopedia tutorial step by step.pdf| walkthrough of a Proteopedia workshop with 1 slide per page]].
|-
*We recommend that the first page you try editing in Proteopedia should be a ''Sandbox'' page, as explained in [[Proteopedia:Getting Started|Getting Started in Proteopedia]]. Please see [[Help:Sandboxes]] for an explanation, and instructions on how to create a Sandbox page for your own use.
|valign="top"|
*For editing help, try [[Help:Editing]], which explains, among other things, how to easily insert references to scientific literature citations using PubMed ID numbers, ''without typing the reference itself''! See also [[Proteopedia:How to Make a Page|How to Make a Page]].
===<i class="fas fa-user-edit"></i> For authors: contributing content===
*[[Proteopedia:Guidelines for Ethical Writing]] lists guidelines for avoiding plagiarism, for content attribution, and for re-use of images.
To get started, read [[Help:Getting Started in Proteopedia]], or watch the videos linked there. You can '''start editing in a sandbox''' (see [[Help:Sandboxes]]). Before reusing content from others, consult [[Proteopedia:Guidelines for Ethical Writing]] for ethical aspects, and [[Help:Editing#Citing_Literature_References]] for formatting references. The text on Proteopedia has an open license that encourages remixing with attribution, see [[Remixing]]. For some suggestions how to improve the quality of a page, see [[Proteopedia:How to Make a Page]].
* Questions? Stuck? Need help? Feel free to [[#Contact|contact us directly]], or subscribe to, and post questions on the [[Proteopedia:Email list]].
<b><i>Español</i> - 日本人 <big>
عربي </big>-
עִברִית -
</b>etc. All pages must be available in English. Translation of English pages to [[Proteopedia:Languages|other languages]] is encouraged ([[Proteopedia:Languages#Non-English_Articles|examples]]). Here are [[Help:Language Translation|instructions for translation]].


===Creating Molecular Scenes===
*For step-by-step instructions on creating example molecular scenes, try [[Proteopedia:DIY:Scenes]].
*If your molecular scenes require a model that is not published in the [[Protein Data Bank]], see [[Help:Uploading molecules]]. See also [[Biological Unit: Showing]] and instructions for hiding portions of a model at [[Help:Getting Started in Proteopedia|Getting Started]].
*If you save a page and get '''XML Error: Mismatched tag at line 1''', don't worry, you can recover your page: see [[Help:Errors]].
*If rotating model looks different than the still rendering read [[Proteopedia:Rotating vs still models|Rotating vs still models]]
*For simple recipes for including Flash, Imagemap, Floating quote Box, Movies (.mov, .mpeg) etc., try [[Proteopedia:Cookbook]].
*If you do not see the Scene Authoring Tool ([[SAT]]) when editing a page: please disable 'Show preview on first edit' in the 'Editing' tab within 'my preferences'. Additionally, the SAT will never be displayed while the editing changes are being previewed (you clicked on the 'Show Preview' button).


===Static Images===
|valign="top"|
* To show a static image (jpeg, png, gif) file in a Proteopedia page, first you need to be sure you have the right to share the image and allow unrestricted re-use by others (see [[Proteopedia:Terms of Service]]). If yes, then you need to upload the image into Proteopedia: see [[Proteopedia:Video_Guide#Video_5:_Uploading_an_image_or_file_and_adding_an_image_to_a_page|Video 5: Uploading an image or file and adding an image to a page]].
*For help on formatting the image within the page, see [http://en.wikipedia.org/wiki/Help:Wiki_markup#Images Wiki markup: Images] or for even more detail, [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Wikipedia:Extended image syntax].


===Interactive 3D "Supplementary Materials" for Journal Publications===
===<i class="fas fa-cubes"></i> For authors: creating 3D scenes===
*For preparing interactive 3D complements to journal publications (similar to supplementary materials), please see [[Interactive 3D Complements in Proteopedia]].
To show a 3D scene, you need structural data (typically from the protein database PDB) and need to decide how to show it. This is described in [[Proteopedia:DIY:Scenes]]. The 3D scenes are created and previewed using the [[Scene authoring tools]]. If you want to show a structure not in the PDB, you have to upload the structure first ([[Help:Uploading molecules]]). Tips how to make 3D scenes that have a lot of information yet are easy to understand is available at [[Proteopedia:How to Make a Scene]].
*For hiding these until the date of publication, please see [[Proteopedia:Workbench]].


===Protecting Pages===
|-
*If you would like to protect a personal page from editing by others, please see [[Proteopedia:Policy]] and [[Help:Protected_Pages]].


===Languages===
|valign="top"|
* For examples of Proteopedia articles in non-English languages, and for the rules and policies for such articles, please see [[Proteopedia:Languages]]. *For instructions for translating articles to other languages, see [[Help:Language Translation]].
* See also [[Help:Text Directionality|Text Directionality]] regarding right-to-left languages such as Arabic or Hebrew.


===Proteopedia Speed===
=== <i class="fas fa-film"></i> For authors: multimedia===
* Proteopedia will '''render faster''' in your computer if you enable the use of Java (see above).
You can insert static images or animations directly in the text, embed videos, and integrate different data in 3D scenes, see [[Help:Multimedia]]. Proteopedia hosts images as long as they come with the appropriate license (see [[Proteopedia:Terms of Service]]). For uploading images, see [[Proteopedia:Video_Guide#Video_5:_Uploading_an_image_or_file_and_adding_an_image_to_a_page|Video Guide 5]]. For help on formatting the image within the page, see [http://en.wikipedia.org/wiki/Help:Wiki_markup#Images Wiki markup: Images] or for even more detail, [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Wikipedia:Extended image syntax].  
* '''Create fast pages''': Following these [[Create_fast_pages|simple tips]] your Proteopedia pages might load and render faster.
|valign="top"|


===Comments===
===<i class="fas fa-atom"></i> For authors: advanced topics===
Users of Proteopedia are invited to comment on published structures. Comments can raise questions about the interpretation, validity or quality of the model, cite other pertinent resources, congratulate the authors on a job well done, discuss implications of the model, etc.
Advanced topics are discussed in [[Proteopedia:Cookbook]], e.g. integrated quizzes (for details, see [[Help:Quiz]]), how to construct a URL showing a specific scene, and inserting interactive buttons (for details, see [[Jmol/Interactivity]]). Consult [[Help:Jmol]] for advanced 3D scenes. To look under the hood of other pages, use the "edit this page" tab. [[Proteopedia:DIY:Templates|Templates]]  and [[Proteopedia:Macros|macros]] can help to achieve effects with less typing.
|-


'''How to comment on articles or published structures:'''
|valign="top"|
Log in to Proteopedia and add your comment by editing the '''discussion''' tab associated with each page. You can comment on any page in Proteopedia. <!--After you save your comments, a banner will appear automatically at the top of the page to alert people to the existence of comments.-->


* [[Proteopedia:Comments_on_Published_Structures|Published Structures with Comments]]
=== <i class="fas fa-chalkboard-teacher"></i> For teachers===
* [[Proteopedia:Comments_on_Articles|Articles with Comments]]
For Teaching with Proteopedia, a good starting point is [[Help: Teaching with Proteopedia]]. Also consult [[Teaching_Scenes, Tutorials, and Educators' Pages]], [[How To Find A Structure]], and if applicable, [[High school teachers' resources]]. Students might benefit from studying [[Proteopedia:Primer]] and [[Media:Proteopedia tutorial step by step.pdf]]. If you need a space for students to draft pages, reserve some sandboxes for your students [https://proteopedia.org/cgi-bin/sandboxReservation here].
|valign="top"|


==Contact==
===<i class="fas fa-question"></i> More help? Contact us===
Feel free to [[Special:Contact|contact us]] with any questions or suggestions.
Feel free to [[Help:Contact Us|contact us]], or subscribe to and post questions on the [[Proteopedia:Email list]]. As a registered user, you can also contact other users (e.g. if you have a question about a page they contributed to) by going to their user page and clicking on "contact this user" on the left side panel. If you encounter error messages, consult [[Help:Errors]].  
|}

Latest revision as of 22:34, 25 October 2024

Proteopedia (see Overview) is the 3D encyclopedia of proteins and other biological molecules. This is the directory of help pages for visitors and for registered users.

Navigating ProteopediaNavigating Proteopedia

Proteopedia is organized like an encyclopedia, with entries (also called pages or articles) on different topics. If you already know the topic you are interested in, you can search for relevant entries using the search box on the left side of the page. For help, go to Help:Searching. You can also browse the entries, starting with the suggestions on the Main Page or the table of contents or the structure index available in the navigation box on the left. Entries have links to other entries (if you right-click them, the current entry will stay available and the linked entry will open in a new tab). This is a way to browse entries on related topics.

Reading and viewing entriesReading and viewing entries

The special feature of Proteopedia entries are the interactive 3D representations of molecules viewable on most pages. They appear in a window integrated into the page (often called "Jmol window"). As you read through the text of an entry, you will find "green links". When you click on them, you stay on the same page but the interactive 3D scene changes to match the green-linked text. To learn how to get the most out of the interactive 3D scenes, reference the Viewing guide and the cheat sheet that comes with it. If you encounter technical terms you are unfamiliar with, try searching for them to learn more about them. The About Macromolecular Structure page is a good place to start.

Who wrote the entry when?Who wrote the entry when?

The section headed "Proteopedia Page Contributors and Editors" (on the bottom of the entry) lists all authors of the entry. If you are interested to learn who wrote what and when the entry was last updated, go to the history tab. Occasionally, the discussion tab contains information about how the entry was created or suggestions for improvement.

Becoming a registered user on ProteopediaBecoming a registered user on Proteopedia

To edit pages or create new ones, you need an account. At the top right of each page, there is a link to login in or request an account. With an account, you can edit pages and create new ones. You will also have a user page to introduce yourself, and access to sandboxes where you can try out creating content.

For authors: contributing contentFor authors: contributing content

To get started, read Help:Getting Started in Proteopedia, or watch the videos linked there. You can start editing in a sandbox (see Help:Sandboxes). Before reusing content from others, consult Proteopedia:Guidelines for Ethical Writing for ethical aspects, and Help:Editing#Citing_Literature_References for formatting references. The text on Proteopedia has an open license that encourages remixing with attribution, see Remixing. For some suggestions how to improve the quality of a page, see Proteopedia:How to Make a Page. Español - 日本人 عربي - עִברִית - etc. All pages must be available in English. Translation of English pages to other languages is encouraged (examples). Here are instructions for translation.


For authors: creating 3D scenesFor authors: creating 3D scenes

To show a 3D scene, you need structural data (typically from the protein database PDB) and need to decide how to show it. This is described in Proteopedia:DIY:Scenes. The 3D scenes are created and previewed using the Scene authoring tools. If you want to show a structure not in the PDB, you have to upload the structure first (Help:Uploading molecules). Tips how to make 3D scenes that have a lot of information yet are easy to understand is available at Proteopedia:How to Make a Scene.

For authors: multimediaFor authors: multimedia

You can insert static images or animations directly in the text, embed videos, and integrate different data in 3D scenes, see Help:Multimedia. Proteopedia hosts images as long as they come with the appropriate license (see Proteopedia:Terms of Service). For uploading images, see Video Guide 5. For help on formatting the image within the page, see Wiki markup: Images or for even more detail, Wikipedia:Extended image syntax.

For authors: advanced topicsFor authors: advanced topics

Advanced topics are discussed in Proteopedia:Cookbook, e.g. integrated quizzes (for details, see Help:Quiz), how to construct a URL showing a specific scene, and inserting interactive buttons (for details, see Jmol/Interactivity). Consult Help:Jmol for advanced 3D scenes. To look under the hood of other pages, use the "edit this page" tab. Templates and macros can help to achieve effects with less typing.

For teachersFor teachers

For Teaching with Proteopedia, a good starting point is Help: Teaching with Proteopedia. Also consult Teaching_Scenes, Tutorials, and Educators' Pages, How To Find A Structure, and if applicable, High school teachers' resources. Students might benefit from studying Proteopedia:Primer and Media:Proteopedia tutorial step by step.pdf. If you need a space for students to draft pages, reserve some sandboxes for your students here.

More help? Contact usMore help? Contact us

Feel free to contact us, or subscribe to and post questions on the Proteopedia:Email list. As a registered user, you can also contact other users (e.g. if you have a question about a page they contributed to) by going to their user page and clicking on "contact this user" on the left side panel. If you encounter error messages, consult Help:Errors.

Proteopedia Page Contributors and Editors (what is this?)Proteopedia Page Contributors and Editors (what is this?)

Eran Hodis, Eric Martz, Jaime Prilusky, Wayne Decatur, Joel L. Sussman, Angel Herraez, Karsten Theis