workflow-to-galaxy 0.2.7 → 0.2.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. data/CHANGES +6 -2
  2. data/README +11 -10
  3. data/Rakefile +7 -6
  4. data/doc/rdoc/CHANGES.html +105 -0
  5. data/doc/rdoc/Generator.html +262 -0
  6. data/doc/rdoc/LICENSE.html +115 -0
  7. data/doc/rdoc/README.html +167 -0
  8. data/doc/rdoc/WorkflowToGalaxy.html +135 -0
  9. data/doc/rdoc/created.rid +6 -1
  10. data/doc/rdoc/images/brick.png +0 -0
  11. data/doc/rdoc/images/brick_link.png +0 -0
  12. data/doc/rdoc/images/bug.png +0 -0
  13. data/doc/rdoc/images/bullet_black.png +0 -0
  14. data/doc/rdoc/images/bullet_toggle_minus.png +0 -0
  15. data/doc/rdoc/images/bullet_toggle_plus.png +0 -0
  16. data/doc/rdoc/images/date.png +0 -0
  17. data/doc/rdoc/images/find.png +0 -0
  18. data/doc/rdoc/images/loadingAnimation.gif +0 -0
  19. data/doc/rdoc/images/macFFBgHack.png +0 -0
  20. data/doc/rdoc/images/package.png +0 -0
  21. data/doc/rdoc/images/page_green.png +0 -0
  22. data/doc/rdoc/images/page_white_text.png +0 -0
  23. data/doc/rdoc/images/page_white_width.png +0 -0
  24. data/doc/rdoc/images/plugin.png +0 -0
  25. data/doc/rdoc/images/ruby.png +0 -0
  26. data/doc/rdoc/images/tag_green.png +0 -0
  27. data/doc/rdoc/images/wrench.png +0 -0
  28. data/doc/rdoc/images/wrench_orange.png +0 -0
  29. data/doc/rdoc/images/zoom.png +0 -0
  30. data/doc/rdoc/index.html +140 -20
  31. data/doc/rdoc/js/darkfish.js +116 -0
  32. data/doc/rdoc/js/jquery.js +32 -0
  33. data/doc/rdoc/js/quicksearch.js +114 -0
  34. data/doc/rdoc/js/thickbox-compressed.js +10 -0
  35. data/doc/rdoc/lib/workflow-to-galaxy/generator_rb.html +55 -0
  36. data/doc/rdoc/lib/workflow-to-galaxy_rb.html +54 -0
  37. data/doc/rdoc/rdoc.css +763 -0
  38. metadata +52 -14
  39. data/doc/rdoc/classes/Generator.html +0 -215
  40. data/doc/rdoc/classes/WorkflowToGalaxy.html +0 -105
  41. data/doc/rdoc/files/LICENSE.html +0 -133
  42. data/doc/rdoc/files/README.html +0 -192
  43. data/doc/rdoc/files/lib/workflow-to-galaxy/generator_rb.html +0 -108
  44. data/doc/rdoc/files/lib/workflow-to-galaxy_rb.html +0 -108
  45. data/doc/rdoc/fr_class_index.html +0 -28
  46. data/doc/rdoc/fr_file_index.html +0 -30
  47. data/doc/rdoc/fr_method_index.html +0 -28
  48. data/doc/rdoc/rdoc-style.css +0 -208
