Alien::GvaScript(3)

NAME
Alien::GvaScript - Gva extension to the prototype javascript framework

SYNOPSIS
  use Alien::GvaScript;
  ...
  $path    = Alien::GvaScript->path();
  ...
  Alien::GvaScript->install( $my_destination_directory );

DESCRIPTION
GvaScript (pronounce "gee-vascript") is a javascript framework born in Geneva, Switzerland ("GVA" is the IATA code for Geneva Cointrin International Airport).

It is built on top of the prototype object-oriented javascript framework (<http://www.prototypejs.org>) and offers a number of extensions and widgets, such as keymap handling, application-specific events, autocompletion on input field, tree navigation, and forms with autofocus and repeated sections. These functionalities are described in separate documentation pages (see Alien::GvaScript::Intro).

GvaScript is distributed using Perl tools, but the actual content of the library is pure javascript; hence its location in the Alien namespace (see the Alien manifesto).

GvaScript runtime library does not need Perl; you can integrate it in any other Web programming framework. Perl is only needed for developers who want to modify GvaScript sources and recreate a distribution package.

INSTALLATION

  With usual Perl CPAN tools
Install "Alien::GvaScript" just as any other CPAN module. Then you can write

  perl -MAlien::GvaScript -e "Alien::GvaScript->install('/my/web/directory')"

to copy the dthml files to your Web server.

  Without Perl tools
Unzip and untar this distribution, then grab the files in lib/Alien/GvaScript/lib subdirectory and copy them to your Web server.

  Note about the documentation
The documentation sources are written in Perl's "POD" format. An HTML version is automatically generated and included in this distribution, under the lib/Alien/GvaScript/html directory; this documentation uses GvaScript's treeNavigator widget for easier browsing.

If this distribution is installed as a CPAN module, then another HTML version will probably be generated automatically by your CPAN tool (but without the treeNavigator widget).

METHODS

  path
Returns the directory where GvaScript files are stored.

  html
Returns the directory where GvaScript documentation is stored.

  install
Copies GvaScript files into the directory supplied as argument

AUTHORS
Laurent Dami, "<laurent.d...@etat.ge.ch>"

Mona Remlawi, "<mona.r...@etat.ge.ch>"

Jean_Christophe Durand

Sébastien Cuendet

BUGS
Please report any bugs or feature requests to "bug-alien-gvascript at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Alien-GvaScript>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT
You can find documentation for this module with the perldoc command.

    perldoc Alien::GvaScript

You can also look for information at:

•   AnnoCPAN: Annotated CPAN documentation

    <http://annocpan.org/dist/Alien-GvaScript>

•   CPAN Ratings

    <http://cpanratings.perl.org/d/Alien-GvaScript>

•   RT: CPAN's request tracker

    <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Alien-GvaScript>

•   Search CPAN

    <http://search.cpan.org/dist/Alien-GvaScript>

ACKNOWLEDGEMENTS
The packaging as an "Alien" module was heavily inspired from Alien::scriptaculous by Graham TerMarsch.

COPYRIGHT & LICENSE
Copyright 2007, 2008, 2009, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.