.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Display 3"
.TH Display 3 "2001-10-24" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Slash::Utility::Display \- SHORT DESCRIPTION for Slash
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        use Slash::Utility;
\&        # do not use this module directly
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1LONG\s0 \s-1DESCRIPTION\s0.
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
.Sh "createSelect(\s-1LABEL\s0, \s-1DATA\s0 [, \s-1DEFAULT\s0, \s-1RETURN\s0, \s-1NSORT\s0, \s-1ORDERED\s0])"
.IX Subsection "createSelect(LABEL, DATA [, DEFAULT, RETURN, NSORT, ORDERED])"
Creates a drop-down list in \s-1HTML\s0.  List is sorted by default
alphabetically according to list values.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1LABEL\s0" 4
.IX Item "LABEL"
.PD
The name for the \s-1HTML\s0 entity.
.IP "\s-1DATA\s0" 4
.IX Item "DATA"
A hashref containing key-value pairs for the list.
Keys are list values, and values are list labels.
If an arrayref is passed, it is converted to a
hashref, where the keys and values are the same.
.IP "\s-1DEFAULT\s0" 4
.IX Item "DEFAULT"
Default value for the list.
.IP "\s-1RETURN\s0" 4
.IX Item "RETURN"
See \*(L"Return value\*(R" below.
.IP "\s-1NSORT\s0" 4
.IX Item "NSORT"
Sort numerically, not alphabetically.
.IP "\s-1ORDERED\s0" 4
.IX Item "ORDERED"
If an arrayref is passed, an already-sorted array reference of keys.
If non\-ref, then an arrayref of hash keys is created sorting the
hash values, alphabetically and case\-insensitively.
If \s-1ORDERED\s0 is passed in either form, then the \s-1NSORT\s0 parameter is ignored.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
If \s-1RETURN\s0 is true, the text of the list is returned.
Otherwise, list is just printed, and returns
true/false if operation is successful.
.Sp
If there are no elements in \s-1DATA\s0, just returns/prints nothing.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'select' template block.
.Sh "selectTopic(\s-1LABEL\s0 [, \s-1DEFAULT\s0, \s-1SECTION\s0, \s-1RETURN\s0])"
.IX Subsection "selectTopic(LABEL [, DEFAULT, SECTION, RETURN])"
Creates a drop-down list of topics in \s-1HTML\s0.  Calls \f(CW\*(C`createSelect\*(C'\fR.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1LABEL\s0" 4
.IX Item "LABEL"
.PD
The name for the \s-1HTML\s0 entity.
.IP "\s-1DEFAULT\s0" 4
.IX Item "DEFAULT"
Default topic for the list.
.IP "\s-1SECTION\s0" 4
.IX Item "SECTION"
Default section to take topics from.
.IP "\s-1RETURN\s0" 4
.IX Item "RETURN"
See \*(L"Return value\*(R" below.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
If \s-1RETURN\s0 is true, the text of the list is returned.
Otherwise, list is just printed, and returns
true/false if operation is successful.
.Sh "selectSection(\s-1LABEL\s0 [, \s-1DEFAULT\s0, \s-1SECT\s0, \s-1RETURN\s0, \s-1ALL\s0])"
.IX Subsection "selectSection(LABEL [, DEFAULT, SECT, RETURN, ALL])"
Creates a drop-down list of sections in \s-1HTML\s0.  Calls \f(CW\*(C`createSelect\*(C'\fR.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1LABEL\s0" 4
.IX Item "LABEL"
.PD
The name for the \s-1HTML\s0 entity.
.IP "\s-1DEFAULT\s0" 4
.IX Item "DEFAULT"
Default topic for the list.
.IP "\s-1SECT\s0" 4
.IX Item "SECT"
Hashref for current section.  If \s-1SECT\-\s0>{isolate} is true,
list is not created, but hidden value is returned instead.
.IP "\s-1RETURN\s0" 4
.IX Item "RETURN"
See \*(L"Return value\*(R" below.
.IP "\s-1ALL\s0" 4
.IX Item "ALL"
Boolean for including \*(L"All Topics\*(R" item.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
If \s-1RETURN\s0 is true, the text of the list is returned.
Otherwise, list is just printed, and returns
true/false if operation is successful.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'sectionisolate' template block.
.Sh "\fIselectSortcode()\fP"
.IX Subsection "selectSortcode()"
Creates a drop-down list of sortcodes in \s-1HTML\s0.  Default is the user's
preference.  Calls \f(CW\*(C`createSelect\*(C'\fR.
.IP "Return value" 4
.IX Item "Return value"
The created list.
.Sh "\fIselectMode()\fP"
.IX Subsection "selectMode()"
Creates a drop-down list of modes in \s-1HTML\s0.  Default is the user's
preference.  Calls \f(CW\*(C`createSelect\*(C'\fR.
.IP "Return value" 4
.IX Item "Return value"
The created list.
.Sh "selectThreshold(\s-1COUNTS\s0)"
.IX Subsection "selectThreshold(COUNTS)"
Creates a drop-down list of thresholds in \s-1HTML\s0.  Default is the user's
preference.  Calls \f(CW\*(C`createSelect\*(C'\fR.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1COUNTS\s0" 4
.IX Item "COUNTS"
.PD
An arrayref of thresholds \-> counts for that threshold.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
The created list.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'selectThreshLabel' template block.
.Sh "linkStory(\s-1STORY\s0)"
.IX Subsection "linkStory(STORY)"
The generic \*(L"Link a Story\*(R" function, used wherever stories need linking.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1STORY\s0" 4
.IX Item "STORY"
.PD
A hashref containing data about a story to be linked to.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
The complete <A \s-1HREF\s0 ...></A> text for linking to the story.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'linkStory' template block.
.Sh "pollbooth(\s-1QID\s0 [, \s-1NO_TABLE\s0, \s-1CENTER\s0])"
.IX Subsection "pollbooth(QID [, NO_TABLE, CENTER])"
Creates a voting pollbooth.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1QID\s0" 4
.IX Item "QID"
.PD
The unique question \s-1ID\s0 for the poll.
.IP "\s-1NO_TABLE\s0" 4
.IX Item "NO_TABLE"
Boolean for whether to leave the poll out of a table.
If false, then will be formatted inside a \f(CW\*(C`fancybox\*(C'\fR.
.IP "\s-1CENTER\s0" 4
.IX Item "CENTER"
Whether or not to center the tabled pollbooth (only
works with \s-1NO_TABLE\s0).
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
Returns the pollbooth data.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'pollbooth' template block.
.Sh "\fIcurrentAdminUsers()\fP"
.IX Subsection "currentAdminUsers()"
Displays table of current admin users, with what they are adminning.
.IP "Return value" 4
.IX Item "Return value"
The \s-1HTML\s0 to display.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'currentAdminUsers' template block.
.Sh "\fIhorizmenu()\fP"
.IX Subsection "horizmenu()"
Silly little function to create a horizontal menu from the
\&'mainmenu' block.
.IP "Return value" 4
.IX Item "Return value"
The horizontal menu.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'mainmenu' template block.
.Sh "titlebar(\s-1WIDTH\s0, \s-1TITLE\s0)"
.IX Subsection "titlebar(WIDTH, TITLE)"
Prints a titlebar widget.  Deprecated; exactly equivalent to:
.PP
.Vb 4
\&        slashDisplay('titlebar', {
\&                width   => $width,
\&                title   => $title
\&        });
.Ve
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1WIDTH\s0" 4
.IX Item "WIDTH"
.PD
Width of the titlebar.
.IP "\s-1TITLE\s0" 4
.IX Item "TITLE"
Title of the titlebar.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
None.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'titlebar' template block.
.Sh "fancybox(\s-1WIDTH\s0, \s-1TITLE\s0, \s-1CONTENTS\s0 [, \s-1CENTER\s0, \s-1RETURN\s0])"
.IX Subsection "fancybox(WIDTH, TITLE, CONTENTS [, CENTER, RETURN])"
Creates a fancybox widget.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1WIDTH\s0" 4
.IX Item "WIDTH"
.PD
Width of the fancybox.
.IP "\s-1TITLE\s0" 4
.IX Item "TITLE"
Title of the fancybox.
.IP "\s-1CONTENTS\s0" 4
.IX Item "CONTENTS"
Contents of the fancybox.  (I see a pattern here.)
.IP "\s-1CENTER\s0" 4
.IX Item "CENTER"
Boolean for whether or not the fancybox
should be centered.
.IP "\s-1RETURN\s0" 4
.IX Item "RETURN"
Boolean for whether to return or print the
fancybox.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
The fancybox if \s-1RETURN\s0 is true, or true/false
on success/failure.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'fancybox' template block.
.Sh "portalbox(\s-1WIDTH\s0, \s-1TITLE\s0, \s-1CONTENTS\s0, \s-1BID\s0 [, \s-1URL\s0])"
.IX Subsection "portalbox(WIDTH, TITLE, CONTENTS, BID [, URL])"
Creates a portalbox widget.  Calls \f(CW\*(C`fancybox\*(C'\fR to process
the box itself.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1WIDTH\s0" 4
.IX Item "WIDTH"
.PD
Width of the portalbox.
.IP "\s-1TITLE\s0" 4
.IX Item "TITLE"
Title of the portalbox.
.IP "\s-1CONTENTS\s0" 4
.IX Item "CONTENTS"
Contents of the portalbox.
.IP "\s-1BID\s0" 4
.IX Item "BID"
The block \s-1ID\s0 for the portal in question.
.IP "\s-1URL\s0" 4
.IX Item "URL"
\&\s-1URL\s0 to link the title of the portalbox to.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
The portalbox.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'fancybox', 'portalboxtitle', and
\&'portalmap' template blocks.
.Sh "linkCommentPages(\s-1SID\s0, \s-1PID\s0, \s-1CID\s0, \s-1TOTAL\s0)"
.IX Subsection "linkCommentPages(SID, PID, CID, TOTAL)"
Print links to pages for additional comments.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1SID\s0" 4
.IX Item "SID"
.PD
Story \s-1ID\s0.
.IP "\s-1PID\s0" 4
.IX Item "PID"
Parent \s-1ID\s0.
.IP "\s-1CID\s0" 4
.IX Item "CID"
Comment \s-1ID\s0.
.IP "\s-1TOTAL\s0" 4
.IX Item "TOTAL"
Total number of comments.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
Links.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'linkCommentPages' template block.
.Sh "linkComment(\s-1COMMENT\s0 [, \s-1PRINTCOMMENT\s0, \s-1DATE\s0])"
.IX Subsection "linkComment(COMMENT [, PRINTCOMMENT, DATE])"
Print a link to a comment.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1COMMENT\s0" 4
.IX Item "COMMENT"
.PD
A hashref containing data about the comment.
.IP "\s-1PRINTCOMMENT\s0" 4
.IX Item "PRINTCOMMENT"
Boolean for whether to create link directly
to comment, instead of to the story for that comment.
.IP "\s-1DATE\s0" 4
.IX Item "DATE"
Boolean for whather to print date with link.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
Link for comment.
.IP "Dependencies" 4
.IX Item "Dependencies"
The 'linkComment' template block.
.Sh "createMenu(\s-1MENU\s0)"
.IX Subsection "createMenu(MENU)"
Creates a menu.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1MENU\s0" 4
.IX Item "MENU"
.PD
The name of the menu to get.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
The menu.
.IP "Dependencies" 4
.IX Item "Dependencies"
The template blocks 'admin', 'user' (in the 'menu' page), and any other
template blocks for menus, along with all the data in the
\&'menus' table.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fISlash\fR\|(3), \fISlash::Utility\fR\|(3).
.SH "VERSION"
.IX Header "VERSION"
$Id: Display.pm,v 1.1.2.33 2001/10/18 02:31:09 pudge Exp $