GuaranaUI/Release_notes.txt

Guarana UI - jQuery-based Library for Nokia WebRunTime - Version 1.2
Support for S60 3rdFP2, S60 5th and Maemo5 WRT
http://www.forum.nokia.com/GuaranaUI
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
ABOUT

This is the release note of the Javascript Library for Nokia Web Runtime, 
Guarana. Nokia WRT is a development and delivery platform that allows the 
creation of applications (widgets) based on standard web technologies, 
such as HTML, CSS, JavaScript, and AJAX. WRT Framework intends to offer 
developers a set of common components to create and deploy widgets in a 
friendly way. If you would like to know how to start developing with 
Nokia WRT, please visit Web Runtime QuickStart available in the Forum 
Nokia website. If you would like to know how to use this library to 
developer widgets, the following topics will help you.

The WRT Framework is closely integrated with the jQuery library. The 
library uses the best practices of other libraries such as jQueryUI, 
MooTools, and ThemeRoller. 


--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
WHAT'S NEW

Including Full Widgets Templates for S60 3rd and 5th Edition

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
SUPORTED PLATFORMS

- S60 3rd Edition FP2
- S60 5th Edition
- Maemo5 WebRuntime

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
PREREQUISITES

HTML
CSS
JavaScript
Qt WebRuntime for Maemo5 devices
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
IMPORTANT FILES/CLASSES

* Build (build folder)
 
This folder is the WRT Framework Build System. We will talk more about it in the next section.
 

* Components Demos (demos folder)
 
This folder include demos for the UI components. We have a demo for each WRT Framework component.  
 
 
* JQuery files (lib folder)
 
This folder includes JQuery Files used by WRT Framework. The JQuery version used is 1.2.6. 
This version is the most compatible version thats works stable in S60 devices.

 
* Core files (src folder)
 
This folder includes all javascript core files. Here we have library core files, components 
implementation files. Additionally we have a sub-folder called i18n that has information 
about components internationalization. In the current version, the only that have 
internationalization is Date component. 
 

* Themes (themes folder)
 
This folders includes all CSS files used by WRT Framework. The two sub-folders presented 
are described bellow:
     a) themeroller: This is the jQuery UI CSS Framework used by Framework. More 
information about themeroller is available here.
     b) nokia: This is the nokia base. Here we have component CSS base for WRT 
Framework. The default base CSS is designed for 360x640 resolution with Nokia Green Theme. 
Everything different from this, i.e. 240x320 resolutions or other theme need to be 
implemented as an nokia base extension. 

This folder is the WRT Framework Build System. We will talk more about it in the next section.
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
THE GUARANA_UI BUILD SYSTEM
 
The library has an automated build system that makes packaging process easy and fast. This 
optimized the production version concatenating and minifying all CSS and javascript files 
in a single one file. After this we have a minimized and simplified version for the Framework. 
To build GuaranaUI, use the following commands. An important point is that the Apache Ant Tool 
must be configured:
 
     $ cd build
     $ ant
 
The build output is a folder Guarana, the structure is detailed:

1. demos/

This includes a demo for each component available in the Framework.

2. lib/

This file includes all javascript componentes implementation and jQuery.

3. themes/themeroller/

The Themeroller CSS Theme, according the theme setted in the build.

4. themes/nokia/base/

The Nokia base CSS File. The default base CSS is designed for 360x640 resolution with Nokia Green Theme. Everything different from this, i.e. 240x320 resolutions or other theme need to be implemented as an nokia base extension. We will talk more about it in next item.

5. themes/Nokia/<theme>/<resolution>

custom.css: Here we have a extension for a specific theme and resolution. For example if you are building a library version for Red theme and 240x320 resolution, we we have the CSS adjustiments for this theme and resolution here.

The default configuration for the framework is 360x640 resolution using Nokia Green Theme. Developer can build library versions for others resolutions and themes available. To generate this use the following command:

$ cd build
 
$ ant -Dresolution=<resolution> -Dtheme=<theme>

The resolution available in this version is 360x640, used by N97 and 5800 for example, and 240x320, very common resolution for non-touch devices. The themes supported at this time is the default green theme and red, this one only available for 360x640. We will have more themes supported in next release.

For example, to generate the red theme version for N97 device (360x640), you must type:

$ cd build
 
$ ant -Dresolution=360x640 -Dtheme=red
Additionally, developer can build a customized version including only a set of components. For example, to generate a custom version including only accordion and button components, you must type:

$ cd build
 
$ ant -Dcomponents=accordion_button
IMPORTANT! After the build process, please copy lib and themes folders to your widget.

IMPORTANT! If you are building a version for Maemo5 you need to add -Ddemofolder=maemo5 param in your command build line.

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
THE GuaranaUI DOCUMENTATION

http://www.forum.nokia.com/GuaranaUI

--------------------------------------------------------------------------------