18.Form rendering options in edit.html page for django project

 

• {{ form.as_table }} will render them as table cells wrapped in <tr> tags

<h1>add contact</h1>
<form action="{% url 'contacts-new' %}" method="post">
  {% csrf_token %}

  <ul>
  {{ form.as_table }}

  </ul>
<input id='save_contact' type="submit" value="save"/>

   
</form>
<a href="{% url 'contacts-list' %}">back to list</a>
 

Output
==========================================

add contact

First name:Last name:Father name:Email:

back to list
=============================================

• {{ form.as_p }} will render them wrapped in <p> tags

<h1>add contact</h1>
<form action="{% url 'contacts-new' %}" method="post">
  {% csrf_token %}

  <ul>
  {{ form.as_p }}

  </ul>
<input id='save_contact' type="submit" value="save"/>

   
</form>
<a href="{% url 'contacts-list' %}">back to list</a>
 
================================
Output

add contact

First name:
Last name:
Father name:
Email:

back to list

 =====================================

• {{ form.as_ul }} will render them wrapped in <li> tags 

<h1>add contact</h1>
<form action="{% url 'contacts-new' %}" method="post">
  {% csrf_token %}

  <ul>
  {{ form.as_ul }}

  </ul>
<input id='save_contact' type="submit" value="save"/>

   
</form>
<a href="{% url 'contacts-list' %}">back to list</a>

Output

 =================

add contact

• First name:
• Last name:
• Father name:
• Email:

back to list
 ============================

17. How to work with file upload in django in the current project

hai guy let us see the file/image upload in the BTMS project...


first let us create a app ie., uploader using terminal in the project folder


$python manage.py startapp uploader


setting .py

INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'login',
    'contacts',
    'uploader',
)




MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
MEDIA_URL = '/media/'


----------------------





in the app ie., uploader

model.py

from django.db import models
from django.forms import ModelForm

class Upload(models.Model):
    pic = models.ImageField("Image", upload_to="images/")    
    upload_date=models.DateTimeField(auto_now_add =True)

# FileUpload form class.
class UploadForm(ModelForm):
    class Meta:
        model = Upload

View.py

from django.shortcuts import render
from uploader.models import UploadForm,Upload
from django.http import HttpResponseRedirect
from django.core.urlresolvers import reverse
# Create your views here.
def upload(request):
    if request.method=="POST":
        img = UploadForm(request.POST, request.FILES)     
        if img.is_valid():
            img.save()
            return HttpResponseRedirect(reverse('imageupload'))
    else:
        img=UploadForm()
    images=Upload.objects.all()
    return render(request,'upload.html',{'form':img,'images':images})

Create a folder templates and create a file upload.html:

<div style="padding:40px;margin:40px;border:1px solid #ccc">
    <h1>picture</h1>
    <form action="#" method="post" enctype="multipart/form-data">
        {% csrf_token %} {{form}}
        <input type="submit" value="Upload" />
    </form>
    {% for img in images %}
        {{forloop.counter}}.<a href="{{ img.pic.url }}">{{ img.pic.name }}</a>
        ({{img.upload_date}})<hr />
    {% endfor %}
</div>

url.py
from django.conf.urls import patterns, include, url
from login.views import hello_page, home
from django.contrib import admin
from uploader.views import upload
admin.autodiscover()
import uploader.views
import contacts.views
from django.conf import settings
from django.conf.urls.static import static
urlpatterns = patterns('',
    # Examples:
    # url(r'^$', 'btms.views.home', name='home'),
    # url(r'^blog/', include('blog.urls')),

   # url(r'^admin/', include(admin.site.urls)),
    url(r'^upload/', 'uploader.views.upload', name='imageupload'),
    url(r'^$', hello_page, name='home'),
    url(r'^home/', home),
    url(r'^view/',contacts.views.ListContactView.as_view(),name='contacts-list',),
    url(r'^new$', contacts.views.CreateContactView.as_view(), name='contacts-new',),
   


)+ static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)






=======


now the output is .....

it is fine ......

16. Let us understand how the view is working in django

so here how the this list is coming ...... let us check what is going inside ....


so for this we need to see the pages ie.,

1. contact_list.html
2. model.py

ie., check down



contact_list.html

<h1>Contacts</h1>

<ul>
{% for contact in object_list %}
<li>{{contact}}</li>
{% endfor %}
</ul>


model.py


from django.db import models

class Contact(models.Model):
    first_name = models.CharField(
        max_length=255,
    )
    last_name = models.CharField(
        max_length=255,

    )

    father_name = models.CharField(
        max_length=255,

    )

    email = models.EmailField()
  

    def __str__(self):

        return ' '.join([
            self.first_name,
            self.last_name,
            self.father_name,
        ])






