Document new attribute nodiscount for [subtotal].

interchange · Jul 21, 2010 · e74fd95 · e74fd95
1 parent e264952
commit e74fd95
Showing 1 changed file with 17 additions and 2 deletions.
diff --git a/refs/subtotal.tag b/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[