Skip to content

Commit

Permalink
[1.2.X] Fixed #14804 -- Metadata improvement, broken link fix, and al…
Browse files Browse the repository at this point in the history
…phabetization of template filters in contrib.humanize reference docs. Thanks to adamv for the patch.

Backport of [14746] from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@14747 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
Gabriel Hurley committed Nov 29, 2010
1 parent fe74b83 commit a647d0b
Showing 1 changed file with 34 additions and 23 deletions.
57 changes: 34 additions & 23 deletions docs/ref/contrib/humanize.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
: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
--------
Expand All @@ -20,26 +23,30 @@ number. This follows Associated Press style.

Examples:

* ``1`` becomes ``'one'``.
* ``2`` becomes ``'two'``.
* ``1`` becomes ``one``.
* ``2`` becomes ``two``.
* ``10`` becomes ``10``.

You can pass in either an integer or a string representation of an integer.

.. templatefilter:: intcomma

intcomma
--------

Converts an integer to a string containing commas every three digits.

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.

.. templatefilter:: intword

intword
-------

Expand All @@ -48,26 +55,15 @@ numbers over 1 million.

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.

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
----------
Expand All @@ -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
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):

Expand All @@ -87,3 +83,18 @@ Examples (when 'today' is 17 Feb 2007):
* ``18 Feb 2007`` becomes ``tomorrow``.
* Any other day is formatted according to given argument or the
: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.

0 comments on commit a647d0b

Please sign in to comment.