From 11b2fbcb3b743691341d3b65ee6be3d99eda9067 Mon Sep 17 00:00:00 2001
From: Carl Eberhard <carlfeberhard@gmail.com>
Date: Thu, 7 May 2015 16:04:25 -0400
Subject: [PATCH] Visualizations registry: switch to entry_point config
 definition for built-in visualizations

---
 .../ipython/config/ipython.xml                |  2 +-
 .../visualizations/charts/config/charts.xml   |  2 +-
 .../circster/config/circster.xml              |  2 +-
 .../graphview/config/graphview.xml            |  2 +-
 .../phyloviz/config/phyloviz.xml              |  2 +-
 .../scatterplot/config/scatterplot.xml        |  2 +-
 .../sweepster/config/sweepster.xml            |  2 +-
 .../trackster/config/trackster.xml            |  2 +-
 .../plugins/visualizations/visualization.dtd  | 34 ++++++++++++++++---
 9 files changed, 38 insertions(+), 12 deletions(-)

diff --git a/config/plugins/interactive_environments/ipython/config/ipython.xml b/config/plugins/interactive_environments/ipython/config/ipython.xml
index 4af9a8540e8..422aad3699b 100644
--- a/config/plugins/interactive_environments/ipython/config/ipython.xml
+++ b/config/plugins/interactive_environments/ipython/config/ipython.xml
@@ -12,5 +12,5 @@
     <params>
         <param type="dataset" var_name_in_template="hda" required="true">dataset_id</param>
     </params>
-    <template>ipython.mako</template>
+    <entry_point entry_point_type="mako">ipython.mako</entry_point>
 </interactive_environment>
diff --git a/config/plugins/visualizations/charts/config/charts.xml b/config/plugins/visualizations/charts/config/charts.xml
index 98623288dc3..b3624fa1bf4 100644
--- a/config/plugins/visualizations/charts/config/charts.xml
+++ b/config/plugins/visualizations/charts/config/charts.xml
@@ -11,5 +11,5 @@
     <params>
         <param type="dataset" var_name_in_template="hda" required="true">dataset_id</param>
     </params>
-    <template>charts.mako</template>
+    <entry_point entry_point_type="mako">charts.mako</entry_point>
 </visualization>
diff --git a/config/plugins/visualizations/circster/config/circster.xml b/config/plugins/visualizations/circster/config/circster.xml
index c572ea29323..795887dbf2c 100644
--- a/config/plugins/visualizations/circster/config/circster.xml
+++ b/config/plugins/visualizations/circster/config/circster.xml
@@ -21,6 +21,6 @@
         <param_modifier type="string" modifies="dataset_id">hda_ldda</param_modifier>
         <param type="dbkey">dbkey</param>
     </params>
-    <template>circster.mako</template>
+    <entry_point entry_point_type="mako">circster.mako</entry_point>
     <render_target>_top</render_target>
 </visualization>
diff --git a/config/plugins/visualizations/graphview/config/graphview.xml b/config/plugins/visualizations/graphview/config/graphview.xml
index 836e60da855..ff1e7d068bd 100644
--- a/config/plugins/visualizations/graphview/config/graphview.xml
+++ b/config/plugins/visualizations/graphview/config/graphview.xml
@@ -16,5 +16,5 @@
     <params>
         <param type="dataset" var_name_in_template="hda" required="true">dataset_id</param>
     </params>
-    <template>graphview.mako</template>
+    <entry_point entry_point_type="mako">graphview.mako</entry_point>
 </visualization>
diff --git a/config/plugins/visualizations/phyloviz/config/phyloviz.xml b/config/plugins/visualizations/phyloviz/config/phyloviz.xml
index 44fdbde3dbd..4fd32303185 100644
--- a/config/plugins/visualizations/phyloviz/config/phyloviz.xml
+++ b/config/plugins/visualizations/phyloviz/config/phyloviz.xml
@@ -14,6 +14,6 @@
         <param type="dataset" var_name_in_template="hda" required="true">dataset_id</param>
         <param type="integer" default="0">tree_index</param>
     </params>
-    <template>phyloviz.mako</template>
+    <entry_point entry_point_type="mako">phyloviz.mako</entry_point>
     <render_target>_top</render_target>
 </visualization>
