Text::Wigwam version 0.01
========================

INSTALLATION

Before Wigwam can be installed, unpack the tarball and cd to the extracted
folder:

   tar -zxf Text-Wigwam-yyyy-mm-dd.tgz
   cd Text-Wigwam-yyyy-mm-dd

Now you must choose to install it globally for everyone's use, or locally in
your home directory.

GLOBAL INSTALL (requires root priveledges)

To install this module for everyone's use, extract the tarball and cd to the
extracted folder:

Build the type the following:

   perl Makefile.PL
   make
   make test
   su root -c "make install"

This installs  the files from this package's lib folder into your Perl
library. No other files are installed.

LOCAL INSTALL

This section explains how to install Wigwam in your home directory on a Linux
machine - it worked for me, although the specifics may differ from machine to
machine.

   perl Makefile.PL PREFIX=~/myperl
   make
   make test
   make install

Now you'll probably have to add this location to your path, perhaps by typing
something similar to the following at the bash prompt:

export PERL5LIB=~/myperl/lib/perl5/site_perl/5.8.6

This line can be added to your .bash_profile for persistence.

Once properly installed, the following line will not produce an error:

perl -e 'use Text::Wigwam'

OPTIONAL STUFF

You may choose to use some of the other files included in this distribution by
manually copying them to the appropriate locations. In particular, see the
files within the www folder.

DEPENDENCIES

Scalar::Util (version 1.08 or higher)
File::Spec

Both are standard Perl modules as of 5.8.0, so you probably have them already.

This module requires no other modules or libraries other than those listed
above, although some Wigwam modules may. These modules should (or will
eventually) contain their own pod docs. In any event, they will not be
documented here. 


GETTING STARTED

perldoc Text::Wigwam::Tutorials::Basics

perldoc Text::Wigwam

For help with directives, see:

  perldoc Text::Wigwam::Library::xxx

  where xxx is one of: Assignment, Iterators, Character, Comparators,
   Conditionals, Datatype, Debug, Math, Misc, Procedure, Sets, Struct, System,
   or Time

TOOLS

This distribution only contains one useful script at this time,
www/cgi-bin/wigwam.launcher.pl. It's primary purpose is to be invoked by the
Apache web server via SSI or mod_rewrite (see the script itself for more
details). Once invoked by Apache, it passes the requested document to Wigwam
where it is parsed and output to the client's browser. The script can also be
invoked from the command line to parse a single template. At the very least,
it serves as a model for writing Wigwam scripts that take advantage of its
debugging capabilities.

COMPATIBILITY

We do not track versions as of yet - everything will remain at version 0.01
until we are confident that the specifications are stable in the sense that
future modifications will remain backwards compatible.

We expect to introduce spec changes to the user interface in future releases
which are not likely to be backwards compatible. Contrarily, the template,
module, and plug-in specifications are not likely to change as those specs have
remained relatively unchanged for quite some time. 

FEEDBACK

Feedback is much appreciated. We could use some real-world advice as we
approach the final stages of development. We'd also be interested in hearing
what Wigwam is being used for out in the field (or why it's not).

Daniel Johnston, E<lt>djohnston@cpan.orgE<gt>
Scot Woodward, E<lt>wingnut@cpan.orgE<gt>

TO DO

- Rethink the whole configuration tag mechanism
- Add some persistence tests
- Command line parser tool (once the interface stabilizes)


KNOWN BUGS



COPYRIGHT AND LICENCE

Copyright (C) 2004-2007 Daniel Johnston & Scot Woodward

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

