UText Installation

Files

Last version (Jan 26th, 2013): UText v. 1.2.08 (for Windows)

The files for Windows are the same, the difference being only in line breaks.

Requirements

This software requires Perl 5.8.8 or above. Any standard installation already contains the required modules. (Modules: URI::URL, Tie::File, File::Temp, POSIX, Time::Local, File::Spec, File::Basename, Cwd; in the UText Shell also Term::ReadLine

Additional modules (see below Installtion Notes):

• OpenOffice::OODoc is required by the optional add-in module odt, not required if you do not load this add-in.
• A readline library is required to get command history functionality at the UText Shell. The shell can be used without one.

Install Steps

1. Download and unpack the installation .zip file.
2. Move the extracted folder UText to your Perl library folder (for example /usr/lib/perl5 on Linux and Macintosh or C:\Perl\lib on Windows).
3. Now the class UText is available for Perl scripts and there is a UText shell utshell.pl for interactive sessions.

Installation Notes

It is recomended to put a link to utshell.pl in the path. Example (Unix, assuming ~/bin is in PATH):

cd ~/bin
ln -s /usr/lib/perl5/UText/utshell.pl ut

The UText Shell uses the readline library to provide command history. To use this functionality, your Perl installation must have a readline package installed. See utshell.pl.

If you want to use the odt add-in module, the Perl module for Open-Office must be installed. See odt add-in.

Sample Shell usage

The code entered by the user is preceded by the UText Shell prompt "ut>", the rest is output by UText.

~$ cd [samples directory]
~$ [UText directory]/utshell.pl
ut> read geneaweb.utl
ut> select <family do ln v name
Clark
Smith
Smith
Smithereen
Smithers
ut> save families.txt
Creating file families.txt
ut> .
~$ cat families.txt
Clark
Smith
Smith
Smithereen
Smithers

Sample Perl usage

use UText::UText;
$ut=new UText;
$ut->readfile('geneaweb.utl');
print $ut->foreach('<family','[v name][lf]');
$ut=undef;

There are some examples at the directory samples included in the distribution .zip file.

Next step: Quick Tour