so here check the red color highligted one



in the html page if we write contact in the filter that is which the list is coming

and in the model.py we wrote def __str__(self) means it is contact class only it will return and it is return with join for first name,last name and father name.

that is why it is coming......



so it means there u r getting first_name,last_name and father name write







now i want to make it different in table order................ ok before that let us try for different list order




wirte for that u need to do like this in html file  ie.,






<ul>
{% for contact in object_list %}
<li>{{contact.father_name}}</li>
{% endfor %}
</ul>

so i got only father name



now i will make the table and check for that in html file.......... ok let do it




<h1>Contacts</h1>

<table border=1>
<tr><th>First Name</th><th>Last Name</th><th>Father Name</th></tr>

{% for contact in object_list %}
<tr>
<td>{{contact.first_name}}</td>
<td>{{contact.last_name}}</td>

<td>{{contact.father_name}}</td>
</tr>
{% endfor %}
</table>



now the output is

15(c). Let us understand what we wrote in edit_contact.html in django project(Very Important)

let us consider this..... ie., 

<form action="{% url 'contacts-new' %}"

so  here we are using tags in the action attribute.  that is ....

{% url 'contacts-new' %}

{%url%} is the template tags ok 

then what is this contacts-new means  where it is going......

let us see url.py........

url.py

=====

from django.conf.urls import patterns, include, url
from login.views import hello_page, home
from django.contrib import admin

admin.autodiscover()


import contacts.views


urlpatterns = patterns('',
    # Examples:
    # url(r'^$', 'btms.views.home', name='home'),
    # url(r'^blog/', include('blog.urls')),

   # url(r'^admin/', include(admin.site.urls)),
    url(r'^$', hello_page),
    url(r'^home/', home),
    url(r'^view/',contacts.views.ListContactView.as_view(),name='contacts-list',),
    url(r'^new$', contacts.views.CreateContactView.as_view(), name='contacts-new',),



)

so in the url.py we added the  

 url(r'^new$', contacts.views.CreateContactView.as_view(), name='contacts-new',),

pattern        : ^new$

include file   : contacts.views.CreateContactView.as_view()

name           : contacts-new

so in the include file let see what is happening ....... ie., 

contacts(app)   =>   view.py   =>  CreateContactView =>  as_view()(this is functionality to view)

View.py 

======== 

from django.views.generic import ListView
from contacts.models import Contact
from django.core.urlresolvers import reverse
from django.views.generic import CreateView


class ListContactView(ListView):
      model=Contact
      template_name = 'contact_list.html'

class CreateContactView(CreateView):
      model = Contact
      template_name = 'edit_contact.html'
      
      def get_success_url(self):
          return reverse('contacts-list')

 --------------------------- so that is fine

so let see more ie, 

{% csrf_token %}

  <ul>
  {{ form.as_ul }}

  </ul>
<input id='save_contact' type="submit" value="save"/>

    
</form> 

so in these what is 

 {% csrf_token %} ?????????????

csrf=

Cross Site Request Forgery protection

 After more investigation it appears the {% csrf_token %} is

 always inserted if the form has method post and not if it doesn't.

 Very clever auto protection from Django.

ie., 

<form action="{% url 'contacts-new' %}" method="post"> 

so better to use ....

------------------- next what we will see 

<ul>
  {{ form.as_ul }}

  </ul>

let us know what is these actually doing .... ie.,

  {{ form.as_ul }} ???????????

in the output....... 

ie., 


 

i did not wrote the input box for every column ie., first name,, last name,, father name and email...

so when i given that in {{ form.as_ul}} i am getting that in unordered list becuase it is there in 

between <ul> tag ....

so how it is happening.....

let us think what actually it is happens....

so .....  

 let us take  files ie., 

edit_contact.html ,model.py , url.py and view.py

edit_contact.html

=================

<h1>add contact</h1>
<form action="{% url 'contacts-new' %}" method="post">
  {% csrf_token %}

  <ul>
  {{ form.as_ul }}

  </ul>
<input id='save_contact' type="submit" value="save"/>

    
</form>
<a href="{% url 'contacts-list' %}">back to list</a>

 View.py ======== from django.views.generic import ListView
from contacts.models import Contact
from django.core.urlresolvers import reverse
from django.views.generic import CreateView


class ListContactView(ListView):
      model=Contact
      template_name = 'contact_list.html'

class CreateContactView(CreateView):
      model = Contact
      template_name = 'edit_contact.html'
      
      def get_success_url(self):
          return reverse('contacts-list')

in model file we have four column ie., 

 model.py

=========

 from django.db import models

