library-mirrors/tablesorter
1
0
Fork 0
mirror of https://github.com/Mottie/tablesorter.git synced 2025-01-12 15:24:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Parser: Added ignoreArticlesExcept option to ignoreArticles parser

Browse Source
This commit is contained in:
Mottie 2014-09-06 22:30:53 -05:00
parent 45e4ef1223
commit af9f9c4450
2 changed files with 92 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
docs/example-parsers-ignore-articles.html
View File

@ -8,6 +8,8 @@
<script src="js/jquery-latest.min.js"></script>
<!-- Demo stuff -->
<link class="ui-theme" rel="stylesheet" href="css/jquery-ui.min.css">
<script src="js/jquery-ui-latest.min.js"></script>
<link rel="stylesheet" href="css/jq.css">
<link href="css/prettify.css" rel="stylesheet">
<script src="js/prettify.js"></script>
@ -28,7 +30,8 @@
headers: {
2: {
sorter: 'ignoreArticles',
ignoreArticles : 'en'
ignoreArticles : 'en',
ignoreArticlesExcept : ''
}
}
});
@ -45,20 +48,54 @@
</div>
<div id="main">
<p class="tip">
<em>NOTE!</em>
<ul>
<li>This parser can not be applied to the original plugin.</li>
<li>Set the language to use by adding any of the following (they all do the same thing), set in order of priority (<span class="version">v2.8.2</span>):
<ul>
<li>jQuery data <code>data-ignore-articles="fr"</code>.</li>
<li>metadata <code>class="{ ignoreArticles : 'fr' }"</code>. This requires the metadata plugin.</li>
<li>headers option <code>headers : { 0 : { ignoreArticles : 'fr' } }</code>.</li>
<li>header class name <code>class="ignoreArticles-fr"</code>.</li>
</ul>
</li>
<li>To add a custom language to the parser, use the following code:
<pre class="prettyprint lang-javascript">$.extend( $.tablesorter.ignoreArticles, {
<p></p>
<br>
<div id="root" class="accordion">
<h3 id="notes"><a href="#">Notes</a></h3>
<div>
<ul>
<li>In <span class="version">v2.17.8</span>, added a new option <code>ignoreArticlesExcept</code> option which allows ignoring a set pattern.</li>
<li>This parser can not be applied to the original plugin.</li>
</ul>
</div>
<h3 id="setup"><a href="#">Setup</a></h3>
<div>
<ul>
<li>Set the language (French shown below; English is set by default) to use by adding any of the following (they all do the same thing), set in order of priority (<span class="version">v2.8.2</span>):
<ul>
<li>jQuery data <code>data-ignore-articles="fr"</code>.</li>
<li>metadata <code>class="{ ignoreArticles : 'fr' }"</code>. This requires the metadata plugin.</li>
<li>headers option <code>headers : { 0 : { ignoreArticles : 'fr' } }</code>.</li>
<li>header class name <code>class="ignoreArticles-fr"</code>.</li>
</ul>
<br>
</li>
<li>In <span class="version">v2.17.8</span>, you can set up a string to ignore, e.g. keep a title intact like "A to Z", as follows:
<ul>
<li>jQuery data <code>data-ignore-articles-except="a to"</code>.</li>
<li>metadata <code>class="{ ignoreArticlesExcept : 'a to' }"</code>. This requires the metadata plugin.</li>
<li>headers option <code>headers : { 0 : { ignoreArticlesExcept : 'a to' } }</code>.</li>
</ul>
</li>
<li>To add more than one title to ignore, separate them using a vertical bar (<kbd>shift</kbd>+<kbd>\</kbd>)
<pre class="prettyprint lang-js">headers: {
0: {
ignoreArticles : 'en',
// no special parsing for titles like "A to Z" or "A B C" or "A One"
ignoreArticlesExcept : 'a to|a b |a one'
}
}</pre><span class="label label-info">Note</span> If your title needs a space (e.g. "A B C") make sure it isn't at the end of the <code>ignoreArticlesExcept</code> string; spaces on either end get stripped away.
</li>
</ul>
</div>
<h3 id="customizing"><a href="#">Customizing</a></h3>
<div>
<ul>
<li>To add a custom language to the parser, use the following code:
<pre class="prettyprint lang-javascript">$.extend( $.tablesorter.ignoreArticles, {
"xx" : "a, l'_, de la"
});
@ -66,21 +103,22 @@ $('table').tablesorter({
headers: {
2: {
sorter: 'ignoreArticles',
ignoreArticles : 'xx'
ignoreArticles : 'xx',
ignoreArticlesExcept : 'a to'
}
}
});</pre>
<ul>
<li>where <code>xx</code> is the <code>ignoreArticles</code> id (abbreviation for the language)</li>
<li>Each leading article must be separated by a comma and will be case-insensitive.</li>
<li>Leading articles will only be removed if they are followed by a space; spaces are automatically included when parsed unless the article definition is followed by an underscore. See the <code>l'_</code> note below.</li>
<li><code>a</code> is an example of a leading article which will be removed. So, "A Fistfull of Dollars" will only parse "Fistfull of Dollars" and will sort with the other words that start with an "F".</li>
<li><code>l'_</code> includes an underscore (<code>_</code>); this tells the parser to <strong><em>not</em></strong> add a space after the word. So a title like "l'enfant" will parse as "enfant".</li>
<li><code>de la</code> is an example showing that the parser can remove a multiple-word article.</li>
</ul>
</li>
<li>Some languages have been included by default. The information below was obtained from <a href="http://en.wikipedia.org/wiki/Article_%28grammar%29#Variation_among_languages">this wikipedia page</a>, so if you discover any errors, or if you want to contribute another language, please <a href="https://github.com/Mottie/tablesorter/issues">open an issue</a>.
<pre class="prettyprint lang-javascript">$.tablesorter.ignoreArticles = {
<ul>
<li>where <code>xx</code> is the <code>ignoreArticles</code> id (abbreviation for the language)</li>
<li>Each leading article must be separated by a comma and will be case-insensitive.</li>
<li>Leading articles will only be removed if they are followed by a space; spaces are automatically included when parsed unless the article definition is followed by an underscore. See the <code>l'_</code> note below.</li>
<li><code>a</code> is an example of a leading article which will be removed. So, "A Fistfull of Dollars" will only parse "Fistfull of Dollars" and will sort with the other words that start with an "F".</li>
<li><code>l'_</code> includes an underscore (<code>_</code>); this tells the parser to <strong><em>not</em></strong> add a space after the word. So a title like "l'enfant" will parse as "enfant".</li>
<li><code>de la</code> is an example showing that the parser can remove a multiple-word article.</li>
</ul>
</li>
<li>Some languages have been included by default. The information below was obtained from <a href="http://en.wikipedia.org/wiki/Article_%28grammar%29#Variation_among_languages">this wikipedia page</a>, so if you discover any errors, or if you want to contribute another language, please <a href="https://github.com/Mottie/tablesorter/issues">open an issue</a>.
<pre class="prettyprint lang-javascript">$.tablesorter.ignoreArticles = {
"en" : "the, a, an",
"de" : "der, die, das, des, dem, den, ein, eine, einer, eines, einem, einen",
"nl" : "de, het, de, een",
@ -90,8 +128,10 @@ $('table').tablesorter({
"it" : "il, lo, la, l'_, i, gli, le, un', uno, una, un",
"hu" : "a, az, egy"
};</pre></li>
</ul>
<p>
</ul>
</div>
</div>
<h1>Demo</h1>
<br>
@ -379,7 +419,8 @@ $(function() {
headers: {
2: {
sorter: 'ignoreArticles',
ignoreArticles : 'fr'
ignoreArticles : 'fr',
ignoreArticlesExcept : ''
}
}
});

28
js/parsers/parser-ignore-articles.js
View File

@ -7,8 +7,10 @@
;(function($){
"use strict";
var ts = $.tablesorter;
// basic list from http://en.wikipedia.org/wiki/Article_%28grammar%29
$.tablesorter.ignoreArticles = {
ts.ignoreArticles = {
"en" : "the, a, an",
"de" : "der, die, das, des, dem, den, ein, eine, einer, eines, einem, einen",
"nl" : "de, het, de, een",
@ -24,22 +26,34 @@
// and then set the language id 'xx' in the headers option
// ignoreArticles : 'xx'
$.tablesorter.addParser({
ts.addParser({
id: 'ignoreArticles',
is: function() {
return false;
},
format: function(s, table, cell, cellIndex) {
var c = table.config, art, lang;
var art, ignore, lang,
c = table.config,
str = s || '';
if ( !(c.headers && c.headers[cellIndex] && c.headers[cellIndex].ignoreArticlesRegex) ) {
// initialize - save regex in c.headers[cellIndex].ignoreArticles
// initialize - save regex in c.headers[cellIndex].ignoreArticlesRegex
if (!c.headers) { c.headers = {}; }
if (!c.headers[cellIndex]) { c.headers[cellIndex] = {}; }
lang = $.tablesorter.getData(c.$headers.eq(cellIndex), c.headers[cellIndex], 'ignoreArticles');
art = ($.tablesorter.ignoreArticles[lang] || "the, a, an" ) + "";
lang = ts.getData( c.$headers.eq(cellIndex), ts.getColumnData( table, c.headers, cellIndex ), 'ignoreArticles' );
art = (ts.ignoreArticles[lang] || "the, a, an" ) + "";
c.headers[cellIndex].ignoreArticlesRegex = new RegExp('^(' + $.trim( art.split(/\s*\,\s*/).join('\\s|') + "\\s" ).replace("_\\s","") + ')', 'i');
// exception regex stored in c.headers[cellIndex].ignoreArticlesRegex2
ignore = ts.getData( c.$headers.eq(cellIndex), ts.getColumnData( table, c.headers, cellIndex ), 'ignoreArticlesExcept' );
c.headers[cellIndex].ignoreArticlesRegex2 = ignore !== '' ? new RegExp('^(' + ignore.replace(/\s/g, "\\s") + ')', 'i') : '';
}
return (s || '').replace(c.headers[cellIndex].ignoreArticlesRegex, '');
art = c.headers[cellIndex].ignoreArticlesRegex;
if (art.test(str)) {
ignore = c.headers[cellIndex].ignoreArticlesRegex2;
if ( !(ignore && ignore.test(str)) ) {
return str.replace(art, '');
}
}
return str;
},
type: 'text'
});