Updated CREDITS, docs and bumped version to 1.0.5

This commit is contained in:
Jose Soares 2012-06-04 08:46:22 -04:00
parent 919c8c791a
commit 895a503eda
24 changed files with 439 additions and 247 deletions

View file

@ -1,12 +1,13 @@
Corey Oordt github.com/coordt
Erik Simmler github.com/tgecho
Martin Ogden githun.com/martinogden
Ramiro Morales github.com/ramiro
Evan Culver github.com/eculver
Andrzej Herok github.com/aherok
Jonathan Hensley github.com/jhensley
Justin Quick github.com/justquick
Josh Ourisman github.com/joshourisman
Jose Soares github.com/josesoa
Corey Oordt github.com/coordt
Erik Simmler github.com/tgecho
Martin Ogden githun.com/martinogden
Ramiro Morales github.com/ramiro
Evan Culver github.com/eculver
Andrzej Herok github.com/aherok
Jonathan Hensley github.com/jhensley
Justin Quick github.com/justquick
Josh Ourisman github.com/joshourisman
Jose Soares github.com/jsoa
David Charbonnier github.com/oxys
Brad Jasper github.com/bradjasper
Brad Jasper github.com/bradjasper
Martin Matusiak github.com/numerodix

View file

@ -1,7 +1,7 @@
__version_info__ = {
'major': 1,
'minor': 0,
'micro': 4,
'micro': 5,
'releaselevel': 'final',
'serial': 1
}

View file

@ -85,6 +85,16 @@ FK_REGISTRY
.. _THUMBNAIL_UPLOAD_PATH:
.. _REGISTER_ADMIN:
REGISTER_ADMIN
==============
**Default:** ``True``
**Description:** If you write your own category class by subclassing ``CategoryBase`` then you probably have no use for registering the default ``Category`` class in the admin.
THUMBNAIL_UPLOAD_PATH
=====================
@ -108,4 +118,4 @@ JAVASCRIPT_URL
**Default:** ``STATIC_URL or MEDIA_URL + 'js/'``
**Description:** Allows for customization of javascript placement.
**Description:** Allows for customization of javascript placement.

View file

@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -79,6 +79,14 @@ div.sphinxsidebar input {
font-size: 1em;
}
div.sphinxsidebar input[type="text"] {
width: 170px;
}
div.sphinxsidebar input[type="submit"] {
width: 30px;
}
img {
border: 0;
}
@ -236,7 +244,6 @@ img.align-center, .figure.align-center, object.align-center {
}
.align-center {
clear: both;
text-align: center;
}
@ -413,7 +420,7 @@ dl.glossary dt {
}
.footnote:target {
background-color: #ffa
background-color: #ffa;
}
.line-block {
@ -440,10 +447,16 @@ dl.glossary dt {
font-style: oblique;
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
td.linenos pre {
@ -524,4 +537,4 @@ span.eqno {
#top-link {
display: none;
}
}
}

View file

@ -2,9 +2,9 @@
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilties for all documentation.
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -185,9 +185,9 @@ var Documentation = {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<li class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>')
.appendTo($('.sidebar .this-page-menu'));
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.appendTo($('#searchbox'));
}
},
@ -213,7 +213,7 @@ var Documentation = {
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('.sidebar .this-page-menu li.highlight-link').fadeOut(300);
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
},

View file

