README for Portal::Example
Created by Xperience, Inc. (admin@pcxperience.com)
12/04/2000

The Portal::Example Perl Module(s) is the implementation of the Example
Application as implemented using Perl Modules.  It is designed to plug into the
Portal application.


Installation is as usual:
  tar xvzf libpcxportal-example-{VERSION}.tar.gz
  cd libpcxportal-example-{VERSION}
  perl Makefile.PL
  make
  make test
  su (if not root)
  make install

  This installs the Perl Modules that make up the application.

  tar xvzf pcxportal-example-{VERSION}.tar.gz
  cd pcxportal-example-{VERSION}
  cd install
  ./install.pl


  If the application has custom images that it wants to reference, they go in 
  the install/files/images directory along with the icon image for the application.

  If the application has JavaScript or static HTML files they need to access,
they must be in install/files/js.

  If the application has CSS files they need to access, they must be in 
install/files/css.

  If the application has any database creation files/scripts they will use 
whenever setting up a company in the portal, they must be in install/files/install.

  These custom files will automatically be copied over when install.pl is run
and will be placed in web server root/portal/images/Example, /portal/js/Example
and /portal/install/Example so that the App has access to them when it runs.

  If the install.pl script is going to configure other things (cron entries, 
etc.) they should be put in the files directory and the install.pl script should
be updated to handle them.

  The Portal now provides a cron directory which should be the install 
destination for any cron scripts the app wants installed.  Do a symlink to them
from the /etc/cron.daily, /etc/cron.hourly directories or just point to them
in the crontab file.

  The Portal now has a ColorScheme implementation which provides for creating
dynamic CSS entries that are customizable on a per application basis.  See the
Portal's documentation on the ColorScheme file format (xml based).  Put your
colorScheme files in install/files/colorSchemes and the installer will pick
them up.  You will need to run 
'/usr/lib/pcx_portal/colorSchemeInstall.pl --appname AppName' 
to install the colorSchemes into the Portal.  Substitute your app's name
for AppName.

