Permalink
Browse files

Document new attribute nodiscount for [subtotal].

  • Loading branch information...
1 parent e264952 commit e74fd95f635aa50872dc8e0db23015a2459bcbec @racke racke committed Jul 21, 2010
Showing with 17 additions and 2 deletions.
  1. +17 −2 refs/subtotal.tag
View
19 refs/subtotal.tag
@@ -16,13 +16,22 @@ __NAME__ synopsis
<entry>&glos-cart; name</entry>
</row>
&ROW_CURRENCYNOFORMAT;
+<row>
+ <entry>nodiscount</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>Whether to disregard discounts in subtotal calculation.</entry>
+</row>
&ROW_CURRENCYDISPLAY;
&TAG_NON_CONTAINER;
__END__
__NAME__ description
-<tag>subtotal</tag> returns the total cost of the products within a cart,
-formatted according to the currency settings.
+<tag>subtotal</tag> returns the total cost of the products within a cart.</para>
+<para>Any &glos-discount;s are applied to the total cost and the return value is
+formatted according to the currency settings. This can be prevented by the
+<literal>nodiscount</literal> and <literal>noformat</literal> attributes, respectively.
__END__
__NAME__ example: Basic example
@@ -31,6 +40,12 @@ __NAME__ example: Basic example
</programlisting>
__END__
+__NAME__ example: Subtotal without discounts
+<programlisting>
+[subtotal nodiscount=1]
+</programlisting>
+__END__
+
<!--
example: Using [subtotal] programatically
<programlisting><![CDATA[

0 comments on commit e74fd95

Please sign in to comment.