| 1 | SLIMBOX V1.8 README |
|---|
| 2 | ==================== |
|---|
| 3 | (c) Christophe Beyls 2007-2011 |
|---|
| 4 | |
|---|
| 5 | http://code.google.com/p/slimbox/ |
|---|
| 6 | |
|---|
| 7 | Included files: |
|---|
| 8 | |
|---|
| 9 | example.html A simple example page demonstrating how to use Slimbox with the default configuration. |
|---|
| 10 | example.jpg An example image used on the example page. |
|---|
| 11 | README.txt The file you are reading. |
|---|
| 12 | css/* The Slimbox stylesheet and its associated images. You can edit them to customize Slimbox appearance. |
|---|
| 13 | You can choose between the standard slimbox.css or slimbox-rtl.css which is designed for right-to-left languages. |
|---|
| 14 | js/mootools.js The minified version of mootools v1.3.2 including only the modules required by Slimbox. |
|---|
| 15 | js/slimbox.js The minified version of Slimbox, plus the editable autoloading code using default options. |
|---|
| 16 | src/slimbox.js The Slimbox source. Contains many comments and is not suitable for production use (needs to be minified first). |
|---|
| 17 | extra/* Some extra scripts that you can add to the autoload code block inside slimbox.js to add special functionality. |
|---|
| 18 | |
|---|
| 19 | |
|---|
| 20 | You can use the provided mootools.js and slimbox.js scripts "as is", or you can use a custom mootools build |
|---|
| 21 | downloaded from the official mootools website and/or edit the autoloading code inside slimbox.js. |
|---|
| 22 | |
|---|
| 23 | You need to download a new mootools version if your web page scripts require additional mootools modules, |
|---|
| 24 | or if you want to use a different version of mootools. This script is only compatible with mootools 1.3 and more recent. |
|---|
| 25 | |
|---|
| 26 | Here are the mootools core modules required by this version of Slimbox: |
|---|
| 27 | - Element.Style, Element.Event, Element.Dimensions |
|---|
| 28 | - Fx.Tween, Fx.Morph (optionally Fx.Transitions) |
|---|
| 29 | - DOMReady |
|---|
| 30 | |
|---|
| 31 | You can remove or customize the provided autoload code block by editing the slimbox.js file. By default, it behaves like Lightbox. |
|---|
| 32 | When deploying slimbox.js, you MUST always preserve the copyright notice at the beginning of the file. |
|---|
| 33 | |
|---|
| 34 | If you are a developer and want to edit the provided Slimbox source code, it is strongly recommended to minify the script using "YUI Compressor" |
|---|
| 35 | by Julien Lecomte before distribution. It will strip spaces and comments and shrink the variable names in order to obtain the smallest file size. |
|---|
| 36 | |
|---|
| 37 | For more information, please read the documentation on the official project page. |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | Enjoy! |
|---|
