rprompt 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. data/.gitignore +0 -1
  2. data/doc/Rprompt.html +129 -0
  3. data/doc/Rprompt/GitBranch.html +335 -0
  4. data/doc/Rprompt/GitNumbers.html +335 -0
  5. data/doc/Rprompt/GitSha.html +335 -0
  6. data/doc/Rprompt/GitTrack.html +455 -0
  7. data/doc/Rprompt/PromptItem.html +516 -0
  8. data/doc/Rprompt/RvmGemset.html +353 -0
  9. data/doc/Rprompt/RvmRuby.html +345 -0
  10. data/doc/String.html +136 -0
  11. data/doc/_index.html +188 -0
  12. data/doc/class_list.html +54 -0
  13. data/doc/css/common.css +1 -0
  14. data/doc/css/full_list.css +57 -0
  15. data/doc/css/style.css +338 -0
  16. data/doc/file.README.html +168 -0
  17. data/doc/file_list.html +56 -0
  18. data/doc/frames.html +28 -0
  19. data/doc/index.html +168 -0
  20. data/doc/js/app.js +214 -0
  21. data/doc/js/full_list.js +178 -0
  22. data/doc/js/jquery.js +4 -0
  23. data/doc/method_list.html +155 -0
  24. data/doc/top-level-namespace.html +114 -0
  25. data/lib/rprompt/version.rb +1 -1
  26. metadata +24 -1
