push @cells,
FAQ::OMatic::button(
FAQ::OMatic::makeAref('-command'=>'faq',
'-params'=>$params,
'-changedParams'=>{'_recurse'=>''}),
gettext("Show Top Category Only") . "");
} else {
push @cells,
FAQ::OMatic::button(
FAQ::OMatic::makeAref('-command'=>'faq',
'-params'=>$params,
'-changedParams'=>{'_recurse'=>1}),
gettext("Show This Entire Category") . "");
}
} else {
push @cells, "";
}
}
if ($showLinks->{'renderText'}) {
my $text;
if ($item->isCategory())
{
$text = gettext("Show This Category As Text");
}
elsif ($item->isAnswer())
{
$text = gettext("Show This Answer As Text");
}
else # fixup for unexpected cases
{
my $whatAmI = gettext($item->whatAmI());
gettexta("Show This %0 As Text", $whatAmI)
}
push @cells,
FAQ::OMatic::button(
FAQ::OMatic::makeAref('-command'=>'faq',
'-params'=>$params,
'-changedParams'=>{'render'=>'text'}),
$text);
if ($item->isCategory() and $showLinks->{'entire'}) {
push @cells,
FAQ::OMatic::button(
FAQ::OMatic::makeAref('-command'=>'faq',
'-params'=>$params,
'-changedParams'=>{'render'=>'text', '_recurse'=>1}),
gettext("Show This Entire Category As Text"));
}
}
if ($showLinks->{'edit'}
and $FAQ::OMatic::Config::showEditOnFaq) {
# Show Edit Commands
if (FAQ::OMatic::getParam($params, 'editCmds') ne 'hide') {
push @cells, FAQ::OMatic::button(
FAQ::OMatic::makeAref('-command'=>'faq',
'-params'=>$params,
'-changedParams'=>{'editCmds'=>'hide'}),
gettext("Hide Expert Edit Commands"));
} else {
my $showStyle = $FAQ::OMatic::Config::showEditOnFaq || 'show';
$showStyle = 'show' if ($showStyle ne 'compact');
push @cells, FAQ::OMatic::button(
FAQ::OMatic::makeAref('-command'=>'faq',
'-params'=>$params,
'-changedParams'=>{'editCmds'=>$showStyle}),
gettext("Show Expert Edit Commands"));
}
}
if ($showLinks->{'faq'}) {
# return to faq
my $cmd = $params->{'cmd'} || '';
if ($cmd ne '' and $cmd ne 'faq') {
push @cells,
FAQ::OMatic::button(
FAQ::OMatic::makeAref('-command'=>'faq',
'-params'=>$params,
# kill unneeded params from 'authenticate':
'-changedParams'=>{'partnum'=>'',
'checkSequenceNumber'=>''},
),
gettext("Return to the FAQ"));
}
}
my $useTable = FAQ::OMatic::getParam($params, 'render') eq 'tables';
my $page = "\n\n";
my $software = gettext("This is a") . " Faq-O-Matic $FAQ::OMatic::VERSION.\n";
if ($useTable) {
my $tw = $FAQ::OMatic::Config::tableWidth || '';
my $bgc = $FAQ::OMatic::Config::regularPartColor || '#ffffff';
$page .="\n"
."\n";
@cells = map { "| $_ | \n" } @cells;
$page .= "\n".join('', @cells)." \n";
my $numCells = scalar(@cells) || 0;
if ($showLinks->{'faqomatic-home'}) {
$page.= "| \n"
.$software
." | ";
}
$page .= " \n"
." |
\n";
} else {
# @cells = map { "
$_\n" } @cells; /jes
@cells = map { "$_\n" } @cells;
$page .= "\n".join('', @cells)."\n";
if ($showLinks->{'faqomatic-home'}) {
# $page .= "
".$software; /jes
$page .= $software."
";
}
}
return $page;
}
sub helpButton {
my $params = shift;
my $page = '';
my $cmd = $params->{'cmd'} || '';
# Help
# -- disabled for this version, since it's not completely implemented
# or very tested. all the other code is here, there's just no
# "front door" to get into the help system through.
# if ($params->{'help'}) {
# $page.=""
# .FAQ::OMatic::button(
# FAQ::OMatic::makeAref('-command'=>$cmd,
# '-params'=>$params,
# '-changedParams'=>{'help'=>''},
# '-saveTransients'=>1,
# '-target'=>'_top'),
# "Hide Help")
# ." | \n";
# } else {
# $page.=""
# .FAQ::OMatic::button(
# FAQ::OMatic::makeAref('-command'=>'help',
# '-params'=>$params,
# '-changedParams'=>{'_onCmd'=>$cmd},
# '-saveTransients'=>1,
# '-target'=>'_top'),
# "Help")
# ." | \n";
# }
return $page;
}
sub max {
my $champ = shift;
while (defined(my $contender = shift)) {
$champ = ($champ > $contender) ? $champ : $contender;
}
return $champ;
}
sub itemRender {
my $params = shift;
my $itemboxes = shift;
# Here is how the itemRender data structure is arranged:
# $itemboxes is a ref to an array, each element contains the data to
# draw a single item. (There are multiple entries when
# [Show All Items Below Here] is in effect.)
# $itemboxes->[i] is a ref to a hash.
# $itemboxes->[i]->{'item'} is the FAQ::OMatic::Item object that this
# itembox represents.
# $itemboxes->[i]->{'rows'} is a ref to an array, each element of which
# is a row, structured as described below. Each row corresponds
# to a part in the item, plus a few extra rows for other parts of
# the page.
# $itemboxes->[i]->{'rows'}->[p] is a ref to a hash, describing that part.
# $itemboxes->[i]->{'rows'}->[p]->{'type'} is one of
# 'three', 'multirow', 'wide'.
# $itemboxes->[i]->{'rows'}->[p]->{'id'} is a debugging string that
# indicates the source of the row data
# type 'three' parts have ->{'body'}, ->{'editbody'}, ->{'afterbody'}
# refs. 'body' is a hash ref to 'text' and 'color'.
# 'editbody' is an array ref to edit cmds that apply to this part body.
# each element of the array is a hash of 'text' and 'color'.
# 'afterbody' is an array ref to edit cmds that apply after this
# part body.
# type 'multirow' fields have ->{'cells'}, a ref to an array of cells
# that should be laid out horizontally.
# type 'wide' fields have ->{'text'} and ->{'color'} parts that should
# fill the width of the display.
my $render = FAQ::OMatic::getParam($params, 'render');
if ($render eq 'simple') {
return itemRenderSimple($params, $itemboxes);
} elsif ($render eq 'text') {
return itemRenderText($params, $itemboxes);
} else {
# tables
my $editDisplay = FAQ::OMatic::getParam($params, 'editCmds');
if ($editDisplay eq 'compact') {
return itemRenderCompactEdits($params, $itemboxes);
} else {
return itemRenderNormalEdits($params, $itemboxes);
}
}
}
sub itemRenderNormalEdits {
my $params = shift;
my $itemboxes = shift;
# first, compute the widest row of cells in the table, so that
# 'wide' and 'three'->'body' parts fit the width of the table.
my $maxwidth = 0;
my $tablerows = 0;
my $tablerowcounts = {};
foreach my $itembox (@{$itemboxes}) {
my $item = $itembox->{'item'};
my $rows = $itembox->{'rows'};
foreach my $row (@{$rows}) {
if ($row->{'type'} eq 'three') {
$maxwidth = max($maxwidth, 3, scalar(@{$row->{'afterbody'}}));
$tablerows += max(2, scalar(@{$row->{'editbody'}})+1);
} elsif ($row->{'type'} eq 'multirow') {
$maxwidth = max($maxwidth, scalar(@{$row->{'cells'}}));
$tablerows += 1;
} elsif ($row->{'type'} eq 'wide') {
$maxwidth = max($maxwidth, 1);
$tablerows += 1;
} else {
die "unknown row type ".$row->{'type'};
}
}
$tablerowcounts->{$rows} = $tablerows;
$tablerows = 0;
# rows are tallied per item ($rows is the set of rows in an item),
# so that we can compute the correct rowspan for the solid bar
# at the left of an item.
}
my $rt = '';
$rt.= "\n";
foreach my $itembox (@{$itemboxes}) {
my $item = $itembox->{'item'};
my $rows = $itembox->{'rows'};
$tablerows = $tablerowcounts->{$rows};
my ($spacer,$sw) = FAQ::OMatic::ImageRef::getImageRefCA('', '',
$item->isCategory(), $params);
my $itemFile = $item->{'filename'};
my $itemName = $item->getTitle();
$rt.="\n\n"
."| \n"
."$spacer\n | \n";
my $first = 1;
# don't send
on first table row, since we already did
foreach my $row (@{$rows}) {
if ($first) {
$first = 0;
} else {
$rt .= "\n
";
}
if ($row->{'type'} eq 'three') {
my ($bodycolor,$bodytext) = getColorText($row->{'body'});
my @editbody = @{$row->{'editbody'}}; # array ref
my $rowspan = scalar @editbody;
my $colspan = $maxwidth - 1;
my @afterbody = @{$row->{'afterbody'}}; # array ref
$rt.="";
# append a row (spanned by part box) for each editbody cell
# first cell shares a row with part body
my $cell = shift @editbody;
my ($color,$text) = getColorText($cell);
$rt .= "\n| $text | \n\n";
# a row from Part.pm with edit commands
$rt .= "\n$bodytext |
\n";
# remaining cells get own rows
foreach $cell (@editbody) {
($color,$text) = getColorText($cell);
$rt .= "\n| "
."$text | \n
\n";
}
# append a row containing the below cells
$rt .= "\n";
foreach $cell (@afterbody) {
($color,$text) = getColorText($cell);
$rt .= "\n| $text | \n";
}
$rt .= "
\n";
} elsif ($row->{'type'} eq 'multirow') {
# row is specified as a series of cells to be crammed
# together horizontally.
$rt.="";
foreach my $cell (@{$row->{'cells'}}) {
my ($color,$text) = getColorText($cell);
$rt .= "\n$text | \n";
}
$rt .= "\n";
} else {
# row is specified as a single cell that should fill the
# width of the table.
my ($color,$text) = getColorText($row);
$rt .= ""
."$text | \n";
}
}
}
$rt.="\n
\n";
return $rt;
}
sub getColorText {
my $hashref = shift;
my $color = $hashref->{'color'} || '';
my $size = $hashref->{'size'} || '';
$color = "bgcolor=$color" if ($color);
my $text = $hashref->{'text'} || '';
if ($size eq 'edit') {
# The editing buttons are smaller so that they'll not look as much like
# part of the item being displayed, but more like little intruders.
$text = "${text}";
}
return ($color,$text);
}
sub itemRenderCompactEdits {
my $params = shift;
my $itemboxes = shift;
# first, compute the widest row of cells in the table, so that
# 'wide' and 'three'->'body' parts fit the width of the table.
my $maxwidth = 0;
my $tablerows = 0;
my $tablerowcounts = {};
foreach my $itembox (@{$itemboxes}) {
my $item = $itembox->{'item'};
my $rows = $itembox->{'rows'};
foreach my $row (@{$rows}) {
if ($row->{'type'} eq 'three') {
# both editbody and afterbody are laid out horizontally.
$maxwidth = max($maxwidth, 3, scalar(@{$row->{'editbody'}}));
$maxwidth = max($maxwidth, 3, scalar(@{$row->{'afterbody'}}));
# the 'body' gets one row, the 'editbody' and 'afterbody'
# share a second row.
$tablerows += 2;
} elsif ($row->{'type'} eq 'multirow') {
$maxwidth = max($maxwidth, scalar(@{$row->{'cells'}}));
$tablerows += 1;
} elsif ($row->{'type'} eq 'wide') {
$maxwidth = max($maxwidth, 1);
$tablerows += 1;
} else {
die "unknown row type ".$row->{'type'};
}
}
$tablerowcounts->{$rows} = $tablerows;
$tablerows = 0;
# rows are tallied per item ($rows is the set of rows in an item),
# so that we can compute the correct rowspan for the solid bar
# at the left of an item.
}
my $rt = '';
$rt.= "\n";
foreach my $itembox (@{$itemboxes}) {
my $item = $itembox->{'item'};
my $rows = $itembox->{'rows'};
$tablerows = $tablerowcounts->{$rows};
my ($spacer,$sw) = FAQ::OMatic::ImageRef::getImageRefCA('', '',
$item->isCategory(), $params);
my $itemFile = $item->{'filename'};
my $itemName = $item->getTitle();
# THANKS to charlie buckheit for suggesting
# the width tag, which helps keep the item-tall bar skinny
# in Internet Exploder. (Nothing seems to help in Netscape.)
$rt.="\n\n"
."| \n"
."$spacer\n | \n";
my $first = 1;
# don't send
on first table row, since we already did
foreach my $row (@{$rows}) {
if ($first) {
$first = 0;
} else {
$rt .= "\n
";
}
if ($row->{'type'} eq 'three') {
my ($bodycolor,$bodytext) = getColorText($row->{'body'});
my @editbody = @{$row->{'editbody'}}; # array ref
my @afterbody = @{$row->{'afterbody'}}; # array ref
$rt.="";
# in compact mode, the 'body' gets a row to itself
# a row from Part.pm with edit commands
$rt .= "\n| $bodytext |
\n";
# 'editbody' and 'afterbody' cells crammed into a single
# cell (hence the "compact" :v)
# everybody in the cell gets the color of the first guy.
my ($color,$text) = getColorText($editbody[0]);
$rt .= "";
my $cell;
foreach $cell (@editbody) {
($color,$text) = getColorText($cell);
$rt.="".$text;
}
$rt .= "\n
";
foreach $cell (@afterbody) {
($color,$text) = getColorText($cell);
$rt.="".$text;
}
$rt .= " |
\n";
} elsif ($row->{'type'} eq 'multirow') {
# row is specified as a series of cells to be crammed
# together horizontally.
my @cells = @{$row->{'cells'}};
# everybody in the cell gets the color of the first guy.
my ($color,$text) = getColorText($cells[0]);
$rt.="";
foreach my $cell (@cells) {
my ($color,$text) = getColorText($cell);
$rt .= "".$text;
}
$rt .= " | \n";
} else {
# row is specified as a single cell that should fill the
# width of the table.
my ($color,$text) = getColorText($row);
$rt .= ""
."$text | \n";
}
}
}
$rt.="\n
\n";
return $rt;
}
sub itemRenderSimple {
# an HTML rendering mode that uses no tables; a goal is for it to
# look acceptable in lynx.
my $params = shift;
my $itemboxes = shift;
my $rt = "\n";
foreach my $itembox (@{$itemboxes}) {
my $item = $itembox->{'item'};
my $rows = $itembox->{'rows'};
my $itemFile = $item->{'filename'};
my $itemName = $item->getTitle();
# this rendering method assumes (hopes!) that the first
# row of an item is a 'wide' row, something that looks like
# a title.
my $row = shift @$rows;
if ($row->{'type'} ne 'wide') {
FAQ::OMatic::gripe('problem', "assertion failed. ".caller(0));
}
my $text = $row->{'text'};
$rt.="\n\n"
."- $text\n"
."
\n";
foreach $row (@{$rows}) {
$rt .= "\n";
if ($row->{'type'} eq 'three') {
my ($bodycolor,$bodytext) = getColorText($row->{'body'});
my @editbody = @{$row->{'editbody'}}; # array ref
my @afterbody = @{$row->{'afterbody'}}; # array ref
$rt.="";
$rt.="- $bodytext
\n";
my $cell;
foreach $cell (@editbody) {
my ($color,$text) = getColorText($cell);
$rt.="".$text;
}
$rt .= "\n
";
foreach $cell (@afterbody) {
my ($color,$text) = getColorText($cell);
$rt.="".$text;
}
} elsif ($row->{'type'} eq 'multirow') {
# row is specified as a series of cells to be crammed
# together horizontally.
$rt.="";
$rt.=" - ";
foreach my $cell (@{$row->{'cells'}}) {
my ($color,$text) = getColorText($cell);
$rt .= "$text\n";
}
} else {
# row is specified as a single cell that should fill the
# width of the table.
my ($color,$text) = getColorText($row);
$rt .= ""
."
- $text\n";
}
}
$rt.="\n
\n";
}
$rt.="\n
\n";
return $rt;
}
sub itemRenderText {
# a text-only rendering mode
my $params = shift;
my $itemboxes = shift;
my $rt = '';
foreach my $itembox (@{$itemboxes}) {
my $item = $itembox->{'item'};
my $rows = $itembox->{'rows'};
my $itemFile = $item->{'filename'};
my $itemName = $item->getTitle();
# this rendering method assumes (hopes!) that the first
# row of an item is a 'wide' row, something that looks like
# a title.
my $row = shift @$rows;
if ($row->{'type'} ne 'wide') {
FAQ::OMatic::gripe('problem', "assertion failed. ".caller(0));
}
my $text = $row->{'text'};
$rt.="$text\n";
foreach $row (@{$rows}) {
my $part = $row->{'part'};
my $indentType = 'regular';
if (defined $part and ($part->{'Type'} eq 'directory')) {
$indentType = 'directory';
}
if ($row->{'type'} eq 'three') {
my ($bodycolor,$bodytext) = getColorText($row->{'body'});
my @editbody = @{$row->{'editbody'}}; # array ref
my @afterbody = @{$row->{'afterbody'}}; # array ref
$rt.=indent($indentType, $bodytext);
# edit text not shown (supported) in render=text mode
# (that's the editbody and afterbody data)
$rt .= "\n";
} elsif ($row->{'type'} eq 'multirow') {
# row is specified as a series of cells to be crammed
# together horizontally.
if (not $row->{'isEdit'}) {
# supress data that's just editing links
foreach my $cell (@{$row->{'cells'}}) {
my ($color,$text) = getColorText($cell);
$rt .= indent($indentType,$text);
}
}
} else {
# row is specified as a single cell that should fill the
# width of the table.
my ($color,$text) = getColorText($row);
$rt .= indent($indentType,$text);
}
}
$rt.="\n";
}
$rt.="\n";
return $rt;
}
$indentTypes = {
'regular' => ' ',
'directory' => ' + ',
};
sub indent {
my $type = shift;
my $text = shift;
my $indent = defined($indentTypes->{$type})
? $indentTypes->{$type}
: $type;
$text =~ s#^#$indent#gm;
return $text;
}
1;