﻿RIA JavaScript Classes Integrator Readme
----------------------------------------

* Web:     http://linux.ria.ua/JsClasses
* Version: 1.1
* Date:    6 October 2008
* License: LGPL
* Author:  Oleg Cherniy <oleg.cherniy(at)gmail(dot)com>


Описание
--------

Класс предназначен для увеличения скорости разработки на JavaScript.

При создании класса были использованы следующие идеи:

   1. Использование JavaScript фреймворка (MooTools 1.2 http://mootools.net)
      в качестве ядра, где реализованы псевдо-классы, которые объявляются 
      с помощью создания объекта Class.

   2. Улучшение структурированности кода достигается путем использования 
      принципов названий классов и их расположение по папкам, по стилю 
      похожему на Zend Framework
      http://framework.zend.com/manual/ru/coding-standard.naming-conventions.html#coding-standard.naming-conventions.classes

   3. Каждый класс должен быть документирован с помощью стандарта JsDoc (опционально)
      http://www.jsdoctoolkit.org/wiki/index.php
      Обязательным условием является тег @requires в коментариях к классам. 
      С помощью которого указываются зависимости между Классами

   4. Результирующий файл должен быть один. Он собирается из классов, код которых расположен
      по разным папкам, учитывая зависимости и порядок следования классов при сборке.

   5. Результирующий файл пересобирается и у него меняется имя, если были внесены изменения хотя бы 
      в один из классов (или зависимых классов), затребованых вашим php-скриптом
   
   6. Результирующий файл упаковывается модулем JSMin, что увеличивает скорость отдачи и не 
      влияет на удобство разработки

   7. Результирующий файл пакуется по методу gzip, что позволяет браузерам, поддерживающим 
      технологию упаковки gzip, еще больше увеличить скорость загрузки.

Подробное описание работы класса ищите на сайте http://linux.ria.ua/JsClasses



Пример работы
-------------

Распакуйте архив, перепишите файлы в папку доступную для запуска php-скриптов из-под вашего 
веб-сервера. 

Убедитесь что у вашего php-скрипта есть права на запись в папку cache и www/js/cache.

Запустите www.vash_sayt.ru/vasha_papka/index.php для просмотра рабочего примера.


Обратная связь
--------------
Буду рад услышать Ваши отзывы и пожелания по улучшению работы JsClasses.




