Help:New Contributor Quickstart
From WikiPathways
(Difference between revisions)
Current revision (00:04, 24 January 2020) (view source) (→Create a new pathway at WikiPathways) |
|||
| (77 intermediate revisions not shown.) | |||
| Line 1: | Line 1: | ||
| - | + | __NOTOC__ | |
| - | __NOTOC__ | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
<font size=2> | <font size=2> | ||
| - | + | ''' Welcome to WikiPathways!''' </font> This guide presents a quick overview of the most common use cases of WikiPathways. | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | '''''Where do you want to start?''''' | |
| - | + | ||
| - | + | = Browse pathway archives or find a specific pathway = | |
| - | + | # To get an overview of the WikiPathways archives, select the '''Browse''' thumbnail on the main page. You can browse pathways by species, and fine-tune the results by '''Collection'''. Results can be viewed as thumbnail images or a list. | |
| - | + | # To find a specific pathway, search for it by name, data node name, data node identifier or keyword. | |
| - | * PathVisio | + | For details '''Search''' and '''Browse''', see [[:Help:Finding_Pathways|Finding Pathways]]. |
| - | * | + | |
| - | + | = Edit an existing pathway = | |
| + | # Become part of the WikiPathways community by [[:Special:Userlogin|creating a user account]]. | ||
| + | # Find a pathway to edit. <br />To identify a pathway that is in need of editing, use the [[:Help:QualityTags|quality tag system]]. You can find [[:Special:SpecialCurationTags|lists of pathways]] organized by curation tag. For example, pathways tagged with the "Annotate nodes" tag or the "Fix interactions" tag can be greatly improved by relatively simple editing. You can also find a pathway through [[:Help:Finding Pathways|search or browse]].<br /> | ||
| + | === Pathway Diagram === | ||
| + | '''The editor for WikiPathways is the local version of PathVisio.''' | ||
| + | |||
| + | * If you have never edited or built a pathway model before, we would advise you to use our online learning tool [http://academy.wikipathways.org/ WikiPathways Academy] first. | ||
| + | |||
| + | * If you directly want to start editing, please download the [https://www.pathvisio.org/downloads/ local PathVisio installation] from the PathVisio website, and install the [https://www.pathvisio.org/plugin/wikipathways-plugin/ WikiPathways plugin] from within PathVisio. | ||
| + | Please be aware that new users (starting in 2019) need to request access to use the WikiPathways plugin; which can be done [http://plugins.pathvisio.org/wp-client/request-webservice-access/ here] or through sending a message to our team on our [https://groups.google.com/forum/#!forum/wikipathways-discuss google discussion forum]. | ||
| + | |||
| + | * Save your pathway by clicking '''Plugins > WikiPathways > Update'''. You will be asked to describe your edits. | ||
| + | |||
| + | The content at WikiPathways is diverse in both style and content. While we don't enforce a particular drawing style, there are some guidelines for editing and graphical style. Our guidelines include [[:Help:Guidelines|general editing guidelines]], [[:Help:Guidelines_EditorPalette|a guide to the editor's palette]], as well as a [[:Help:Guidelines#Example_pathways|list of example pathways]] for your reference. There is also a specific process for including pathways into specific pathway collections at WikiPathways, read more about it [[:Help:Guidelines#Inclusion_of_pathways_into_specific_pathway_collections|here]]. | ||
| + | |||
| + | === Additional fields of the pathway page === | ||
| + | In addition to the graphical pathway representation, the [[:Help:Viewing_Pathways|Pathway Page]] has additional information fields that can be edited. | ||
| + | # Add or remove relevant quality tags. For example, if you added database references to all unassigned DataNodes on the pathway, remove the "Annotate nodes" tag by clicking the '''Remove''' button next to the tag. Similarly, to add a quality tag, click the '''New tag''' button at the bottom of the Quality Tags section and select a tag from the drop-down menu. For example, if you consider the pathway incomplete, add the "Needs work" tag. | ||
| + | # To edit the pathway description, click the '''Edit''' link in the '''Description''' section. | ||
| + | # Add relevant ontology tags by searching for tags or by browsing the three ontologies. | ||
| - | + | = Create a new pathway at WikiPathways = | |
| - | + | # Become part of the WikiPathways community by [[:Special:Userlogin|creating a user account]]. | |
| - | + | # To create a pathway, you can either '''upload an existing gpml via the '''Upload File''' option, or '''create a pathway in PathVisio and upload it to WikiPathways''' via the [[:Help:WPClientPluginCuration|WikiPathways plugin for PathVisio]]. | |
| - | + | === Upload gpml === | |
| - | + | # You can also upload an existing gpml via the '''Upload File''' option on the [[:Special:CreatePathwayPage|Create new pathway]] page. Make sure the existing gpml contains a species designation. | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | === PathVisio === | |
| - | + | You can upload a local gpml directly from PathVisio by opening the pathway in PathVisio, and then selecting '''Plugins > WikiPathways > Upload New'''. Make sure the pathway contains a species designation. | |
| - | + | === Guide for New Authors === | |
| + | * Be sure to consult the [http://wikipathways.org/img_auth.php/d/d0/Instructions_for_WikiPathways_Authors.pdf Guide for New Authors] for pathway modeling tips. | ||
Current revision
Welcome to WikiPathways! This guide presents a quick overview of the most common use cases of WikiPathways.
Where do you want to start?
Browse pathway archives or find a specific pathway
- To get an overview of the WikiPathways archives, select the Browse thumbnail on the main page. You can browse pathways by species, and fine-tune the results by Collection. Results can be viewed as thumbnail images or a list.
- To find a specific pathway, search for it by name, data node name, data node identifier or keyword.
For details Search and Browse, see Finding Pathways.
Edit an existing pathway
- Become part of the WikiPathways community by creating a user account.
- Find a pathway to edit.
To identify a pathway that is in need of editing, use the quality tag system. You can find lists of pathways organized by curation tag. For example, pathways tagged with the "Annotate nodes" tag or the "Fix interactions" tag can be greatly improved by relatively simple editing. You can also find a pathway through search or browse.
Pathway Diagram
The editor for WikiPathways is the local version of PathVisio.
- If you have never edited or built a pathway model before, we would advise you to use our online learning tool WikiPathways Academy first.
- If you directly want to start editing, please download the local PathVisio installation from the PathVisio website, and install the WikiPathways plugin from within PathVisio.
Please be aware that new users (starting in 2019) need to request access to use the WikiPathways plugin; which can be done here or through sending a message to our team on our google discussion forum.
- Save your pathway by clicking Plugins > WikiPathways > Update. You will be asked to describe your edits.
The content at WikiPathways is diverse in both style and content. While we don't enforce a particular drawing style, there are some guidelines for editing and graphical style. Our guidelines include general editing guidelines, a guide to the editor's palette, as well as a list of example pathways for your reference. There is also a specific process for including pathways into specific pathway collections at WikiPathways, read more about it here.
Additional fields of the pathway page
In addition to the graphical pathway representation, the Pathway Page has additional information fields that can be edited.
- Add or remove relevant quality tags. For example, if you added database references to all unassigned DataNodes on the pathway, remove the "Annotate nodes" tag by clicking the Remove button next to the tag. Similarly, to add a quality tag, click the New tag button at the bottom of the Quality Tags section and select a tag from the drop-down menu. For example, if you consider the pathway incomplete, add the "Needs work" tag.
- To edit the pathway description, click the Edit link in the Description section.
- Add relevant ontology tags by searching for tags or by browsing the three ontologies.
Create a new pathway at WikiPathways
- Become part of the WikiPathways community by creating a user account.
- To create a pathway, you can either upload an existing gpml via the Upload File option, or create a pathway in PathVisio and upload it to WikiPathways via the WikiPathways plugin for PathVisio.
Upload gpml
- You can also upload an existing gpml via the Upload File option on the Create new pathway page. Make sure the existing gpml contains a species designation.
PathVisio
You can upload a local gpml directly from PathVisio by opening the pathway in PathVisio, and then selecting Plugins > WikiPathways > Upload New. Make sure the pathway contains a species designation.
Guide for New Authors
- Be sure to consult the Guide for New Authors for pathway modeling tips.
