Difference between revisions of "Template:Interactive pathway maps/doc"

From blackwiki
Jump to navigation Jump to search
imported>AlexanderPico
(Created page with '{{documentation subpage}} This template is the product of a custom export process of [http://www.wikipathways.org WikiPathways] content as interactive pathway maps ...')
 
imported>AlexanderPico
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
This template is the product of a custom export process of [http://www.wikipathways.org WikiPathways] content as interactive pathway maps for Wikipedia articles. Please do not edit these templates directly as they include calculated hyperlinks and annotations based on original content curated at WikiPathways. Please feel free to edit and update the pathway content at WikiPathways. Your changes will be reflected here when the template is regenerated.  
+
This template is the product of a custom export process of [http://www.wikipathways.org WikiPathways] content as interactive pathway maps for Wikipedia articles. Please do not edit these templates directly as they include calculated hyperlinks and annotations based on original content curated at [http://www.wikipathways.org WikiPathways]. Please feel free to edit and update the pathway content at [http://www.wikipathways.org WikiPathways]. Your changes will be reflected here when the template is regenerated.  
  
 
== Features ==
 
== Features ==
 +
* '''[[Portal:Gene Wiki|Gene Wiki]] links''' - click on blue-underlined gene boxes in pathway to go to the corresponding Gene Wiki article
 +
* '''Metabolite links''' - click on blue-underlined metabolite boxes in pathway to go to the corresponding metabolite article
 +
* '''Start new pages''' - click on red-underlined boxes to start a ''new'' Wikipedia article where one currently does not exist
 +
* '''Bold self links''' - the gene or metabolite focused on in the current article is displayed as a bold-bordered self link
 +
* '''Pathway links''' - click anywhere in the background on the pathway to go to the corresponding pathway article with an expanded view of the interactive pathway map
 +
* '''Variable-controlled cropping''' - pathway maps can be cropped by referencing a gene or metabolite, or by manually specifying crop variables (see Usage below).
  
 
== Usage ==
 
== Usage ==
 
This template is commonly transcluded into the following types of articles in the following ways:
 
This template is commonly transcluded into the following types of articles in the following ways:
1. '''Pathway articles'''
+
<br>1. '''Pathway articles'''
 
:: Where you want to see the full pathway
 
:: Where you want to see the full pathway
  {{TCACycle_WP78}}
+
  <nowiki>{{</nowiki>TCACycle_WP78<nowiki>}}</nowiki>
2. '''[[Portal:GeneWiki|Gene Wiki]] articles'''
+
<br>2. '''[[Portal:Gene Wiki|Gene Wiki]] articles'''
 
:: Where you want to crop the pathway view to center on a particular gene
 
:: Where you want to crop the pathway view to center on a particular gene
  {{TCACycle_WP78|highlight=Dihydrolipoyl_transacetylase}}
+
  <nowiki>{{</nowiki>TCACycle_WP78|highlight=Dihydrolipoyl_transacetylase<nowiki>}}</nowiki>
3. '''Metabolite articles'''
+
<br>3. '''Metabolite articles'''
 
:: Where you want to crop the pathway view to center on a particular metabolite
 
:: Where you want to crop the pathway view to center on a particular metabolite
  {{TCACycle_WP78|highlight=Fumaric_acid}}
+
  <nowiki>{{</nowiki>TCACycle_WP78|highlight=Fumaric_acid<nowiki>}}</nowiki>
4. '''Miscellaneous'''
+
<br>4. '''Miscellaneous'''
 
:: Where you override default variables and control the cropping yourself
 
:: Where you override default variables and control the cropping yourself
  {{TCACycle_WP78|cWidth=600|cHeight=300|oTop=325|oLeft=310}}
+
  <nowiki>{{</nowiki>TCACycle_WP78|cWidth=600|cHeight=300|oTop=325|oLeft=310<nowiki>}}</nowiki>
<code>cWidth</code>: the width of the crop window
+
*<code>cWidth</code>: the width of the crop window
<code>cHeight</code>: the heigth of the crop window
+
*<code>cHeight</code>: the heigth of the crop window
<code>oTop</code>: the offset of the crop window from the top ''(Note: set to at least 25px to crop out unsightly template syntax)''
+
*<code>oTop</code>: the offset of the crop window from the top ''(Note: set to at least 25px to crop out unsightly template syntax)''
<code>oLeft</code>: the offset of the crop window from the left ''(Note: set to at least 10px to crop out unsightly template syntax)''
+
*<code>oLeft</code>: the offset of the crop window from the left ''(Note: set to at least 10px to crop out unsightly template syntax)''
 +
 
 +
== Examples ==
 +
* [[Citric_acid_cycle|Citric acid cycle pathway]]
 +
* [[Dihydrolipoyl_transacetylase#Interactive_pathway_map|DLAT gene wiki article]]
 +
* Where is [[Special:WhatLinksHere/{{PAGENAME}}|this template]] used?

Revision as of 20:09, 7 August 2010

This template is the product of a custom export process of WikiPathways content as interactive pathway maps for Wikipedia articles. Please do not edit these templates directly as they include calculated hyperlinks and annotations based on original content curated at WikiPathways. Please feel free to edit and update the pathway content at WikiPathways. Your changes will be reflected here when the template is regenerated.

Features

  • Gene Wiki links - click on blue-underlined gene boxes in pathway to go to the corresponding Gene Wiki article
  • Metabolite links - click on blue-underlined metabolite boxes in pathway to go to the corresponding metabolite article
  • Start new pages - click on red-underlined boxes to start a new Wikipedia article where one currently does not exist
  • Bold self links - the gene or metabolite focused on in the current article is displayed as a bold-bordered self link
  • Pathway links - click anywhere in the background on the pathway to go to the corresponding pathway article with an expanded view of the interactive pathway map
  • Variable-controlled cropping - pathway maps can be cropped by referencing a gene or metabolite, or by manually specifying crop variables (see Usage below).

Usage

This template is commonly transcluded into the following types of articles in the following ways:
1. Pathway articles

Where you want to see the full pathway
{{TCACycle_WP78}}


2. Gene Wiki articles

Where you want to crop the pathway view to center on a particular gene
{{TCACycle_WP78|highlight=Dihydrolipoyl_transacetylase}}


3. Metabolite articles

Where you want to crop the pathway view to center on a particular metabolite
{{TCACycle_WP78|highlight=Fumaric_acid}}


4. Miscellaneous

Where you override default variables and control the cropping yourself
{{TCACycle_WP78|cWidth=600|cHeight=300|oTop=325|oLeft=310}}
  • cWidth: the width of the crop window
  • cHeight: the heigth of the crop window
  • oTop: the offset of the crop window from the top (Note: set to at least 25px to crop out unsightly template syntax)
  • oLeft: the offset of the crop window from the left (Note: set to at least 10px to crop out unsightly template syntax)

Examples