bionic (3) wml::std::page.3.gz

Provided by: wml_2.0.12ds1-10build2_amd64 bug

NAME

       wml::std::page - Standard HTML Page Header and Footer

SYNOPSIS

        #use wml::std::page

        <page [attributes]>
        [<page_end>]

        <head>...</head>
        <title>...</title>

DESCRIPTION

       This include file provides the new "<page>" tag which is a advanced combination of the HTML "<body>" and
       "<head>" container tags. The idea is to provide complete header and footer tags via one single tag while
       providing new features like page indentation, easy title specification and setup of default values for
       the page colors.

ATTRIBUTES

       "title"
           This is a shorthand for the container tag "<title>". The value of this attribute is placed in the
           "<head>" section of the page, surrounded with the "<title>" tag.

       "indent"
           This sets the indentation level of the page in units of "<blockquote>"'s.  Default is no indentation.
           Setting "indent" to a value of N means the page is surrounded by N "<blockquote">> tags.  The
           attribute "indent=1" or "indent=2" usually provides the best readable layout.

       "background"
           This just corresponds to the same attribute of the "<body>" tag and sets the background image.  This
           is per default not used.

       "bgcolor"
           This just corresponds to the same attribute of the "<body>" tag and sets the background color.
           Default is "bgcolor="#ffffff"" (white).

       "text"
           This just corresponds to the same attribute of the "<body>" tag and sets the text color.  Default is
           "text="#000000"" (black).

       "link"
           This just corresponds to the same attribute of the "<body>" tag and sets the normal hyperlink color.
           Default is "text="#333399"" (medium blue).

       "alink"
           This just corresponds to the same attribute of the "<body>" tag and sets the color for activated
           hyperlinks. Default is "text="#9999ff"" (light blue).

       "vlink"
           This just corresponds to the same attribute of the "<body>" tag and sets the color for already
           visited hyperlinks. Default is "text="#000066"" (dark blue).

       "color"
           When setting "color="none"", the five previous attributes are not put into the "<body>" tag.

       "onload"
           This just corresponds to the same attribute of the "<body>" tag and sets a JavaScript even handler
           which is activated after page was loaded.  This is per default not used.

       "info"
           This automatically puts a "<info style=meta>" tag into the "<head>" section of the page. See
           wml::std::info(3) for more details.

       "slices"
           This enables the creating of three slices: "WML_STDPAGE_HEAD", "WML_STDPAGE_BODY" and
           "WML_STDPAGE_FOOT". These can be used later in Pass 9 (Slice) for cutting out parts of the page.

       :html:ATTR=STR :body:ATTR=STR
           The ``ATTR=STR'' pairs are passed along to the "<html>" and "<body>" HTML tags.

OTHER COMMANDS

       This module implements two new macros, called "<title>"..."</title>" and "<head>"..."</head>". The first
       one defines the title of the page, and the second appends its body into the HEAD section of the HTML
       documents.  Its main purpose is to add meta-tags, either directly or with the help of wml::std::info(3).

AUTHOR

        Ralf S. Engelschall
        rse@engelschall.com
        www.engelschall.com

REQUIRES

        Internal: P1, P2, P5
        External: --

SEE ALSO

       HTML "<head>", "<body>" and "<title>" tags; wml::std::info(3)