@ -1,10 +1,10 @@
/*
* searchtools.js
* ~~~~~~~~~~~~~~
* searchtools.js_t
* ~~~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilties for the full-text search.
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -36,10 +36,11 @@ jQuery.makeSearchSummary = function(text, keywords, hlwords) {
return rv;
}
/**
* Porter Stemmer
*/
var PorterStemmer = function() {
var Stemmer = function() {
var step2list = {
ational: 'ate',
@ -300,20 +301,20 @@ var Search = {
},
query : function(query) {
var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in',
'if', 'for', 'no', 'there', 'their', 'was', 'is',
'be', 'to', 'that', 'but', 'they', 'not', 'such',
'with', 'by', 'a', 'on', 'these', 'of', 'will',
'this', 'near', 'the', 'or', 'at'];
var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"];
// stem the searchterms and add them to the correct list
var stemmer = new PorterStemmer();
// Stem the searchterms and add them to the correct list
var stemmer = new Stemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = query.split(/\s+/);
var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null;
var objectterms = [];
for (var i = 0; i < tmp.length; i++) {
if (tmp[i] != "") {
objectterms.push(tmp[i].toLowerCase());
}
if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) ||
tmp[i] == "") {
// skip this "word"
@ -344,9 +345,6 @@ var Search = {
var filenames = this._index.filenames;
var titles = this._index.titles;
var terms = this._index.terms;
var objects = this._index.objects;
var objtypes = this._index.objtypes;
var objnames = this._index.objnames;
var fileMap = {};
var files = null;
// different result priorities
@ -357,40 +355,19 @@ var Search = {
$('#search-progress').empty();
// lookup as object
if (object != null) {
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
if (fullname.toLowerCase().indexOf(object) > -1) {
match = objects[prefix][name];
descr = objnames[match[1]] + _(', in ') + titles[match[0]];
// XXX the generated anchors are not generally correct
// XXX there may be custom prefixes
result = [filenames[match[0]], fullname, '#'+fullname, descr];
switch (match[2]) {
case 1: objectResults.push(result); break;
case 0: importantResults.push(result); break;
case 2: unimportantResults.push(result); break;
}
}
}
}
for (var i = 0; i < objectterms.length; i++) {
var others = [].concat(objectterms.slice(0,i),
objectterms.slice(i+1, objectterms.length))
var results = this.performObjectSearch(objectterms[i], others);
// Assume first word is most likely to be the object,
// other words more likely to be in description.
// Therefore put matches for earlier words first.
// (Results are eventually used in reverse order).
objectResults = results[0].concat(objectResults);
importantResults = results[1].concat(importantResults);
unimportantResults = results[2].concat(unimportantResults);
}
// sort results descending
objectResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
importantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
unimportantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
// perform the search on the required terms
for (var i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
@ -489,7 +466,7 @@ var Search = {
listItem.slideDown(5, function() {
displayNextItem();
});
});
}, "text");
} else {
// no source available, just display title
Search.output.append(listItem);
@ -510,9 +487,74 @@ var Search = {
}
}
displayNextItem();
},
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
var importantResults = [];
var objectResults = [];
var unimportantResults = [];
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
if (fullname.toLowerCase().indexOf(object) > -1) {
var match = objects[prefix][name];
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
if (otherterms.length > 0) {
var haystack = (prefix + ' ' + name + ' ' +
objname + ' ' + title).toLowerCase();
var allfound = true;
for (var i = 0; i < otherterms.length; i++) {
if (haystack.indexOf(otherterms[i]) == -1) {
allfound = false;
break;
}
}
if (!allfound) {
continue;
}
}
var descr = objname + _(', in ') + title;
anchor = match[3];
if (anchor == '')
anchor = fullname;
else if (anchor == '-')
anchor = objnames[match[1]][1] + '-' + fullname;
result = [filenames[match[0]], fullname, '#'+anchor, descr];
switch (match[2]) {
case 1: objectResults.push(result); break;
case 0: importantResults.push(result); break;
case 2: unimportantResults.push(result); break;
}
}
}
}
// sort results descending
objectResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
importantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
unimportantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
return [importantResults, objectResults, unimportantResults]
}
}
$(document).ready(function() {
Search.init();
});
});

View file

