put the documentation in a proper <%doc> section
authorivan <ivan>
Tue, 6 May 2008 01:15:46 +0000 (01:15 +0000)
committerivan <ivan>
Tue, 6 May 2008 01:15:46 +0000 (01:15 +0000)
httemplate/elements/customer-table.html

index fc298b0..779b01c 100644 (file)
@@ -1,15 +1,23 @@
-%  # options example...  
-%  #
-%  # #listrefs...
-%  # 'header'      => [ '#', 'Item' ],
-%  # 'fields'      => [
-%  #                    'column',
-%  #                    sub { my ($row,$param) = @_; $param->{"column$row"}; },
-%  #                  ],
-%  # 'sizes'       => [],                         # sizes ignored for immutable
-%  # 'types'       => ['immutable', ''],          # immutable or ''/text
-%  # 'param'       => { column0 => 1 },           # preset column of row 0 to 1
-%  # 
+<%doc>
+
+Example:
+
+  include( '/elements/customer-table.html',
+
+             #listrefs...
+             'header'      => [ '#', 'Item' ],
+             'fields'      => [
+                                'column',
+                                sub { my ($row,$param) = @_;
+                                      $param->{"column$row"};
+                                    },
+                              ],
+             'sizes'       => [],                # sizes ignored for immutable
+             'types'       => ['immutable', ''], # immutable or ''/text
+             'param'       => { column0 => 1 },  # preset column of row 0 to 1
+         )
+
+</%doc>
 
 <SCRIPT TYPE="text/javascript">