[interchange-docs] xmldocs - racke modified refs/attr-list.tag

[docs at icdevgroup.org]

User:      racke
Date:      2008-09-08 08:10:57 GMT
Modified:  refs     attr-list.tag
Log:
describe placeholders

Revision  Changes    Path
1.3                  xmldocs/refs/attr-list.tag


rev 1.3, prev_rev 1.2
Index: attr-list.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/attr-list.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- attr-list.tag	15 Jul 2008 12:19:39 -0000	1.2
+++ attr-list.tag	8 Sep 2008 08:10:57 -0000	1.3
@@ -1,3 +1,7 @@
+__NAME__ purpose
+replaces placeholders in curly braces with provided values
+__END__
+
 __NAME__ synopsis 
 <row>
 
@@ -20,3 +24,36 @@
 </row> 
 &TAG_CONTAINER;
 __END__
+
+__NAME__ description
+<tag>attr-list</tag> replaces placeholders in curly braces with
+provided values. These values can be passed as parameters or as
+Perl hash reference in the <literal>hash</literal> parameter.
+
+<informaltable>
+<tgroup cols="2">
+<thead>
+<row>
+<entry>Placeholder</entry>
+<entry>Replacement</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry>{NAME}</entry>
+<entry>value of NAME</entry>
+</row>
+<row>
+<entry>{NAME?}...{/NAME?}</entry>
+<entry>placeholder contents if NAME is true</entry>
+</row>
+<row>
+<entry>{NAME?}...{/NAME?}</entry>
+<entry>placeholder contents if NAME is false</entry>
+</row>
+</tbody>
+</tgroup>
+</informaltable>
+&TAG_CONTAINER;
+__END__
+