[Bio] / FigKernelPackages / TemplateObject.pm Repository:
ViewVC logotype

Diff of /FigKernelPackages/TemplateObject.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.7, Tue Jun 12 21:10:58 2007 UTC revision 1.8, Thu Dec 6 13:59:34 2007 UTC
# Line 103  Line 103 
103    
104  =head3 new  =head3 new
105    
106  C<< my $to = FIG_CGI->new($cgi, $type => $name, $request); >>      my $to = FIG_CGI->new($cgi, $type => $name, $request);
107    
108  Construct a new template object for the current script.  Construct a new template object for the current script.
109    
# Line 176  Line 176 
176    
177  =head3 mode  =head3 mode
178    
179  C<< my $flag = $to->mode(); >>      my $flag = $to->mode();
180    
181  Return TRUE if a template is active, else FALSE.  Return TRUE if a template is active, else FALSE.
182    
# Line 191  Line 191 
191    
192  =head3 raw  =head3 raw
193    
194  C<< my $flag = $to->raw(); >>      my $flag = $to->raw();
195    
196  Return TRUE if we're accumulating raw HTML, else FALSE.  Return TRUE if we're accumulating raw HTML, else FALSE.
197    
# Line 206  Line 206 
206    
207  =head3 add  =head3 add
208    
209  C<< $to->add($name => $html); >>      $to->add($name => $html);
210    
211  or  or
212    
213  C<< $to->add($html); >>      $to->add($html);
214    
215  Add HTML to the template data using the specified name. If a template is in effect, the  Add HTML to the template data using the specified name. If a template is in effect, the
216  data will be put into a variable hash. If raw HTML is being accumulated, the data will  data will be put into a variable hash. If raw HTML is being accumulated, the data will
# Line 256  Line 256 
256    
257  =head3 append  =head3 append
258    
259  C<< $to->append($name, $html); >>      $to->append($name, $html);
260    
261  Append HTML to a named variable. Unlike L</add>, this method will not destroy a  Append HTML to a named variable. Unlike L</add>, this method will not destroy a
262  variable's existing value; instead, it will concatenate the new data at the end of the  variable's existing value; instead, it will concatenate the new data at the end of the
# Line 296  Line 296 
296    
297  =head3 titles  =head3 titles
298    
299  C<< to->titles($parameters); >>      to->titles($parameters);
300    
301  If no template is in use, generate the plain SEED header. If a template is in  If no template is in use, generate the plain SEED header. If a template is in
302  use, get the version, peg ID, and message of the day for use in the template.  use, get the version, peg ID, and message of the day for use in the template.
# Line 366  Line 366 
366    
367  =head3 finish  =head3 finish
368    
369  C<< my $webPage = $to->finish(); >>      my $webPage = $to->finish();
370    
371  Format the template information into a web page. The HTML passed in by the L</add> methods  Format the template information into a web page. The HTML passed in by the L</add> methods
372  is assembled into the proper form and returned to the caller.  is assembled into the proper form and returned to the caller.

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.8

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3