Skip to content
This repository was archived by the owner on Jul 25, 2019. It is now read-only.

Commit aaaff1c

Browse files
committed
cosmetic: simplify documentation and license
1 parent 2e68091 commit aaaff1c

File tree

2 files changed

+27
-77
lines changed

2 files changed

+27
-77
lines changed

LICENSE

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
(The MIT License)
2+
3+
Copyright (c) 2012 Marcin Warpechowski <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
'Software'), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

index.html

+5-77
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,9 @@
106106
</style>
107107

108108
<script src="jquery.handsontable.js"></script>
109-
<script src="lib/bootstrap-typeahead.js"></script>
110-
<script src="lib/jquery.autoresize.js"></script>
111-
<script src="lib/json2.min.js"></script>
112-
<!-- Only needed by index.html for IE6/IE7 support. Not needed by jquery.handsontable.js -->
109+
<script src="lib/bootstrap-typeahead.js"></script><!-- only if you need the autocomplete feature -->
110+
<script src="lib/jquery.autoresize.js"></script><!-- only if you need the sexy autoexpanding textarea feature -->
111+
<script src="lib/json2.min.js"></script><!-- Only needed by index.html for IE6/IE7 support. Not needed by jquery.handsontable.js -->
113112
<link rel="stylesheet" media="screen" href="jquery.handsontable.css">
114113
</head>
115114

@@ -266,85 +265,14 @@ <h3>Autocomplete and Legend <span class="super"> NEW!</span></h3>
266265

267266
<h2>Documentation</h2>
268267

269-
<h3>handsontable(options)</h3>
270-
271-
<p>
272-
Plugin constructor <span class="code">handsontable(options)</span> accepts the following configuration options
273-
as the first argument:
274-
</p>
275-
<ul>
276-
<li><b>rows</b> - Initial number of rows</li>
277-
<li><b>cols</b> - Initial number of columns</li>
278-
<li><b>minWidth</b> - <i>(Optional)</i> Number. If set, will add as many columns as needed to meet the given width
279-
in pixels
280-
</li>
281-
<li><b>minHeight</b> - <i>(Optional)</i> Number. If set, will add as many rows as needed to meet the given height in
282-
pixels
283-
</li>
284-
<li><b>minSpareCols</b> - <i>(Optional)</i> Number. If set to 1 (or more), will add a new column at the end of grid
285-
when there are no&nbsp;more empty columns
286-
</li>
287-
<li><b>minSpareRows</b> - <i>(Optional)</i> Number. If set to 1 (or more), will add a new row at the end of grid
288-
when there are no&nbsp;more empty rows
289-
</li>
290-
<li><b>onChange</b> - <i>(Optional)</i> Function to be called after one or more cells is changed (with changes
291-
array as an argument)
292-
</li>
293-
<li><b>multiSelect</b> - <i>(Optional)</i> Boolean. If true, selection of multiple cells using keyboard or mouse
294-
is allowed. Default true.
295-
</li>
296-
<li><b>legend</b> - <i>(Optional)</i> Array of object literals. Each literal defines 4 properties:
297-
<ul>
298-
<li><b>match</b>(row, col, data) - Function to check if legend should be used for a cell. Returns TRUE if
299-
legend should be used. Function parameters:
300-
301-
<ul>
302-
<li>row - Number of row, starting of 0</li>
303-
<li>col - Number of column, starting of 0</li>
304-
<li>data - Function that returns array of current data for all cells. Can be used to check what is
305-
the current content of any cell.
306-
</li>
307-
</ul>
308-
</li>
309-
<li><b>style</b> - <i>(Optional)</i>. Object literal that contains CSS properties for matched cell</li>
310-
<li><b>title</b> - <i>(Optional)</i>. String that will be used as "title" attribute for matched cell</li>
311-
<li><b>readOnly</b> - <i>(Optional)</i>. Boolean. If true, then value of matched cell cannot be manually
312-
changed
313-
</li>
314-
</ul>
315-
</li>
316-
<li><b>autocomplete</b> - <i>(Optional)</i> Array of object literals. Each literal defines 2 properties:
317-
<ul>
318-
<li><b>match</b>(row, col, data) - Function to check if the source should be used as autocomplete for
319-
a cell. Returns TRUE if source should be used. Function parameters:
320-
321-
<ul>
322-
<li>row - Number of row, starting of 0</li>
323-
<li>col - Number of column, starting of 0</li>
324-
<li>data - Function that returns array of current data for all cells. Can be used to check what is
325-
the current content of any cell.
326-
</li>
327-
</ul>
328-
</li>
329-
<li><b>highlighter</b>(item) - Function to render suggestion row for autocomplete. See the above example for
330-
color highlighter.
331-
</li>
332-
<li><b>source</b>() - Function to return data for autocomplete</li>
333-
</ul>
334-
</li>
335-
</ul>
336-
337-
<h3>handsontable("loadData", data)</h3>
338-
339268
<p>
340-
Plugin method <span class="code">handsontable("loadData", data)</span> accepts initial cell data as the
341-
argument.
269+
Available plugin methods and configuration options are listed in <a href="http://github.com/warpech/jquery-handsontable">README.md on GitHub</a>
342270
</p>
343271

344272
<h2>License</h2>
345273

346274
<p>
347-
Dual licensed under the MIT or GPL Version 2 licenses.
275+
Licensed under the MIT license
348276
</p>
349277

350278
<h2>Authors</h2>

0 commit comments

Comments
 (0)