Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

ini_html_gen.pl File Reference

Generates one or more HTML files based upon what is found in the ini file. More...

Go to the source code of this file.

Defines

Functions

Variables


Detailed Description

Generates one or more HTML files based upon what is found in the ini file.

../perl/ini_html_gen.pl

Parameters:
root_dir  something like doc_publish/cref_sysxini/
src_ini  source file to parse ./z_include/sysx.ini
html_tmpl  template for generated files voyant_master_nav.html
org_title  optional title for the example file.
a_header  optional additional source file with tag information.
Author:
Glenn C. Maxey

Definition in file ini_html_gen.pl.


Define Documentation

#define a1
 

#define after   ""
 

#define after   ""
 

#define b1
 

#define before   ""
 

#define before   ""
 

#define close_tag   ">"
 

#define debug_all   0
 

#define debug_btxs   0
 

#define debug_cds   0
 

#define debug_gdm   0
 

#define debug_master   0
 

#define debug_rs   0
 

#define debug_rwm   0
 

#define debug_wom   0
 

#define debug_ws   0
 

#define end_tag   ($nada, "<\/p", "<\/font", "</i", "</b", "</ul", "</ol", "</li", $nada)
 

#define file_out
 

#define file_out
 

#define file_out2
 

#define file_out_doc
 

#define file_out_tag
 

#define hname   $_[0]
 

#define html   $_[1]
 

#define html_name   "_TBD_"
 

#define html_name   $seed
 

#define html_out   $_[2]
 

#define level   $_[1]
 

#define level   $_[1]
 

#define level   $_[1]
 

#define level   $_[1]
 

#define level   $_[1]
 

#define nada   "_n_a_d_a_"
 

#define next   "_TBD_"
 

#define org_seed   $pseed
 

#define out_head   ""
 

#define out_string   ""
 

#define outhtm   ""
 

#define outpath   "$globe::xtag_struct{$pseed}{name}"
 

#define output_html   0
 

#define outtxt   ""
 

#define p1
 

#define piece   ""
 

#define piece   ""
 

#define plus   0
 

#define prev   "_TBD_"
 

#define pseed   $_[0]
 

#define replace_end   ("", "", "\\fR", "\\fR", "\\fR", "", "", "\n\.RE\n", "" )
 

#define replace_start   ("\.LP\n", "\.LP\n", "\\fI", "\\fI", "\\fB", "", "", "\.HP\n\- ", "" )
 

#define seed   $_[0]
 

#define seed   $_[0]
 

#define seed   $_[0]
 

#define seed   $_[0]
 

#define seed   $_[0]
 

#define seed   $_[0]
 

#define seed   $_[0]
 

#define start_tag   ("<br", "<p", "<font" , "<i", "<b", "<ul", "<ol", "<li", "<" )
 

#define temp   $globe::xtag_struct{$hname}{desc_man}
 

#define trace_parent
 

#define ttt_error_out   "_TBD_: "
 

#define zap_it_string   $_[0]
 


Function Documentation

int BEGIN  
 

Definition at line 96 of file ini_html_gen.pl.

int build_trace_xtag_struct  
 

Traces through the input and builds an xtag_struct for the INI file.

Parameters:
h_ind  The name of the parent section as the hash index.
file_line_index  The index to the file array.
Returns:
The hash index for the parent; that is either the parent already passed in, or itself if it is determined to have children based on whether or not it is enclosed in braces. In addition, the xtag_struct is built up for the element.
$name is the key into the hash made up of all previous levels and this level.
globe:
:xtag_struct{
name}{name} = Display name for item.

Definition at line 774 of file ini_html_gen.pl.

int create_data_structure  
 

Creates a data structure from each line in the message file.

$hname = created name for hash made from actual names of parents and children

globe:
:xtag_struct{
hname}{name} = actual item name
globe:
:xtag_struct{
hname}{parent} = owning section
globe:
:xtag_struct{
hname}{child}[] = array of associated children
globe:
:xtag_struct{
hname}{comment} = comment flag
globe:
:xtag_struct{
hname}{comment_full} = complete comments with no tags
globe:
:xtag_struct{
hname}{desc_html} = description in html
globe:
:xtag_struct{
hname}{desc_man} = description in man
Limitations and Caveats:

Definition at line 727 of file ini_html_gen.pl.

if   nested_scripts = ~ /\[/
 

Definition at line 841 of file ini_html_gen.pl.

if  
 

Definition at line 748 of file ini_html_gen.pl.

return  
 


Variable Documentation

default
 

Initial value:

~ s/^\s*
   $default =~ s/\s*$
   if ($debug_btxs) {

   }
   $new_h_ind = "$h_ind\-$name"

Definition at line 849 of file ini_html_gen.pl.



 "Perl Program Reference" 
 < Previous 
 Next > 



Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-perl-hcr-02