class Contact(models.Model):
    first_name = models.CharField(
        max_length=255,
    )
    last_name = models.CharField(
        max_length=255,

    )

    father_name = models.CharField(
        max_length=255,

    )

    email = models.EmailField()
   

    def __str__(self):

        return ' '.join([
            self.first_name,
            self.last_name,
        ])

 url.py

=======

from django.conf.urls import patterns, include, url
from login.views import hello_page, home
from django.contrib import admin

admin.autodiscover()


import contacts.views


urlpatterns = patterns('',
    # Examples:
    # url(r'^$', 'btms.views.home', name='home'),
    # url(r'^blog/', include('blog.urls')),

   # url(r'^admin/', include(admin.site.urls)),
    url(r'^$', hello_page),
    url(r'^home/', home),
    url(r'^view/',contacts.views.ListContactView.as_view(),name='contacts-list',),
    url(r'^new$', contacts.views.CreateContactView.as_view(), name='contacts-new',),



) 

flow steps

===========

-> so when i write {{form.as_url }} 
-> it is searching from action url ie., contact-new

-> so it will check through url.py..for contact-new... ie., 

  url(r'^new$', contacts.views.CreateContactView.as_view(), name='contacts-new',),

-> so it will go to contact---->  view  --->  CreateContactView ---->

and search for model name....... ie., 
  model = Contact

->so in model.py ----> class Contact(models.Model): --> it will send the column name what ever it have...

-> so coming to this example it will have 4 column ie., first name,last name,father name and email...

-> that column are appear with respect data type for example .... i am writing .... email as something.... without proper pattern,,,,

so i am getting error becuase model is sending the datatype also..... so it will take default validation....... ....it is great na..

Advantage of {{form.as_ul}}

=================

it is avoiding the html work... and validation for basic that is the result ....all are saying it is easy to develop compare to other......

----------------------------------- next we will see

<a href="{% url 'contacts-list' %}">back to list</a>

this is anchor tag  but in href see once again we use template tags......

so with this no need to write the complete path like 

<a href="127.0.0.1:8080/view"> back to list</a>

if we change the ip address we need to change all......

so it will become more work.... to avoid these 

django is using template tags..... great .....

15(b). Let us understand what we wrote in edit_contact.html in django project-(Tags)

Template Tags

Fundamental template tags

using

The tag using allows you to avoid repeated references to a Python dictionary in a template or dashboard report. This is a block tag with syntax

{% using <dictionary> %} ... {% endusing %}

For example:

if the 'targets' variable holds a dictionary of Congressional information, write

{% using targets %}
    Call {{ title_last }} and tell {{ them }} that {{ they }} should
    vote no:

    {{ listing_html|safe }}
{% endusing %}

instead of:

Call {{ targets.title_last }} and tell {{ targets.them }} that
{{ targets.they }} should vote no:

{{ targets.listing_html|safe }}

Report related tags

report

The tag report allows you to include a Query Report result in your Dashboard Report. You may also supply required parameters.
For example,

{% report 'progress_mail_page_clicks' with dm.id as mailing_id don.id as page_id %}

where the short_name of the query report is in quotes.

Hint

The report result comes wrapped in some HTML, for example u'<span class="query-">555</span>' The filter strip_nondigits can remove the HTML formatting.

A simpler way to include a report result is, for example, {{ reports.users_new }}. However, only the template tag report can include assignments for required parameters.

Arithmetic template tags

divide

The tag divide performs floating point division, and takes three arguments: top, bottom, and precision.
For example:

{% divide 72 499 2 %}

returns "0.14"

save_sum

The tag save_sum takes the sum of an arbitrary number of template variables and saves it to a new variable that you specify. The syntax is:

{% save_sum this that as those %}

If only one variable is specified, then save_sum allows you to copy a variable.

sign_difference

The tag sign_difference compares its two numeric arguments and returns a "-" string if and only if the first argument is less than the second. Otherwise it returns an empty string.

Data related Tags

client_domain

The tag client_domain returns the domain of your organization's ActionKit instance. The usage is always

{% client_domain %}

not {{ client_domain }}.

client_name

The tag client_name returns the name of your organization. As above, the usage is

{% client_name %}

not {{ client_name }}.

client_ssl_domain

The tag client_ssl_domain returns the SSL domain of your organization's ActionKit instance. The usage is always

{% client_ssl_domain %}

not {{ client_ssl_domain }}.

load_quick_link_info

The tag load_quick_link_info pulls a data structure of links to events by status for a specified campaign. It also includes counts by status.
For example:

