NAME

EWS::htmldep.pm - an object-oriented class providing backward compatablility for applications using DEPRECATED HTML 4.01 entities.


SYNOPSIS

 use EWS::htmldep;

 $html = new EWS::htmldep(-debug => 0);

 ...

DESCRIPTION

EWS::htmldep extends the EWS::htmlout class providing backward compatablility for applications using DEPRECATED HTML 4.01 entities not provided by EWS::htmlout.

VERSION

This is version 1.0 of EWS::htmldep.

PUBLIC METHODS

new

$html = new EWS::htmldep(%parameters);

or

$html = EWS::htmldep->new(%parameters);

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      returns a blessed reference to a new htmldep object.

    parameters are of the form:

      -arg => value

    acceptable values are:
      -debug      => 1 = debug messages
      -htmlformat => 1 = html format, else console format
      -timestamp  => 1 = timestamp display line messages
      -type       => 0 = console output (default)
                     1 = output to file only
                     2 = output to console and file (log messages)
      -end        => string to check for in input stream to end program
                        (default = 'exit')
      -file       => name of file for output (type = 1 or 2).
                        (default = /dev/null)

DEPRECATED METHODS

Global structure tokens

Html

Output HTML token

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -lang    = specify the language for the value of the content attribute.
      -dir     = text direction.
      -version = specifies which HTML DTD version governs the current document.

Document Body Tokens

Body - EndBody

Output HTML body token

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onload      = on load action.
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -onunload    = on unload action.
      -style       = inline style information
      -title       = element title

Text - Paragraphs, Lines and Phrases

BR

Outputs the HTML BR token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
          -clear       = specifies where the next line should appear
      -id          = id name
      -style       = inline style information
      -title       = element title

Lists

LI

Output DEPRECATED LI entities.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
      -compact = TRUE | FALSE.
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -start   = starting number.
      -style       = inline style information
      -title       = element title
      -type    = numbering type.
      -value   = current list item.

OL

Output HTML OL token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -type    = numbering type.
                   1 | a | A | i | I.
      -start   = starting number.
      -value   = current list item.
      -compact = TRUE | FALSE.

UL

Output HTML UL token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -type    = numbering type.
                   1 | a | A | i | I.
      -value   = current list item.
      -compact = TRUE | FALSE.

Tables

Caption

Output HTML CAPTION token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -align     = alignment.
                     LEFT | CENTER | RIGHT.

Table

Output HTML TABLE token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -align       = alignment.
          -bgcolor     = background color.
      -border      = frame width around table.
      -cellpadding = space around each cell
      -cellspacing = space around the contained (outtermost) cells
      -class       = class name
      -dir         = text direction
      -frame       = parts of frame to render.
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -padding     = padding within cells.
      -rules       = rulings between rows and columns.
      -spacing     = spacing between cells.
      -style       = inline style information
      -summary     = purpose structure (for speech output).
      -title       = element title
      -width       = Table width.

TD

Output HTML TD token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

          -bgcolor   = background color.
      -width     = Table header width.
      -height    = Table header height.
      -align     = alignment.
                     LEFT | CENTER | RIGHT.
      -valign    = vertical alignment.
      -rowspan   = number of rows spanned by cell.
      -colspan   = number of columns spanned by cell.
      -axis      = groups of related headers.
      -headers   = id's for header cells.
      -scope     = scope covered by header cells.
      -nowrap    = turn off wrapping.

TH

Output HTML TH token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

          -bgcolor   = background color.
      -width     = Table header width.
      -height    = Table header height.
      -align     = alignment.
                     LEFT | CENTER | RIGHT.
      -valign    = vertical alignment.
      -rowspan   = number of rows spanned by cell.
      -colspan   = number of columns spanned by cell.
      -axis      = groups of related headers.
      -headers   = id's for header cells.
      -scope     = scope covered by header cells.
      -nowrap    = turn off wrapping.

TR

Output HTML TR token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -align       = horiz. alignment.
          -bgcolor     = background color.
      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title
      -valign      = vertical alignment.
      -width       = Table width.

Objects and Images

Applet - EndApplet