diff --git a/config/plugins/visualizations/scatterplot/config/scatterplot.xml b/config/plugins/visualizations/scatterplot/config/scatterplot.xml
index 642b528dd0f..14004ceb1e5 100644
--- a/config/plugins/visualizations/scatterplot/config/scatterplot.xml
+++ b/config/plugins/visualizations/scatterplot/config/scatterplot.xml
@@ -11,5 +11,5 @@
     <params>
         <param type="dataset" var_name_in_template="hda" required="true">dataset_id</param>
     </params>
-    <template>scatterplot.mako</template>
+    <entry_point entry_point_type="mako">scatterplot.mako</entry_point>
 </visualization>
diff --git a/config/plugins/visualizations/sweepster/config/sweepster.xml b/config/plugins/visualizations/sweepster/config/sweepster.xml
index 6676733b37a..647e2bcf412 100644
--- a/config/plugins/visualizations/sweepster/config/sweepster.xml
+++ b/config/plugins/visualizations/sweepster/config/sweepster.xml
@@ -20,6 +20,6 @@
         <param type="hda_or_ldda" var_name_in_template="dataset">dataset_id</param>
         <param_modifier type="string" modifies="dataset_id">hda_ldda</param_modifier>
     </params>
-    <template>sweepster.mako</template>
+    <entry_point entry_point_type="mako">sweepster.mako</entry_point>
     <render_target>_top</render_target>
 </visualization>
diff --git a/config/plugins/visualizations/trackster/config/trackster.xml b/config/plugins/visualizations/trackster/config/trackster.xml
index bba0900d04d..02e06e73e52 100644
--- a/config/plugins/visualizations/trackster/config/trackster.xml
+++ b/config/plugins/visualizations/trackster/config/trackster.xml
@@ -23,6 +23,6 @@
         <param type="genome_region">genome_region</param>
         <param type="dbkey">dbkey</param>
     </params>
-    <template>browser.mako</template>
+    <entry_point entry_point_type="mako">browser.mako</entry_point>
     <render_target>_top</render_target>
 </visualization>
diff --git a/config/plugins/visualizations/visualization.dtd b/config/plugins/visualizations/visualization.dtd
index 1fdf4aa67e9..e01aa7ce12d 100644
--- a/config/plugins/visualizations/visualization.dtd
+++ b/config/plugins/visualizations/visualization.dtd
@@ -1,6 +1,12 @@
 <!-- each visualization must have a template (all other elements are optional) -->
-<!ELEMENT visualization (description*,data_sources*,params*,template_root*,template,render_target*)>
-<!ELEMENT interactive_environment (description*,data_sources*,params*,template_root*,template,render_target*)>
+<!ELEMENT visualization (
+  description*,
+  data_sources*,
+  params*,
+  template_root*,
+  entry_point,
+  render_target*
+)>
 <!-- visualization
         name: the title/display name of the visualization (e.g. 'Trackster', 'Fastq Stats', etc.) REQUIRED
         disabled: if included (value does not matter), this attribute will prevent the visualization being loaded
@@ -14,6 +20,21 @@
     embeddable  CDATA #IMPLIED
 >
 
+<!ELEMENT interactive_environment (
+  description*,
+  data_sources*,
+  params*,
+  template_root*,
+  entry_point,
+  render_target*
+)>
+<!ATTLIST interactive_environment
+    name        CDATA #REQUIRED
+    disabled    CDATA #IMPLIED
+    embeddable  CDATA #IMPLIED
+>
+
+
 <!ELEMENT description (#PCDATA)>
 <!-- a text description of what the visualization does -->
 
@@ -128,8 +149,13 @@
       var_name_in_template  CDATA #IMPLIED
   >
 
-<!-- template: the template used to render the visualization. REQUIRED -->
-<!ELEMENT template (#PCDATA)>
+<!-- template: the template used to render the visualization. DEPRECATED -->
+<!-- <!ELEMENT template (#PCDATA)> -->
+<!-- entry_point: the method the registry will use to begin rendering the visualization - a loading point. REQUIRED -->
+<!ELEMENT entry_point (#PCDATA)>
+<!ATTLIST entry_point
+    entry_point_type  CDATA #REQUIRED
+>
 <!-- render_target: used as the target attribute of the link to the visualization.
       Can be 'galaxy_main', '_top', '_blank'. DEFAULT: 'galaxy_main'
 -->