| 1 |
= Prototype |
|---|
| 2 |
==== An object-oriented JavaScript framework |
|---|
| 3 |
|
|---|
| 4 |
Prototype is a JavaScript framework that aims to ease development of dynamic |
|---|
| 5 |
web applications. It offers a familiar class-style OO framework, extensive |
|---|
| 6 |
Ajax support, higher-order programming constructs, and easy DOM manipulation. |
|---|
| 7 |
|
|---|
| 8 |
=== Targeted platforms |
|---|
| 9 |
|
|---|
| 10 |
Prototype currently targets the following platforms: |
|---|
| 11 |
|
|---|
| 12 |
* Microsoft Internet Explorer for Windows, version 6.0 and higher |
|---|
| 13 |
* Mozilla Firefox 1.0/Mozilla 1.7 and higher |
|---|
| 14 |
* Apple Safari 1.2 and higher |
|---|
| 15 |
|
|---|
| 16 |
== Using Prototype |
|---|
| 17 |
|
|---|
| 18 |
To use Prototype in your application, download the latest release from the |
|---|
| 19 |
Prototype web site (http://prototypejs.org/download) and copy |
|---|
| 20 |
<tt>dist/prototype.js</tt> to a suitable location. Then include it in your HTML |
|---|
| 21 |
like so: |
|---|
| 22 |
|
|---|
| 23 |
<script type="text/javascript" src="/path/to/prototype.js"></script> |
|---|
| 24 |
|
|---|
| 25 |
=== Building Prototype from source |
|---|
| 26 |
|
|---|
| 27 |
<tt>prototype.js</tt> is a composite file generated from many source files in |
|---|
| 28 |
the <tt>src/</tt> directory. To build Prototype, you'll need: |
|---|
| 29 |
|
|---|
| 30 |
* a copy of the Prototype source tree, either from a distribution tarball or |
|---|
| 31 |
from the Subversion repository (see below) |
|---|
| 32 |
* Ruby 1.8.2 or higher (http://www.ruby-lang.org/) |
|---|
| 33 |
* Rake -- Ruby Make (http://rake.rubyforge.org/) |
|---|
| 34 |
* RDoc, if your Ruby distribution does not include it |
|---|
| 35 |
|
|---|
| 36 |
From the root Prototype directory, |
|---|
| 37 |
|
|---|
| 38 |
* <tt>rake dist</tt> will preprocess the Prototype source using ERB and |
|---|
| 39 |
generate the composite <tt>dist/prototype.js</tt>. |
|---|
| 40 |
* <tt>rake package</tt> will create a distribution tarball in the |
|---|
| 41 |
<tt>pkg/</tt> directory. |
|---|
| 42 |
|
|---|
| 43 |
== Contributing to Prototype |
|---|
| 44 |
|
|---|
| 45 |
Check out the Prototype source with |
|---|
| 46 |
$ svn co http://svn.rubyonrails.org/rails/spinoffs/prototype/trunk/ prototype |
|---|
| 47 |
|
|---|
| 48 |
Find out how to contribute: |
|---|
| 49 |
http://prototypejs.org/contribute |
|---|
| 50 |
|
|---|
| 51 |
== Documentation |
|---|
| 52 |
|
|---|
| 53 |
Please see the online Prototype API: |
|---|
| 54 |
http://prototypejs.org/api |
|---|
| 55 |
|
|---|
