[Openinteract-commits] CVS: OpenInteract2/doc/Manual API.pod,1.1,1.2

[Chris W. <la...@us...>]

Update of /cvsroot/openinteract/OpenInteract2/doc/Manual
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8438

Modified Files:
	API.pod 
Log Message:
OIN-46: add more content...


Index: API.pod
===================================================================
RCS file: /cvsroot/openinteract/OpenInteract2/doc/Manual/API.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** API.pod	13 Mar 2005 05:35:30 -0000	1.1
--- API.pod	13 Mar 2005 05:47:16 -0000	1.2
***************
*** 1,2 ****
--- 1,3 ----
+ [%- TAGS star -%]
  =head1 NAME
  
***************
*** 46,50 ****
  just use the longer form.
  
! =head1 TEMPLATES
  
  =head2 General guidelines
--- 47,91 ----
  just use the longer form.
  
! =head1 TEMPLATES: TEMPLATE TOOLKIT
! 
! =head2 Pointers
! 
! The Template Toolkit is a great piece of software and is quite well
! documented. But there's a lot of documentation so it might be
! confusing on a starting point. A good one is the
! L<Template::Manual::Intro> document -- it gives you a good idea about
! using templates, templates as components, the different types of data
! you can pass into a template and more.
! 
! Some other good documents are: L<Template::Manual::Syntax> and
! L<Template::Manual::Directives> to give you an idea of how to 'speak'
! and your available vocabulary.
! 
! One more thing: you have a number of OI2-specific functions available
! in the OI2 plugin -- read L<OpenInteract2::TT2::Plugin> for what you
! can do with lots of examples.
! 
! =head2 Including other templates
! 
! The Template Toolkit is very flexible about bringing in other
! templates. You can use either C<INCLUDE> or C<PROCESS> to bring in
! another template and evaluate it, and those templates can bring in
! other templates too, and so on down the line. If you're not careful
! you can get a fairly complicated sequence of includes that makes
! debugging difficult -- for example, the templates to create a SELECT
! form element include:
! 
!   form_select
!   form_select_intro
!   form_select_option
!   form_select_options_iterator
!   form_select_options_list
!   form_select_options_plain_list
! 
! So a simple 'INCLUDE form_select' will bring in 'form_select_intro',
! and assuming you pass in an 'iterator' argument will call
! 'form_select_options_iterator' which will call 'form_select_option'
! multiple times to create the individual OPTION elements. Probably a
! little too complicated for a little-old dropdown box...
  
  =head2 General guidelines