emerald 0.0.1.alpha3 → 0.0.1.alpha4

Sign up to get free protection for your applications and to get access to all the features.
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.0.1-alpha3
1
+ 0.0.1-alpha4
@@ -50,3 +50,15 @@ function generate_toc(heading){
50
50
 
51
51
  return list;
52
52
  }
53
+
54
+ /**
55
+ * Event handler for the resize event on the browser window,
56
+ * also called when the site loads (see the <script> tag at
57
+ * the bottom of the layout template file). It adjusts the
58
+ * height of the sidebar to the correct proportions instead
59
+ * of its default wild guess of 95% percent of the browser
60
+ * height.
61
+ */
62
+ function handle_resize(){
63
+ $("#sidebar").height($(window).height() - 8); /* 4px top margin, 4px bottom margin */
64
+ }
@@ -197,13 +197,22 @@ div.private-instance {
197
197
 
198
198
  /********** Indices **********/
199
199
  div.index {
200
- overflow: hidden; }
200
+ height: 33%; }
201
+ div.index div.list {
202
+ height: 80%;
203
+ overflow-x: hidden;
204
+ overflow-y: auto; }
201
205
  div.index ul {
202
206
  list-style-type: none;
203
- padding-left: 0px; }
207
+ padding-left: 0px;
208
+ margin: 4px 0px 0px 0px; }
204
209
  div.index ul li {
205
210
  font-size: small; }
206
211
  div.index div.header {
212
+ display: table;
213
+ /* Needed for vertically centering the text in it, see <p> style below */
214
+ width: 100%;
215
+ height: 20%;
207
216
  border: 1px solid #0E3062;
208
217
  background-color: #336699;
209
218
  color: white;
@@ -211,7 +220,9 @@ div.index {
211
220
  font-size: 1.5em;
212
221
  font-variant: small-caps; }
213
222
  div.index div.header p {
214
- margin: 0px; }
223
+ margin: 0px;
224
+ display: table-cell;
225
+ vertical-align: middle; }
215
226
 
216
227
  span.method-classname {
217
228
  color: gray; }
@@ -324,16 +335,32 @@ pre.ruby span.ruby-comment {
324
335
  /****************************************
325
336
  * Unique elements
326
337
  ****************************************/
327
- div#indices {
328
- float: left;
338
+ div#sidebar {
339
+ position: fixed;
340
+ top: 4px;
341
+ left: 4px;
329
342
  width: 19%;
330
- /* Some space */ }
343
+ /* Some space */
344
+ height: 95%;
345
+ /* This is adjusted by JavaScript */
346
+ padding-right: 8px;
347
+ overflow: hidden;
348
+ border-right: 2px dashed gray; }
349
+ div#sidebar form#search {
350
+ height: 5%; }
351
+ div#sidebar form#search p {
352
+ margin: 0px 0px 2px 0px; }
353
+ div#sidebar form#search p input {
354
+ width: 100%; }
355
+ div#sidebar div#indices {
356
+ height: 95%; }
331
357
 
332
358
  div#content {
333
- float: right;
334
- width: 79%;
359
+ position: absolute;
360
+ top: 4px;
361
+ right: 4px;
362
+ width: 78.5%;
335
363
  /* Some space */
336
- border-left: 2px dashed gray;
337
364
  padding-left: 10px; }
338
365
 
339
366
  div#footer {
@@ -4,61 +4,69 @@
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
5
5
  <link rel="stylesheet" type="text/css" href="<%= root_path + 'stylesheets' + 'rdoc.css' %>"/>
6
6
  <script src="<%= root_path + 'javascripts' + 'jquery.js' %>"></script>
7
+ <script src="<%= root_path + 'javascripts' + 'functions.js' %>"></script>
7
8
  <script src="<%= root_path + 'javascripts' + 'emerald.js' %>"></script>
8
- <script src="<%= root_path + 'javascripts' + 'toc.js' %>"></script>
9
9
  <title><%= title %></title>
10
10
  </head>
11
11
  <body>
12
- <div id="indices">
12
+ <div id="sidebar">
13
13
  <form id="search">
14
- <p style="margin-top: 0px"><input style="width: 100%" type="text" placeholder="Regexp Search"/></p>
14
+ <p><input type="text" placeholder="Regexp Search"/></p>
15
15
  </form>
16
16
 
17
- <div class="index" id="file-index">
18
- <div class="header">
19
- <p>File Index</p>
17
+ <div id="indices">
18
+ <div class="index" id="file-index">
19
+ <div class="header">
20
+ <p>File Index</p>
21
+ </div>
22
+
23
+ <div class="list">
24
+ <ul>
25
+ <% @toplevels.each do |tl| %>
26
+ <% target = root_path + rdocize_toplevel(tl) %>
27
+ <% if tl.name.end_with?(".rdoc") %>
28
+ <li class="rdoc-file"><a href="<%= target %>"><%= tl.name %></a></li>
29
+ <% else %>
30
+ <%# Usually you don’t want to see the code files %>
31
+ <li class="code-file" style="display: none"><a href="<%= target %>"><%= tl.name %></a></li>
32
+ <% end %>
33
+ <% end %>
34
+ <li><a style="font-style: italic" id="toggle-all-files" href="#">Show all</a></li>
35
+ </ul>
36
+ </div>
20
37
  </div>
