5,576
edits
Changes
From SME Server
Jump to navigationJump to searchno edit summary
== NAME ==
=== NAME ===
esmith::cgi - Useful CGI routines for e-smith server and gateway
esmith::cgi - Useful CGI routines for e-smith server and gateway
In a root terminal you can do the command below if you want to display the up-to-date content
In a root terminal you can do the command below if you want to display the up-to-date content
perldoc esmith::esmith::cgi
perldoc esmith::esmith::cgi
== VERSION ==
=== VERSION ===
This file documents "esmith::cgi" version 1.4.0
This file documents "esmith::cgi" version 1.4.0
== SYNOPSIS ==
=== SYNOPSIS ===
use esmith::cgi;
use esmith::cgi;
== DESCRIPTION ==
=== DESCRIPTION ===
This module contains a collection of useful routines for working with the e-smith manager’s CGI interface. =head1 WEB PAGE HEADER GENERATION ROUTINES
This module contains a collection of useful routines for working with the e-smith manager’s CGI interface. =head1 WEB PAGE HEADER GENERATION ROUTINES
=== genHeaderNonCacheable($q, $confref, $title) ===
==== genHeaderNonCacheable($q, $confref, $title) ====
=== genHeaderCacheableNoPasswordCheck($q, $confref, $title) ===
==== genHeaderCacheableNoPasswordCheck($q, $confref, $title) ====
=== genHeaderCacheableNoPasswordCheck($q, $confref, $title) ===
==== genHeaderCacheableNoPasswordCheck($q, $confref, $title) ====
=== genHeader($q, $confref, $title, $expiry, $checkpassword) ===
==== genHeader($q, $confref, $title, $expiry, $checkpassword) ====
=== genNavigationHeader($q) ===
==== genNavigationHeader($q) ====
=== genNoframesHeader($q) ===
==== genNoframesHeader($q) ====
=== genHeaderStartHTML($q) ===
==== genHeaderStartHTML($q) ====
== WEB PAGE FOOTER GENERATION ROUTINES ==
=== WEB PAGE FOOTER GENERATION ROUTINES ===
=== genFooter($q) ===
==== genFooter($q) ====
=== genFooterNoCopyright($q) ===
==== genFooterNoCopyright($q) ====
=== genNavigationFooter($q) ===
==== genNavigationFooter($q) ====
=== genNoframesFooter($q) ===
==== genNoframesFooter($q) ====
== FONT ROUTINES ==
=== FONT ROUTINES ===
=== curFont() ===
==== curFont() ====
Returns the preferred font faces eg. "Verdana, Arial, Helvetica, sans-serif". This should be done by CSS now, so if you’re calling this, you shouldn’t be.
Returns the preferred font faces eg. "Verdana, Arial, Helvetica, sans-serif". This should be done by CSS now, so if you’re calling this, you shouldn’t be.
== TABLE GENERATION ROUTINES ==
=== TABLE GENERATION ROUTINES ===
=== genCell($q, $text) ===
==== genCell($q, $text) ====
=== genDoubleCell($q, $text); ===
==== genDoubleCell($q, $text); ====
Generates a cell which spans two columns, containing the text specified.
Generates a cell which spans two columns, containing the text specified.
=== genSmallCell($q, $text, $type, $colspan) ===
==== genSmallCell($q, $text, $type, $colspan) ====
Generates a cell with "small" text (font size is 80%). "$type" can be one of: "normal" : creates <td class="sme-border"> cell "header" : creates <th class="sme-border"> cell
Generates a cell with "small" text (font size is 80%). "$type" can be one of: "normal" : creates <td class="sme-border"> cell "header" : creates <th class="sme-border"> cell
=== genSmallCellCentered($q, $text) ===
==== genSmallCellCentered($q, $text) ====
=== Generates a cell with "small" text (font size is 80%), centered. creates <td class="sme-border-center"> cell ===
==== Generates a cell with "small" text (font size is 80%), centered. creates <td class="sme-border-center"> cell ====
=== genSmallCellRightJustified($q, $text) ===
==== genSmallCellRightJustified($q, $text) ====
=== genSmallCellCentered($q, $text) ===
==== genSmallCellCentered($q, $text) ====
Generates a cell with "small" text (font size is 80%), right justified. creates <td class="sme-border-right"> cell
Generates a cell with "small" text (font size is 80%), right justified. creates <td class="sme-border-right"> cell
=== genSmallRedCell($q, $text) ===
==== genSmallRedCell($q, $text) ====
Generates a cell with "small" text (font size is 80%), left justified. creates <td class="sme-border-warning"> cell
Generates a cell with "small" text (font size is 80%), left justified. creates <td class="sme-border-warning"> cell
=== genTextRow($q, $text) ===
==== genTextRow($q, $text) ====
Returns a table row containing a two-column cell containing $text.
Returns a table row containing a two-column cell containing $text.
=== genButtonRow($q, $button) ===
==== genButtonRow($q, $button) ====
Returns a table row containing an empty first cell and a second cell containing a button with the value $button.
Returns a table row containing an empty first cell and a second cell containing a button with the value $button.
=== genNameValueRow($q, $fieldlabel, $fieldname, $fieldvalue) ===
==== genNameValueRow($q, $fieldlabel, $fieldname, $fieldvalue) ====
Returns a table row with two cells. The first has the text "$fieldlabel:" in it, and the second has a text field with the default value $fieldvalue and the name $fieldname.
Returns a table row with two cells. The first has the text "$fieldlabel:" in it, and the second has a text field with the default value $fieldvalue and the name $fieldname.
=== sub genWidgetRow($q, $fieldlabel, $popup) ===
==== sub genWidgetRow($q, $fieldlabel, $popup) ====
== STATUS AND ERROR REPORT GENERATION ROUTINES ==
=== STATUS AND ERROR REPORT GENERATION ROUTINES ===
=== genResult($q, $msg) ===
=== genResult($q, $msg) ===
Generates a "status report" page, including the footer
Generates a "status report" page, including the footer
=== genStateError($q, $confref) ===
==== genStateError($q, $confref) ====
Subroutine to generate "unknown state" error message.
Subroutine to generate "unknown state" error message.
== AUTHOR ==
=== AUTHOR ===
Mitel Networks Corporation
Mitel Networks Corporation
