Sean Campbell > HTML-DWT-Simple > HTML::DWT::Simple

Download:
HTML-DWT-Simple-1.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.02   Source  

NAME ^

HTML::DWT::Simple - DreamWeaver HTML Template Module (Simple)

SYNOPSIS ^

  use HTML::DWT::Simple;
  
  $template = new HTML::DWT::Simple(filename => "file.dwt");    
  %dataHash = (
               doctitle => 'DWT Generated',
               leftcont => 'some HTML content here'     
               );  
  $template->param(%dataHash);
  $html = $template->output();

DESCRIPTION ^

A perl module designed to parse a simple HTML template file generated by Macromedia Dreamweaver and replace fields in the template with values from a CGI script.

METHODS ^

new()

  new HTML::DWT("file.dwt");

  new HTML::DWT(
                filename => "file.dwt",
                associate => $q,
               );

Creates and returns a new HTML::DWT object based on the Dreamweaver template 'file.dwt' (can specify a relative or absolute path). The Second instance is recommended, although the first style is still supported for backwards compatability with versions of HTML::DWT before 2.05.

associate: The associate option allows the template to inherit parameter values from other objects. The object associated with the template must have a param() method which works like HTML::DWT::Simple's param(). Both CGI and HTML::Template fit this profile. To associate another object, create it and pass the reference scalar to HTML::DWT::Simple's new() method under the associate option (see above).

param()

  $template->param();

  $template->param('doctitle');

  $template->param(
                  doctitle => '<title>DWT Generated</title>',
                  leftcont => 'Some HTML content here'
                  );

Takes a hash of one or more key/value pairs, where each key is a named area of the template, and the associated value is the HTML content for that area. This method returns void (HTML substitiutions are stored within the object awaiting output()).

If called with a single paramter--this parameter must be a valid field name--param() returns the value currently set for the field, or undef if no value has been set.

If called with no parameters, param() returns a list of all field names.

NOTE: All Dreamweaver templates store the HTML page's title in a field named 'doctitle'. HTML::DWT::Simple will accept a raw title (without <title> tags) and will add the appropriate tags if the content of the 'doctitle' field should require them.

This is a HTML::Template compatible method.

output()

  $template->output();
  
  $template->output(print_to => \*STDOUT);

Returns the parsed template and its substituted HTML for output. The template must be filled using either fill() or param() before calling output().

print_to: Alternativly, by passing a filehandle reference to output()'s print_to option you may output the template content directly to that filehandle. In this case output() returns an undefined value.

This is a HTML::Template compatible method.

DIAGNOSTICS ^

Template File $file not opened:

(F) The template file was not opened properly. This message is stored in $HTML::DWT::Simple::errmsg

BUGS ^

No known bugs, but if you find any please contact the author.

AUTHOR ^

S.D. Campbell, whytwolf@spots.ab.ca

SEE ALSO ^

perl(1), HTML::Template, HTML::DWT, HTML::LBI.

LICENSE ^

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

syntax highlighting: