Section Intro: Powerstrip System Tags

THE META-HTML LANGUAGE REFERENCE MANUAL

Using Gnuplot

[TOC]

Dynamic Modules

Section Intro: Powerstrip System Tags

Powerstrip System Tags

Synopsis:

The following functions are used in the implementation of the PowerStrip System area (/System/*).

These functions are only useful to those persons who are adding functionality to the PowerStrip system itself, or who need to manipulate the underlying data structures and mechanisms of that system.

Commands:

basic-auth::powerstrip-login
defparam
ibis::initialize
ibis::package-get
ibis::package-parameters
ibis::parameter-input
ibis::standard-footer
ibis::standard-header

layout::clear-contents
layout::default-header
layout::initialize
layout::left-border
layout::page
layout::resolve-contents
layout::right-border

login::initialize
login::powerstrip-login
signon-required
site::admin-body-value
site::body-value
site::image
site::image-file

<basic-auth::powerstrip-login Simple

<defparam NAME DOCUMENTATION &key [TYPE] [VALUE] [CHOICES[]] Simple

Functions which allow the modification of a particular plugin's parameter set.

Each plugin which can be installed in the System area of IBIS may have a file in its top-level directory called default.params, which contain the parameters for that application as shipped by the manufacturer.

When such a file is present, the PowerStrip administrator can use the generic plugin parameter manipulation tools to modify the values.

<ibis::initialize Simple

Initialize the PowerStrip system. Should be called after defining any overriding variables for a specific page, such as layout::layout, etc.

<ibis::package-get PACKAGE Simple

Get the parameters for PACKAGE, storing them in PACKAGE.

<ibis::package-parameters PACKAGE INTO-ARRAY Simple

Get the parameters for PACKAGE into the variable named by INTO-ARRAY, a fully qualified variable name. Each element of the returned array is an alist.

<ibis::parameter-input PARAM-ALIST Simple

Create a form entry for editing PARAM-ALIST.

<ibis::standard-footer Simple

The corollary to ibis::standard-header.

<ibis::standard-header Simple

Insert the standard PowerStrip header, including the system site header, and inserting the contents of the variable IBIS::HEAD-PARAMS in the <HEAD> ... </HEAD> area.

Also see ibis::standard-footer.

<layout::clear-contents Simple

Discard any content that has been previously assigned to the left border, right border, or page contents areas. Such content was presumably prepared using layout::left-border, layout::page, or layout::right-border.

Please see layout::initialize for more information.

<layout::default-header Simple

Produces the HTML which implements the appropriate table structure for the type of layout that you have specified by setting the variable layout::layout. Please see layout::initialize.

<layout::initialize &key [DEBUGGING] [DEBUGGING-OUTPUT] Simple

Call layout::initialize after loading this package, and after setting the variables which define the type of layout that you would like. Those variables are:

LAYOUT::LAYOUT
One of "plain", "bordered-left", "bordered-right", or "bordered-right-and-left".
LAYOUT::LEFT-BORDER-WIDTH
An absolute number which determines the width of the left border. Only has an effect when the layout actually contains a left border.
LAYOUT::RIGHT-BORDER-WIDTH
An absolute number which determines the width of the right border. Only has an effect when the layout actually contains a right border.

Then, in the page itself, you can use:

          <layout::page> html </layout::page>
   <layout::left-border> html </layout::left-border>
  <layout::right-border> html </layout::right-border>

Those tags place the HTML that you specify in the indicated region of the page.

Finally, make sure that you call layout::resolve-contents before the page returns. A complete invocation might look like:

 <defvar layout::layout bordered-left>
 <layout::initialize>
 <layout::default-header>
<p>
 <layout::page>
   This is in the page.
 </layout::page>
<p>
 <layout::left-border>
   This is in the left border.
 </layout::left-border>
<p>
 <layout::resolve-contents>

<layout::left-border body </layout::left-border> Complex

Append BODY to the portion of the resultant page which appears in the left border. Please see layout::initialize for more information.

<layout::page body </layout::page> Complex

Append BODY to the portion of the resultant page which appears between the left and the right borders. Please see layout::initialize for more information.

<layout::resolve-contents Simple

Resolve the contents of the page according to the layout that you have specified by setting the variable layout::layout. Please see layout::initialize.

<layout::right-border body </layout::right-border> Complex

Append BODY to the portion of the resultant page which appears in the right border. Please see layout::initialize for more information.

<login::initialize Simple

Place before including the header, if, and only if, this page is to contain the login form generated by <login::powerstrip-login>.

<login::powerstrip-login CONTINUE-LINK Simple

<signon-required Simple

This enforces a PowerStrip login before pages which contain sensitive information may be viewed.

<site::admin-body-value TAG Simple

<site::admin-body-value text> ==> text="#000000" or nothing.

<site::body-value TAG Simple

<site::body-value text> ==> text="#000000" or nothing.

<site::image NAME Simple

Returns the full web-relative pathname of the image named by NAME.

 <site::image foo> ==> /System/images/site/foo.gif

<site::image-file URL Simple

Return the full pathname of the file representing the image in URL.

Edit Section
Function Index
Variable Index