diff --git a/features/fuzzySearch/index.html b/features/fuzzySearch/index.html index f2218bd..e76d1f7 100644 --- a/features/fuzzySearch/index.html +++ b/features/fuzzySearch/index.html @@ -77,7 +77,7 @@ $(document).ready(function() {
  • fuzzySearch.toggleSmart allows the searching to be changed from exact matching to fuzzy searching.
  • fuzzySearch.rankColumn allows the % match to be set in a column within the datatable. Some examples of use cases could be to display the value to the user, or to hide the column and order based on it - as a search engine would.
    • -
  • fuzzySearch.threshold allows the value of similarity that is required from the damerau-levenshtein function to display the row to be +
  • fuzzySearch.threshold allows the value of similarity that is required from the Damerau-Levenshtein function to display the row to be changed.
  • fuzzySearch.returnSearch allows the option for searching to only occur when the enter key is pressed.
    • diff --git a/features/fuzzySearch/rankColumn.html b/features/fuzzySearch/rankColumn.html index bb5ac81..bf5b0cc 100644 --- a/features/fuzzySearch/rankColumn.html +++ b/features/fuzzySearch/rankColumn.html @@ -72,17 +72,22 @@ $(document).ready(function() {

    Fuzzy searching is used in search engines and databases to perform searches that will match results that are not necessarily exactly the same as the search term. This allows spelling mistakes and typos to be accounted for. It also allows small changes in dialect not to affect search results. A commonly used example is for surname searching. "Smith" and "Smythe" are pronounced the same way, but using conventional searching typing "Smith" would not return "Smythe".

    -

    This plug-in adds fuzzy search functionality to datatables. It does this through a combination of exact matching and the damerau-levenshtein algorithm. There are four initialisation options that are associated with this +

    This plug-in adds fuzzy search functionality to Datatables. It does this through a combination of exact matching and the Damerau-Levenshtein algorithm. There are four initialisation options that are associated with this plugin.

    +

    This example demonstrates the use of the fuzzySearch.rankColumn initialisation option. The default value for this option is undefined which will lead to the + similarity not being displayed in any column. In this example fuzzySearch.rankColumn is set to 6 which is the column on the far right of + the table. When usingfuzzy searching this column will be updated with the similarity value found within the rows data. When normal searching is being used this + column is not updated to include a value. The type that must be used for fuzzySearch.rankColumn is number. The full range of Datatables + column selectors cannot be used here as the value is used to index internal arrays rather than using the Datatables API

    diff --git a/features/fuzzySearch/returnSearch.html b/features/fuzzySearch/returnSearch.html index 23bf060..c2f3a06 100644 --- a/features/fuzzySearch/returnSearch.html +++ b/features/fuzzySearch/returnSearch.html @@ -72,17 +72,20 @@ $(document).ready(function() {

    Fuzzy searching is used in search engines and databases to perform searches that will match results that are not necessarily exactly the same as the search term. This allows spelling mistakes and typos to be accounted for. It also allows small changes in dialect not to affect search results. A commonly used example is for surname searching. "Smith" and "Smythe" are pronounced the same way, but using conventional searching typing "Smith" would not return "Smythe".

    -

    This plug-in adds fuzzy search functionality to datatables. It does this through a combination of exact matching and the damerau-levenshtein algorithm. There are four initialisation options that are associated with this +

    This plug-in adds fuzzy search functionality to Datatables. It does this through a combination of exact matching and the Damerau-Levenshtein algorithm. There are four initialisation options that are associated with this plugin.

    +

    This example demonstrates the use of the fuzzySearch.returnSearch initialisation option. The default value for this option is undefined which lead to the search + results being updated on every keypress. In this example fuzzySearch.returnSearch is set to true, meaning that the search results displayed within the table will + only be updated when the enter key is pressed.

    diff --git a/features/fuzzySearch/stateSaving.html b/features/fuzzySearch/stateSaving.html index cad43e3..a98752d 100644 --- a/features/fuzzySearch/stateSaving.html +++ b/features/fuzzySearch/stateSaving.html @@ -74,17 +74,20 @@ $(document).ready(function() {

    Fuzzy searching is used in search engines and databases to perform searches that will match results that are not necessarily exactly the same as the search term. This allows spelling mistakes and typos to be accounted for. It also allows small changes in dialect not to affect search results. A commonly used example is for surname searching. "Smith" and "Smythe" are pronounced the same way, but using conventional searching typing "Smith" would not return "Smythe".

    -

    This plug-in adds fuzzy search functionality to datatables. It does this through a combination of exact matching and the damerau-levenshtein algorithm. There are four initialisation options that are associated with this +

    This plug-in adds fuzzy search functionality to Datatables. It does this through a combination of exact matching and the Damerau-Levenshtein algorithm. There are four initialisation options that are associated with this plugin.

    +

    This example shows how fuzzySearch integrates with stateSave. The search mode, the value within the search box and the search results are restored + as they were on reload. To display all of the stateSave functionality, fuzzySearch.toggleSmart and fuzzySearch.rankColumn + are set to true and 6 respectively.

    diff --git a/features/fuzzySearch/threshold.html b/features/fuzzySearch/threshold.html index 99fd6d2..f39ee36 100644 --- a/features/fuzzySearch/threshold.html +++ b/features/fuzzySearch/threshold.html @@ -73,17 +73,22 @@ $(document).ready(function() {

    Fuzzy searching is used in search engines and databases to perform searches that will match results that are not necessarily exactly the same as the search term. This allows spelling mistakes and typos to be accounted for. It also allows small changes in dialect not to affect search results. A commonly used example is for surname searching. "Smith" and "Smythe" are pronounced the same way, but using conventional searching typing "Smith" would not return "Smythe".

    -

    This plug-in adds fuzzy search functionality to datatables. It does this through a combination of exact matching and the damerau-levenshtein algorithm. There are four initialisation options that are associated with this +

    This plug-in adds fuzzy search functionality to Datatables. It does this through a combination of exact matching and the Damerau-Levenshtein algorithm. There are four initialisation options that are associated with this plugin.

    +

    This example demonstrates the use of the fuzzySearch.threshold initialisation option. The default value for this option is 0.5. This value is used to + compare against the Damerau-Levenshtein similarity metric which is calculated by dividing the number of changes needed to make the words the same, by the length of + the longest word. This means that rows where each word in the search value matches a word in the row by at least 0.5 will be displayed. In this example + fuzzySearch.threshold is set to 0.1. This will mean that significantly more rows are displayed than normal. The value set here has to be + a decimal number between 0 and 1 with no limit on decimal places. Any greater than 1 and no results will be displayed, 0 will always display all results.

    diff --git a/features/fuzzySearch/toggleSmart.html b/features/fuzzySearch/toggleSmart.html index 43a9c33..4dc86a7 100644 --- a/features/fuzzySearch/toggleSmart.html +++ b/features/fuzzySearch/toggleSmart.html @@ -73,17 +73,23 @@ $(document).ready(function() {

    Fuzzy searching is used in search engines and databases to perform searches that will match results that are not necessarily exactly the same as the search term. This allows spelling mistakes and typos to be accounted for. It also allows small changes in dialect not to affect search results. A commonly used example is for surname searching. "Smith" and "Smythe" are pronounced the same way, but using conventional searching typing "Smith" would not return "Smythe".

    -

    This plug-in adds fuzzy search functionality to datatables. It does this through a combination of exact matching and the damerau-levenshtein algorithm. There are four initialisation options that are associated with this +

    This plug-in adds fuzzy search functionality to Datatables. It does this through a combination of exact matching and the Damerau-Levenshtein algorithm. There are four initialisation options that are associated with this plugin.

    +

    This example demonstrates the use of the fuzzySearch.toggleSmart initialisation option. The default value for this option is undefined which leads + to fuzzy searching being used all the time if the fuzzySearch option is declared in the initialisation options. In this example fuzzySearch.toggleSmart + is set to true, meaning that the search mode can be toggled by the end user. This can be done by hovering over the search box. When doing so a tooltip + will appear with two buttons - one for exact searching and one for fuzzy searching. Alternatively the fuzzy searching logo can be pressed. This logo is blurred when + in fuzzy search mode, and clear when in exact search mode. fuzzySearch.rankColumn is also set to 6 to display how the similarity is shown + when toggling between exact and fuzzy searching modes. When exact searching no value is shown here.