From a63ea6d8ee95a5add2ecf0da057772f095fcfa5e Mon Sep 17 00:00:00 2001 From: Mottie Date: Wed, 26 Mar 2014 21:54:57 -0500 Subject: [PATCH] doc updates --- docs/example-widget-column-selector.html | 1 - docs/index.html | 66 ++++++++++++------------ 2 files changed, 33 insertions(+), 34 deletions(-) diff --git a/docs/example-widget-column-selector.html b/docs/example-widget-column-selector.html index 573469be..55519ad1 100644 --- a/docs/example-widget-column-selector.html +++ b/docs/example-widget-column-selector.html @@ -356,7 +356,6 @@

Demo

-

CSS only popup

diff --git a/docs/index.html b/docs/index.html index 7ad497ea..0a44fb6a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,10 +5,10 @@ jQuery plugin: Tablesorter 2.0 - + - + @@ -557,7 +557,7 @@ String "" - Additional CSS class applied to style the header with a ascending sort - v2.11. + Additional CSS class applied to style the header with a ascending sort (v2.11).

Changed to empty string ("") in v2.11, as the "tablesorter-headerAsc" class will always be added to a header cell with an ascending sort; this option now contains any additional class names to add. @@ -575,7 +575,7 @@ cssChildRow String "tablesorter-childRow" - Add this css class to a child row that should always be attached to its parent. Click on the "cssChildRow" link to toggle the view on the attached child row. Previous default was "expand-child" (Changed in v2.4). + Add this css class to a child row that should always be attached to its parent. Click on the "cssChildRow" link to toggle the view on the attached child row. Previous default was "expand-child" (Modified v2.4). 1 2 @@ -633,7 +633,7 @@ String "" - Additional CSS class applied to style the header with a descending sort - v2.11. + Additional CSS class applied to style the header with a descending sort (v2.11).

Changed to empty string in v2.11, as the "tablesorter-headerDesc" class will always be added to a header cell with a descending sort; this option now contains any additional class names to add.

Example from the blue theme:

@@ -650,7 +650,7 @@ String "" - Additional CSS class applied to style the headers - v2.11 + Additional CSS class applied to style the headers (v2.11).

Changed to empty string in v2.11, as the "tablesorter-header" class will always be added to the table headers; this option now contains any additional class names to add.

Example from the blue theme:

@@ -671,7 +671,7 @@ String "" - Additional CSS class applied to style the header row - v2.11 + Additional CSS class applied to style the header row (v2.11).

Changed to empty string in v2.11, as the "tablesorter-headerRow" class will always be added to a table header row; this option now contains any additional class names to add.

This CSS style was added in v2.4, prior to that the row would get the same class as the header cells. This class was added to make it easier to determine what element was being targeted in the plugin.

@@ -710,10 +710,10 @@ String "" - Additional CSS class applied to style the header cell while it is being sorted or filtered - v2.11 + Additional CSS class applied to style the header cell while it is being sorted or filtered (v2.4; v2.11).

Changed to empty string in v2.11, as the "tablesorter-processing" class will always be added to a table cells during processing; this option now contains any additional class names to add.
-

This class name is added to the header cell that is currently being sorted or filted. To prevent this class name from being added, set the showProcessing option to false (v2.4).

+

This class name is added to the header cell that is currently being sorted or filted. To prevent this class name from being added, set the showProcessing option to false.

@@ -1273,7 +1273,7 @@ From the example function above, you'll end up with something similar to this HT tabIndex Boolean true - Add a tabindex to the headers for keyboard accessibility; this was previously always applied v2.14 + Add a tabindex to the headers for keyboard accessibility; this was previously always applied (v2.14). @@ -1281,7 +1281,7 @@ From the example function above, you'll end up with something similar to this HT String "" - Additional CSS class applied to style the table - v2.11 + Additional CSS class applied to style the table (v2.11).

Changed to empty string in v2.11, as the "tablesorter" class will always be added to the table; this option now contains any additional class names to add.