@@ -0,0 +1,167 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: README [workflow-to-galaxy Docs]</title>
10
+
11
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="./js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="./js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="./js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="./js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file">
24
+ <div id="metadata">
25
+ <div id="home-metadata">
26
+ <div id="home-section" class="section">
27
+ <h3 class="section-header">
28
+ <a href="./index.html">Home</a>
29
+ <a href="./index.html#classes">Classes</a>
30
+ <a href="./index.html#methods">Methods</a>
31
+ </h3>
32
+ </div>
33
+ </div>
34
+
35
+ <div id="project-metadata">
36
+
37
+
38
+ <div id="fileindex-section" class="section project-section">
39
+ <h3 class="section-header">Files</h3>
40
+ <ul>
41
+
42
+ <li class="file"><a href="./CHANGES.html">CHANGES</a></li>
43
+
44
+ <li class="file"><a href="./LICENSE.html">LICENSE</a></li>
45
+
46
+ <li class="file"><a href="./README.html">README</a></li>
47
+
48
+ </ul>
49
+ </div>
50
+
51
+
52
+ <div id="classindex-section" class="section project-section">
53
+ <h3 class="section-header">Class Index
54
+ <span class="search-toggle"><img src="./images/find.png"
55
+ height="16" width="16" alt="[+]"
56
+ title="show/hide quicksearch" /></span></h3>
57
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
58
+ <fieldset>
59
+ <legend>Quicksearch</legend>
60
+ <input type="text" name="quicksearch" value=""
61
+ class="quicksearch-field" />
62
+ </fieldset>
63
+ </form>
64
+
65
+ <ul class="link-list">
66
+
67
+ <li><a href="./Generator.html">Generator</a></li>
68
+
69
+ <li><a href="./WorkflowToGalaxy.html">WorkflowToGalaxy</a></li>
70
+
71
+ </ul>
72
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
73
+ </div>
74
+
75
+
76
+ </div>
77
+ </div>
78
+
79
+ <div id="documentation">
80
+
81
+ <h1>workflow-to-galaxy tool generator</h1>
82
+ <table class="rdoc-list"><tr><td class="rdoc-term"><p>Authors</p></td>
83
+ <td>
84
+ <p>Konstantinos Karasavvas</p>
85
+ </td></tr><tr><td class="rdoc-term"><p>Gem Version</p></td>
86
+ <td>
87
+ <p>0.2.8</p>
88
+ </td></tr><tr><td class="rdoc-term"><p>Contact</p></td>
89
+ <td>
90
+ <p><a href="mailto:kostas.karasavvas@nbic.nl">kostas.karasavvas@nbic.nl</a></p>
91
+ </td></tr><tr><td class="rdoc-term"><p>Licence</p></td>
92
+ <td>
93
+ <p>MIT (See LICENCE or <a
94
+ href="http://www.opensource.org/licenses/mit-license">www.opensource.org/licenses/mit-license</a>)</p>
95
+ </td></tr><tr><td class="rdoc-term"><p>Copyright</p></td>
96
+ <td>
97
+ <p>© 2010 Netherlands Bioinformatics Centre, The Netherlands</p>
98
+ </td></tr></table>
99
+
100
+ <h2>Synopsis</h2>
101
+
102
+ <p>This script requires a Taverna2 workflow URL as input and generates a
103
+ Galaxy tool (a UI XML definition plus a script) that will enable the
104
+ execution of this workflow through Galaxy. The tool’s description is as
105
+ good as the description provided in the workflow itself. Currently, the
106
+ myExperiment workflow repository is used to access workflow information via
107
+ its REST API but a workflow description from a file is also supported.</p>
108
+
109
+ <p>The name is workflow-to-galaxy rather than t2-workflow-to-galaxy because it
110
+ is possible that it will support other workflow management systems in the
111
+ future.</p>
112
+
113
+ <h2>Installation</h2>
114
+
115
+ <pre>[sudo] gem install workflow-to-galaxy</pre>
116
+
117
+ <h2>Usage</h2>
118
+
119
+ <p>workflow_to_galaxy [options] &lt;myExperiement-workflow&gt; |
120
+ &lt;t2flow-file&gt;</p>
121
+
122
+ <p>Generates a Galaxy tool (a UI xml definition plus a script) for the
123
+ specified Taverna2 workflow, where &lt;myExperiment-workflow&gt; is the
124
+ full URL of the workflow in the myExperiment website. Alternatively a
125
+ t2flow file can be passed for workflows not in myExperiment. Available
126
+ options are:</p>
127
+
128
+ <pre>-o OUTPUT, --output=OUTPUT The file name(s) of the generated tool. If it is not specified then the workflow's name will be used.
129
+
130
+ -s SERVER, --server=SERVER The taverna server that the script will request execution from. If it is not specified then &quot;http://localhost:8980/taverna-server&quot; will be used.
131
+
132
+ -t, --t2flow The workflow is a t2flow file.</pre>
133
+
134
+ <h2>Example</h2>
135
+
136
+ <p>Let’s say we want to install the taverna2 workflow <a
137
+ href="http://www.myexperiment.org/workflows/74.html">www.myexperiment.org/workflows/74.html</a>
138
+ from myExperiment repository:</p>
139
+
140
+ <pre>$ workflow_to_galaxy -s http://localhost:8980/taverna-server http://www.myexperiment.org/workflows/74/download/bioaid_proteindiscovery_781733.t2flow?version=5</pre>
141
+
142
+ <h2>References</h2>
143
+ <table class="rdoc-list"><tr><td class="rdoc-term"><p>Taverna-Galaxy</p></td>
144
+ <td>
145
+ <p><a
146
+ href="https://trac.nbic.nl/elabfactory/wiki/eGalaxy">trac.nbic.nl/elabfactory/wiki/eGalaxy</a></p>
147
+ </td></tr><tr><td class="rdoc-term"><p>Galaxy</p></td>
148
+ <td>
149
+ <p><a href="http://galaxy.psu.edu">galaxy.psu.edu</a></p>
150
+ </td></tr><tr><td class="rdoc-term"><p>Taverna2</p></td>
151
+ <td>
152
+ <p><a href="http://www.taverna.org.uk">www.taverna.org.uk</a></p>
153
+ </td></tr><tr><td class="rdoc-term"><p>myExperiment</p></td>
154
+ <td>
155
+ <p><a href="http://www.myexperiment.org">www.myexperiment.org</a></p>
156
+ </td></tr></table>
157
+
158
+ </div>
159
+
160
+ <div id="validator-badges">
161
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
162
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
163
+ Rdoc Generator</a> 2</small>.</p>
164
+ </div>
165
+ </body>
166
+ </html>
167
+
@@ -0,0 +1,135 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
7
+
8
+ <title>Module: WorkflowToGalaxy</title>
9
+
10
+ <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
13
+ <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
14
+ <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
15
+ <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
16
+
17
+ </head>
18
+ <body id="top" class="module">
19
+
20
+ <div id="metadata">
21
+ <div id="home-metadata">
22
+ <div id="home-section" class="section">
23
+ <h3 class="section-header">
24
+ <a href="./index.html">Home</a>
25
+ <a href="./index.html#classes">Classes</a>
26
+ <a href="./index.html#methods">Methods</a>
27
+ </h3>
28
+ </div>
29
+ </div>
30
+
31
+ <div id="file-metadata">
32
+ <div id="file-list-section" class="section">
33
+ <h3 class="section-header">In Files</h3>
34
+ <div class="section-body">
35
+ <ul>
36
+
37
+ <li><a href="./lib/workflow-to-galaxy_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
38
+ class="thickbox" title="lib/workflow-to-galaxy.rb">lib/workflow-to-galaxy.rb</a></li>
39
+
40
+ </ul>
41
+ </div>
42
+ </div>
43
+
44
+
45
+ </div>
46
+
47
+ <div id="class-metadata">
48
+
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+ </div>
58
+
59
+ <div id="project-metadata">
60
+
61
+
62
+ <div id="fileindex-section" class="section project-section">
63
+ <h3 class="section-header">Files</h3>
64
+ <ul>
65
+
66
+ <li class="file"><a href="./CHANGES.html">CHANGES</a></li>
67
+
68
+ <li class="file"><a href="./LICENSE.html">LICENSE</a></li>
69
+
70
+ <li class="file"><a href="./README.html">README</a></li>
71
+
72
+ </ul>
73
+ </div>
74
+
75
+
76
+ <div id="classindex-section" class="section project-section">
77
+ <h3 class="section-header">Class/Module Index
78
+ <span class="search-toggle"><img src="./images/find.png"
79
+ height="16" width="16" alt="[+]"
80
+ title="show/hide quicksearch" /></span></h3>
81
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
82
+ <fieldset>
83
+ <legend>Quicksearch</legend>
84
+ <input type="text" name="quicksearch" value=""
85
+ class="quicksearch-field" />
86
+ </fieldset>
87
+ </form>
88
+
89
+ <ul class="link-list">
90
+
91
+ <li><a href="./Generator.html">Generator</a></li>
92
+
93
+ <li><a href="./WorkflowToGalaxy.html">WorkflowToGalaxy</a></li>
94
+
95
+ </ul>
96
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
97
+ </div>
98
+
99
+
100
+ </div>
101
+ </div>
102
+
103
+ <div id="documentation">
104
+ <h1 class="module">WorkflowToGalaxy</h1>
105
+
106
+ <div id="description" class="description">
107
+
108
+ </div><!-- description -->
109
+
110
+
111
+ <div id="5Buntitled-5D" class="documentation-section">
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+ <!-- Methods -->
121
+
122
+ </div><!-- 5Buntitled-5D -->
123
+
124
+
125
+ </div><!-- documentation -->
126
+
127
+ <div id="validator-badges">
128
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
129
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
130
+ Rdoc Generator</a> 2</small>.</p>
131
+ </div>
132
+
133
+ </body>
134
+ </html>
135
+
data/doc/rdoc/created.rid CHANGED
@@ -1 +1,6 @@
1
- Thu, 21 Jul 2011 18:53:50 +0200
1
+ Fri, 22 Jul 2011 15:00:07 +0200
2
+ lib/workflow-to-galaxy.rb Mon, 13 Dec 2010 15:22:40 +0100
3
+ LICENSE Wed, 06 Apr 2011 16:41:53 +0200
4
+ README Fri, 22 Jul 2011 14:51:41 +0200
5
+ CHANGES Fri, 22 Jul 2011 14:46:31 +0200
6
+ lib/workflow-to-galaxy/generator.rb Mon, 04 Jul 2011 16:13:08 +0200
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
data/doc/rdoc/index.html CHANGED
@@ -1,24 +1,144 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
5
4
 