Output HTML Applet

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -alt         = alternative text
          -align       = horizontal alignment
      -archive     = space separated archive list
      -class       = class name
      -codebase    = base URI for class, data, archive
      -code        = class file
      -data        = reference to object's data.
      -declare     = declare but don't instantiate flag.
      -dir         = text direction
      -height      = override height
      -hspace      = horizontal gutter
      -id          = id name
      -lang        = language information
      -name        = assigns a name to the image map for usemap.
      -object      = serialized applet file
      -standby     = message to show while loading
      -style       = inline style information
      -tabindex    = position in tabbing order.
      -title       = element title
      -type        = content type for data
      -width       = override width
      -vspace      = vertical gutter

Alignment, Font Styles and Horizontal Rules

BaseFont

Output HTML BaseFont

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -id     = document-wide unique id
      -size   = size value.
      -color  = text color
      -face   = comma separated list of font names

Center

Output HTML center token

    Enter:
      none.
    Exit:
      none.

EndCenter

Output HTML center end token

    Enter:
      none.
    Exit:
      none.

Font

Output HTML font

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -size   = size value.
      -face   = face name.
      -color  = character color.

EndFont

Output HTML end font token.

    Enter:
      none.
    Exit:
      none.

HR

Output HTML HR token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -align       = LEFT | CENTER | RIGHT.
      -class       = class name
      -color       = Foreground color.
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -noshade     = TRUE | FALSE.
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -size        = size.
      -style       = inline style information
      -title       = element title
      -width       = Width in percent.

S - EndS

Output HTML S

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title

Strike - EndStrike

Output HTML Strike

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title

U - EndU

Output HTML U

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title

Forms

FieldSet

Output HTML FIELDSET token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -accesskey   = accessibility key character
          -align       = horizontal alignment
      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title

Legend - EndLegend

Output HTML LEGEND token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -accesskey   = accessibility key character
          -align       = horizontal alignment
      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title

Scripts

Script

Output HTML SCRIPT token.

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -charset = char encoding of linked resource
      -defer   = UA may defer execution of script
      -lang    = text language
      -src     = URI for an external script
      -type    = content type of script language

PUBLIC ATTRIBUTES

Revision

The Revision method returns the revision number of htmldep.pm:

      $revision = $htmldep->Revision;

    Enter:
      none.
    Exit:
      current revision string.

Version

The Version method returns the version number of htmldep.pm:

      $version = $htmldep->Version;

    Enter:
      none.
    Exit:
      current version string.

PRIVATE ENTITY METHODS

Alignment, Font Styles and Horizontal Rules

_s

Output HTML S parameters

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title

_strike

Output HTML Strike parameters

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title

_u

Output HTML U parameters

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -class       = class name
      -dir         = text direction
      -id          = id name
      -lang        = language information
      -onclick     = occurs when the pointing device button is clicked
      -ondblclick  = occurs when the pointing device button is double clicked
      -onkeydown   = occurs when a key is pressed down over an element
      -onkeypress  = occurs when a key is pressed and released over an element
      -onkeyup     = occurs when a key is released over an element
      -onmousedown = occurs when the pointing device button is pressed over an element
      -onmousemove = occurs when the pointing device is moved while it is over an element
      -onmouseout  = occurs when the pointing device is moved away from an element
      -onmouseover = occurs when the pointing device is moved onto an element
      -onmouseup   = occurs when the pointing device button is released over an element
      -style       = inline style information
      -title       = element title

PRIVATE METHODS

_BGColor

Process DEPRECATED HTML -bgcolor parameter

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

          -bgcolor = sets the background color for the document body or table cells

_Body

Output DEPRECATED HTML body parameters

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -background = path to background image.
      -bgcolor    = background color
      -text       = text color code.
      -link       = link color code.
      -vlink      = vlink color code.
      -alink      = alink color code.

_Clear

Process DEPRECATED HTML -clear parameter

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

          -clear       = specifies where the next line should appear

_ColorFace

Process -color, -face

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -color = text color
      -face  = comma separated list of font names

_Version

Process -version

    Enter:
      %parameters = parameter hash (see below).
    Exit:
      none.

    parameters are of the form:

      -arg => value

    acceptable values are:

      -version = specifies which HTML DTD version governs the current document.

DEPENDENCIES

EWS::htmldep is dependent upon the following support modules:

EWS::htmlout

EWS::htmlout is the base class from which EWS::htmldep is derived. It is an object-oriented class which provides HTML 4.01 methods.

AVAILABILITY

EWS::htmldep is available at

AUTHOR

Jay Wheeler, EarthWalk Software.

COPYRIGHT

EWS::htmldep is copyright © 2002. EarthWalk Software.

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

This module 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA