Hopiu/django-categories
1
0
Fork 0
mirror of https://github.com/jazzband/django-categories.git synced 2026-03-16 22:30:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
django-categories/docs/reference/settings.html

198 lines
13 KiB
HTML
Raw Normal View History

Some Docs
2011-05-11 11:10:01 +00:00
<!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" />
Updated and rendered docs
2012-07-12 23:31:27 +00:00
<title>Settings &mdash; Django Categories v1.1 documentation</title>
Some Docs
2011-05-11 11:10:01 +00:00
<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: '../',
Updated and rendered docs
2012-07-12 23:31:27 +00:00
VERSION: '1.1',
Some Docs
2011-05-11 11:10:01 +00:00
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<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>
Updated and rendered docs
2012-07-12 23:31:27 +00:00
<link rel="top" title="Django Categories v1.1 documentation" href="../index.html" />
Some Docs
2011-05-11 11:10:01 +00:00
<link rel="up" title="Reference" href="index.html" />
Update to template tags to include ways to retrieve an object from a model other than Category.
2012-07-11 11:05:47 +00:00
<link rel="next" title="Template tags and filters" href="templatetags.html" />
Updating the documentation.
2011-08-01 13:48:50 +00:00
<link rel="prev" title="Models" href="models.html" />
Some Docs
2011-05-11 11:10:01 +00:00
</head>
<body>
<div id="docstitle">
Updated and rendered docs
2012-07-12 23:31:27 +00:00
<p>Django Categories v1.1 documentation</p>
Some Docs
2011-05-11 11:10:01 +00:00
</div>
<div id="header">
<div id="title"><h1>Settings</h1></div>
<ul id="headerButtons">
<li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li>
<li id="page_buttons">
<div class="headerButton"><a href="../genindex.html" title="General Index" accesskey="I">index</a></div>
Update to template tags to include ways to retrieve an object from a model other than Category.
2012-07-11 11:05:47 +00:00
<div class="headerButton"><a href="templatetags.html" title="Template tags and filters" accesskey="N">next</a></div>
Updating the documentation.
2011-08-01 13:48:50 +00:00
<div class="headerButton"><a href="models.html" title="Models" accesskey="P">previous</a></div>
Some Docs
2011-05-11 11:10:01 +00:00
</li>
</ul>
</div>
<div id="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<ul><li class="toctree-l1"><a href="../index.html">Main Page</a></li></ul>
<ul class="current">
Fixes #13 : Documented installation and re-rendered the docs.
2012-01-03 14:16:34 +00:00
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
Some Docs
2011-05-11 11:10:01 +00:00
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Using categories in templates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../registering_models.html">Registering Models</a></li>
Updating the documentation.
2011-08-01 13:48:50 +00:00
<li class="toctree-l1"><a class="reference internal" href="../adding_the_fields.html">Adding the fields to the database</a></li>
Updated documentation for 1.0b1
2012-02-08 16:23:58 +00:00
<li class="toctree-l1"><a class="reference internal" href="../custom_categories.html">Creating Custom Categories</a></li>
Some Docs
2011-05-11 11:10:01 +00:00
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
Updating the documentation.
2011-08-01 13:48:50 +00:00
<li class="toctree-l2"><a class="reference internal" href="management_commands.html">Management Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
Some Docs
2011-05-11 11:10:01 +00:00
<li class="toctree-l2 current"><a class="current reference internal" href="">Settings</a></li>
Update to template tags to include ways to retrieve an object from a model other than Category.
2012-07-11 11:05:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="templatetags.html">Template tags and filters</a></li>
Some Docs
2011-05-11 11:10:01 +00:00
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/reference/settings.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<form class="search" action="../search.html" method="get">
<div class="search-wrapper">
<span class="search-left"></span>
<input class="prettysearch" type="text" name="q" size="18" />
<span class="search-right">&nbsp;</span>
</div>
<input type="submit" value="Search" class="searchbutton" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="settings">
Updated docs.
2011-05-16 12:58:37 +00:00
<span id="reference-settings"></span><h1>Settings<a class="headerlink" href="#settings" title="Permalink to this headline"></a></h1>
<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>
Updated documentation for 1.0b1
2012-02-08 16:23:58 +00:00
<div class="contents local topic" id="contents">
<ul class="simple">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated documentation for 1.0b1
2012-02-08 16:23:58 +00:00
</ul>
</div>
Updated docs.
2011-05-16 12:58:37 +00:00
<p>The default settings are:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">CATEGORIES_SETTINGS</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">&#39;ALLOW_SLUG_CHANGE&#39;</span><span class="p">:</span> <span class="bp">False</span><span class="p">,</span>
<span class="s">&#39;CACHE_VIEW_LENGTH&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&#39;RELATION_MODELS&#39;</span><span class="p">:</span> <span class="p">[],</span>
Final doc rendering
2011-05-18 11:27:38 +00:00
<span class="s">&#39;M2M_REGISTRY&#39;</span><span class="p">:</span> <span class="p">{},</span>
<span class="s">&#39;FK_REGISTRY&#39;</span><span class="p">:</span> <span class="p">{},</span>
Updated docs.
2011-05-16 12:58:37 +00:00
<span class="s">&#39;THUMBNAIL_UPLOAD_PATH&#39;</span><span class="p">:</span> <span class="s">&#39;uploads/categories/thumbnails&#39;</span><span class="p">,</span>
<span class="s">&#39;THUMBNAIL_STORAGE&#39;</span><span class="p">:</span> <span class="n">settings</span><span class="o">.</span><span class="n">DEFAULT_FILE_STORAGE</span><span class="p">,</span>
Updated documentation for 1.0b1
2012-02-08 16:23:58 +00:00
<span class="s">&#39;SLUG_TRANSLITERATOR&#39;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span>
Updated docs.
2011-05-16 12:58:37 +00:00
<span class="p">}</span>
</pre></div>
</div>
<div class="section" id="allow-slug-change">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Update to template tags to include ways to retrieve an object from a model other than Category.
2012-07-11 11:05:47 +00:00
<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>
Updated documentation for 1.0b1
2012-02-08 16:23:58 +00:00
</div>
<div class="section" id="slug-transliterator">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated documentation for 1.0b1
2012-02-08 16:23:58 +00:00
<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>
Updated docs.
2011-05-16 12:58:37 +00:00
</div>
<div class="section" id="cache-view-length">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated docs.
2011-05-16 12:58:37 +00:00
<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">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated docs.
2011-05-16 12:58:37 +00:00
<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">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated docs.
2011-05-16 12:58:37 +00:00
<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">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated docs.
2011-05-16 12:58:37 +00:00
<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>
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Update to template tags to include ways to retrieve an object from a model other than Category.
2012-07-11 11:05:47 +00:00
<p><strong>Default:</strong> <tt class="xref docutils literal"><span class="pre">True</span></tt></p>
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated docs.
2011-05-16 12:58:37 +00:00
<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">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated docs.
2011-05-16 12:58:37 +00:00
<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>
Updated and rendered docs.
2011-08-02 17:46:21 +00:00
<div class="section" id="javascript-url">
Updated CREDITS, docs and bumped version to 1.0.5
2012-06-04 12:46:22 +00:00
<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>
Updated and rendered docs.
2011-08-02 17:46:21 +00:00
<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>
Some Docs
2011-05-11 11:10:01 +00:00
</div>
</div>
</div>
</div>
<div class="footer">
<p>
Fixes #13 : Documented installation and re-rendered the docs.
2012-01-03 14:16:34 +00:00
&copy; Copyright 2010-2012, Corey Oordt.
Updated and rendered docs
2012-07-12 23:31:27 +00:00
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
Some Docs
2011-05-11 11:10:01 +00:00
</p>
</div>
<div class="clearer"></div>
</div>
<div id="breadcrumbs">
<a href="index.html" accesskey="U">Reference</a><img src="../_static/triangle_closed.png" height="9" width="9" alt="&gt;">
Settings
</ul>
</div>
<script type="text/javascript" charset="utf-8" src="../_static/toc.js"></script>
</body>
</html>
Reference in a new issue Copy permalink