21
38
 
22
- <ul>
23
- <% @toplevels.each do |tl| %>
24
- <% target = root_path + rdocize_toplevel(tl) %>
25
- <% if tl.name.end_with?(".rdoc") %>
26
- <li class="rdoc-file"><a href="<%= target %>"><%= tl.name %></a></li>
27
- <% else %>
28
- <%# Usually you don’t want to see the code files %>
29
- <li class="code-file" style="display: none"><a href="<%= target %>"><%= tl.name %></a></li>
30
- <% end %>
31
- <% end %>
32
- <li><a style="font-style: italic" id="toggle-all-files" href="#">Show all</a></li>
33
- </ul>
34
- </div>
39
+ <div class="index" id="class-index">
40
+ <div class="header">
41
+ <p>Class Index</p>
42
+ </div>
35
43
 
36
- <div class="index" id="class-index">
37
- <div class="header">
38
- <p>Class Index</p>
44
+ <div class="list">
45
+ <ul>
46
+ <% @classes_and_modules.each do |classmod| %>
47
+ <li>
48
+ <a href="<%= root_path + rdocize_classmod(classmod) %>"><%= classmod.full_name %></a>
49
+ </li>
50
+ <% end %>
51
+ </ul>
52
+ </div>
39
53
  </div>
40
54
 
41
- <ul>
42
- <% @classes_and_modules.each do |classmod| %>
43
- <li>
44
- <a href="<%= root_path + rdocize_classmod(classmod) %>"><%= classmod.full_name %></a>
45
- </li>
46
- <% end %>
47
- </ul>
48
- </div>
55
+ <div class="index" id="method-index">
56
+ <div class="header">
57
+ <p>Method Index</p>
58
+ </div>
49
59
 
50
- <div class="index" id="method-index">
51
- <div class="header">
52
- <p>Method Index</p>
60
+ <div class="list">
61
+ <ul>
62
+ <% @methods.each do |method| %>
63
+ <li><a href="<%= root_path +
64
+ "#{rdocize_classmod(method.parent)}##{method.aref}"
65
+ %>"><%= method.pretty_name %></a>&nbsp;<span class="method-classname">(<%= method.parent.full_name %>)</span></li>
66
+ <% end %>
67
+ </ul>
68
+ </div>
53
69
  </div>
54
-
55
- <ul>
56
- <% @methods.each do |method| %>
57
- <li><a href="<%= root_path +
58
- "#{rdocize_classmod(method.parent)}##{method.aref}"
59
- %>"><%= method.pretty_name %></a>&nbsp;<span class="method-classname">(<%= method.parent.full_name %>)</span></li>
60
- <% end %>
61
- </ul>
62
70
  </div>
63
71
  </div>
64
72
 
@@ -77,4 +85,12 @@
77
85
 
78
86
  <div class="clear"></div>
79
87
  </body>
88
+
89
+ <!-- Adjust the sidebar’s height according to the browser
90
+ window’s height, both on initial loading and whenever
91
+ the window gets resized. -->
92
+ <script type="text/javascript">
93
+ $(window).resize(handle_resize);
94
+ handle_resize();
95
+ </script>
80
96
  </html>
@@ -3,7 +3,8 @@
3
3
  <%= toplevel.description %>
4
4
 
5
5
  <% if @options.generate_toc %>
6
- <script>
6
+
7
+ <script type="text/javascript">
7
8
  html = "<div class=\"toc\"><p>Contents</p>";
8
9
  html += generate_toc();
9
10
  html += "</div>";
@@ -49,6 +49,48 @@ class RDoc::Generator::Emerald
49
49
  class EmeraldError < StandardError
50
50
  end
51
51
 
52
+ # Minimal RDoc::Toplevel-alike object (i.e. it responds to the
53
+ # two methods required for rendering it, +full_name+ and
54
+ # +description+) that is used to create the index page if
55
+ # none was set. I really recommend to manually set a
56
+ # useful index page!
57
+ DummyStartPage = Struct.new(:full_name, :description) do
58
+ def initialize
59
+ super()
60
+ self.full_name = "Start page"
61
+ self.description =<<-DESC
62
+ <h1>RDoc documentation</h1>
63
+ <p>This is a dummy start page for the RDoc documentation of this project.</p>
64
+ <p>You’re seeing it, because the original author didn’t specify a real start
65
+ page for this project’s documentation, so you may want to contact him and
66
+ make him aware of this.</p>
67
+ <p>If you <em>are</em> the original author, try one or both of the following
68
+ code snippets to make your <strong>README.rdoc</strong> file the start
69
+ page of your documentation:</p>
70
+ <pre>
71
+ # In your gemspec:
72
+ Gem::Specification.new do |spec|
73
+ # ...
74
+ # "-m" sets the start ("main") page. "-t" specifies
75
+ # the title to display in the window title bar.
76
+ spec.rdoc_options << "-m" << "README.rdoc" << "-t" "Docs for YourProject"
77
+ end
78
+
79
+ # In your Rakefile:
80
+ RDoc::Task.new do |rt|
81
+ # ...
82
+ # Sets the start ("main") page and specifies the
83
+ # title to display in the window title bar:
84
+ rt.main = "README.rdoc"
85
+ rt.title = "Docs for YourProject"
86
+ end
87
+ </pre>
88
+ <p>For the time being, use the navigation sidebar to the left
89
+ in order to read this documentation.</p>
90
+ DESC
91
+ end
92
+ end
93
+
52
94
  # Tell RDoc about the new generator