6
- <!--
7
-
8
- workflow-to-galaxy Docs
9
-
10
- -->
11
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
12
6
  <head>
7
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
8
+
13
9
  <title>workflow-to-galaxy Docs</title>
14
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+
11
+ <link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="js/jquery.js" type="text/javascript" charset="utf-8"></script>
14
+ <script src="js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
15
+ <script src="js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
16
+ <script src="js/darkfish.js" type="text/javascript" charset="utf-8"></script>
17
+
15
18
  </head>
16
- <frameset rows="20%, 80%">
17
- <frameset cols="25%,35%,45%">
18
- <frame src="fr_file_index.html" title="Files" name="Files" />
19
- <frame src="fr_class_index.html" name="Classes" />
20
- <frame src="fr_method_index.html" name="Methods" />
21
- </frameset>
22
- <frame src="files/README.html" name="docwin" />
23
- </frameset>
24
- </html>
19
+ <body class="indexpage">
20
+
21
+
22
+ <h1>workflow-to-galaxy Docs</h1>
23
+
24
+
25
+ <div id="main">
26
+
27
+ <table class="rdoc-list"><tr><td class="rdoc-term"><p>Authors</p></td>
28
+ <td>
29
+ <p>Konstantinos Karasavvas</p>
30
+ </td></tr><tr><td class="rdoc-term"><p>Gem Version</p></td>
31
+ <td>
32
+ <p>0.2.8</p>
33
+ </td></tr><tr><td class="rdoc-term"><p>Contact</p></td>
34
+ <td>
35
+ <p><a href="mailto:kostas.karasavvas@nbic.nl">kostas.karasavvas@nbic.nl</a></p>
36
+ </td></tr><tr><td class="rdoc-term"><p>Licence</p></td>
37
+ <td>
38
+ <p>MIT (See LICENCE or <a
39
+ href="http://www.opensource.org/licenses/mit-license">www.opensource.org/licenses/mit-license</a>)</p>
40
+ </td></tr><tr><td class="rdoc-term"><p>Copyright</p></td>
41
+ <td>
42
+ <p>© 2010 Netherlands Bioinformatics Centre, The Netherlands</p>
43
+ </td></tr></table>
44
+
45
+ <h2>Synopsis</h2>
46
+
47
+ <p>This script requires a Taverna2 workflow URL as input and generates a
48
+ Galaxy tool (a UI XML definition plus a script) that will enable the
49
+ execution of this workflow through Galaxy. The tool’s description is as
50
+ good as the description provided in the workflow itself. Currently, the
51
+ myExperiment workflow repository is used to access workflow information via
52
+ its REST API but a workflow description from a file is also supported.</p>
53
+
54
+ <p>The name is workflow-to-galaxy rather than t2-workflow-to-galaxy because it
55
+ is possible that it will support other workflow management systems in the
56
+ future.</p>
57
+
58
+ <h2>Installation</h2>
59
+
60
+ <pre>[sudo] gem install workflow-to-galaxy</pre>
61
+
62
+ <h2>Usage</h2>
63
+
64
+ <p>workflow_to_galaxy [options] &lt;myExperiement-workflow&gt; |
65
+ &lt;t2flow-file&gt;</p>
66
+
67
+ <p>Generates a Galaxy tool (a UI xml definition plus a script) for the
68
+ specified Taverna2 workflow, where &lt;myExperiment-workflow&gt; is the
69
+ full URL of the workflow in the myExperiment website. Alternatively a
70
+ t2flow file can be passed for workflows not in myExperiment. Available
71
+ options are:</p>
72
+
73
+ <pre>-o OUTPUT, --output=OUTPUT The file name(s) of the generated tool. If it is not specified then the workflow's name will be used.
74
+
75
+ -s SERVER, --server=SERVER The taverna server that the script will request execution from. If it is not specified then &quot;http://localhost:8980/taverna-server&quot; will be used.
76
+
77
+ -t, --t2flow The workflow is a t2flow file.</pre>
78
+
79
+ <h2>Example</h2>
80
+
81
+ <p>Let’s say we want to install the taverna2 workflow <a
82
+ href="http://www.myexperiment.org/workflows/74.html">www.myexperiment.org/workflows/74.html</a>
83
+ from myExperiment repository:</p>
84
+
85
+ <pre>$ workflow_to_galaxy -s http://localhost:8980/taverna-server http://www.myexperiment.org/workflows/74/download/bioaid_proteindiscovery_781733.t2flow?version=5</pre>
86
+
87
+ <h2>References</h2>
88
+ <table class="rdoc-list"><tr><td class="rdoc-term"><p>Taverna-Galaxy</p></td>
89
+ <td>
90
+ <p><a
91
+ href="https://trac.nbic.nl/elabfactory/wiki/eGalaxy">trac.nbic.nl/elabfactory/wiki/eGalaxy</a></p>
92
+ </td></tr><tr><td class="rdoc-term"><p>Galaxy</p></td>
93
+ <td>
94
+ <p><a href="http://galaxy.psu.edu">galaxy.psu.edu</a></p>
95
+ </td></tr><tr><td class="rdoc-term"><p>Taverna2</p></td>
96
+ <td>
97
+ <p><a href="http://www.taverna.org.uk">www.taverna.org.uk</a></p>
98
+ </td></tr><tr><td class="rdoc-term"><p>myExperiment</p></td>
99
+ <td>
100
+ <p><a href="http://www.myexperiment.org">www.myexperiment.org</a></p>
101
+ </td></tr></table>
102
+
103
+ </div>
104
+
105
+
106
+
107
+
108
+ <h2>Files</h2>
109
+ <ul>
110
+
111
+ <li class="file"><a href="CHANGES.html">CHANGES</a></li>
112
+
113
+ <li class="file"><a href="LICENSE.html">LICENSE</a></li>
114
+
115
+ <li class="file"><a href="README.html">README</a></li>
116
+
117
+ </ul>
118
+
119
+
120
+ <h2 id="classes">Classes/Modules</h2>
121
+ <ul>
122
+
123
+ <li class="module"><a href="Generator.html">Generator</a></li>
124
+
125
+ <li class="module"><a href="WorkflowToGalaxy.html">WorkflowToGalaxy</a></li>
126
+
127
+ </ul>
128
+
129
+ <h2 id="methods">Methods</h2>
130
+ <ul>
131
+
132
+ <li><a href="Generator.html#method-i-generate_script">#generate_script &mdash; Generator</a></li>
133
+
134
+ <li><a href="Generator.html#method-i-generate_xml">#generate_xml &mdash; Generator</a></li>
135
+
136
+ </ul>
137
+
138
+ <div id="validator-badges">
139
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
140
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
141
+ Rdoc Generator</a> 2</small>.</p>
142
+ </div>
143
+ </body>
144
+ </html>
@@ -0,0 +1,116 @@
1
+ /**
2
+ *
3
+ * Darkfish Page Functions
4
+ * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
5
+ *
6
+ * Author: Michael Granger <mgranger@laika.com>
7
+ *
8
+ */
9
+
10
+ /* Provide console simulation for firebug-less environments */
11
+ if (!("console" in window) || !("firebug" in console)) {
12
+ var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
13
+ "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
14
+
15
+ window.console = {};
16
+ for (var i = 0; i < names.length; ++i)
17
+ window.console[names[i]] = function() {};
18
+ };
19
+
20
+
21
+ /**
22
+ * Unwrap the first element that matches the given @expr@ from the targets and return them.
23
+ */
24
+ $.fn.unwrap = function( expr ) {
25
+ return this.each( function() {
26
+ $(this).parents( expr ).eq( 0 ).after( this ).remove();
27
+ });
28
+ };
29
+
30
+
31
+ function showSource( e ) {
32
+ var target = e.target;
33
+ var codeSections = $(target).
34
+ parents('.method-detail').
35
+ find('.method-source-code');
36
+
37
+ $(target).
38
+ parents('.method-detail').
39
+ find('.method-source-code').
40
+ slideToggle();
41
+ };
42
+
43
+ function hookSourceViews() {
44
+ $('.method-description,.method-heading').click( showSource );
45
+ };
46
+
47
+ function toggleDebuggingSection() {
48
+ $('.debugging-section').slideToggle();
49
+ };
50
+
51
+ function hookDebuggingToggle() {
52
+ $('#debugging-toggle img').click( toggleDebuggingSection );
53
+ };
54
+
55
+ function hookQuickSearch() {
56
+ $('.quicksearch-field').each( function() {
57
+ var searchElems = $(this).parents('.section').find( 'li' );
58
+ var toggle = $(this).parents('.section').find('h3 .search-toggle');
59
+ // console.debug( "Toggle is: %o", toggle );
60
+ var qsbox = $(this).parents('form').get( 0 );
61
+
62
+ $(this).quicksearch( this, searchElems, {
63
+ noSearchResultsIndicator: 'no-class-search-results',
64
+ focusOnLoad: false
65
+ });
66
+ $(toggle).click( function() {
67
+ // console.debug( "Toggling qsbox: %o", qsbox );
68
+ $(qsbox).toggle();
69
+ });
70
+ });
71
+ };
72
+
73
+ function highlightTarget( anchor ) {
74
+ console.debug( "Highlighting target '%s'.", anchor );
75
+
76
+ $("a[name=" + anchor + "]").each( function() {
77
+ if ( !$(this).parent().parent().hasClass('target-section') ) {
78
+ console.debug( "Wrapping the target-section" );
79
+ $('div.method-detail').unwrap( 'div.target-section' );
80
+ $(this).parent().wrap( '<div class="target-section"></div>' );
81
+ } else {
82
+ console.debug( "Already wrapped." );
83
+ }
84
+ });
85
+ };
86
+
87
+ function highlightLocationTarget() {
88
+ console.debug( "Location hash: %s", window.location.hash );
89
+ if ( ! window.location.hash || window.location.hash.length == 0 ) return;
90
+
91
+ var anchor = window.location.hash.substring(1);
92
+ console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" );
93
+
94
+ highlightTarget( anchor );
95
+ };
96
+
97
+ function highlightClickTarget( event ) {
98
+ console.debug( "Highlighting click target for event %o", event.target );
99
+ try {
100
+ var anchor = $(event.target).attr( 'href' ).substring(1);
101
+ console.debug( "Found target anchor: %s", anchor );
102
+ highlightTarget( anchor );
103
+ } catch ( err ) {
104
+ console.error( "Exception while highlighting: %o", err );
105
+ };
106
+ };
107
+
108
+
109
+ $(document).ready( function() {
110
+ hookSourceViews();
111
+ hookDebuggingToggle();
112
+ hookQuickSearch();
113
+ highlightLocationTarget();
114
+
115
+ $('ul.link-list a').bind( "click", highlightClickTarget );
116
+ });