This class was required in the default markup in version 2.0.5. But in version 2.0.6, it was added as an option.

@@ -1346,7 +1346,7 @@ $(function(){ String Undefined - This option should contain a unique namespace for each table; it is used when binding to event listeners. v2.15.7. + This option should contain a unique namespace for each table; it is used when binding to event listeners (v2.15.7).

Notes about this namespace option: @@ -1371,7 +1371,7 @@ $(function(){ Function null - Replace the default number sorting algorithm with a custom one using this option v2.12. + Replace the default number sorting algorithm with a custom one using this option (v2.12).

Here is an example: @@ -1625,7 +1625,7 @@ $(function(){ Numeric 50 - Used by the two digit year parser to set the date range v2.14. + Used by the two digit year parser to set the date range (v2.14). Example @@ -1634,7 +1634,7 @@ $(function(){ String Undefined - This option was added to set a specific page when storing data using the $.tablesorter.storage code. v2.12. + This option was added to set a specific page when storing data using the $.tablesorter.storage code (v2.12).

More specifically, when the storage function is used, it attempts to give every table a unique identifier using both the page url and table ID (or index on the page if no id exists). This option allows you to override the current page url (it doesn't need to be a url, just some constant value) and save data for multiple tables across a domain.

@@ -1892,7 +1892,7 @@ $(function(){ String or Array "" - Additional CSS class applied to each filter - v2.15 + Additional CSS class applied to each filter (v2.15).

As of v2.15, this option can also contain an array of class names that are to be applied to input filters.

@@ -2388,7 +2388,7 @@ $('table').trigger('search', false);
String "" - Sticky Headers widget: This additional CSS class applied to the sticky header row - v2.11 + Sticky Headers widget: This additional CSS class applied to the sticky header row (v2.11).

Changed to empty string in v2.11, as the "tablesorter-stickyHeader" class will always be added to the sticky header row; this option now contains any additional class names to add.

Previously, this option contained the class name to be applied to the sticky header row (tr) (v2.1).

@@ -3386,7 +3386,7 @@ This ajaxProcessing function must return an object with "total", "headers" and " - Use this method to add table rows. (v2.0.16). + Use this method to add table rows (v2.0.16).

It does not work the same as "update" in that it only adds rows, it does not remove them.
Also, use this method to add table rows while using the pager plugin. If the "update" method is used, only the visible table rows continue to exist. @@ -3617,7 +3617,7 @@ $('table').trigger('applyWidgets'); - Use this method to remove tablesorter from the table. + Use this method to remove tablesorter from the table (v2.3.2). 
// Remove tablesorter and all classes
 $("table").trigger("destroy");
@@ -4319,7 +4319,7 @@ var config = $('#mytable').data('tablesorter');
 			
 				
 				Array
-				Internal list of each header's starting HTML (as text)
+				Internal list of each header's starting HTML (as text) (v2.8)
 					


 						This HTML snapshot is taken using the $headers jQuery object, and done before the headerTemplate is applied and before the onRenderTemplate and onRenderHeader callbacks are executed.

 						

@@ -4557,7 +4557,7 @@ var wo = $('#mytable').data('tablesorter').widgetOptions;
 			
 				
 				
-					This function detaches the targeted tbody from the DOM to allow faster manipulation of the tbody contents.
+					This function detaches the targeted tbody from the DOM to allow faster manipulation of the tbody contents (v2.4).
 					

 						Use it as follows:
 						
$.tablesorter.processTbody( table, $(tbody), getIt );

@@ -4587,7 +4587,7 @@ for (tbodyIndex = 0; tbodyIndex < tbodies.length; tbodyIndex++) {
 
 			
 				
-				This function adds the processing (indeterminant loading icon) to specific or all header cells while processing table elements.
+				This function adds the processing (indeterminant loading icon) to specific or all header cells while processing table elements (v2.4).
 					


 						Use it as follows:
 						
$.tablesorter.isProcessing( table, toggle, $ths );

@@ -4626,7 +4626,7 @@ for (tbodyIndex = 0; tbodyIndex < tbodies.length; tbodyIndex++) {
 
 			
 				
-				This function adds header event listeners to the targeted cells (v2.15).
+				This function adds header event listeners to the targeted cells (v2.8; v2.15).
 					


 						Use it as follows:
 						
$.tablesorter.bindEvents( table, $headers );

@@ -4652,7 +4652,7 @@ $.tablesorter.bindEvents( $table, $clonedTable.find('th') );
- This function restores the table headers cells with their original content. + This function restores the table headers cells with their original content (v2.8).

The original header cell content is saved, within the headerContent variable array, before the headerTemplate is applied and before the onRenderTemplate and onRenderHeader callbacks are executed.

@@ -4668,7 +4668,7 @@ $.tablesorter.bindEvents( $table, $clonedTable.find('th') ); - This function completely removes tablesorter, including all widgets, associated data & event handlers from the table. + This function completely removes tablesorter, including all widgets, associated data & event handlers from the table (v2.3.2).

Use it as follows: 
$.tablesorter.destroy( table, removeClasses, callback );
@@ -4690,7 +4690,7 @@ $.tablesorter.bindEvents( $table, $clonedTable.find('th') ); - This function sorts the a & b parameter using a natural sort. + This function sorts the a & b parameter using a natural sort (v2.12).

Access it as follows: 
$.tablesorter.sortNatural(a, b);
@@ -4702,14 +4702,14 @@ $.tablesorter.bindEvents( $table, $clonedTable.find('th') ); 
var myArray = [ '1a', '10a', '2a', '2b' ];
 // result: ["1a", "2a", "2b", "10a"]
 myArray.sort(function(a,b) { return $.tablesorter.sortNatural(a, b); });
- Please note that this natural sort function only accepts strings. + Please note that this natural sort function only accepts strings (added v2.0.6; renamed v2.12).
- This function sorts the a & b parameter using a basic sort. + This function sorts the a & b parameter using a basic sort (renamed v2.12).

Access it as follows: 
$.tablesorter.sortText(a, b);
@@ -4727,7 +4727,7 @@ myArray.sort(function(a,b) { return $.tablesorter.sortText(a, b); }); - This function replaces basic accented characters to better sorting & filtering of table contents. + This function replaces basic accented characters to better sorting & filtering of table contents (v2.2).

Use it as follows: 
$.tablesorter.replaceAccents(string);
@@ -4842,7 +4842,7 @@ widget.format( table, table.config, table.config.widgetOptions ); - This function removes, then reapplies all currently selected widgets on a table. + This function removes, then reapplies all currently selected widgets on a table (v2.4).

Use it as follows: 
$.tablesorter.refreshWidgets( table, doAll, dontapply );
@@ -4860,7 +4860,7 @@ widget.format( table, table.config, table.config.widgetOptions ); - This functions gets the sorter, string, empty, etc options for each column from jQuery data, metadata, header option or header class name ("sorter-false"). + This functions gets the sorter, string, empty, etc options for each column from jQuery data, metadata, header option or header class name ("sorter-false") (v2.1.16).

priority = jQuery data > meta > headers option > header class name

@@ -4948,7 +4948,7 @@ $.tablesorter.isDigit( "(2,345.67)" ); - This function allows adding/removing a row to the thead, to display any errors v2.15 + This function allows adding/removing a row to the thead, to display any errors (v2.15).

This function is ONLY included within the widget-pager.js and jquery.tablesorter.pager.js files; in version 3+, I plan to add it as a selectable option in a build.

@@ -5103,7 +5103,7 @@ $.tablesorter.addHeaderResizeEvent( table, true ); - This function allows saving specific table data (especially widgets) to local storage (cookie fallback for no browser support) + This function allows saving specific table data (especially widgets) to local storage (cookie fallback for no browser support) (v2.1)

Access it as follows: 
$.tablesorter.storage(table, key, value, options);