[Sommaire] [Imprimer]

   1  = Prototype
   2  ==== An object-oriented JavaScript framework
   3  
   4  (c) 2005 Sam Stephenson (mailto:sam@conio.net)
   5  
   6  Prototype is a JavaScript framework that aims to ease development of dynamic 
   7  web applications.  Its development is driven heavily by the Ruby on Rails 
   8  framework, but it can be used in any environment.
   9  
  10  === Targeted platforms
  11  
  12  Prototype currently targets the following platforms:
  13  
  14  * Microsoft Internet Explorer for Windows, version 6.0 and higher
  15  * Mozilla Firefox 1.0/Mozilla 1.7 and higher
  16  * Apple Safari 1.2 and higher
  17  
  18  == Using Prototype
  19  
  20  To use Prototype in your application, download the latest release from the 
  21  Prototype web site (http://prototype.conio.net/) and copy 
  22  <tt>dist/prototype.js</tt> to a suitable location. Then include it in your HTML
  23  like so:
  24  
  25    <script type="text/javascript" src="/path/to/prototype.js"></script>
  26  
  27  === Building Prototype from source
  28  
  29  <tt>prototype.js</tt> is a composite file generated from many source files in 
  30  the <tt>src/</tt> directory. To build Prototype, you'll need:
  31  
  32  * a copy of the Prototype source tree, either from a distribution tarball or
  33    from the darcs repository (see below)
  34  * Ruby 1.8.2 or higher (http://www.ruby-lang.org/)
  35  * Rake -- Ruby Make (http://rake.rubyforge.org/)
  36  * RDoc, if your Ruby distribution does not include it
  37  * darcs 1.0.1 or higher (http://abridgegame.org/darcs/; static binaries 
  38    available at http://www.scannedinavian.org/DarcsWiki/CategoryBinaries)
  39  
  40  From the root Prototype directory,
  41  
  42  * <tt>rake dist</tt> will preprocess the Prototype source using ERB and 
  43    generate the composite <tt>dist/prototype.js</tt>.
  44  * <tt>rake package</tt> will create a distribution tarball in the 
  45    <tt>pkg/</tt> directory.
  46  
  47  == Contributing to Prototype
  48  
  49  You'll need the tools mentioned above. Modify the files in <tt>src/</tt>, add 
  50  tests in <tt>test/</tt> if possible, generate a new dist file, and record the 
  51  changes with <tt>darcs record -al</tt>. Then email patches to 
  52  mailto:sam@conio.net using <tt>darcs send</tt>.
  53  
  54  == Documentation
  55  
  56  Prototype is embarrassingly lacking in documentation. (The source code should 
  57  be fairly easy to comprehend; I'm committed to using a clean style with 
  58  meaningful identifiers. But I know that only goes so far.)
  59  
  60  Much of the problem is that there is no easy way to document it from within the
  61  source code itself. I've tried JSDoc[http://jsdoc.sf.net/] and a Perl script 
  62  included with JsUnit[http://www.edwardh.com/jsunit/]; neither groks Prototype's
  63  hash-style class definitions or inheritance scheme. Making them work would 
  64  require major changes, and I don't have the time for that right now.