Help:Editing Pathways
From WikiPathways
(Difference between revisions)
Current revision (08:30, 22 February 2022) (view source) |
|||
| (13 intermediate revisions not shown.) | |||
| Line 1: | Line 1: | ||
__NOEDITSECTION__ <!-- Turn off section editing --> | __NOEDITSECTION__ <!-- Turn off section editing --> | ||
| - | '''The | + | = Editing Pathway content through PathVisio: = |
| + | |||
| + | '''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. | ||
| + | |||
| + | * You can also browse WikiPathways and open and edit any pathway from within PathVisio, as well as create new pathways. For more details, see [[:Help:WPClientPluginCuration|Using the WikiPathways Client plugin]]. | ||
| + | __NOTOC__ | ||
<!-- | <!-- | ||
{{#ev:youtube|tYD9JxILxv8|700|left|Intro to Editing Video}} | {{#ev:youtube|tYD9JxILxv8|700|left|Intro to Editing Video}} | ||
| - | + | ||
| - | + | ||
= Editing in PathVisio Webstart = | = Editing in PathVisio Webstart = | ||
| Line 11: | Line 22: | ||
* Click the '''Launch Editor''' button on any '''Pathway Page''' to open the [http://www.pathvisio.org PathVisio] program with the current pathway loaded. You can add, edit or delete content from the pathway and when you save, updated versions of the images, controlled text, and data files are generated and are immediately available. For instructions on basic editing features please refer to [http://www.pathvisio.org/documentation/editing-and-viewing-pathways/ PathVisio documentation]. | * Click the '''Launch Editor''' button on any '''Pathway Page''' to open the [http://www.pathvisio.org PathVisio] program with the current pathway loaded. You can add, edit or delete content from the pathway and when you save, updated versions of the images, controlled text, and data files are generated and are immediately available. For instructions on basic editing features please refer to [http://www.pathvisio.org/documentation/editing-and-viewing-pathways/ PathVisio documentation]. | ||
| - | + | --> | |
| - | + | <!-- | |
| - | + | ||
= Editing using Quick Edit = | = Editing using Quick Edit = | ||
We have a new, quick way to edit data node annotations and styles. When logged in, the '''Quick Edit''' button is located at the bottom center of the pathway view. Clicking the '''Quick Edit''' button opens the editor: | We have a new, quick way to edit data node annotations and styles. When logged in, the '''Quick Edit''' button is located at the bottom center of the pathway view. Clicking the '''Quick Edit''' button opens the editor: | ||
[[Image:QuickEdit.png]] | [[Image:QuickEdit.png]] | ||
| + | |||
=== Editing data node annotation === | === Editing data node annotation === | ||
| Line 32: | Line 43: | ||
* Use the color chooser to change the border and label color of the node, or use the buttons to set the label text to bold and italic. | * Use the color chooser to change the border and label color of the node, or use the buttons to set the label text to bold and italic. | ||
* Click the '''Save & Close''' button to save and exit Quick Edit. | * Click the '''Save & Close''' button to save and exit Quick Edit. | ||
| + | --> | ||
| + | = Editing Pathway Page directly on the website: = | ||
| + | Text fields on a '''Pathway Page''' can be edited like any other text on a wiki. Please refer to the [http://meta.wikimedia.org/wiki/Help:Wikitext WikiMedia] website for details on formatting. | ||
| - | = | + | === Description === |
| - | + | Each '''Pathway Page''' includes a '''Description''' section, which contains information about the biological process described in the pathway. The '''Description''' can be edited by clicking the Edit link to the right of the Description section. | |
=== Quality Tags === | === Quality Tags === | ||
'''Quality tags''' can be added to a pathway to notify the author and community about the state of the pathway. For example, you could tag a pathway that isn't annotated properly or tag your own pathway as work in progress. Quality Tags can be added by clicking the green plus sign icon in the Quality Tags section. Choose the type of Quality Tag from the drop-down list and enter a comment if appropriate. | '''Quality tags''' can be added to a pathway to notify the author and community about the state of the pathway. For example, you could tag a pathway that isn't annotated properly or tag your own pathway as work in progress. Quality Tags can be added by clicking the green plus sign icon in the Quality Tags section. Choose the type of Quality Tag from the drop-down list and enter a comment if appropriate. | ||
| - | === | + | === Ontology Tags === |
| - | + | The '''Ontology Tags''' section contains any ontology tags added to the pathway and an interface for adding ontology tags. To add ontology tags, click the '''Add Ontology tags''' link, which will open two tools for finding and adding ontology tags: a search interface and browsable trees for the supported ontologies. To search for a term, simply begin typing in the ''Search'' field. Pick a term from the results and click the ''Add'' button (green check mark) to add the term. Alternatively, find a term from the browsable ontology trees, select it and click the '''Add''' button. You can delete any ontology term from the pathway by selecting it and clicking the '''Remove''' button (red x). To learn more about a particular term, click the '''View more info on BioPortal''' button (blue i). | |
| + | |||
| + | <!-- Not possible to edit on website. | ||
=== Bibliography === | === Bibliography === | ||
Each '''Pathway Page''' includes a '''Bibliography''' section, designed to hold reference information relevant to the pathway. When editing a pathway in the editor, any references to publications, textbooks and websites can be added to this section by right-clicking on any object in the pathway and selecting '''Add''' or '''Edit''' from the '''Literature''' menu. Details on how to incorporate literature references can be found [[:Help:LiteratureReferences|here]]. | Each '''Pathway Page''' includes a '''Bibliography''' section, designed to hold reference information relevant to the pathway. When editing a pathway in the editor, any references to publications, textbooks and websites can be added to this section by right-clicking on any object in the pathway and selecting '''Add''' or '''Edit''' from the '''Literature''' menu. Details on how to incorporate literature references can be found [[:Help:LiteratureReferences|here]]. | ||
| - | |||
| - | |||
| - | |||
| - | |||
--> | --> | ||
| - | === Creating a new pathway | + | |
| - | + | = Editing Guidelines = | |
| + | |||
| + | === Best practices === | ||
| + | |||
| + | * Our comprehensive [http://wikipathways.org/img_auth.php/d/d0/Instructions_for_WikiPathways_Authors.pdf Instructions for Authors] outlines how to author pathways from a beginner's perspective and includes recommendations for best practices for authoring pathways. | ||
| + | |||
| + | * The [[:Help:Guidelines_EditorPalette|Editor Palette guide]] describes the recommended utilization of the most commonly used elements of the WikiPathways editor palette. Examples are taken directly from the WikiPathways archives. | ||
| + | |||
| + | === General Guidelines === | ||
| + | |||
| + | * Complete pathway authoring guidelines are available [[:Help:Guidelines|here]]. | ||
| + | |||
| + | = Creating a new pathway = | ||
| + | To create a pathway, you can either: | ||
| + | * Use the PathVisio webstart editor at WikiPathways. | ||
| + | * Upload an existing gpml via the '''Upload File''' option. | ||
| + | * Create a pathway in PathVisio and upload it to WikiPathways via the [[:Help:WPClientPluginCuration|WikiPathways plugin for PathVisio]]. | ||
| + | |||
| + | For details on how to create a new pathway, refer to the [[:Help:New_Contributor_Quickstart#Create_a_new_pathway_at_WikiPathways|'''New Contributor Quickstart''']] guide. | ||
<p>[[:Help:Contents|Return to Help Contents]]</p> | <p>[[:Help:Contents|Return to Help Contents]]</p> | ||
<p>[[:Help:Deleting_Pathways|Continue to Deleting pathways]]</p> | <p>[[:Help:Deleting_Pathways|Continue to Deleting pathways]]</p> | ||
Current revision
Editing Pathway content through PathVisio:
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.
- You can also browse WikiPathways and open and edit any pathway from within PathVisio, as well as create new pathways. For more details, see Using the WikiPathways Client plugin.
Editing Pathway Page directly on the website:
Text fields on a Pathway Page can be edited like any other text on a wiki. Please refer to the WikiMedia website for details on formatting.
Description
Each Pathway Page includes a Description section, which contains information about the biological process described in the pathway. The Description can be edited by clicking the Edit link to the right of the Description section.
Quality Tags
Quality tags can be added to a pathway to notify the author and community about the state of the pathway. For example, you could tag a pathway that isn't annotated properly or tag your own pathway as work in progress. Quality Tags can be added by clicking the green plus sign icon in the Quality Tags section. Choose the type of Quality Tag from the drop-down list and enter a comment if appropriate.
Ontology Tags
The Ontology Tags section contains any ontology tags added to the pathway and an interface for adding ontology tags. To add ontology tags, click the Add Ontology tags link, which will open two tools for finding and adding ontology tags: a search interface and browsable trees for the supported ontologies. To search for a term, simply begin typing in the Search field. Pick a term from the results and click the Add button (green check mark) to add the term. Alternatively, find a term from the browsable ontology trees, select it and click the Add button. You can delete any ontology term from the pathway by selecting it and clicking the Remove button (red x). To learn more about a particular term, click the View more info on BioPortal button (blue i).
Editing Guidelines
Best practices
- Our comprehensive Instructions for Authors outlines how to author pathways from a beginner's perspective and includes recommendations for best practices for authoring pathways.
- The Editor Palette guide describes the recommended utilization of the most commonly used elements of the WikiPathways editor palette. Examples are taken directly from the WikiPathways archives.
General Guidelines
- Complete pathway authoring guidelines are available here.
Creating a new pathway
To create a pathway, you can either:
- Use the PathVisio webstart editor at WikiPathways.
- Upload an existing gpml via the Upload File option.
- Create a pathway in PathVisio and upload it to WikiPathways via the WikiPathways plugin for PathVisio.
For details on how to create a new pathway, refer to the New Contributor Quickstart guide.
