Prototype An object-oriented Javascript library

README

Path:	README
Last Update:	Mon Apr 18 02:09:58 CDT 2005

Prototype

An object-oriented Javascript library

© 2005 Sam Stephenson ([e-mail])

Prototype is a Javascript library that aims to ease development of dynamic web applications. Its development is driven heavily by the Ruby on Rails framework, but it can be used in any environment.

Targeted platforms

Prototype currently targets the following platforms:

• Microsoft Internet Explorer for Windows, version 6.0 and higher
• Mozilla Firefox 1.0/Mozilla 1.7 and higher
• Apple Safari 1.2 and higher

Using Prototype

To use Prototype in your application, download the latest release from the Prototype web site (prototype.conio.net/) and copy dist/prototype.js to a suitable location. Then include it in your HTML like so:

  <script type="text/javascript" src="/path/to/prototype.js"></script>

Building Prototype from source

prototype.js is a composite file generated from many source files in the src/ directory. To build Prototype, you’ll need:

• a copy of the Prototype source tree, either from a distribution tarball or from the darcs repository (see below)
• Ruby 1.8.2 or higher (www.ruby-lang.org/)
• Rake — Ruby Make (rake.rubyforge.org/)
• RDoc, if your Ruby distribution does not include it
• darcs 1.0.1 or higher (abridgegame.org/darcs/; static binaries available at www.scannedinavian.org/DarcsWiki/CategoryBinaries)

From the root Prototype directory,

• rake generate_dist_prototype will run script/make-dist.rb, which preprocesses the Prototype source and generates the single-file dist/prototype.js.
• rake generate_dist_tarball will run the aforementioned task and create a distribution tarball of your current darcs repository with darcs dist. (rake dist, or just rake, can be used for this, too.)

Contributing to Prototype

You‘ll need the tools mentioned above. Modify the files in src/, add tests in test/ if possible, generate a new dist file, and record the changes with darcs record -al. Then email patches to [e-mail] using darcs send.

Documentation

Prototype is embarrassingly lacking in documentation. (The source code should be fairly easy to comprehend; I’m committed to using a clean style with meaningful identifiers. But I know that only goes so far.)

Much of the problem is that there is no easy way to document it from within the source code itself. I’ve tried JSDoc and a Perl script included with JsUnit; neither groks Prototype’s hash-style class definitions or inheritance scheme. Making them work would require major changes, and I don’t have the time for that right now.

[Validate]