53
95
  RDoc::RDoc.add_generator(self)
54
96
 
@@ -110,8 +152,10 @@ class RDoc::Generator::Emerald
110
152
  evaluate_classes_and_modules
111
153
 
112
154
  unless @options.main_page # If set, #evaluate_toplevels creates the index.html for us
155
+ toplevel = DummyStartPage.new
156
+ root_path "./" # This *is* in the toplevel
113
157
  File.open(@op_dir + "index.html", "w") do |file|
114
- file.write("<!DOCTYPE HTML>\n<html><head><title>RDoc documentation</title></head><body><p>This is the RDoc documentation.</p></body></html>")
158
+ file.write(render(:toplevel, binding))
115
159
  end
116
160
  end
117
161
  end
@@ -0,0 +1,7 @@
1
+ = Changelog
2
+
3
+ Who changed what when?
4
+
5
+ == 0.0.1
6
+
7
+ * Birthday!
@@ -0,0 +1,664 @@
1
+ = Emerald copying conditions
2
+
3
+ == GNU GENERAL PUBLIC LICENSE
4
+ Version 3, 29 June 2007
5
+
6
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
7
+ Everyone is permitted to copy and distribute verbatim copies
8
+ of this license document, but changing it is not allowed.
9
+
10
+ === Preamble
11
+
12
+ The GNU General Public License is a free, copyleft license for
13
+ software and other kinds of works.
14
+
15
+ The licenses for most software and other practical works are designed
16
+ to take away your freedom to share and change the works. By contrast,
17
+ the GNU General Public License is intended to guarantee your freedom to
18
+ share and change all versions of a program--to make sure it remains free
19
+ software for all its users. We, the Free Software Foundation, use the
20
+ GNU General Public License for most of our software; it applies also to
21
+ any other work released this way by its authors. You can apply it to
22
+ your programs, too.
23
+
24
+ When we speak of free software, we are referring to freedom, not
25
+ price. Our General Public Licenses are designed to make sure that you
26
+ have the freedom to distribute copies of free software (and charge for
27
+ them if you wish), that you receive source code or can get it if you
28
+ want it, that you can change the software or use pieces of it in new
29
+ free programs, and that you know you can do these things.
30
+
31
+ To protect your rights, we need to prevent others from denying you
32
+ these rights or asking you to surrender the rights. Therefore, you have
33
+ certain responsibilities if you distribute copies of the software, or if
34
+ you modify it: responsibilities to respect the freedom of others.
35
+
36
+ For example, if you distribute copies of such a program, whether
37
+ gratis or for a fee, you must pass on to the recipients the same
38
+ freedoms that you received. You must make sure that they, too, receive
39
+ or can get the source code. And you must show them these terms so they
40
+ know their rights.
41
+
42
+ Developers that use the GNU GPL protect your rights with two steps:
43
+ (1) assert copyright on the software, and (2) offer you this License
44
+ giving you legal permission to copy, distribute and/or modify it.
45
+
46
+ For the developers' and authors' protection, the GPL clearly explains
47
+ that there is no warranty for this free software. For both users' and
48
+ authors' sake, the GPL requires that modified versions be marked as
49
+ changed, so that their problems will not be attributed erroneously to
50
+ authors of previous versions.
51
+
52
+ Some devices are designed to deny users access to install or run
53
+ modified versions of the software inside them, although the manufacturer
54
+ can do so. This is fundamentally incompatible with the aim of
55
+ protecting users' freedom to change the software. The systematic
56
+ pattern of such abuse occurs in the area of products for individuals to
57
+ use, which is precisely where it is most unacceptable. Therefore, we
58
+ have designed this version of the GPL to prohibit the practice for those
59
+ products. If such problems arise substantially in other domains, we
60
+ stand ready to extend this provision to those domains in future versions
61
+ of the GPL, as needed to protect the freedom of users.
62
+
63
+ Finally, every program is threatened constantly by software patents.
64
+ States should not allow patents to restrict development and use of
65
+ software on general-purpose computers, but in those that do, we wish to
66
+ avoid the special danger that patents applied to a free program could
67
+ make it effectively proprietary. To prevent this, the GPL assures that
68
+ patents cannot be used to render the program non-free.
69
+
70
+ The precise terms and conditions for copying, distribution and
71
+ modification follow.
72
+
73
+ == TERMS AND CONDITIONS
74
+
75
+ === 0. Definitions.
76
+
77
+ "This License" refers to version 3 of the GNU General Public License.
78
+
79
+ "Copyright" also means copyright-like laws that apply to other kinds of
80
+ works, such as semiconductor masks.
81
+
82
+ "The Program" refers to any copyrightable work licensed under this
83
+ License. Each licensee is addressed as "you". "Licensees" and
84
+ "recipients" may be individuals or organizations.
85
+
86
+ To "modify" a work means to copy from or adapt all or part of the work
87
+ in a fashion requiring copyright permission, other than the making of an
88
+ exact copy. The resulting work is called a "modified version" of the
89
+ earlier work or a work "based on" the earlier work.
90
+
91
+ A "covered work" means either the unmodified Program or a work based
92
+ on the Program.
93
+
94
+ To "propagate" a work means to do anything with it that, without
95
+ permission, would make you directly or secondarily liable for
96
+ infringement under applicable copyright law, except executing it on a
97
+ computer or modifying a private copy. Propagation includes copying,
98
+ distribution (with or without modification), making available to the
99
+ public, and in some countries other activities as well.
100
+
101
+ To "convey" a work means any kind of propagation that enables other
102
+ parties to make or receive copies. Mere interaction with a user through
103
+ a computer network, with no transfer of a copy, is not conveying.
104
+
105
+ An interactive user interface displays "Appropriate Legal Notices"
106
+ to the extent that it includes a convenient and prominently visible
107
+ feature that (1) displays an appropriate copyright notice, and (2)
108
+ tells the user that there is no warranty for the work (except to the
109
+ extent that warranties are provided), that licensees may convey the
110
+ work under this License, and how to view a copy of this License. If
111
+ the interface presents a list of user commands or options, such as a
112
+ menu, a prominent item in the list meets this criterion.
113
+
114
+ === 1. Source Code.
115
+
116
+ The "source code" for a work means the preferred form of the work
117
+ for making modifications to it. "Object code" means any non-source
118
+ form of a work.
119
+
120
+ A "Standard Interface" means an interface that either is an official
121
+ standard defined by a recognized standards body, or, in the case of
122
+ interfaces specified for a particular programming language, one that
123
+ is widely used among developers working in that language.
124
+
125
+ The "System Libraries" of an executable work include anything, other
126
+ than the work as a whole, that (a) is included in the normal form of
127
+ packaging a Major Component, but which is not part of that Major
128
+ Component, and (b) serves only to enable use of the work with that
129
+ Major Component, or to implement a Standard Interface for which an
130
+ implementation is available to the public in source code form. A
131
+ "Major Component", in this context, means a major essential component
132
+ (kernel, window system, and so on) of the specific operating system
133
+ (if any) on which the executable work runs, or a compiler used to
134
+ produce the work, or an object code interpreter used to run it.
135
+
136
+ The "Corresponding Source" for a work in object code form means all
137
+ the source code needed to generate, install, and (for an executable
138
+ work) run the object code and to modify the work, including scripts to
139
+ control those activities. However, it does not include the work's
140
+ System Libraries, or general-purpose tools or generally available free
141
+ programs which are used unmodified in performing those activities but
142
+ which are not part of the work. For example, Corresponding Source
143
+ includes interface definition files associated with source files for
144
+ the work, and the source code for shared libraries and dynamically
145
+ linked subprograms that the work is specifically designed to require,
146
+ such as by intimate data communication or control flow between those
147
+ subprograms and other parts of the work.
148
+
149
+ The Corresponding Source need not include anything that users
150
+ can regenerate automatically from other parts of the Corresponding
151
+ Source.
152
+
153
+ The Corresponding Source for a work in source code form is that
154
+ same work.
155
+
156
+ === 2. Basic Permissions.
157
+
158
+ All rights granted under this License are granted for the term of
159
+ copyright on the Program, and are irrevocable provided the stated
160
+ conditions are met. This License explicitly affirms your unlimited
161
+ permission to run the unmodified Program. The output from running a
162
+ covered work is covered by this License only if the output, given its
163
+ content, constitutes a covered work. This License acknowledges your
164
+ rights of fair use or other equivalent, as provided by copyright law.
165
+
166
+ You may make, run and propagate covered works that you do not
167
+ convey, without conditions so long as your license otherwise remains
168
+ in force. You may convey covered works to others for the sole purpose
169
+ of having them make modifications exclusively for you, or provide you
170
+ with facilities for running those works, provided that you comply with
171
+ the terms of this License in conveying all material for which you do
172
+ not control copyright. Those thus making or running the covered works
173
+ for you must do so exclusively on your behalf, under your direction
174
+ and control, on terms that prohibit them from making any copies of
175
+ your copyrighted material outside their relationship with you.
176
+
177
+ Conveying under any other circumstances is permitted solely under
178
+ the conditions stated below. Sublicensing is not allowed; section 10
179
+ makes it unnecessary.
180
+
181
+ === 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
182
+
183
+ No covered work shall be deemed part of an effective technological
184
+ measure under any applicable law fulfilling obligations under article
185
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
186
+ similar laws prohibiting or restricting circumvention of such
187
+ measures.
188
+
189
+ When you convey a covered work, you waive any legal power to forbid
190
+ circumvention of technological measures to the extent such circumvention
191
+ is effected by exercising rights under this License with respect to
192
+ the covered work, and you disclaim any intention to limit operation or
193
+ modification of the work as a means of enforcing, against the work's
194
+ users, your or third parties' legal rights to forbid circumvention of
195
+ technological measures.
196
+
197
+ === 4. Conveying Verbatim Copies.
198
+
199
+ You may convey verbatim copies of the Program's source code as you
200
+ receive it, in any medium, provided that you conspicuously and
201
+ appropriately publish on each copy an appropriate copyright notice;
202
+ keep intact all notices stating that this License and any
203
+ non-permissive terms added in accord with section 7 apply to the code;
204
+ keep intact all notices of the absence of any warranty; and give all
205
+ recipients a copy of this License along with the Program.
206
+
207
+ You may charge any price or no price for each copy that you convey,
208
+ and you may offer support or warranty protection for a fee.
209
+
210
+ === 5. Conveying Modified Source Versions.
211
+
212
+ You may convey a work based on the Program, or the modifications to
213
+ produce it from the Program, in the form of source code under the
214
+ terms of section 4, provided that you also meet all of these conditions:
215
+
216
+ a. The work must carry prominent notices stating that you modified
217
+ it, and giving a relevant date.
218
+ b. The work must carry prominent notices stating that it is
219
+ released under this License and any conditions added under
220
+ section 7. This requirement modifies the requirement in
221
+ section 4 to "keep intact all notices".
222
+ c. You must license the entire work, as a whole, under this
223
+ License to anyone who comes into possession of a copy. This
224
+ License will therefore apply, along with any applicable section 7
225
+ additional terms, to the whole of the work, and all its parts,
226
+ regardless of how they are packaged. This License gives no
227
+ permission to license the work in any other way, but it does not
228
+ invalidate such permission if you have separately received it.
229
+ d. If the work has interactive user interfaces, each must display
230
+ Appropriate Legal Notices; however, if the Program has interactive
231
+ interfaces that do not display Appropriate Legal Notices, your
232
+ work need not make them do so.
233
+
234
+ A compilation of a covered work with other separate and independent
235
+ works, which are not by their nature extensions of the covered work,
236
+ and which are not combined with it such as to form a larger program,
237
+ in or on a volume of a storage or distribution medium, is called an
238
+ "aggregate" if the compilation and its resulting copyright are not
239
+ used to limit the access or legal rights of the compilation's users
240
+ beyond what the individual works permit. Inclusion of a covered work
241
+ in an aggregate does not cause this License to apply to the other
242
+ parts of the aggregate.
243
+
244
+ === 6. Conveying Non-Source Forms.
245
+
246
+ You may convey a covered work in object code form under the terms
247
+ of sections 4 and 5, provided that you also convey the
248
+ machine-readable Corresponding Source under the terms of this License,
249
+ in one of these ways:
250
+
251
+ a. Convey the object code in, or embodied in, a physical product
252
+ (including a physical distribution medium), accompanied by the
253
+ Corresponding Source fixed on a durable physical medium
254
+ customarily used for software interchange.
255
+ b. Convey the object code in, or embodied in, a physical product
256
+ (including a physical distribution medium), accompanied by a
257
+ written offer, valid for at least three years and valid for as
258
+ long as you offer spare parts or customer support for that product
259
+ model, to give anyone who possesses the object code either (1) a
260
+ copy of the Corresponding Source for all the software in the
261
+ product that is covered by this License, on a durable physical
262
+ medium customarily used for software interchange, for a price no
263
+ more than your reasonable cost of physically performing this
264
+ conveying of source, or (2) access to copy the
265
+ Corresponding Source from a network server at no charge.
266
+ c. Convey individual copies of the object code with a copy of the
267
+ written offer to provide the Corresponding Source. This
268
+ alternative is allowed only occasionally and noncommercially, and
269
+ only if you received the object code with such an offer, in accord
270
+ with subsection 6b.
271
+ d. Convey the object code by offering access from a designated
272
+ place (gratis or for a charge), and offer equivalent access to the
273
+ Corresponding Source in the same way through the same place at no
274
+ further charge. You need not require recipients to copy the
275
+ Corresponding Source along with the object code. If the place to
276
+ copy the object code is a network server, the Corresponding Source
277
+ may be on a different server (operated by you or a third party)
278
+ that supports equivalent copying facilities, provided you maintain
279
+ clear directions next to the object code saying where to find the
280
+ Corresponding Source. Regardless of what server hosts the
281
+ Corresponding Source, you remain obligated to ensure that it is
282
+ available for as long as needed to satisfy these requirements.
283
+ e. Convey the object code using peer-to-peer transmission, provided
284
+ you inform other peers where the object code and Corresponding
285
+ Source of the work are being offered to the general public at no
286
+ charge under subsection 6d.
287
+
288
+ A separable portion of the object code, whose source code is excluded
289
+ from the Corresponding Source as a System Library, need not be
290
+ included in conveying the object code work.
291
+
292
+ A "User Product" is either (1) a "consumer product", which means any
293
+ tangible personal property which is normally used for personal, family,
294
+ or household purposes, or (2) anything designed or sold for incorporation
295
+ into a dwelling. In determining whether a product is a consumer product,
296
+ doubtful cases shall be resolved in favor of coverage. For a particular
297
+ product received by a particular user, "normally used" refers to a
298
+ typical or common use of that class of product, regardless of the status
299
+ of the particular user or of the way in which the particular user
300
+ actually uses, or expects or is expected to use, the product. A product
301
+ is a consumer product regardless of whether the product has substantial
302
+ commercial, industrial or non-consumer uses, unless such uses represent
303
+ the only significant mode of use of the product.
304
+
305
+ "Installation Information" for a User Product means any methods,
306
+ procedures, authorization keys, or other information required to install
307
+ and execute modified versions of a covered work in that User Product from
308
+ a modified version of its Corresponding Source. The information must
309
+ suffice to ensure that the continued functioning of the modified object
310
+ code is in no case prevented or interfered with solely because
311
+ modification has been made.
312
+
313
+ If you convey an object code work under this section in, or with, or
314
+ specifically for use in, a User Product, and the conveying occurs as
315
+ part of a transaction in which the right of possession and use of the
316
+ User Product is transferred to the recipient in perpetuity or for a
317
+ fixed term (regardless of how the transaction is characterized), the
318
+ Corresponding Source conveyed under this section must be accompanied
319
+ by the Installation Information. But this requirement does not apply
320
+ if neither you nor any third party retains the ability to install
321
+ modified object code on the User Product (for example, the work has
322
+ been installed in ROM).
323
+
324
+ The requirement to provide Installation Information does not include a
325
+ requirement to continue to provide support service, warranty, or updates
326
+ for a work that has been modified or installed by the recipient, or for
327
+ the User Product in which it has been modified or installed. Access to a
328
+ network may be denied when the modification itself materially and
329
+ adversely affects the operation of the network or violates the rules and
330
+ protocols for communication across the network.
331
+
332
+ Corresponding Source conveyed, and Installation Information provided,
333
+ in accord with this section must be in a format that is publicly
334
+ documented (and with an implementation available to the public in
335
+ source code form), and must require no special password or key for
336
+ unpacking, reading or copying.
337
+
338
+ === 7. Additional Terms.
339
+
340
+ "Additional permissions" are terms that supplement the terms of this
341
+ License by making exceptions from one or more of its conditions.
342
+ Additional permissions that are applicable to the entire Program shall
343
+ be treated as though they were included in this License, to the extent
344
+ that they are valid under applicable law. If additional permissions
345
+ apply only to part of the Program, that part may be used separately
346
+ under those permissions, but the entire Program remains governed by
347
+ this License without regard to the additional permissions.
348
+
349
+ When you convey a copy of a covered work, you may at your option
350
+ remove any additional permissions from that copy, or from any part of
351
+ it. (Additional permissions may be written to require their own
352
+ removal in certain cases when you modify the work.) You may place
353
+ additional permissions on material, added by you to a covered work,
354
+ for which you have or can give appropriate copyright permission.
355
+
356
+ Notwithstanding any other provision of this License, for material you
357
+ add to a covered work, you may (if authorized by the copyright holders of
358
+ that material) supplement the terms of this License with terms:
359
+
360
+ a. Disclaiming warranty or limiting liability differently from the
361
+ terms of sections 15 and 16 of this License; or
362
+ b. Requiring preservation of specified reasonable legal notices or
363
+ author attributions in that material or in the Appropriate Legal
364
+ Notices displayed by works containing it; or
365
+ c. Prohibiting misrepresentation of the origin of that material, or
366
+ requiring that modified versions of such material be marked in
367
+ reasonable ways as different from the original version; or
368
+ d. Limiting the use for publicity purposes of names of licensors or
369
+ authors of the material; or
370
+ e. Declining to grant rights under trademark law for use of some
371
+ trade names, trademarks, or service marks; or
372
+ f. Requiring indemnification of licensors and authors of that
373
+ material by anyone who conveys the material (or modified versions of
374
+ it) with contractual assumptions of liability to the recipient, for
375
+ any liability that these contractual assumptions directly impose on
376
+ those licensors and authors.
377
+
378
+ All other non-permissive additional terms are considered "further
379
+ restrictions" within the meaning of section 10. If the Program as you
380
+ received it, or any part of it, contains a notice stating that it is
381
+ governed by this License along with a term that is a further
382
+ restriction, you may remove that term. If a license document contains
383
+ a further restriction but permits relicensing or conveying under this
384
+ License, you may add to a covered work material governed by the terms
385
+ of that license document, provided that the further restriction does
386
+ not survive such relicensing or conveying.
387
+
388
+ If you add terms to a covered work in accord with this section, you
389
+ must place, in the relevant source files, a statement of the
390
+ additional terms that apply to those files, or a notice indicating
391
+ where to find the applicable terms.
392
+
393
+ Additional terms, permissive or non-permissive, may be stated in the
394
+ form of a separately written license, or stated as exceptions;
395
+ the above requirements apply either way.
396
+
397
+ === 8. Termination.
398
+
399
+ You may not propagate or modify a covered work except as expressly
400
+ provided under this License. Any attempt otherwise to propagate or
401
+ modify it is void, and will automatically terminate your rights under
402
+ this License (including any patent licenses granted under the third
403
+ paragraph of section 11).
404
+
405
+ However, if you cease all violation of this License, then your
406
+ license from a particular copyright holder is reinstated (a)
407
+ provisionally, unless and until the copyright holder explicitly and
408
+ finally terminates your license, and (b) permanently, if the copyright
409
+ holder fails to notify you of the violation by some reasonable means
410
+ prior to 60 days after the cessation.
411
+
412
+ Moreover, your license from a particular copyright holder is
413
+ reinstated permanently if the copyright holder notifies you of the
414
+ violation by some reasonable means, this is the first time you have
415
+ received notice of violation of this License (for any work) from that
416
+ copyright holder, and you cure the violation prior to 30 days after
417
+ your receipt of the notice.
418
+
419
+ Termination of your rights under this section does not terminate the
420
+ licenses of parties who have received copies or rights from you under
421
+ this License. If your rights have been terminated and not permanently
422
+ reinstated, you do not qualify to receive new licenses for the same
423
+ material under section 10.
424
+
425
+ === 9. Acceptance Not Required for Having Copies.
426
+
427
+ You are not required to accept this License in order to receive or
428
+ run a copy of the Program. Ancillary propagation of a covered work
429
+ occurring solely as a consequence of using peer-to-peer transmission
430
+ to receive a copy likewise does not require acceptance. However,
431
+ nothing other than this License grants you permission to propagate or
432
+ modify any covered work. These actions infringe copyright if you do
433
+ not accept this License. Therefore, by modifying or propagating a
434
+ covered work, you indicate your acceptance of this License to do so.
435
+
436
+ === 10. Automatic Licensing of Downstream Recipients.
437
+
438
+ Each time you convey a covered work, the recipient automatically
439
+ receives a license from the original licensors, to run, modify and
440
+ propagate that work, subject to this License. You are not responsible
441
+ for enforcing compliance by third parties with this License.
442
+
443
+ An "entity transaction" is a transaction transferring control of an
444
+ organization, or substantially all assets of one, or subdividing an
445
+ organization, or merging organizations. If propagation of a covered
446
+ work results from an entity transaction, each party to that
447
+ transaction who receives a copy of the work also receives whatever
448
+ licenses to the work the party's predecessor in interest had or could
449
+ give under the previous paragraph, plus a right to possession of the
450
+ Corresponding Source of the work from the predecessor in interest, if
451
+ the predecessor has it or can get it with reasonable efforts.
452
+
453
+ You may not impose any further restrictions on the exercise of the
454
+ rights granted or affirmed under this License. For example, you may
455
+ not impose a license fee, royalty, or other charge for exercise of
456
+ rights granted under this License, and you may not initiate litigation
457
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
458
+ any patent claim is infringed by making, using, selling, offering for
459
+ sale, or importing the Program or any portion of it.
460
+
461
+ === 11. Patents.
462
+
463
+ A "contributor" is a copyright holder who authorizes use under this
464
+ License of the Program or a work on which the Program is based. The
465
+ work thus licensed is called the contributor's "contributor version".
466
+
467
+ A contributor's "essential patent claims" are all patent claims
468
+ owned or controlled by the contributor, whether already acquired or
469
+ hereafter acquired, that would be infringed by some manner, permitted
470
+ by this License, of making, using, or selling its contributor version,
471
+ but do not include claims that would be infringed only as a
472
+ consequence of further modification of the contributor version. For
473
+ purposes of this definition, "control" includes the right to grant
474
+ patent sublicenses in a manner consistent with the requirements of
475
+ this License.
476
+
477
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
478
+ patent license under the contributor's essential patent claims, to
479
+ make, use, sell, offer for sale, import and otherwise run, modify and
480
+ propagate the contents of its contributor version.
481
+
482
+ In the following three paragraphs, a "patent license" is any express
483
+ agreement or commitment, however denominated, not to enforce a patent
484
+ (such as an express permission to practice a patent or covenant not to
485
+ sue for patent infringement). To "grant" such a patent license to a
486
+ party means to make such an agreement or commitment not to enforce a
487
+ patent against the party.
488
+
489
+ If you convey a covered work, knowingly relying on a patent license,
490
+ and the Corresponding Source of the work is not available for anyone
491
+ to copy, free of charge and under the terms of this License, through a
492
+ publicly available network server or other readily accessible means,
493
+ then you must either (1) cause the Corresponding Source to be so
494
+ available, or (2) arrange to deprive yourself of the benefit of the
495
+ patent license for this particular work, or (3) arrange, in a manner
496
+ consistent with the requirements of this License, to extend the patent
497
+ license to downstream recipients. "Knowingly relying" means you have
498
+ actual knowledge that, but for the patent license, your conveying the
499
+ covered work in a country, or your recipient's use of the covered work
500
+ in a country, would infringe one or more identifiable patents in that
501
+ country that you have reason to believe are valid.
502
+
503
+ If, pursuant to or in connection with a single transaction or
504
+ arrangement, you convey, or propagate by procuring conveyance of, a
505
+ covered work, and grant a patent license to some of the parties
506
+ receiving the covered work authorizing them to use, propagate, modify
507
+ or convey a specific copy of the covered work, then the patent license
508
+ you grant is automatically extended to all recipients of the covered
509
+ work and works based on it.
510
+
511
+ A patent license is "discriminatory" if it does not include within
512
+ the scope of its coverage, prohibits the exercise of, or is
513
+ conditioned on the non-exercise of one or more of the rights that are
514
+ specifically granted under this License. You may not convey a covered
515
+ work if you are a party to an arrangement with a third party that is
516
+ in the business of distributing software, under which you make payment
517
+ to the third party based on the extent of your activity of conveying
518
+ the work, and under which the third party grants, to any of the
519
+ parties who would receive the covered work from you, a discriminatory
520
+ patent license (a) in connection with copies of the covered work
521
+ conveyed by you (or copies made from those copies), or (b) primarily
522
+ for and in connection with specific products or compilations that
523
+ contain the covered work, unless you entered into that arrangement,
524
+ or that patent license was granted, prior to 28 March 2007.
525
+
526
+ Nothing in this License shall be construed as excluding or limiting
527
+ any implied license or other defenses to infringement that may
528
+ otherwise be available to you under applicable patent law.
529
+
530
+ === 12. No Surrender of Others' Freedom.
531
+
532
+ If conditions are imposed on you (whether by court order, agreement or
533
+ otherwise) that contradict the conditions of this License, they do not
534
+ excuse you from the conditions of this License. If you cannot convey a
535
+ covered work so as to satisfy simultaneously your obligations under this
536
+ License and any other pertinent obligations, then as a consequence you may
537
+ not convey it at all. For example, if you agree to terms that obligate you
538
+ to collect a royalty for further conveying from those to whom you convey
539
+ the Program, the only way you could satisfy both those terms and this
540
+ License would be to refrain entirely from conveying the Program.
541
+
542
+ === 13. Use with the GNU Affero General Public License.
543
+
544
+ Notwithstanding any other provision of this License, you have
545
+ permission to link or combine any covered work with a work licensed
546
+ under version 3 of the GNU Affero General Public License into a single
547
+ combined work, and to convey the resulting work. The terms of this
548
+ License will continue to apply to the part which is the covered work,
549
+ but the special requirements of the GNU Affero General Public License,
550
+ section 13, concerning interaction through a network will apply to the
551
+ combination as such.
552
+
553
+ === 14. Revised Versions of this License.
554
+
555
+ The Free Software Foundation may publish revised and/or new versions of
556
+ the GNU General Public License from time to time. Such new versions will
557
+ be similar in spirit to the present version, but may differ in detail to
558
+ address new problems or concerns.
559
+
560
+ Each version is given a distinguishing version number. If the
561
+ Program specifies that a certain numbered version of the GNU General
562
+ Public License "or any later version" applies to it, you have the
563
+ option of following the terms and conditions either of that numbered
564
+ version or of any later version published by the Free Software
565
+ Foundation. If the Program does not specify a version number of the
566
+ GNU General Public License, you may choose any version ever published
567
+ by the Free Software Foundation.
568
+
569
+ If the Program specifies that a proxy can decide which future
570
+ versions of the GNU General Public License can be used, that proxy's
571
+ public statement of acceptance of a version permanently authorizes you
572
+ to choose that version for the Program.
573
+
574
+ Later license versions may give you additional or different
575
+ permissions. However, no additional obligations are imposed on any
576
+ author or copyright holder as a result of your choosing to follow a
577
+ later version.
578
+
579
+ === 15. Disclaimer of Warranty.
580
+
581
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
582
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
583
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
584
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
585
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
586
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
587
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
588
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
589
+
590
+ === 16. Limitation of Liability.
591
+
592
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
593
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
594
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
595
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
596
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
597
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
598
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
599
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
600
+ SUCH DAMAGES.
601
+
602
+ === 17. Interpretation of Sections 15 and 16.
603
+
604
+ If the disclaimer of warranty and limitation of liability provided
605
+ above cannot be given local legal effect according to their terms,
606
+ reviewing courts shall apply local law that most closely approximates
607
+ an absolute waiver of all civil liability in connection with the
608
+ Program, unless a warranty or assumption of liability accompanies a
609
+ copy of the Program in return for a fee.
610
+
611
+ == END OF TERMS AND CONDITIONS
612
+
613
+ === How to Apply These Terms to Your New Programs
614
+
615
+ If you develop a new program, and you want it to be of the greatest
616
+ possible use to the public, the best way to achieve this is to make it
617
+ free software which everyone can redistribute and change under these terms.
618
+
619
+ To do so, attach the following notices to the program. It is safest
620
+ to attach them to the start of each source file to most effectively
621
+ state the exclusion of warranty; and each file should have at least
622
+ the "copyright" line and a pointer to where the full notice is found.
623
+
624
+ <one line to give the program's name and a brief idea of what it does.>
625
+ Copyright (C) <year> <name of author>
626
+
627
+ This program is free software: you can redistribute it and/or modify
628
+ it under the terms of the GNU General Public License as published by
629
+ the Free Software Foundation, either version 3 of the License, or
630
+ (at your option) any later version.
631
+
632
+ This program is distributed in the hope that it will be useful,
633
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
634
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
635
+ GNU General Public License for more details.
636
+
637
+ You should have received a copy of the GNU General Public License
638
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
639
+
640
+ Also add information on how to contact you by electronic and paper mail.
641
+
642
+ If the program does terminal interaction, make it output a short
643
+ notice like this when it starts in an interactive mode:
644
+
645
+ <program> Copyright (C) <year> <name of author>
646
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
647
+ This is free software, and you are welcome to redistribute it
648
+ under certain conditions; type `show c' for details.
649
+
650
+ The hypothetical commands `show w' and `show c' should show the appropriate
651
+ parts of the General Public License. Of course, your program's commands
652
+ might be different; for a GUI interface, you would use an "about box".
653
+
654
+ You should also get your employer (if you work as a programmer) or school,
655
+ if any, to sign a "copyright disclaimer" for the program, if necessary.
656
+ For more information on this, and how to apply and follow the GNU GPL, see
657
+ <http://www.gnu.org/licenses/>.
658
+
659
+ The GNU General Public License does not permit incorporating your program
660
+ into proprietary programs. If your program is a subroutine library, you
661
+ may consider it more useful to permit linking proprietary applications with
662
+ the library. If this is what you want to do, use the GNU Lesser General
663
+ Public License instead of this License. But first, please read
664
+ <http://www.gnu.org/philosophy/why-not-lgpl.html>.