HTML::FormatNroff - Format HTML as nroff man page
require HTML::FormatNroff; $html = parse_htmlfile("test.html"); $format_nroff = new HTML::FormatNroff(name => 'trial', project => 'MyProject'); print $formatter->format($html);
The HTML::FormatNroff is a formatter that outputs nroff source for the nroff text processor, using man macros, and tbl commands for table processing.
The result of using the formatter must be processed as follows, when directing output to the screen (assume output is in the file "text.nroff"):
tbl -TX text.nroff | nroff -man | col
If the output is to be printed, on an laser printer for example, a command similar to the following must be used:
tbl -TX text.nroff | nroff -man -Tlj | lpr
Meta tags may be placed in the HTML so that portions of the HTML will be ignored and not processed. Content between the tags
<META NAME="nroff-control" CONTENT="ignore_start"> <META NAME="nroff-control" CONTENT="ignore_end">
will be ignored. In the BODY META is not supported, but DIV may be used as follows:
<DIV TYPE="NROFF_IGNORE"> </DIV>
In both the META and DIV uses, case is ignored.
Start a definition term <DT>, using a temporary indent and vertical space.
Start a data definition, <DD>, using a temporary indent.
Configure the nroff formatter, setting the attributes passed in the $arg attribute (hash reference)
Begin HTML formatting.
End HTML formatting.
Process <HTML> start tag. Create the man page header based on saved attributes, unless the attribute $format_nroff->{'man_header'} is not set. This generates the following header:
.TH "name" section "date" "project"
Start the font specified by the $font character (e.g. B, or I). The font is remembered so nested fonts are handled correctly.
End the current font, returning to the previous one.
Process <I> tag.
Process </I> tag.
Process <B> tag.
Process </B> tag.
Process <TABLE>, start table processing. $node is the current html_parser node.
Pass on the $format_nroff->{'page_width'} to FormatTableNroff
Process <TR>, add table row.
End the table row </TR>
<A> is ignored.
</A> is ignored.
Process <TD>, add table cell
Process </TD>, end table cell
Process <TH>, add table header cell
Process </TH>, end table header cell
Process </TABLE>. Actually output entire table.
Process <P>.
Process </P> by doing nothing.
goto_lm does nothing.
Process <BR>.
Process <HR>
Process <H?> simply using .SH
Process </H?> simply outputing newline
Output text.
Output <PRE> text.
Output newline.
adjust indent (left margin)
not used.
output the bullet, using a temporary indent and the $tag
Output text or add it to table if currently inside a table If centered add .ce unless inside a table, if underlined add .ul, if the left margin is adjusted use a .ti for every new line.
Start <BLOCKQUOTE>, by making a new paragraph, and indenting.
</BLOCKQUOTE>, by ending indent, and making a new paragraph
Process DIV
<DIV TYPE="NROFF_IGNORE"> is used to ignore all subsequent content until the next </DIV> This allows HTML to be used which is not to be converted to HTML (such as navigation controls). Case is ignored in the type.
In the header you probably should use <META NAME="nroff-control" CONTENT="ignore_start"> is used to ignore all subsequent content until the next <META NAME="nroff-control" CONTENT="ignore_end">
Process <META> tag.
<META NAME="nroff-control" CONTENT="ignore_start"> is used to ignore all subsequent content until the next <META NAME="nroff-control" CONTENT="ignore_end"> This allows HTML to be used which is not to be converted to HTML (such as navigation controls). Case is ignored.
Strictly speaking META is only allowed in the HTML HEAD, so this META. In the body, you should use:
HTML::Formatter, HTML::FormatTableCell, HTML::FormatTableCellNroff, HTML::FormatTableNroff, HTML::FormatTableRow, HTML::FormatTableRowNroff
Copyright (c) 1997 Frederick Hirsch. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Frederick Hirsch <f.hirsch@opengroup.org>
To install HTML::Testing, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HTML::Testing
CPAN shell
perl -MCPAN -e shell install HTML::Testing
For more information on module installation, please visit the detailed CPAN module installation guide.