This library is basically fork from django-chunks but with few improvements.
Biggest feature is that added possibility to bind chunks to particular objects via Generic Relations.
Second feature is possibility to render any chunks by special "builder" objects which can build any chunk by provided rules.
Third feature is cache of all of above - particular chunk, object-related chunk or list of chunks for special object.
Anyone have project where content consist from several parts like content and custom column or some quote etc. It's easy to make with django-smartchunks - you can write custom builder which may display custom tweets or some part of your content etc.
chunkArguments:- key
- cache_time
object_chunkArguments:- object
- key
- cache_time
- default_chunk
object_chunks_list- object
- context_name
For object_chunk you may specify default_chunk argument which will
display plain chunk in case if chunk with provided key for particular object
is not exist.
{% load chunks %}
<html>
<head>
<title>Test</title>
</head>
<body>
<h1> Blah blah blah</h1>
<div id="sidebar">
...
</div>
<div id="left">
{% chunk "home_page_left" %}
</div>
<div id="right">
{% chunk "home_page_right" %}
</div>
<div id="content">
<blockquote>{% object_chunk content "quote" %}</blockquote>
<p>{{ content.body }}</p>
<div class="somedata">
{% object_chunk content "quote" 0 %}
</div>
</div>
</body>
</html>
Builders are useful mechanism to make chunks "smarter". You may create widgets based on your own code but display it as simple chunks.
ChunkBuilder methods
id- this property will returnchunk=<builder-title>where<builder-title>is ident of your widgetappropriate_key- override this method to handle your own logic of initialize builderrender- method where you render your chunk. You'll get all necessary data to do it, especially request, current template context, current chunk and inline object
Simple widget which display few last tweets from database:
from django.template.loader import render_to_string
from chunks.builders import ChunkBuilder
from models import Tweet
class TwitterStreamWidget(ChunkBuilder):
ident = u'twitter-widget'
title = u'Twitter widget'
def appropriate_key(self, name, chunk=None, obj=None):
if not chunk:
return False
if self.id in chunk.content:
return True
def render(self, request, chunk, parent=None, context={}):
"""Your tweets stored in Tweet database"""
tweets_count = 5
twitter_account = 'testuser'
content = chunk.content.replace(self.id, '')
tweets = Tweet.objects.all()[0:tweets_count]
return render_to_string('twitter/box.html', {
'tweets': tweets,
'chunk': chunk,
'parent': parent,
'context': context,
'twitter_account': twitter_account
})
Place above code into chunk_builders.py. You don't need to import file into
any location - django-smartchunks will care (and cache) about that at startup.