RT# 34134 - added documentation for new feature

[freeside.git] / httemplate / elements / tr-select-payment_options.html

diff --git a/httemplate/elements/tr-select-payment_options.html b/httemplate/elements/tr-select-payment_options.html
index 5197c37..3c50e88 100644 (file)
--- a/httemplate/elements/tr-select-payment_options.html
+++ b/httemplate/elements/tr-select-payment_options.html
@@ -1,3 +1,25 @@
+<%doc>
+
+Example:
+
+  include( '/elements/tr-select-payment_options.html',
+
+    #opt - most get used in /elements/tr-amount-fee
+    'custnum'              => 4,     # customer number needed for selecting invoices
+    'prefix'               => 'pre', # prefix to fields and row ID's
+    'amount'               => 1,     # payment amount
+    'process-pkgpart'      => scalar($conf->config('manual_process-pkgpart', $cust_main->agentnum)),
+    'process-display'      => scalar($conf->config('manual_process-display')),
+    'process-skip_first'   => $conf->exists('manual_process-skip_first'),
+    'num_payments'         => scalar($cust_main->cust_pay),
+    'surcharge_percentage' =>
+      ( $payby eq 'CARD'
+          ? scalar($conf->config('credit-card-surcharge-percentage', $cust_main->agentnum))
+          : 0
+      ),
+  )
+
+</%doc>
 
   <TR STYLE="display:block">
     <TH ALIGN="right"><% mt('Payment options') |h %></TH>
@@ -17,7 +39,8 @@
   </TR>
 
   <& /elements/tr-select-invoice.html,
-       %opt
+       'custnum' => $opt{custnum},
+       'prefix'  => $opt{prefix},
   &>
 
   <& /elements/tr-amount_fee.html,
@@ -31,6 +54,7 @@
         if ( what.value == 'select' ) {
                document.getElementById('payment_amount_row').style.display = 'none';
                document.getElementById('invoice_row').style.display = 'none';
+          document.getElementById('<% $opt{prefix} %>invoice').value = 'select';
                document.getElementById('amount').value = '';
         }
         else if ( what.value == 'invoice' ) {
@@ -41,6 +65,7 @@
         else {
                document.getElementById('payment_amount_row').style.display = 'block';
                document.getElementById('invoice_row').style.display = 'none';
+          document.getElementById('<% $opt{prefix} %>invoice').value = 'select';
                document.getElementById('amount').value = what.value;
         }