Browse Source

Documented compact_date filter

Rafał Pitoń 10 years ago
parent
commit
e82193b2c7

+ 16 - 0
docs/developers/settings.rst

@@ -201,6 +201,22 @@ MISAGO_AVATARS_SIZES
 Misago uses avatar cache that prescales avatars to requested sizes. Enter here sizes to which those should be optimized.
 Misago uses avatar cache that prescales avatars to requested sizes. Enter here sizes to which those should be optimized.
 
 
 
 
+MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH
+------------------------------------
+
+Date format used by Misago ``compact_date`` filter for dates in this year.
+
+Expects standard Django date format, documented `here <https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date>`_
+
+
+MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH_YEAR
+-----------------------------------------
+
+Date format used by Misago ``compact_date`` filter for dates in past years.
+
+Expects standard Django date format, documented `here <https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date>`_
+
+
 MISAGO_DYNAMIC_AVATAR_DRAWER
 MISAGO_DYNAMIC_AVATAR_DRAWER
 ----------------------------
 ----------------------------
 
 

+ 9 - 0
docs/developers/template_tags.rst

@@ -57,6 +57,15 @@ Captures part of template to variable that may then be displayed many more times
 There is also trimmed flavour ``capture trimmed as`` that trims captured template part before assinging it to variable.
 There is also trimmed flavour ``capture trimmed as`` that trims captured template part before assinging it to variable.
 
 
 
 
+misago_dates
+============
+
+``compact_date`` filter
+-----------------------
+
+Filter that formats date according to format defines in ``MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH`` setting if date is in current year, or ``MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH_YEAR`` if not. Defaults to "7 may" for same year dates and "23 may 13" for past year dates.
+
+
 misago_editor
 misago_editor
 =============
 =============
 
 

+ 2 - 2
misago/conf/defaults.py

@@ -210,8 +210,8 @@ TIME_ZONE = 'UTC'
 
 
 # Misago specific date formats
 # Misago specific date formats
 # https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date
 # https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date
-MISAGO_COMPACT_DATE_DAY_MONTH = 'j E'
-MISAGO_COMPACT_DATE_DAY_MONTH_YEAR = 'j E y'
+MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH = 'j M'
+MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH_YEAR = 'j M y'
 
 
 
 
 # Use Misago CSRF Failure Page
 # Use Misago CSRF Failure Page

+ 6 - 2
misago/core/templatetags/misago_dates.py

@@ -7,9 +7,13 @@ from django.utils import timezone
 register = template.Library()
 register = template.Library()
 
 
 
 
+FORMAT_DAY_MONTH = settings.MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH
+FORMAT_DAY_MONTH_YEAR = settings.MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH_YEAR
+
+
 @register.filter
 @register.filter
 def compact_date(value):
 def compact_date(value):
     if value.year == timezone.now().year:
     if value.year == timezone.now().year:
-        return dj_date(value, settings.MISAGO_COMPACT_DATE_DAY_MONTH)
+        return dj_date(value, FORMAT_DAY_MONTH)
     else:
     else:
-        return dj_date(value, settings.MISAGO_COMPACT_DATE_DAY_MONTH_YEAR)
+        return dj_date(value, FORMAT_DAY_MONTH_YEAR)

+ 2 - 2
misago/templates/misago/profile/warnings.html

@@ -116,7 +116,7 @@
             <strong>{{ warning.giver_username }}</strong>,
             <strong>{{ warning.giver_username }}</strong>,
             {% endif %}
             {% endif %}
             <abbr class="tooltip-top dynamic time-ago" title="{{ warning.given_on }}" data-timestamp="{{ warning.given_on|date:"c" }}">
             <abbr class="tooltip-top dynamic time-ago" title="{{ warning.given_on }}" data-timestamp="{{ warning.given_on|date:"c" }}">
-              {{ warning.given_on|compact_date }}
+              {{ warning.given_on|compact_date|lower }}
             </abbr>
             </abbr>
           </li>
           </li>
           {% if warning.is_canceled %}
           {% if warning.is_canceled %}
@@ -132,7 +132,7 @@
             {% endcapture %}
             {% endcapture %}
             {% capture trimmed as canceled %}
             {% capture trimmed as canceled %}
             <abbr class="tooltip-top dynamic time-ago" title="{{ warning.canceled_on }}" data-timestamp="{{ warning.canceled_on|date:"c" }}">
             <abbr class="tooltip-top dynamic time-ago" title="{{ warning.canceled_on }}" data-timestamp="{{ warning.canceled_on|date:"c" }}">
-              {{ warning.canceled_on|compact_date }}
+              {{ warning.canceled_on|compact_date|lower }}
             </abbr>
             </abbr>
             {% endcapture %}
             {% endcapture %}
             {% blocktrans trimmed with user=canceler|safe canceled=canceled|safe %}
             {% blocktrans trimmed with user=canceler|safe canceled=canceled|safe %}

+ 1 - 1
misago/templates/misago/threads/base.html

@@ -93,7 +93,7 @@
               {% endif %}
               {% endif %}
 
 
               <a href="#" class="dynamic time-ago tooltip-top" data-timestamp="{{ thread.last_post_on|date:"c" }}" title="{% blocktrans with last_post=thread.last_post_on|date %}Last post from {{ last_post }}{% endblocktrans %}">
               <a href="#" class="dynamic time-ago tooltip-top" data-timestamp="{{ thread.last_post_on|date:"c" }}" title="{% blocktrans with last_post=thread.last_post_on|date %}Last post from {{ last_post }}{% endblocktrans %}">
-                {{ thread.last_post_on|compact_date }}
+                {{ thread.last_post_on|compact_date|lower }}
               </a>
               </a>
               {% endblock thread-stats %}
               {% endblock thread-stats %}
             </div>
             </div>