Browse Source

Fixed #14804 -- Metadata improvement, broken link fix, and alphabetization of template filters in contrib.humanize reference docs. Thanks to adamv for the patch.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@14746 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Gabriel Hurley 14 years ago
parent
commit
a0b3306349
1 changed files with 34 additions and 23 deletions
  1. 34 23
      docs/ref/contrib/humanize.txt

+ 34 - 23
docs/ref/contrib/humanize.txt

@@ -10,7 +10,10 @@ A set of Django template filters useful for adding a "human touch" to data.
 
 
 To activate these filters, add ``'django.contrib.humanize'`` to your
 To activate these filters, add ``'django.contrib.humanize'`` to your
 :setting:`INSTALLED_APPS` setting. Once you've done that, use
 :setting:`INSTALLED_APPS` setting. Once you've done that, use
-``{% load humanize %}`` in a template, and you'll have access to these filters:
+``{% load humanize %}`` in a template, and you'll have access to the following
+filters.
+
+.. templatefilter:: apnumber
 
 
 apnumber
 apnumber
 --------
 --------
@@ -20,12 +23,14 @@ number. This follows Associated Press style.
 
 
 Examples:
 Examples:
 
 
-    * ``1`` becomes ``'one'``.
-    * ``2`` becomes ``'two'``.
+    * ``1`` becomes ``one``.
+    * ``2`` becomes ``two``.
     * ``10`` becomes ``10``.
     * ``10`` becomes ``10``.
 
 
 You can pass in either an integer or a string representation of an integer.
 You can pass in either an integer or a string representation of an integer.
 
 
+.. templatefilter:: intcomma
+
 intcomma
 intcomma
 --------
 --------
 
 
@@ -33,13 +38,15 @@ Converts an integer to a string containing commas every three digits.
 
 
 Examples:
 Examples:
 
 
-    * ``4500`` becomes ``'4,500'``.
-    * ``45000`` becomes ``'45,000'``.
-    * ``450000`` becomes ``'450,000'``.
-    * ``4500000`` becomes ``'4,500,000'``.
+    * ``4500`` becomes ``4,500``.
+    * ``45000`` becomes ``45,000``.
+    * ``450000`` becomes ``450,000``.
+    * ``4500000`` becomes ``4,500,000``.
 
 
 You can pass in either an integer or a string representation of an integer.
 You can pass in either an integer or a string representation of an integer.
 
 
+.. templatefilter:: intword
+
 intword
 intword
 -------
 -------
 
 
@@ -48,26 +55,15 @@ numbers over 1 million.
 
 
 Examples:
 Examples:
 
 
-    * ``1000000`` becomes ``'1.0 million'``.
-    * ``1200000`` becomes ``'1.2 million'``.
-    * ``1200000000`` becomes ``'1.2 billion'``.
+    * ``1000000`` becomes ``1.0 million``.
+    * ``1200000`` becomes ``1.2 million``.
+    * ``1200000000`` becomes ``1.2 billion``.
 
 
 Values up to 1000000000000000 (one quadrillion) are supported.
 Values up to 1000000000000000 (one quadrillion) are supported.
 
 
 You can pass in either an integer or a string representation of an integer.
 You can pass in either an integer or a string representation of an integer.
 
 
-ordinal
--------
-
-Converts an integer to its ordinal as a string.
-
-Examples:
-
-    * ``1`` becomes ``'1st'``.
-    * ``2`` becomes ``'2nd'``.
-    * ``3`` becomes ``'3rd'``.
-
-You can pass in either an integer or a string representation of an integer.
+.. templatefilter:: naturalday
 
 
 naturalday
 naturalday
 ----------
 ----------
@@ -78,7 +74,7 @@ For dates that are the current day or within one day, return "today",
 "tomorrow" or "yesterday", as appropriate. Otherwise, format the date using
 "tomorrow" or "yesterday", as appropriate. Otherwise, format the date using
 the passed in format string.
 the passed in format string.
 
 
-**Argument:** Date formatting string as described in the :ttag:`now` tag.
+**Argument:** Date formatting string as described in the :tfilter:`date` tag.
 
 
 Examples (when 'today' is 17 Feb 2007):
 Examples (when 'today' is 17 Feb 2007):
 
 
@@ -87,3 +83,18 @@ Examples (when 'today' is 17 Feb 2007):
     * ``18 Feb 2007`` becomes ``tomorrow``.
     * ``18 Feb 2007`` becomes ``tomorrow``.
     * Any other day is formatted according to given argument or the
     * Any other day is formatted according to given argument or the
       :setting:`DATE_FORMAT` setting if no argument is given.
       :setting:`DATE_FORMAT` setting if no argument is given.
+
+.. templatefilter:: ordinal
+
+ordinal
+-------
+
+Converts an integer to its ordinal as a string.
+
+Examples:
+
+    * ``1`` becomes ``1st``.
+    * ``2`` becomes ``2nd``.
+    * ``3`` becomes ``3rd``.
+
+You can pass in either an integer or a string representation of an integer.