Using rz_html_utils

The file rz_html_utils is a collection of Bourne/Korn shell subroutines which provide a neat way of encapsulating HTML formatting for shell scripts.

To use rz_html_utils, just as in using rz_utils, your Bourne/Korn shell script will need to "dot" in the file. For example...

#!/bin/sh
. $RAZOR_HOME/scripts/rz_html_utils
#...continue on from here...

In contrast to rz_toolbox, rz_html_utils does not depend upon any external parameters being set. Once "dotted", you'll be able to take advantage of the functions described below, much as you would a normal UNIX program.

init_html <title> [<background color>]

Initialize the HTML. This should generally be done first and only once.

end_html

End of HTML. This should be done last.

row_heading <heading string>

Define a row heading.

new_row

Start a new row in a table.

end_row

End a row in a table.

fill_cell <title> <val> <span> <align>

Fill a cell in a table. All four parameters should be specified. The title will appear in bold text. If the title should be omitted, an empty string must be specified. The <val> will follow the title. The <span> specifies how many cells to span. If missing the default is 1. The <align> parameter specifies how the contents of the cell should be aligned. The default is left.

init_table <caption> <border width>

Initialize a table. This should be done once per table.

end_table

End an HTML table. There should be one of these for each init_table.

insert_text_block <file>

Insert the text contained in the file.

main_heading <heading> [<alignment>]

Create a main heading. This function should be called after init_html. An optional alignment value can be set to control placement of the heading. The options are left, center or right. The default value is right.

list_heading

Add a heading.

create_anchor <name> <title> <file>

Create an anchor for a file.

line

Insert a line break.

start_pre

Start a preformatted paragraph.

end_pre

End a preformatted paragraph.

font <size> (+1, +2, etc...)

Set Font size and characteristics.