
/*****************************************************************************/

  This README is an attempt to keep the house clean under the 'js' directory.

  Last update: 2009/11/23

/*****************************************************************************/

Directory contents
-------------------
+ js/

  - autoexpand.js :
    Several functions used throughout the translate page
    (writespecial, copyoriginaltranslation).

    These functions can be rewritten using jQuery.

  - correctpng.js :
    Fixes for IE 5.5 & 6 to correctly handle PNG transparencies.

    http://homepage.ntlworld.com/bobosola

  - json2.min.js :
    JavaScript library for encoding/decoding data to/from JSON format.

    http://www.json.org/js.html

  - search.js :
    Code to handle the advanced search dropdown. May be merged with other code
    in the translate page.

  - 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).
    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/

  - translatepage.js :
    This handles several actions performed in the translate page. Including:

    1. Automatically unchecks the fuzzy mark when an edit is detected in a fuzzy
    entry. Used in the translate page.
    A new implementation would be better:
    http://bugs.locamotion.org/show_bug.cgi?id=473

    2. Handles suggestions doing XMLHttpRequest calls using jQuery and
    sending/receiving data in JSON format.

  + jquery/

    - 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.textarea-expander.js :
      jQuery plugin used in the translate page textareas.

      http://blogs.sitepointstatic.com/examples/tech/textarea-expander/jquery.textarea-expander.js

    - jquery.min.js :
      The jQuery library, version 1.2.6, minified. Bumping to 1.3.1 should be a
      good move.

