.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "wml::std::page 3"
.TH wml::std::page 3 "2020-11-29" "EN Tools" "EN Tools"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
wml::std::page \- Standard HTML Page Header and Footer
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #use wml::std::page
\&
\& <page [attributes]>
\& [<page_end>]
\&
\& <head>...</head>
\& <title>...</title>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This include file provides the new \f(CW\*(C`<page>\*(C'\fR tag which is a advanced
combination of the \s-1HTML\s0 \f(CW\*(C`<body>\*(C'\fR and \f(CW\*(C`<head>\*(C'\fR 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.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .IP """title""" 4
.el .IP "\f(CWtitle\fR" 4
.IX Item "title"
This is a shorthand for the container tag \f(CW\*(C`<title>\*(C'\fR. The value of
this attribute is placed in the \f(CW\*(C`<head>\*(C'\fR section of the page,
surrounded with the \f(CW\*(C`<title>\*(C'\fR tag.
.ie n .IP """indent""" 4
.el .IP "\f(CWindent\fR" 4
.IX Item "indent"
This sets the indentation level of the page in units of
\&\f(CW\*(C`<blockquote>\*(C'\fR's.  Default is no indentation. Setting \f(CW\*(C`indent\*(C'\fR to a
value of N means the page is surrounded by N \f(CW\*(C`<blockquote\*(C'\fR>> tags.
The attribute \f(CW\*(C`indent=1\*(C'\fR or \f(CW\*(C`indent=2\*(C'\fR usually provides the best readable
layout.
.ie n .IP """background""" 4
.el .IP "\f(CWbackground\fR" 4
.IX Item "background"
This just corresponds to the same attribute of the \f(CW\*(C`<body>\*(C'\fR tag and
sets the background image.  This is per default not used.
.ie n .IP """bgcolor""" 4
.el .IP "\f(CWbgcolor\fR" 4
.IX Item "bgcolor"
This just corresponds to the same attribute of the \f(CW\*(C`<body>\*(C'\fR tag and
sets the background color.  Default is \f(CW\*(C`bgcolor="#ffffff"\*(C'\fR (white).
.ie n .IP """text""" 4
.el .IP "\f(CWtext\fR" 4
.IX Item "text"
This just corresponds to the same attribute of the \f(CW\*(C`<body>\*(C'\fR tag and
sets the text color.  Default is \f(CW\*(C`text="#000000"\*(C'\fR (black).
.ie n .IP """link""" 4
.el .IP "\f(CWlink\fR" 4
.IX Item "link"
This just corresponds to the same attribute of the \f(CW\*(C`<body>\*(C'\fR tag and
sets the normal hyperlink color. Default is \f(CW\*(C`text="#333399"\*(C'\fR (medium blue).
.ie n .IP """alink""" 4
.el .IP "\f(CWalink\fR" 4
.IX Item "alink"
This just corresponds to the same attribute of the \f(CW\*(C`<body>\*(C'\fR tag and
sets the color for activated hyperlinks. Default is \f(CW\*(C`text="#9999ff"\*(C'\fR (light
blue).
.ie n .IP """vlink""" 4
.el .IP "\f(CWvlink\fR" 4
.IX Item "vlink"
This just corresponds to the same attribute of the \f(CW\*(C`<body>\*(C'\fR tag and
sets the color for already visited hyperlinks. Default is \f(CW\*(C`text="#000066"\*(C'\fR
(dark blue).
.ie n .IP """color""" 4
.el .IP "\f(CWcolor\fR" 4
.IX Item "color"
When setting \f(CW\*(C`color="none"\*(C'\fR, the five previous attributes are not put
into the \f(CW\*(C`<body>\*(C'\fR tag.
.ie n .IP """onload""" 4
.el .IP "\f(CWonload\fR" 4
.IX Item "onload"
This just corresponds to the same attribute of the \f(CW\*(C`<body>\*(C'\fR tag and
sets a JavaScript even handler which is activated after page was loaded.  This
is per default not used.
.ie n .IP """info""" 4
.el .IP "\f(CWinfo\fR" 4
.IX Item "info"
This automatically puts a \f(CW\*(C`<info style=meta>\*(C'\fR tag into the
\&\f(CW\*(C`<head>\*(C'\fR section of the page. See \fBwml::std::info\fR\|(3) for more details.
.ie n .IP """slices""" 4
.el .IP "\f(CWslices\fR" 4
.IX Item "slices"
This enables the creating of three slices: \f(CW\*(C`WML_STDPAGE_HEAD\*(C'\fR,
\&\f(CW\*(C`WML_STDPAGE_BODY\*(C'\fR and \f(CW\*(C`WML_STDPAGE_FOOT\*(C'\fR. These can be used later in
Pass 9 (Slice) for cutting out parts of the page.
.IP ":html:\fI\s-1ATTR\s0\fR=\fI\s-1STR\s0\fR :body:\fI\s-1ATTR\s0\fR=\fI\s-1STR\s0\fR" 4
.IX Item ":html:ATTR=STR :body:ATTR=STR"
The ``\fI\s-1ATTR\s0\fR=\fI\s-1STR\s0\fR'' pairs are passed along to the \f(CW\*(C`<html>\*(C'\fR
and \f(CW\*(C`<body>\*(C'\fR \s-1HTML\s0 tags.
.SH "OTHER COMMANDS"
.IX Header "OTHER COMMANDS"
This module implements two new macros, called
\&\f(CW\*(C`<title>\*(C'\fR...\f(CW\*(C`</title>\*(C'\fR
and \f(CW\*(C`<head>\*(C'\fR...\f(CW\*(C`</head>\*(C'\fR. The first one defines the
title of the page, and the second appends its body into the \s-1HEAD\s0 section
of the \s-1HTML\s0 documents.  Its main purpose is to add meta-tags, either
directly or with the help of \fBwml::std::info\fR\|(3).
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 3
\& Ralf S. Engelschall
\& rse@engelschall.com
\& www.engelschall.com
.Ve
.SH "REQUIRES"
.IX Header "REQUIRES"
.Vb 2
\& Internal: P1, P2, P5
\& External: \-\-
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1HTML\s0 \f(CW\*(C`<head>\*(C'\fR, \f(CW\*(C`<body>\*(C'\fR and \f(CW\*(C`<title>\*(C'\fR tags;
\&\fBwml::std::info\fR\|(3)