{% load_quick_link_info campaign_name %}
{% using quick_link_info %}
<div><a href="{{ all.url }}">{{ all.count }} events</a></div>
<div>Counts by status:</div>
<div style="margin-left: 10px;">
<div>
   <a href="{{ open.url }}">{{ open.count }} open</a>
   (<a href="{{ open_public.url }}">{{ open_public.count }} public</a>,
   <a href="{{ open_private.url }}">{{ open_private.count }} private</a>)
</div>
{% if campaign.require_email_confirmation %}
<div><a href="{{ unconfirmed.url }}">{{ unconfirmed.count }} waiting for host confirmation</a></div>
{% endif %}
{% if campaign.require_staff_approval %}
<div><a href="{{ unapproved.url }}">{{ unapproved.count }} waiting for staff approval</a></div>
{% endif %}
<div><a href="{{ cancelled.url }}">{{ cancelled.count }} cancelled or deleted</a></div>
</div>
{% endusing %}

withevents

The tag withevents is a block tag that does a search for events near a user, and makes the information available inside the block. The syntax is:

{% withevents with user.zip as zip 'campaign_name as campaign 30 as radius %}
...code using events...
{% endwithevents %}

The withevents line supports other search arguments: "user as nearby_user" can substitute for zip, and "user as host" or "user as attendee" can substitute for zip and radius. A limit like "3 as limit" is optional.
Also available within the withevents block is {{ page_name }}. This tries to find the actual page the user used (for host/attendee sign ups) or one matching the user's language (per user.lang).
For example:

{% load actionkit_tags %}
{% withevents with user.zip as zip 'campaign_name' as campaign 30 as radius 10 as limit %}
{% for event in events %}
Event: {{ event.name }}<br />
  {{ event.starts_at }}<br />
  {{ event.venue }}<br />
  {{ event.city }}, {{ event.state }}<br />
{% endfor %}
{% endwithevents %}

Miscellaneous template tags

localtime

The tag localtime formats a particular datetime value, say an updated_at column or {{ now }} above, according to a particular format string or relative_time which smartly picks a format from 1:30 am, Jan 31, or Jan 31 2009. For example:

{% localtime object.updated_at "m/j/y, P" %}

record

The tag record is used take a specified value or variable and append it to a specified list. The list is created if necessary, and an optional argument reportresult will tell the template tag to extract an integer result from an HTML tag. This tag can be used within a for loop to build a series of report results at different points in time or for different pages.
For example:

{% record reportresult progress_users in series_users %}

appends the current value of ``{{ progress_users }}`` to the list ``{{ series_users }}``, creating it if necessary.

required_parameter

The tag required_parameter is a dummy tag used in Dashboard Reports to indicate to ActionKit that a parameter is required from the user. For example, our built-in dashboard event_report contains:

{% required_parameter "campaign_name" %}

ActionKit sees this and prompts the user to enter a value for campaign_name. After using the above tag, the variable {campaign_name} is available in the report (note the single braces).

requires_value

The tag requires_value takes one argument, and raises a Template Syntax Error if the value of the argument is not available or resolves to False. This is useful in mailing snippets.
For example,

{% requires_value targets.count %}

ensures that code involving targets will display in that email.

right_now

The tag right_now creates the variable {{ now }} that contains the Python datetime object datetime.now(). You would include this once in your template as

{% right_now %}

before using filters like now|months_until and now|months_past.
Right_now also adds to context a variable {{ months_for_chart }} that is necessary to create the x-axis for our month-by-month bar graph charts used in certain dashboards.

select_index

The tag select_index takes a list, an index, and a variable name to save list[index] to.
For example:

{% select_index dogs 3 as dog %}

15(a). Let us understand what we wrote in edit_contact.html in django project-(Filters)

Filters

Arithmetic filters

Many of the filters in this section were designed to act on Query Report results. Our report results that return a single value are wrapped in a <span> html tag. For example, a variable containing a report result would actually hold <span class="query-">555</span> not '555.' While the HTML will render invisibly, built-in filters like add and subtract cannot handle a such a string. Many of our filters will strip away the HTML tag to pull out the report value.
More precisely, the filters extract the first occurrence of an integer or real number.

add

The filter add returns the sum of the argument and the value. This overrides Django's built-in filter which works on integers only. This filter can extract a number from the value and argument and add both floats and integers, rounding results to two decimal places (for adding dollar amounts, for example).
For example:

if a is <span class="query-">25.50</span> and b is 30

a|add:b

returns 55.25

commify

The filter commify renders a numeric value with commas as the thousands separator. This filter currently only works on integers, but like arithmetic filters above it will extract an integer from a string containing non-numeric characters.

humanize_seconds

The filter humanize_seconds takes a numeric argument (as a string or an integer) of a number of seconds and converts it to a smart string of the form "X days, X hours, X minutes, X seconds" with an appropriate level of detail (no more than two units).
For example:

{{ 5982|humanize_seconds }} and {{ 200000|humanize_seconds }}

return '1 hour, 39 minutes' and '2 days, 7 hours', respectively

mod

The filter mod returns the integer remainder of the value divided by the argument. Value and argument are coerced to be integers and this essentially exposes Python's % operator to you.
For example:

'35'|mod:'4'

returns 3

multiply

The filter multiply returns the product of the value mutiplied by the argument.
For example:

{{ suggested_ask|multiply:"2" }}

returns the user's suggested ask as defined on your page times two.

percent_of

The filter percent_of returns the value divided by the argument, formatted as a percentage with one decimal place.
For example:

If value is 72 and argument is 499

{{ value|percent_of:argument }}

returns '14.4%'

percent_of2

The filter percent_of2 functions like percent_of but returns the percentage formatted to two decimal places.

subtract

The filter subtract returns the difference of the value and the argument. Like add, this overrides Django's filter.

Text related filters

akid

The filter akid takes a string value and a user object as its argument (or anything with either an attribute or method token) and modifies all client links in the string by appending ?akid=[token] or &akid=[token] if the url has a querystring. Client links are those where the top-level domain is actionkit.com or one of your hostnames. Links appearing inside a src="" attribute, such as images, are excluded.

ak_field

The filter ak_field is used to translate a field name in your page templates. For example, we could write:

{% filter ak_field:"email" %}E-mail{% endfilter %}

Django's built-in filter template tag ensures that ak_field applies to the entire text contained in the tag. The text "E-mail" is replced by the translation for field_email in the selected language for the page being viewed. If no translated text is avilable, "E-mail" will be displayed by default.

ak_text

The filter ak_text works like ak_field above and can be used to translate any custom phrases you want. First, go to Pages > Related Tools > Manage Languages. Click Edit on the language your page will use for translation and click "Translate another piece of text" at the bottom. Enter a label in the left box and the translation into the right box.
For example, if the label is "hokey_pokey", include this block in your template:

{% filter ak_text:"hokey_pokey" %}
Do the hokey pokey and turn yourself around (that's what it's all about)
{% endfilter %}

The text will be replaced by your translation, with the enclosed text being used as a default.

blank_money_field

The filter blank_money_field filters a string containing a field for a donation amount so that the field is blank instead of 0.00.

break_long_words

The filter break_long_words takes a string value and returns the string with a space inserted in any long stretches of non-whitespace characters. The argument specifies how many characters are left untouched before breaking up a word; it is optional and defaults to 30.
For example:

if alpha = abcdefghijklmnopqrstuvwxyz0123456789

{{ alpha|break_long_words:15 }}

yields u'abcdefghijklmno pqrstuvwxyz0123 456789'

collapse_spaces

The filter collapse_spaces takes a string value and returns the string with runs of whitespace replaced by a single space or a single new line (depending on whether the whitespace was within one line or spanned more than one line, respectively).

endswith

The filter endswith returns True if value ends with arg. This filter exposes Python's <string>.endswith(<string>) method.

escapeall

The filter escapeall takes a string value and escapes both accented characters and HTML-unsafe ones.

has_8bit

This one is confusingly named, for legacy reasons. The filter has_8bit returns True or False depending on whether a string contains characters outside the range \\x00 to \\xff. In other words, it will be True for strings that contain multi-byte Unicode characters.

has_rtl

The filter has_rtl returns True or False depending on whether a string contains right-to-left characters in it, e.g. Hebrew and Arabic characters.

is_defined

The filter is_defined returns True if the value is not None.

is_nonblank

The filter is_nonblank returns True if the string does not appear blank when rendered - that is, it consists of more than just whitespace and invisible HTML.
For example the strings with spaces and \t , and &nbsp; , and <p></p><div class="lol">&nbsp;</div> would all return False.

json

The filter json returns the value encoded as a JSON data structure without any HTML escaping.

login_string

The filter login_string is used in mailings to supply the login hash for an ActionKit user to access event pages, recurring donation management pages and any other pages that require login. This goes in the links query string as ?i=[login_string]. It expects to be passed a dict with a key id that contains the user_id.
For example:

http://roboticdogs.actionkit.com/event/{{ page_name }}/tools/?i={{ user|login_string }}

matches

The filter matches returns True if value contains the regular expression in arg case insensitively. This filter uses Python's re module. Further information on regular expression syntax can be found in the documentation.

no_blank_paragraphs

The filter no_blank_paragraphs takes a string and removes HTML paragraphs that would render as blank (whitespace or invisible HTML).
For example:

if text is <p class='content'>&nbsp;</p>,

{{ text|no_blank_paragraphs }}

returns an empty string

nospam

The filter nospam filters a string value by returning a blank string if the value contains HTML, links, or profanity. This can be used to remove spammy comments or other user input.

pretty_json

The filter pretty_json returns the value rendered as a pretty-fied JSON structure: with indentations, sort keys in dictionaries and HTML escaping.

readable_identifier

The filter readable_identifier take a string value; it replaces each underscore with a space, capitalizes the first character and puts the rest in lowercase.

redirect_links

The filter redirect_links takes a string value and rewrites links as redirect urls. Links appearing inside a src="" attribute and those with no_redirect=1 or no_akid=1 in the query string are excluded.

referring_akid

The filter referring_akid takes a string value and a user object as its argument (or anything with an attribute or method of token) and modifies all client links in the string by appending ?referring_akid=[token] or &referring_akid=[token] if the url has a querystring. Client links are those where the top-level domain is actionkit.com or one of your hostnames. Links appearing inside a src="" attribute, such as images, are excluded.

replacechar

The filter replacechar takes a string value that it acts on and a two character string for an argument. The argument consists of the character to be replaced followed by the character it is replaced with. The replacement is done for every occurrence within the value.
For example:

{{ "1.2 km"|replacechar:".," }}

returns 1,2 km. This filter is useful for display distance for countries that use the comma in the standard display.

single_line

The filter single_line takes a string value and returns the string with newlines (and adjacent whitespace) replaced by a single space. This is useful for text-only versions of transactional mail, for instance.

spaces_to_underscores

The filter spaces_to_underscores takes a string value; it replaces each space with an underscore and converts the string to lowercase.

star_required

The filter star_required takes a string value containing the HTML for a field and searches for class="required". If found, it adds a * to show that the field is required.

startswith

The filter startswith returns True if the string value begins with arg (as a substring). This filter exposes Python's <string>.startswith(<string>) method.

strip

The filter strip returns the string value with leading and trailing whitespace removed. This exposes Python's <string>.strip() method.

strip_nondigits

The filter strip_nondigits takes a string value and returns only the 0-9 digits contained within it. This is useful for stripping away any non-numeric formatting so that the resulting numeric string can be passed to an arithmetic tag. If you are writing a Dashboard Report that combines the integer results of several Query Reports, use this filter to remove the HTML formatting from the Query Report result like <span class="query-">555</span> so that it can be used in intermediate computations.

tag_links

The filter tag_links takes a string value and an argument consisting of a tag. Client links (with the top-level domain of actionkit.com or one of your registered domains) in the string have ?[tag] appended, or &[tag] if a query string already exists. Links appearing inside an src="" attribute, such as images, are excluded.
For example:

if text is

"Click to sign an important petition:
<a href='http://roboticdogs.actionkit.com/sign/robotic_kitties'>
http://roboticdogs.actionkit.com/sign/robotic_kitties</a>"

then

{{ text|tag_links:'dog=yes'|safe }}

returns

"Click to sign an important petition:
<a href='http://roboticdogs.actionkit.com/sign/robotic_kitties?dog=yes'>
http://roboticdogs.actionkit.com/sign/robotic_kitties?dog=yes</a>"

truncateeachword

The filter trunchateeachword takes a string value and a numeric argument. If any word in the string is longer than the specified character length, that word is cut off with the ellipsis "..." appended.
For example:

if text is reallylongword anotherendlessword

{{ text|truncateeachword:8 }}

returns u'reallylo... anothere...'

truncatehtml

The filter truncatehtml takes a string value and a numeric argument. If the length of the HTML string exceeds the specified character length, the string is cut off with the ellipsis "..." appended. However, care is taken not to cut off the string in the middle of an HTML entity, and after the ellipsis any open HTML tags are closed. HTML escaping is also applied to the output.
For example:

if document is the string <html><body><p>ActionKit is built by We Also Walk Dogs.</p></body></html>, then

{{ document|truncatehtml:20|safe }}

yields u'<html><body><p>ActionKit is built b...</p></body></html>

truncateletters

The filter truncateletters takes a string value and a numeric argument. If the length of the string exceeds the number of characters in arg, the string gets truncated to that length and "..." is appended. This can be useful for keeping long page titles and mailing subjects to a manageable size.

List related filters

columns

The filter columns acts on a list to break it into sublists (rows) of n elements (columns) each. When the list does not divide evenly by n, this method divides the first columns evenly, leaving the remainder in the last column. In more precise mathematical terms, in the cases when n does not divide then len(value), it takes the columns to have length int(1 + (len(value)/n)). The rows have length n or n-1.
For example:

if data is range(0,10):

{{ data|columns: 3 }}

returns [[0, 4, 8], [1, 5, 9], [2, 6], [3, 7]]
i.e.:

[[0, 4, 8],
 [1, 5, 9],
 [2, 6],
 [3, 7]]

This filter is used in ActionKit in the Donate template (in the Original templateset and any others that haven't been too heavily rewritten). We use the following code to format the donation amount choices into three columns:

<div id="amount_list">
<p><label for="amount">Donation Amount:</label>
<table border="1">
{% for row in amounts|columns:3 %}
<tr>
    {% for amount in row %}
        ... code to display the radio buttons and the amounts ...
    {% endfor %}
</tr>
{% endfor %}
</table>
</div>

We've set up a page illustrating this use of columns with 13 donation amounts at https://roboticdogs.actionkit.com/donate/columnexample/#1.
See also:

• rows

contains

The filter contains returns true if the value contains the arg.
For example:

if zips is ['10001', '10003', '10011']

{{ zips|contains:'10001' }}

would be True.

is_in

The filter is_in is the reverse of contains; it returns true if the arg contains the value.
For example:

{{ '10001'|is_in:zips }}

returns True.

islice

The filter islice returns a slice of the list (or generator) object. This has the same syntax as Python's list slicing. For example,

If list is ['we', 'also', 'walk', 'dogs'],

{{ list|islice:"1:3" }}

returns ['also', 'walk'].

This filter is similar to Django's built-in filter slice but uses Python's itertools.islice().

join

The filter joins takes a list for its value and a delimiter as its argument and returns a string of lists elements joined by the delimiter. This mirrors the functionality of Python's delimiter.join(<list>) method. The argument is mandatory.
For example:

If list is ['we', 'also', 'walk', 'dogs'],

{{ list|join:'' }}

returns the string u'wealsowalkdogs'

limit

The filter limit returns the first n items (specified by the arg) of a list (supplied as the value).

nth

The filter nth returns n-th item (specified by the arg, counting from 0) of a list (supplied as the value). While Django already supports list-indexing in templates, e.g. {{ states.4 }}, our filter works in daisy chains of several filters.
For example:

if states is ['AL', 'CA', 'CA', 'OR'],

{{ states|unique|nth:2 }}

will return OR
but {{ states|unique.2 }} does not parse.

rows

The filter rows acts on a list to break it into n "rows" (sublists). When the list does not divide evenly by n, this method divides the first rows evenly, leaving the remainder in the last row. In more precise mathematical terms, in this method when n does not divide the len(value), it takes the rows to have length int(1 + (len(value)/n)). This can lead to some rows being empty in cases where n is almost as big as len(value).
Note the the order of the elements in value is preserved.
For example:

if data is range(0,10)

{{ data|rows:3 }}

returns [[0, 1, 2, 3], [4, 5, 6, 7], [8, 9]]

and

{{ data|rows:9 }}

returns [[0, 1], [2, 3], [4, 5], [6, 7], [8, 9], [], [], [], []]

rows_distributed

The filter rows_distributed acts like rows, but breaks up the value into n rows in an intuitive manner. A list of length 10 is broken into 4 rows as 3, 3, 2, 2 not 3, 3, 3, 1.
For example:

if data is as above

{{ data|rows_distributed:9 }}

gives us [[0, 1], [2], [3], [4], [5], [6], [7], [8], [9]]

shuffle

The filter shuffle takes a list for a value and returns the list with its items shuffled randomly. This filter does not take an argument.

split

The filter splits a string value on a given separator (default is whitespace) and returns a list. This could be useful for constructing loops. The functionality is analogous to Python's .split() method for strings.
For example:

If value is the string "We Also Walk Dogs"

{{ value|split:" " }}

returns the list [u'We', u'Also', u'Walk', u'Dogs']

Another example:

If months is the string "January February March April"

{% for month in months|split %}
---something involving {{month}}---
{% endfor %}

creates a loop where {{month}} takes the values "January", "February", etc in turn.

unique

The filter unique takes a sequence type (list, tuple, etc) and filters it to return a generator object with only distinct elements.
We limit this to the first 100 items to avoid problems with overly large inputs.
unique accepts an optional argument, key, and if present filters the elements for distinct values of getattr(item, key, item) for each item in value.
For example:

if value is ['Action', 'Action', 'Kit', 'Action', 'Kit']

value|unique

returns a generator object that yields 'Action' and then 'Kit'.

Data related filters

actiontaken

The filter actiontaken returns 1 or 0 depending on whether or not the user (the value) has taken an action on the page specified as the arg.
For example,

{{ user|actiontaken:1 }}

returns 1 if the user took action on page_id 1.

campaign

The filter campaign takes a campaign name for its value and a column in events.campaign for its arg, and returns the column's value from the database. Columns include id, name, title, starts_at, max_event_size, etc. See the database table reference for a complete listing.

tagged

The filter tagged returns 1 or 0 depending on whether or not the user (the value) has taken an action on any of the pages associated with the tag specified as the arg.
For example,

{{ user|tagged:"dogs" }}

returns 1 if the user has taken any action on dog-related pages.

Miscellaneous filters

chart_data

The filter chart_data takes a list of numeric values and returns a comma-separated string for use in the Google charts some of our built-in Dashboard Reports use. If value has more or fewer than 12 elements, items are truncated from the left or zeroes are padded onto the right.

chart_data_misc

The filter chart_data_misc takes a list of numeric values and returns a comma-separated string for use in the Google charts some of our built-in Dashboard Reports use.

chart_labels

The filter chart_labels takes a list of numeric values and returns a pipe ('|') separated string for use in the Google charts some of our built-in Dashboard Reports use.

chart_spacing and chart_scale

These filters are used in the Google charts in some of our built-in Dashboard Reports. They act on the chart data in order to determine an appropriate y-axis scale and y-axis spacing for the chart.

country_names

The filter country_names takes a string consisting of a two-letter ISO language code, for example 'en' or 'fr' or 'pl.' It returns a list of tuples, with tuples of the form (<english country name>, <country name in the given language>) for each country.
For example:

{{ 'fr'|country_names }}

returns a list with elements such as (u'Poland', u'Pologne').

days_past

The filter ``days_past` can be used in your dashboard reports to generate a list of timestamps for the last several days, the number of which is specified by the argument. The value supplied to the filter must be a Python datetime object. You can use this to build a table or Google chart of data by day.
For example:

if now holds datetime.now() and the present time is '2013-01-15 20:00:00',

{{ now|days_past:6 }}

returns ['2012-01-10 00:00:00', '2012-01-11 00:00:00', '2012-01-12 00:00:00', '2013-01-13 00:00:00', '2013-01-14 00:00:00', '2013-01-15 00:00:00']

make_urls_absolute

This filter takes an HTML string for its value and tries to convert relative URLs into absolute ones. Takes a True/False argument for whether to use SSL.

month_ago

The filter month_ago acts on a MySQL style datetime value and subtracts one month.
For example:

{{ '2012-06-01 15:15:30'|month_ago }}

returns '2012-05-01 15:15:30'

month_year

The filter month_year acts on a MySQL style datetime value to return a prettified Month Year string we can use in monthly reports.
For example,

{{ "2010-06-01 01:02:03"|month_year }}

returns "June 2012".

months_past

The filter ``months_past` is used in the built-in progress report dashboards to generate a list of the last several months, the number of which is specified by the argument. The value supplied to the filter must be a Python datetime object. This can be used to build a table with a row of data for each month or to build a table for a Google chart.
For example:

if now holds datetime.now() and the present time is '2012-06-01 19:00:00',

{{ now|months_past:12 }}

returns ['2011-07-01 00:00:00', '2011-08-01 00:00:00', '2011-09-01 00:00:00', '2011-10-01 00:00:00', '2011-11-01 00:00:00', '2011-12-01 00:00:00', '2012-01-01 00:00:00', '2012-02-01 00:00:00', '2012-03-01 00:00:00', '2012-04-01 00:00:00', '2012-05-01 00:00:00', '2012-06-01 00:00:00']

months_pastyr

The filter months_pastyr has been deprecated. Please see months_past.

months_until

The filter months_until has a specific use in the built-in progress report dashboards. It acts on a Python datetime object that holds the current time, and returns a list that can be iterated over with an entry for each month in the calendar year up to now.
For example:

if now holds datetime.now() and the present time is '2012-06-01 19:00:00',

{{ now|months_until }}

returns ['2012-01-01 00:00:00', '2012-02-01 00:00:00', '2012-03-01 00:00:00', '2012-04-01 00:00:00', '2012-05-01 00:00:00', '2012-06-01 00:00:00']

weeks_past

The filter weeks_past can be used in your dashboard reports to generate a list of timestamps for the last several weeks, the number of which is specified by the argument. The value supplied to the filter must be a Python datetime object. You can use this to build a table or Google chart of data by week.
For example:

if now holds datetime.now() and the present time is '2013-01-15 20:00:00',

{{ now|weeks_past:6 }}

returns ['2012-12-11 00:00:00', '2012-12-18 00:00:00', '2012-12-25 00:00:00', '2013-01-01 00:00:00', '2013-01-08 00:00:00', '2013-01-15 00:00:00']