diff options
Diffstat (limited to 'src/pootle_it/html/js/README')
| -rw-r--r-- | src/pootle_it/html/js/README | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/src/pootle_it/html/js/README b/src/pootle_it/html/js/README new file mode 100644 index 0000000..627214d --- /dev/null +++ b/src/pootle_it/html/js/README @@ -0,0 +1,148 @@ + +/*****************************************************************************/ + + This README is an attempt to keep the house clean under the 'js' directory. + +/*****************************************************************************/ + +Directory contents +------------------- ++ js/ + + - admin.js : + Code for tasks performed in the administration area. + + Also sorts select elements (both normal and multiple) where language names are + involved. This is done in JavaScript because currently it's not possible + to sort them within Django. + To sort a new select element, add the end of the element id to the 'ids' + array. + + - common.js : + Common code that is included in every page. This includes: + - Code to handle the page zoom feature. + - Code to handle the advanced search dropdown. May be merged with other code + in the translate page. + + - correctpng.js : + Fixes for IE 5.5 & 6 to correctly handle PNG transparencies. + + http://homepage.ntlworld.com/bobosola + + - diff_match_patch.js : + Google's Diff, Match, and Patch libraries for plain text. + It's used for suggestion's diff highlighting. + + https://code.google.com/p/google-diff-match-patch/ + + - editor.js : + Code that sets up the editor and handles all the actions involved there. + This includes unit navigation, submission, suggestions' handling, copying + functions, fuzzy/unfuzzy, and several other helper stuff. + + - json2.min.js : + JavaScript library for encoding/decoding data to/from JSON format. + + http://www.json.org/js.html + + - shortcut.js : + Small library to ease adding keyboard shortcuts. + + http://www.openjs.com/scripts/events/keyboard_shortcuts/ + + - sorttable.js : + Sorts tables according to its values. Used in the homepage as well as on the + languages and projects listings. It has some customisations to support + zebra stripes once the sort is done (using jQuery). The icons used on the + table headings are custom code too. + We may want to use a table sorter purely written in jQuery, such as + tablesorter (http://tablesorter.com/docs/). + + http://www.kryogenix.org/code/browser/sorttable/ + + + jquery/ + + - jquery.js : + The jQuery library, version 1.4.4. + + - jquery.bidi.js : + jQuery plugin used to automatically set line direction of news + item based on their content. + + http://plugins.jquery.com/project/bidi + + - jquery.caret.js : + jQuery plugin to write text on top of the selected text or just after + the caret position. + + http://www.jquery-plugin.buss.hk/my-plugins/jquery-caret-plugin + + - jquery.easing.js : + jQuery plugin that provides dfferent easing (animation) formulas. + + http://gsgd.co.uk/sandbox/jquery/easing/ + + - jquery.fancybox.js : + Fancybox plugin for jQuery that adds the ability to display overlay + boxes with all sorts of content: images, HTML, AJAX data, ... + + Using version 1.3.4. + + http://fancybox.net/ + + - jquery.fieldselection.js : + jQuery plugin to retrieve or replace text selections within + textareas. + + http://laboratorium.0xab.cd/jquery/fieldselection/0.1.0/ + + - jquery.highlighRegex.js : + Plugin to highlight text on selected elements using regular expressions. + + https://github.com/jbr/jQuery.highlightRegex + + - jquery.history.js : + Plugin to handle AJAX history using hashes. + + http://github.com/tkyk/jquery-history-plugin/ + + - jquery.jsonp.js : + Alternative solution to jQuery's JSONP support. + + jQuery's JSONP support has some limitations (it can't handle error + callbacks, doesn't have an abort method, ...), and this plugin + tries to address those issues. + + These features may be implemented in jQuery core at some stage. + + Using version 2.1.4. + + https://code.google.com/p/jquery-jsonp/ + + - jquery.serializeObject.js : + A method for serializing forms directly into objects. + + Whereas jQuery’s built-in .serializeArray() method serializes a form + into an array, .serializeObject() serializes a form into an + (arguably more useful) object. + + http://benalman.com/projects/jquery-misc-plugins/#serializeobject + + - jquery.textarea-expander.js : + jQuery plugin used in the translate page textareas. + + http://blogs.sitepointstatic.com/examples/tech/textarea-expander/jquery.textarea-expander.js + + - jquery.tmpl.js : + jQuery templating engine. + + http://github.com/nje/jquery-tmpl + + + mt/ + + - apertium.js : + Script to load translation suggestions using the Apertium service. + + - google-translate.js : + Script to load translation suggestions using the Google Translate service. + |