data/doc/file.README.html ADDED
@@ -0,0 +1,168 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.8.6.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: README</span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
52
+
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame"></iframe>
63
+
64
+ <div id="content"><div id='filecontents'><h1>rprompt</h1>
65
+
66
+ <p>Pimp your prompt :-)</p>
67
+
68
+ <p>This prompt is a shameless port (and enhancement) of the &quot;Informative git prompt for bash and fish&quot; which you can find <a href="https://github.com/magicmonty/bash-git-prompt.git">here</a></p>
69
+
70
+ <p>This gem is targeted toward users who use ruby, rvm and git. It will improve your <code>bash</code> prompt by displaying information about the current git repository or the rvm ruby version and gemset.</p>
71
+
72
+ <h2>Usage</h2>
73
+
74
+ <p>The prompt is customizable via a yaml file that enables you to:</p>
75
+
76
+ <ul>
77
+ <li>choose the options you want to see</li>
78
+ <li>set your standard unix prompt</li>
79
+ <li>set your git prompt</li>
80
+ <li>set your rvm prompt</li>
81
+ <li>change the layout of what goes where</li>
82
+ <li>change the symbols to identify options</li>
83
+ <li>change colors (all colors provided by the term-ansicolor gem)</li>
84
+ </ul>
85
+
86
+ <p>Using the layout is actually very easy: throw the name of the options around, add white spaces, delimiters, etc... Save, hit enter in your shell, done!</p>
87
+
88
+ <h3>Git examples</h3>
89
+
90
+ <p>The prompt may look like the following:</p>
91
+
92
+ <ul>
93
+ <li><code>(master↑3|✚1)</code>: on branch <code>master</code>, ahead of remote by 3 commits, 1 file changed but not staged</li>
94
+ <li><code>(status|●2)</code>: on branch <code>status</code>, 2 files staged</li>
95
+ <li><code>(master|✚7…)</code>: on branch <code>master</code>, 7 files changed, some files untracked</li>
96
+ <li><code>(master|✖2✚3)</code>: on branch <code>master</code>, 2 conflicts, 3 files changed</li>
97
+ <li><code>(experimental↓2↑3|✔)</code>: on branch <code>experimental</code>; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean</li>
98
+ </ul>
99
+
100
+ <p>The symbols are as follows:</p>
101
+
102
+ <ul>
103
+ <li>Local Status Symbols
104
+
105
+ <ul>
106
+ <li><code>✔</code>: repository clean</li>
107
+ <li><code>●n</code>: there are <code>n</code> staged files</li>
108
+ <li><code>✖n</code>: there are <code>n</code> unmerged files</li>
109
+ <li><code>✚n</code>: there are <code>n</code> changed but <em>unstaged</em> files</li>
110
+ <li><code>…n</code>: there are <code>n</code> untracked files</li>
111
+ </ul></li>
112
+ <li>Branch Tracking Symbols
113
+
114
+ <ul>
115
+ <li><code>↑n</code>: ahead of remote by <code>n</code> commits</li>
116
+ <li><code>↓n</code>: behind remote by <code>n</code> commits</li>
117
+ </ul></li>
118
+ </ul>
119
+
120
+ <h3>Rvm examples</h3>
121
+
122
+ <ul>
123
+ <li>∆1.9.3-p448: ruby version 1.9.3</li>
124
+ <li>›global: using the global gemset</li>
125
+ </ul>
126
+
127
+ <h2>Installation</h2>
128
+
129
+ <pre class="code ruby"><code class="ruby">$ gem install rprompt
130
+ </code></pre>
131
+
132
+ <p>Once the gem is installed,</p>
133
+
134
+ <pre class="code ruby"><code class="ruby">$ rpromptconf
135
+ </code></pre>
136
+
137
+ <p>This will provide a standard config file: <code>$HOME/.rprompt/config.yml</code></p>
138
+
139
+ <p>To make the magic happen:</p>
140
+
141
+ <ul>
142
+ <li>edit your ~/.bashrc or ~/.bash_profile
143
+ (depending on your preferences and setup)</li>
144
+ <li>if you&#39;re setting PS1 already, comment it while you&#39;re using rprompt</li>
145
+ <li><p>paste the following lines between &#39;---&#39; at the end of the file</p>
146
+
147
+ <pre class="code ruby"><code class="ruby">---
148
+ # Setting terminal promt with rprompt gem
149
+ PROMPT_COMMAND=&quot;$PROMPT_COMMAND PS1=\&quot;\$(rprompt)\&quot;;&quot;
150
+ ---
151
+ </code></pre></li>
152
+ <li><p>quit your terminal and re-open it for the change to take effect.</p></li>
153
+ </ul>
154
+
155
+ <p>Edit $HOME/.rprompt/config.yml to change the configuration.
156
+ (you can always re-install the default configuration by issuing &#39;rpromptconf&#39;)</p>
157
+
158
+ <p>Enjoy :))</p>
159
+ </div></div>
160
+
161
+ <div id="footer">
162
+ Generated on Sat Jul 20 10:38:07 2013 by
163
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
164
+ 0.8.6.2 (ruby-1.9.3).
165
+ </div>
166
+
167
+ </body>
168
+ </html>
data/doc/file_list.html ADDED
@@ -0,0 +1,56 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html>
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <script type="text/javascript" charset="utf-8">
23
+ if (window.top.frames.main) {
24
+ document.getElementById('base_target').target = 'main';
25
+ document.body.className = 'frames';
26
+ }
27
+ </script>
28
+ <div id="content">
29
+ <h1 id="full_list_header">File List</h1>
30
+ <div id="nav">
31
+
32
+ <span><a target="_self" href="class_list.html">
33
+ Classes
34
+ </a></span>
35
+
36
+ <span><a target="_self" href="method_list.html">
37
+ Methods
38
+ </a></span>
39
+
40
+ <span><a target="_self" href="file_list.html">
41
+ Files
42
+ </a></span>
43
+
44
+ </div>
45
+ <div id="search">Search: <input type="text" /></div>
46
+
47
+ <ul id="full_list" class="file">
48
+
49
+
50
+ <li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
51
+
52
+
53
+ </ul>
54
+ </div>
55
+ </body>
56
+ </html>
data/doc/frames.html ADDED
@@ -0,0 +1,28 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
3
+
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7
+ <title>Documentation by YARD 0.8.6.2</title>
8
+ </head>
9
+ <script type="text/javascript" charset="utf-8">
10
+ window.onload = function() {
11
+ var match = window.location.hash.match(/^#!(.+)/);
12
+ var name = 'index.html';
13
+ if (match) {
14
+ name = unescape(match[1]);
15
+ }
16
+ document.writeln('<frameset cols="20%,*">' +
17
+ '<frame name="list" src="class_list.html" />' +
18
+ '<frame name="main" src="' + name + '" />' +
19
+ '</frameset>');
20
+ }
21
+ </script>
22
+ <noscript>
23
+ <frameset cols="20%,*">
24
+ <frame name="list" src="class_list.html" />
25
+ <frame name="main" src="index.html" />
26
+ </frameset>
27
+ </noscript>
28
+ </html>
data/doc/index.html ADDED
@@ -0,0 +1,168 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.8.6.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: README</span>
36
+
37
+
38
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
+ </div>
40
+
41
+ <div id="search">
42
+
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
52
+
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame"></iframe>
63
+
64
+ <div id="content"><div id='filecontents'><h1>rprompt</h1>
65
+
66
+ <p>Pimp your prompt :-)</p>
67
+
68
+ <p>This prompt is a shameless port (and enhancement) of the &quot;Informative git prompt for bash and fish&quot; which you can find <a href="https://github.com/magicmonty/bash-git-prompt.git">here</a></p>
69
+
70
+ <p>This gem is targeted toward users who use ruby, rvm and git. It will improve your <code>bash</code> prompt by displaying information about the current git repository or the rvm ruby version and gemset.</p>
71
+
72
+ <h2>Usage</h2>
73
+
74
+ <p>The prompt is customizable via a yaml file that enables you to:</p>
75
+
76
+ <ul>
77
+ <li>choose the options you want to see</li>
78
+ <li>set your standard unix prompt</li>
79
+ <li>set your git prompt</li>
80
+ <li>set your rvm prompt</li>
81
+ <li>change the layout of what goes where</li>
82
+ <li>change the symbols to identify options</li>
83
+ <li>change colors (all colors provided by the term-ansicolor gem)</li>
84
+ </ul>
85
+
86
+ <p>Using the layout is actually very easy: throw the name of the options around, add white spaces, delimiters, etc... Save, hit enter in your shell, done!</p>
87
+
88
+ <h3>Git examples</h3>
89
+
90
+ <p>The prompt may look like the following:</p>
91
+
92
+ <ul>
93
+ <li><code>(master↑3|✚1)</code>: on branch <code>master</code>, ahead of remote by 3 commits, 1 file changed but not staged</li>
94
+ <li><code>(status|●2)</code>: on branch <code>status</code>, 2 files staged</li>
95
+ <li><code>(master|✚7…)</code>: on branch <code>master</code>, 7 files changed, some files untracked</li>
96
+ <li><code>(master|✖2✚3)</code>: on branch <code>master</code>, 2 conflicts, 3 files changed</li>
97
+ <li><code>(experimental↓2↑3|✔)</code>: on branch <code>experimental</code>; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean</li>
98
+ </ul>
99
+
100
+ <p>The symbols are as follows:</p>
101
+
102
+ <ul>
103
+ <li>Local Status Symbols
104
+
105
+ <ul>
106
+ <li><code>✔</code>: repository clean</li>
107
+ <li><code>●n</code>: there are <code>n</code> staged files</li>
108
+ <li><code>✖n</code>: there are <code>n</code> unmerged files</li>
109
+ <li><code>✚n</code>: there are <code>n</code> changed but <em>unstaged</em> files</li>
110
+ <li><code>…n</code>: there are <code>n</code> untracked files</li>
111
+ </ul></li>
112
+ <li>Branch Tracking Symbols
113
+
114
+ <ul>
115
+ <li><code>↑n</code>: ahead of remote by <code>n</code> commits</li>
116
+ <li><code>↓n</code>: behind remote by <code>n</code> commits</li>
117
+ </ul></li>
118
+ </ul>
119
+
120
+ <h3>Rvm examples</h3>
121
+
122
+ <ul>
123
+ <li>∆1.9.3-p448: ruby version 1.9.3</li>
124
+ <li>›global: using the global gemset</li>
125
+ </ul>
126
+
127
+ <h2>Installation</h2>
128
+
129
+ <pre class="code ruby"><code class="ruby">$ gem install rprompt
130
+ </code></pre>
131
+
132
+ <p>Once the gem is installed,</p>
133
+
134
+ <pre class="code ruby"><code class="ruby">$ rpromptconf
135
+ </code></pre>
136
+
137
+ <p>This will provide a standard config file: <code>$HOME/.rprompt/config.yml</code></p>
138
+
139
+ <p>To make the magic happen:</p>
140
+
141
+ <ul>
142
+ <li>edit your ~/.bashrc or ~/.bash_profile
143
+ (depending on your preferences and setup)</li>
144
+ <li>if you&#39;re setting PS1 already, comment it while you&#39;re using rprompt</li>
145
+ <li><p>paste the following lines between &#39;---&#39; at the end of the file</p>
146
+
147
+ <pre class="code ruby"><code class="ruby">---
148
+ # Setting terminal promt with rprompt gem
149
+ PROMPT_COMMAND=&quot;$PROMPT_COMMAND PS1=\&quot;\$(rprompt)\&quot;;&quot;
150
+ ---
151
+ </code></pre></li>
152
+ <li><p>quit your terminal and re-open it for the change to take effect.</p></li>
153
+ </ul>
154
+
155
+ <p>Edit $HOME/.rprompt/config.yml to change the configuration.
156
+ (you can always re-install the default configuration by issuing &#39;rpromptconf&#39;)</p>
157
+
158
+ <p>Enjoy :))</p>
159
+ </div></div>
160
+
161
+ <div id="footer">
162
+ Generated on Sat Jul 20 10:38:07 2013 by
163
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
164
+ 0.8.6.2 (ruby-1.9.3).
165
+ </div>
166
+
167
+ </body>
168
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,214 @@
1
+ function createSourceLinks() {
2
+ $('.method_details_list .source_code').
3
+ before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
4
+ $('.toggleSource').toggle(function() {
5
+ $(this).parent().nextAll('.source_code').slideDown(100);
6
+ $(this).text("Hide source");
7
+ },
8
+ function() {
9
+ $(this).parent().nextAll('.source_code').slideUp(100);
10
+ $(this).text("View source");
11
+ });
12
+ }
13
+
14
+ function createDefineLinks() {
15
+ var tHeight = 0;
16
+ $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
17
+ $('.toggleDefines').toggle(function() {
18
+ tHeight = $(this).parent().prev().height();
19
+ $(this).prev().show();
20
+ $(this).parent().prev().height($(this).parent().height());
21
+ $(this).text("(less)");
22
+ },
23
+ function() {
24
+ $(this).prev().hide();
25
+ $(this).parent().prev().height(tHeight);
26
+ $(this).text("more...");
27
+ });
28
+ }
29
+
30
+ function createFullTreeLinks() {
31
+ var tHeight = 0;
32
+ $('.inheritanceTree').toggle(function() {
33
+ tHeight = $(this).parent().prev().height();
34
+ $(this).parent().toggleClass('showAll');
35
+ $(this).text("(hide)");
36
+ $(this).parent().prev().height($(this).parent().height());
37
+ },
38
+ function() {
39
+ $(this).parent().toggleClass('showAll');
40
+ $(this).parent().prev().height(tHeight);
41
+ $(this).text("show all");
42
+ });
43
+ }
44
+
45
+ function fixBoxInfoHeights() {
46
+ $('dl.box dd.r1, dl.box dd.r2').each(function() {
47
+ $(this).prev().height($(this).height());
48
+ });
49
+ }
50
+
51
+ function searchFrameLinks() {
52
+ $('.full_list_link').click(function() {
53
+ toggleSearchFrame(this, $(this).attr('href'));
54
+ return false;
55
+ });
56
+ }
57
+
58
+ function toggleSearchFrame(id, link) {
59
+ var frame = $('#search_frame');
60
+ $('#search a').removeClass('active').addClass('inactive');
61
+ if (frame.attr('src') == link && frame.css('display') != "none") {
62
+ frame.slideUp(100);
63
+ $('#search a').removeClass('active inactive');
64
+ }
65
+ else {
66
+ $(id).addClass('active').removeClass('inactive');
67
+ frame.attr('src', link).slideDown(100);
68
+ }
69
+ }
70
+
71
+ function linkSummaries() {
72
+ $('.summary_signature').click(function() {
73
+ document.location = $(this).find('a').attr('href');
74
+ });
75
+ }
76
+
77
+ function framesInit() {
78
+ if (hasFrames) {
79
+ document.body.className = 'frames';
80
+ $('#menu .noframes a').attr('href', document.location);
81
+ window.top.document.title = $('html head title').text();
82
+ }
83
+ else {
84
+ $('#menu .noframes a').text('frames').attr('href', framesUrl);
85
+ }
86
+ }
87
+
88
+ function keyboardShortcuts() {
89
+ if (window.top.frames.main) return;
90
+ $(document).keypress(function(evt) {
91
+ if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
92
+ if (typeof evt.target !== "undefined" &&
93
+ (evt.target.nodeName == "INPUT" ||
94
+ evt.target.nodeName == "TEXTAREA")) return;
95
+ switch (evt.charCode) {
96
+ case 67: case 99: $('#class_list_link').click(); break; // 'c'
97
+ case 77: case 109: $('#method_list_link').click(); break; // 'm'
98
+ case 70: case 102: $('#file_list_link').click(); break; // 'f'
99
+ default: break;
100
+ }
101
+ });
102
+ }
103
+
104
+ function summaryToggle() {
105
+ $('.summary_toggle').click(function() {
106
+ if (localStorage) {
107
+ localStorage.summaryCollapsed = $(this).text();
108
+ }
109
+ $('.summary_toggle').each(function() {
110
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
111
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
112
+ if (next.hasClass('compact')) {
113
+ next.toggle();
114
+ next.nextAll('ul.summary').first().toggle();
115
+ }
116
+ else if (next.hasClass('summary')) {
117
+ var list = $('<ul class="summary compact" />');
118
+ list.html(next.html());
119
+ list.find('.summary_desc, .note').remove();
120
+ list.find('a').each(function() {
121
+ $(this).html($(this).find('strong').html());
122
+ $(this).parent().html($(this)[0].outerHTML);
123
+ });
124
+ next.before(list);
125
+ next.toggle();
126
+ }
127
+ });
128
+ return false;
129
+ });
130
+ if (localStorage) {
131
+ if (localStorage.summaryCollapsed == "collapse") {
132
+ $('.summary_toggle').first().click();
133
+ }
134
+ else localStorage.summaryCollapsed = "expand";
135
+ }
136
+ }
137
+
138
+ function fixOutsideWorldLinks() {
139
+ $('a').each(function() {
140
+ if (window.location.host != this.host) this.target = '_parent';
141
+ });
142
+ }
143
+
144
+ function generateTOC() {
145
+ if ($('#filecontents').length === 0) return;
146
+ var _toc = $('<ol class="top"></ol>');
147
+ var show = false;
148
+ var toc = _toc;
149
+ var counter = 0;
150
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
151
+ var i;
152
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
153
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
154
+ var lastTag = parseInt(tags[0][1], 10);
155
+ $(tags.join(', ')).each(function() {
156
+ if ($(this).parents('.method_details .docstring').length != 0) return;
157
+ if (this.id == "filecontents") return;
158
+ show = true;
159
+ var thisTag = parseInt(this.tagName[1], 10);
160
+ if (this.id.length === 0) {
161
+ var proposedId = $(this).attr('toc-id');
162
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
163
+ else {
164
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
165
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
166
+ this.id = proposedId;
167
+ }
168
+ }
169
+ if (thisTag > lastTag) {
170
+ for (i = 0; i < thisTag - lastTag; i++) {
171
+ var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
172
+ }
173
+ }
174
+ if (thisTag < lastTag) {
175
+ for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
176
+ }
177
+ var title = $(this).attr('toc-title');
178
+ if (typeof(title) == "undefined") title = $(this).text();
179
+ toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
180
+ lastTag = thisTag;
181
+ });
182
+ if (!show) return;
183
+ html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
184
+ $('#content').prepend(html);
185
+ $('#toc').append(_toc);
186
+ $('#toc .hide_toc').toggle(function() {
187
+ $('#toc .top').slideUp('fast');
188
+ $('#toc').toggleClass('hidden');
189
+ $('#toc .title small').toggle();
190
+ }, function() {
191
+ $('#toc .top').slideDown('fast');
192
+ $('#toc').toggleClass('hidden');
193
+ $('#toc .title small').toggle();
194
+ });
195
+ $('#toc .float_toc').toggle(function() {
196
+ $(this).text('float');
197
+ $('#toc').toggleClass('nofloat');
198
+ }, function() {
199
+ $(this).text('left');
200
+ $('#toc').toggleClass('nofloat');
201
+ });
202
+ }
203
+
204
+ $(framesInit);
205
+ $(createSourceLinks);
206
+ $(createDefineLinks);
207
+ $(createFullTreeLinks);
208
+ $(fixBoxInfoHeights);
209
+ $(searchFrameLinks);
210
+ $(linkSummaries);
211
+ $(keyboardShortcuts);
212
+ $(summaryToggle);
213
+ $(fixOutsideWorldLinks);
214
+ $(generateTOC);