@ -16,7 +16,7 @@
* Once the browser is closed the cookie is deleted and the position
* reset to the default (expanded).
*
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -29,6 +29,9 @@ $(function() {
var sidebar = $('.sphinxsidebar');
var sidebarwrapper = $('.sphinxsidebarwrapper');
// for some reason, the document has no sidebar; do not run into errors
if (!sidebar.length) return;
// original margin-left of the bodywrapper and width of the sidebar
// with the sidebar expanded
var bw_margin_expanded = bodywrapper.css('margin-left');

View file

@ -1,3 +1,10 @@
// Underscore.js 0.5.5
// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc.
// Underscore is freely distributable under the terms of the MIT license.
// Portions of Underscore are inspired by or borrowed from Prototype.js,
// Oliver Steele's Functional, and John Resig's Micro-Templating.
// For all details and documentation:
// http://documentcloud.github.com/underscore/
(function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e<f;e++)c.call(d,
a[e],e,a);else{var g=b.keys(a);f=g.length;for(e=0;e<f;e++)c.call(d,a[g[e]],g[e],a)}}catch(h){if(h!=m)throw h;}return a};b.map=function(a,c,d){if(a&&b.isFunction(a.map))return a.map(c,d);var e=[];b.each(a,function(f,g,h){e.push(c.call(d,f,g,h))});return e};b.reduce=function(a,c,d,e){if(a&&b.isFunction(a.reduce))return a.reduce(b.bind(d,e),c);b.each(a,function(f,g,h){c=d.call(e,c,f,g,h)});return c};b.reduceRight=function(a,c,d,e){if(a&&b.isFunction(a.reduceRight))return a.reduceRight(b.bind(d,e),c);
var f=b.clone(b.toArray(a)).reverse();b.each(f,function(g,h){c=d.call(e,c,g,h,a)});return c};b.detect=function(a,c,d){var e;b.each(a,function(f,g,h){if(c.call(d,f,g,h)){e=f;b.breakLoop()}});return e};b.select=function(a,c,d){if(a&&b.isFunction(a.filter))return a.filter(c,d);var e=[];b.each(a,function(f,g,h){c.call(d,f,g,h)&&e.push(f)});return e};b.reject=function(a,c,d){var e=[];b.each(a,function(f,g,h){!c.call(d,f,g,h)&&e.push(f)});return e};b.all=function(a,c,d){c=c||b.identity;if(a&&b.isFunction(a.every))return a.every(c,

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Adding the fields to the database &mdash; Django Categories v1.0.1 documentation</title>
<title>Adding the fields to the database &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,13 +24,13 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="index.html" />
<link rel="next" title="Creating Custom Categories" href="custom_categories.html" />
<link rel="prev" title="Registering Models" href="registering_models.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Adding the fields to the database</h1></div>
@ -113,7 +116,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Creating Custom Categories &mdash; Django Categories v1.0.1 documentation</title>
<title>Creating Custom Categories &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,13 +24,13 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="index.html" />
<link rel="next" title="Reference" href="reference/index.html" />
<link rel="prev" title="Adding the fields to the database" href="adding_the_fields.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Creating Custom Categories</h1></div>
@ -325,7 +328,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -1,18 +1,23 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; Django Categories v1.0.1 documentation</title>
<title>Index &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,11 +26,11 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="index.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Index</h1></div>
@ -81,100 +86,167 @@
<div class="body">
<h1 id="index">Index</h1>
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a>
</div>
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#O"><strong>O</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
</div>
<h2 id="A">A</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.active">active (CategoryBase attribute)</a></dt>
<dt><a href="reference/models.html#Category.alternate_title">alternate_title (Category attribute)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.alternate_url">alternate_url (Category attribute)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.active">active (CategoryBase attribute)</a>
</dt>
<dt><a href="reference/models.html#Category.alternate_title">alternate_title (Category attribute)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.alternate_url">alternate_url (Category attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="C">C</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#Category">Category (built-in class)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase">CategoryBase (built-in class)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#Category">Category (built-in class)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase">CategoryBase (built-in class)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="D">D</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.description">description (Category attribute)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.description">description (Category attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="M">M</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.meta_extra">meta_extra (Category attribute)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.meta_keywords">meta_keywords (Category attribute)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.meta_extra">meta_extra (Category attribute)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.meta_keywords">meta_keywords (Category attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="N">N</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.name">name (CategoryBase attribute)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.name">name (CategoryBase attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="O">O</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.objects">objects (CategoryBase attribute)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.order">order (Category attribute)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.objects">objects (CategoryBase attribute)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.order">order (Category attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="P">P</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.parent">parent (CategoryBase attribute)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.parent">parent (CategoryBase attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="R">R</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="registering_models.html#register_fk">register_fk() (built-in function)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="registering_models.html#register_m2m">register_m2m() (built-in function)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="registering_models.html#register_fk">register_fk() (built-in function)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="registering_models.html#register_m2m">register_m2m() (built-in function)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="S">S</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.slug">slug (CategoryBase attribute)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#CategoryBase.slug">slug (CategoryBase attribute)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="T">T</h2>
<table width="100%" class="indextable genindextable"><tr>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.thumbnail">thumbnail (Category attribute)</a></dt>
<dt><a href="reference/models.html#Category.thumbnail_height">thumbnail_height (Category attribute)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.thumbnail_width">thumbnail_width (Category attribute)</a></dt>
<dt><a href="reference/models.html#CategoryBase.tree">tree (CategoryBase attribute)</a></dt>
</dl></td>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.thumbnail">thumbnail (Category attribute)</a>
</dt>
<dt><a href="reference/models.html#Category.thumbnail_height">thumbnail_height (Category attribute)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="reference/models.html#Category.thumbnail_width">thumbnail_width (Category attribute)</a>
</dt>
<dt><a href="reference/models.html#CategoryBase.tree">tree (CategoryBase attribute)</a>
</dt>
</dl></td>
</tr></table>
@ -185,7 +257,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Getting Started &mdash; Django Categories v1.0.1 documentation</title>
<title>Getting Started &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,13 +24,13 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="index.html" />
<link rel="next" title="Using categories in templates" href="usage.html" />
<link rel="prev" title="Installation" href="installation.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Getting Started</h1></div>
@ -152,7 +155,7 @@ Subject 2
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Django Categories v 1.0 &mdash; Django Categories v1.0.1 documentation</title>
<title>Django Categories v 1.0 &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,12 +24,12 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="#" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="#" />
<link rel="next" title="Installation" href="installation.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Django Categories v 1.0</h1></div>
@ -167,7 +170,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installation &mdash; Django Categories v1.0.1 documentation</title>
<title>Installation &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,13 +24,13 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="index.html" />
<link rel="next" title="Getting Started" href="getting_started.html" />
<link rel="prev" title="Django Categories v 1.0" href="index.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Installation</h1></div>
@ -141,7 +144,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,8 +2,6 @@
# Project: Django Categories
# Version: 1.0
# The remainder of this file is compressed using zlib.
xÚ¥VKoÛ0 ¾ûWX¯ê°{sÓ,Éæ<<3C>ÇŠ<C387>Æfl7²ÈJÓì×<C3AC>ò»IØî%ˆH}ŸHñið}î<>Æ Qg¾Pø©<C3B8>jÿQÀ…Í~Ø
w¨Pzø= Æ(5÷˜V~zêX|ßg%+8˜¥0ˆR<CB86>*<01>Åñ¥?gkØY<C398>[Ö&{š™,ã­„HðT'ŠâºuŠZ® ¯`¬„­Ç›éÓÌ™¸|µž/<2F>ÑТC#éãûGÆÃ™•ŽœÊDrhOŒ‰² £DÞHõóhJP•çÐuÖ“ùŒOçÏCwe(?‰¤´aäç¿Â¤žŠš•hw|<7C>aóËùã¬ËÉbÍ7KתËÍÊrwVÆ<56>=­ pY©8\+<2B>©ˆ¨ª@•h°² àÊÝŒøzéÌVîd=\:TDiT¥CüTÒWîJÆFsd.Eìd,vaÑI¶òAÃR´BPô~¨zæWJôL9/Ë•¥@:¥ÑÏÏ28áX7&+]Yé·´ZñCÌóG¡ÎíBL¦|9MVëå_Ë<03>²~‹ðÄÊ@‡í330VÀÎ`<ä&Ãîg£õØÚí;F¹Û×Aþü]ÇŇDé²+EØ]v9k00+EPÞEº¹­xG«|Â(-"9ñL§^²mwÉ`,Sis\wþÂ3<C382>ÆÎŒº¯ÃEÇ휟á¸è¸”¡§2¥yGjnñÍ ¼r5.à,÷7ooP¸ìA沕ËðïÜMúѽKë¦ÜëÎ~<ˆ|~€¶2­»{e´îð›…;wžùÂ!¹6Çðø!‘ÈË~œ†Ñ¡û°–±°,ÍÑ6ÕðÌtÂhÝÜfUñ2£¶¤°³
·*þXE•Î4º=ijW#;RO¹û‰ÚÚ}²}¥j¤ Z«h{ÔØ
}_WïùtùÝbÔÀñ<C380>Ú|°<>ù@3ÂúBðݱٵ)ø { $"iÅu¤E†R|·7 ÝQæ<51>ê¶b¯>€2Ó¹{ЉòQõ»©nl\<5C>ùNé)©=žOrÚ³¶büÒ{1
BÝót­°<EFBFBD>*èC ¯,Ìkâ{»z
xÚ¥VMSã0 ½çWdf¹š<C2B9>åÈ-”,ínZ˜´,³'<27>«‰Áq:Ž týÊùj(0“”K¦òž%ëI*Á°˜fÏ7•(ýÒŠKkT>ûáÜ A<C2A0>à÷˜£¶<)rzåyfsõ „`-k8˜g0•¥E#uÊóB zG|ì¯ÙzvÖàâƒÉŸW&Ïf»|­A*^ÚÂP\ŸE]¢µ„kÈ;ka«éýüjÌ"¾\ÝÆÁMèÑ¡R |}˸ݳÖQS¹Hv
ý™3Q¶
¬,ô'©~M êò £`5»]ðùíu-½Í¯oÃì‡nžXøùÇáÍl¹Šÿz<C3BF>ð ebäÖò<C396>¸æ0¿?ÁrÏîVü>޼ƒX+†Ñº9óç<C3B3>ËŸ4.¯T»”[ºTjT§a; ;.£û¾ŠƒÅ2š­Â8 {$W§9á‡çîDîIæVâAeñÉâ7[To,¬¡D/CÝEµuO­1qÅ~{ZZ§@*cQÔg9«p¬‡•®‰¬ôl­]q¹ÔCuWcX<63>©eÆ<¸žÏ^~<>!ºÂK ¡{|–øÂêÔfÃ+s0ÖÀ&Ádò?³ð<C2B3>Gáâf5õRÔ´ikmz´nN™o cÛ9'q¼TkÖc`^‰`£„j[sø²þàŽ(=Pªxá•¶“ ôÐyUÁX¥ìDÑí¯t=™ šWÂÛ£>:?Çq4Ã)ÃÄ TêLv4.óO/ð<>»©bgµ¿{“ÆåO*—?é\žûqíâýF‰è½ß"‡]±ÛªßÂP!öE eô¨aú x~Qhäíh/3¹¿÷€U,ì K OÅÛ3[0úÌïæu©ð6•¡C¡±³·l~xMyö´/eé¿QU/3MûõÍÀóbýHe(¬5r½³8}~(Û‹tëãr´Àñ•v `<60>õösŠúBðã±ÕµO8IDÓ·Òª Ý"Ù<9Ðf§ënú\±ïÞq«||Ð…hN»©qì]<5D>ûSs¢¤žpÿB!—'ÖVCŽ_ê‡ ešÙOQíøSeáÖ×ðÿ1à•3

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Reference &mdash; Django Categories v1.0.1 documentation</title>
<title>Reference &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,13 +24,13 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="../index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="../index.html" />
<link rel="next" title="Management Commands" href="management_commands.html" />
<link rel="prev" title="Creating Custom Categories" href="../custom_categories.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Reference</h1></div>
@ -114,7 +117,8 @@
<li class="toctree-l2"><a class="reference internal" href="settings.html#relation-models">RELATION_MODELS</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#m2m-registry">M2M_REGISTRY</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#fk-registry">FK_REGISTRY</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#thumbnail-upload-path">THUMBNAIL_UPLOAD_PATH</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#register-admin">REGISTER_ADMIN</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#id8">THUMBNAIL_UPLOAD_PATH</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#thumbnail-storage">THUMBNAIL_STORAGE</a></li>
<li class="toctree-l2"><a class="reference internal" href="settings.html#javascript-url">JAVASCRIPT_URL</a></li>
</ul>
@ -138,7 +142,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Management Commands &mdash; Django Categories v1.0.1 documentation</title>
<title>Management Commands &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,14 +24,14 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="../index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="../index.html" />
<link rel="up" title="Reference" href="index.html" />
<link rel="next" title="Models" href="models.html" />
<link rel="prev" title="Reference" href="index.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Management Commands</h1></div>
@ -121,7 +124,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Models &mdash; Django Categories v1.0.1 documentation</title>
<title>Models &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,14 +24,14 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="../index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="../index.html" />
<link rel="up" title="Reference" href="index.html" />
<link rel="next" title="Settings" href="settings.html" />
<link rel="prev" title="Management Commands" href="management_commands.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Models</h1></div>
@ -124,7 +127,7 @@
<dl class="attribute">
<dt id="CategoryBase.active">
<tt class="descname">active</tt><a class="headerlink" href="#CategoryBase.active" title="Permalink to this definition"></a></dt>
<dd><p><strong>Required</strong> <tt class="docutils literal"><span class="pre">BooleanField</span></tt> <em>default:</em> <tt class="xref docutils literal"><span class="pre">True</span></tt></p>
<dd><p><strong>Required</strong> <tt class="docutils literal"><span class="pre">BooleanField</span></tt> <em>default:</em> <tt class="docutils literal"><span class="pre">True</span></tt></p>
<p>Is this item active. If it is inactive, all children are set to inactive as well.</p>
</dd></dl>
@ -132,7 +135,7 @@
<dt id="CategoryBase.objects">
<tt class="descname">objects</tt><a class="headerlink" href="#CategoryBase.objects" title="Permalink to this definition"></a></dt>
<dd><p><tt class="docutils literal"><span class="pre">CategoryManager</span></tt></p>
<p>An object manager that adds an <tt class="docutils literal"><span class="pre">active</span></tt> method for only selecting items whose <tt class="docutils literal"><span class="pre">active</span></tt> attribute is <tt class="xref docutils literal"><span class="pre">True</span></tt>.</p>
<p>An object manager that adds an <tt class="docutils literal"><span class="pre">active</span></tt> method for only selecting items whose <tt class="docutils literal"><span class="pre">active</span></tt> attribute is <tt class="docutils literal"><span class="pre">True</span></tt>.</p>
</dd></dl>
<dl class="attribute">
@ -155,7 +158,7 @@
<dt id="Category.thumbnail">
<tt class="descname">thumbnail</tt><a class="headerlink" href="#Category.thumbnail" title="Permalink to this definition"></a></dt>
<dd><p><tt class="docutils literal"><span class="pre">FileField</span></tt></p>
<p>An optional thumbnail, that is uploaded to <a class="reference internal" href="settings.html#thumbnail-upload-path"><em>THUMBNAIL_UPLOAD_PATH</em></a> via <a class="reference internal" href="settings.html#thumbnail-storage"><em>THUMBNAIL_STORAGE</em></a>.</p>
<p>An optional thumbnail, that is uploaded to <a class="reference internal" href="settings.html#thumbnail-upload-path"><em>REGISTER_ADMIN</em></a> via <a class="reference internal" href="settings.html#thumbnail-storage"><em>THUMBNAIL_STORAGE</em></a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Why isn&#8217;t this an <tt class="docutils literal"><span class="pre">ImageField</span></tt>?</p>
@ -237,7 +240,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Settings &mdash; Django Categories v1.0.1 documentation</title>
<title>Settings &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,14 +24,14 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="../index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="../index.html" />
<link rel="up" title="Reference" href="index.html" />
<link rel="next" title="Template Tags" href="templatetags.html" />
<link rel="prev" title="Models" href="models.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Settings</h1></div>
@ -98,15 +101,16 @@
<p>The <tt class="docutils literal"><span class="pre">CATEGORIES_SETTINGS</span></tt> dictionary is where you can override the default settings. You don&#8217;t have to include all the settings; only the ones which you want to override.</p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#allow-slug-change" id="id10">ALLOW_SLUG_CHANGE</a></li>
<li><a class="reference internal" href="#slug-transliterator" id="id11">SLUG_TRANSLITERATOR</a></li>
<li><a class="reference internal" href="#cache-view-length" id="id12">CACHE_VIEW_LENGTH</a></li>
<li><a class="reference internal" href="#relation-models" id="id13">RELATION_MODELS</a></li>
<li><a class="reference internal" href="#m2m-registry" id="id14">M2M_REGISTRY</a></li>
<li><a class="reference internal" href="#fk-registry" id="id15">FK_REGISTRY</a></li>
<li><a class="reference internal" href="#thumbnail-upload-path" id="id16">THUMBNAIL_UPLOAD_PATH</a></li>
<li><a class="reference internal" href="#thumbnail-storage" id="id17">THUMBNAIL_STORAGE</a></li>
<li><a class="reference internal" href="#javascript-url" id="id18">JAVASCRIPT_URL</a></li>
<li><a class="reference internal" href="#allow-slug-change" id="id11">ALLOW_SLUG_CHANGE</a></li>
<li><a class="reference internal" href="#slug-transliterator" id="id12">SLUG_TRANSLITERATOR</a></li>
<li><a class="reference internal" href="#cache-view-length" id="id13">CACHE_VIEW_LENGTH</a></li>
<li><a class="reference internal" href="#relation-models" id="id14">RELATION_MODELS</a></li>
<li><a class="reference internal" href="#m2m-registry" id="id15">M2M_REGISTRY</a></li>
<li><a class="reference internal" href="#fk-registry" id="id16">FK_REGISTRY</a></li>
<li><a class="reference internal" href="#register-admin" id="id17">REGISTER_ADMIN</a></li>
<li><a class="reference internal" href="#id8" id="id18">THUMBNAIL_UPLOAD_PATH</a></li>
<li><a class="reference internal" href="#thumbnail-storage" id="id19">THUMBNAIL_STORAGE</a></li>
<li><a class="reference internal" href="#javascript-url" id="id20">JAVASCRIPT_URL</a></li>
</ul>
</div>
<p>The default settings are:</p>
@ -123,48 +127,53 @@
</pre></div>
</div>
<div class="section" id="allow-slug-change">
<span id="id1"></span><h2><a class="toc-backref" href="#id10">ALLOW_SLUG_CHANGE</a><a class="headerlink" href="#allow-slug-change" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="xref docutils literal"><span class="pre">False</span></tt></p>
<p><strong>Description:</strong> Changing the slug for a category can have serious consequences if it is used as part of a URL. Setting this to <tt class="xref docutils literal"><span class="pre">True</span></tt> will allow users to change the slug of a category.</p>
<span id="id1"></span><h2><a class="toc-backref" href="#id11">ALLOW_SLUG_CHANGE</a><a class="headerlink" href="#allow-slug-change" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="docutils literal"><span class="pre">False</span></tt></p>
<p><strong>Description:</strong> Changing the slug for a category can have serious consequences if it is used as part of a URL. Setting this to <tt class="docutils literal"><span class="pre">True</span></tt> will allow users to change the slug of a category.</p>
</div>
<div class="section" id="slug-transliterator">
<span id="id2"></span><h2><a class="toc-backref" href="#id11">SLUG_TRANSLITERATOR</a><a class="headerlink" href="#slug-transliterator" title="Permalink to this headline"></a></h2>
<span id="id2"></span><h2><a class="toc-backref" href="#id12">SLUG_TRANSLITERATOR</a><a class="headerlink" href="#slug-transliterator" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="docutils literal"><span class="pre">lambda</span> <span class="pre">x:</span> <span class="pre">x</span></tt></p>
<p><strong>Description:</strong> Allows the specification of a function to convert non-ASCII characters in the potential slug to ASCII characters. Allows specifying a <tt class="docutils literal"><span class="pre">callable()</span></tt> or a string in the form of <tt class="docutils literal"><span class="pre">'path.to.module.function'</span></tt>.</p>
<p>A great tool for this is <a class="reference external" href="http://pypi.python.org/pypi/Unidecode">Unidecode</a>. Use it by setting <tt class="docutils literal"><span class="pre">SLUG_TRANSLITERATOR</span></tt> to <tt class="docutils literal"><span class="pre">'unidecode.unidecode</span></tt>.</p>
</div>
<div class="section" id="cache-view-length">
<span id="id3"></span><h2><a class="toc-backref" href="#id12">CACHE_VIEW_LENGTH</a><a class="headerlink" href="#cache-view-length" title="Permalink to this headline"></a></h2>
<span id="id3"></span><h2><a class="toc-backref" href="#id13">CACHE_VIEW_LENGTH</a><a class="headerlink" href="#cache-view-length" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="docutils literal"><span class="pre">0</span></tt></p>
<p><strong>Description:</strong> This setting will be deprecated soon, but in the mean time, it allows you to specify the amount of time each view result is cached.</p>
</div>
<div class="section" id="relation-models">
<span id="id4"></span><h2><a class="toc-backref" href="#id13">RELATION_MODELS</a><a class="headerlink" href="#relation-models" title="Permalink to this headline"></a></h2>
<span id="id4"></span><h2><a class="toc-backref" href="#id14">RELATION_MODELS</a><a class="headerlink" href="#relation-models" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="docutils literal"><span class="pre">[]</span></tt></p>
<p><strong>Description:</strong> Relation models is a set of models that a user can associate with this category. You specify models using <tt class="docutils literal"><span class="pre">'app_name.modelname'</span></tt> syntax.</p>
</div>
<div class="section" id="m2m-registry">
<span id="id5"></span><h2><a class="toc-backref" href="#id14">M2M_REGISTRY</a><a class="headerlink" href="#m2m-registry" title="Permalink to this headline"></a></h2>
<span id="id5"></span><h2><a class="toc-backref" href="#id15">M2M_REGISTRY</a><a class="headerlink" href="#m2m-registry" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> {}</p>
<p><strong>Description:</strong> A dictionary where the keys are in <tt class="docutils literal"><span class="pre">'app_name.model_name'</span></tt> syntax, and the values are a string, dict, or tuple of dicts. See <a class="reference internal" href="../registering_models.html#registering-models"><em>Registering Models</em></a>.</p>
</div>
<div class="section" id="fk-registry">
<span id="id6"></span><h2><a class="toc-backref" href="#id15">FK_REGISTRY</a><a class="headerlink" href="#fk-registry" title="Permalink to this headline"></a></h2>
<span id="id6"></span><h2><a class="toc-backref" href="#id16">FK_REGISTRY</a><a class="headerlink" href="#fk-registry" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> {}</p>
<p><strong>Description:</strong> A dictionary where the keys are in <tt class="docutils literal"><span class="pre">'app_name.model_name'</span></tt> syntax, and the values are a string, dict, or tuple of dicts. See <a class="reference internal" href="../registering_models.html#registering-models"><em>Registering Models</em></a>.</p>
</div>
<div class="section" id="thumbnail-upload-path">
<span id="id7"></span><h2><a class="toc-backref" href="#id16">THUMBNAIL_UPLOAD_PATH</a><a class="headerlink" href="#thumbnail-upload-path" title="Permalink to this headline"></a></h2>
<div class="section" id="register-admin">
<span id="thumbnail-upload-path"></span><span id="id7"></span><h2><a class="toc-backref" href="#id17">REGISTER_ADMIN</a><a class="headerlink" href="#register-admin" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="docutils literal"><span class="pre">True</span></tt></p>
<p><strong>Description:</strong> If you write your own category class by subclassing <tt class="docutils literal"><span class="pre">CategoryBase</span></tt> then you probably have no use for registering the default <tt class="docutils literal"><span class="pre">Category</span></tt> class in the admin.</p>
</div>
<div class="section" id="id8">
<h2><a class="toc-backref" href="#id18">THUMBNAIL_UPLOAD_PATH</a><a class="headerlink" href="#id8" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="docutils literal"><span class="pre">'uploads/categories/thumbnails'</span></tt></p>
<p><strong>Description:</strong> Where thumbnails for the categories will be saved.</p>
</div>
<div class="section" id="thumbnail-storage">
<span id="id8"></span><h2><a class="toc-backref" href="#id17">THUMBNAIL_STORAGE</a><a class="headerlink" href="#thumbnail-storage" title="Permalink to this headline"></a></h2>
<span id="id9"></span><h2><a class="toc-backref" href="#id19">THUMBNAIL_STORAGE</a><a class="headerlink" href="#thumbnail-storage" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="docutils literal"><span class="pre">settings.DEFAULT_FILE_STORAGE</span></tt></p>
<p><strong>Description:</strong> How to store the thumbnails. Allows for external storage engines like S3.</p>
</div>
<div class="section" id="javascript-url">
<span id="id9"></span><h2><a class="toc-backref" href="#id18">JAVASCRIPT_URL</a><a class="headerlink" href="#javascript-url" title="Permalink to this headline"></a></h2>
<span id="id10"></span><h2><a class="toc-backref" href="#id20">JAVASCRIPT_URL</a><a class="headerlink" href="#javascript-url" title="Permalink to this headline"></a></h2>
<p><strong>Default:</strong> <tt class="docutils literal"><span class="pre">STATIC_URL</span> <span class="pre">or</span> <span class="pre">MEDIA_URL</span> <span class="pre">+</span> <span class="pre">'js/'</span></tt></p>
<p><strong>Description:</strong> Allows for customization of javascript placement.</p>
</div>
@ -177,7 +186,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Template Tags &mdash; Django Categories v1.0.1 documentation</title>
<title>Template Tags &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,13 +24,13 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="../index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="../index.html" />
<link rel="up" title="Reference" href="index.html" />
<link rel="prev" title="Settings" href="settings.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Template Tags</h1></div>
@ -206,7 +209,7 @@ as an iterable.</p>
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Registering Models &mdash; Django Categories v1.0.1 documentation</title>
<title>Registering Models &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,13 +24,13 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="index.html" />
<link rel="next" title="Adding the fields to the database" href="adding_the_fields.html" />
<link rel="prev" title="Using categories in templates" href="usage.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Registering Models</h1></div>
@ -175,7 +178,7 @@
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>model</strong> &#8211; The Django Model to link to Django Categories</li>
<li><strong>field_name</strong> &#8211; Optional name for the field <strong>default:</strong> category</li>
<li><strong>extra_params</strong> &#8211; Optional dictionary of extra parameters passed to the <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> class.</li>
@ -209,7 +212,7 @@
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>model</strong> &#8211; The Django Model to link to Django Categories</li>
<li><strong>field_name</strong> &#8211; Optional name for the field <strong>default:</strong> categories</li>
<li><strong>extra_params</strong> &#8211; Optional dictionary of extra parameters passed to the <tt class="docutils literal"><span class="pre">ManyToManyField</span></tt> class.</li>
@ -235,7 +238,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; Django Categories v1.0.1 documentation</title>
<title>Search &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -22,7 +25,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
@ -31,7 +34,7 @@
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Search</h1></div>
@ -96,7 +99,7 @@
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>

File diff suppressed because one or more lines are too long

View file

@ -2,17 +2,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Using categories in templates &mdash; Django Categories v1.0.1 documentation</title>
<title>Using categories in templates &mdash; Django Categories 1.0.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.0.1',
VERSION: '1.0.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -21,13 +24,13 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Django Categories v1.0.1 documentation" href="index.html" />
<link rel="top" title="Django Categories 1.0.5 documentation" href="index.html" />
<link rel="next" title="Registering Models" href="registering_models.html" />
<link rel="prev" title="Getting Started" href="getting_started.html" />
</head>
<body>
<div id="docstitle">
<p>Django Categories v1.0.1 documentation</p>
<p>Django Categories 1.0.5 documentation</p>
</div>
<div id="header">
<div id="title"><h1>Using categories in templates</h1></div>
@ -167,21 +170,21 @@ two-tuples of the current tree item and a <tt class="docutils literal"><span cla
information about the tree structure around the item, with the following
keys:</p>
<blockquote>
<dl class="docutils">
<div><dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">'new_level'</span></tt></dt>
<dd><tt class="xref docutils literal"><span class="pre">True</span></tt> if the current item is the start of a new level in
the tree, <tt class="xref docutils literal"><span class="pre">False</span></tt> otherwise.</dd>
<dd><tt class="docutils literal"><span class="pre">True</span></tt> if the current item is the start of a new level in
the tree, <tt class="docutils literal"><span class="pre">False</span></tt> otherwise.</dd>
<dt><tt class="docutils literal"><span class="pre">'closed_levels'</span></tt></dt>
<dd>A list of levels which end after the current item. This will
be an empty list if the next item&#8217;s level is the same as or
greater than the level of the current item.</dd>
</dl>
</blockquote>
</div></blockquote>
<p>An optional argument can be provided to specify extra details about the
structure which should appear in the <tt class="docutils literal"><span class="pre">dict</span></tt>. This should be a
comma-separated list of feature names. The valid feature names are:</p>
<blockquote>
<dl class="docutils">
<div><dl class="docutils">
<dt>ancestors</dt>
<dd><p class="first">Adds a list of unicode representations of the ancestors of the
current node, in descending order (root node first, immediate
@ -195,7 +198,7 @@ on the right:</p>
</div>
</dd>
</dl>
</blockquote>
</div></blockquote>
</div>
</div>
</div>
@ -207,7 +210,7 @@ on the right:</p>
<div class="footer">
<p>
&copy; Copyright 2010-2012, Corey Oordt.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</p>
</div>
<div class="clearer"></div>