PageRenderTime 49ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/reference/templatetags.html

https://bitbucket.org/forcreation/django-categories
HTML | 393 lines | 381 code | 12 blank | 0 comment | 0 complexity | 21536658e8ff923d5675dab95a0f9e60 MD5 | raw file
    

  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>Template tags and filters &mdash; Django Categories v1.1 documentation</title>
    10. 

  10.     <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    12. 

  12.     <script type="text/javascript">
    13. 

  13.       var DOCUMENTATION_OPTIONS = {
    14. 

  14.         URL_ROOT:    '../',
    15. 

  15.         VERSION:     '1.1',
    16. 

  16.         COLLAPSE_INDEX: false,
    17. 

  17.         FILE_SUFFIX: '.html',
    18. 

  18.         HAS_SOURCE:  true
    19. 

  19.       };
    20. 

  20.     </script>
    21. 

  21.     <script type="text/javascript" src="../_static/jquery.js"></script>
    22. 

  22.     <script type="text/javascript" src="../_static/underscore.js"></script>
    23. 

  23.     <script type="text/javascript" src="../_static/doctools.js"></script>
    24. 

  24.     <link rel="top" title="Django Categories v1.1 documentation" href="../index.html" />
    25. 

  25.     <link rel="up" title="Reference" href="index.html" />
    26. 

  26.     <link rel="prev" title="Settings" href="settings.html" /> 
    27. 

  27.   </head>
    28. 

  28.   <body>
    29. 

  29. <div id="docstitle">
    30. 

  30. 	<p>Django Categories v1.1 documentation</p>
    31. 

  31. </div>
    32. 

  32. <div id="header">
    33. 

  33. 	<div id="title"><h1>Template tags and filters</h1></div>
    34. 

  34. 	<ul id="headerButtons">
    35. 

  35. 		<li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li>
    36. 

  36. 		<li id="page_buttons">
    37. 

  37. 			<div class="headerButton"><a href="../genindex.html" title="General Index" accesskey="I">index</a></div>
    38. 

  38. 			<div class="headerButton"><a href="settings.html" title="Settings" accesskey="P">previous</a></div>
    39. 

  39. 		</li>
    40. 

  40. 	</ul>
    41. 

  41. </div>
    42. 

  42. 

  43. <div id="sphinxsidebar">
    44. 

  44.   <div class="sphinxsidebarwrapper">
    45. 

  45. 	<ul><li class="toctree-l1"><a href="../index.html">Main Page</a></li></ul>
    46. 

  46. 	<ul class="current">
    47. 

  47. <li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
    48. 

  48. <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
    49. 

  49. <li class="toctree-l1"><a class="reference internal" href="../usage.html">Using categories in templates</a></li>
    50. 

  50. <li class="toctree-l1"><a class="reference internal" href="../registering_models.html">Registering Models</a></li>
    51. 

  51. <li class="toctree-l1"><a class="reference internal" href="../adding_the_fields.html">Adding the fields to the database</a></li>
    52. 

  52. <li class="toctree-l1"><a class="reference internal" href="../custom_categories.html">Creating Custom Categories</a></li>
    53. 

  53. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
    54. 

  54. <li class="toctree-l2"><a class="reference internal" href="management_commands.html">Management Commands</a></li>
    55. 

  55. <li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
    56. 

  56. <li class="toctree-l2"><a class="reference internal" href="settings.html">Settings</a></li>
    57. 

  57. <li class="toctree-l2 current"><a class="current reference internal" href="">Template tags and filters</a></li>
    58. 

  58. </ul>
    59. 

  59. </li>
    60. 

  60. </ul>
    61. 

  61. 

  62.       <h3>This Page</h3>
    63. 

  63.       <ul class="this-page-menu">
    64. 

  64.         <li><a href="../_sources/reference/templatetags.txt"
    65. 

  65.                rel="nofollow">Show Source</a></li>
    66. 

  66.       </ul>
    67. 

  67.     <div id="searchbox" style="display: none">
    68. 

  68.       
    69. 

  69.         <form class="search" action="../search.html" method="get">
    70. 

  70. 			<div class="search-wrapper">
    71. 

  71. 			<span class="search-left"></span>
    72. 

  72. 			<input class="prettysearch" type="text" name="q" size="18" />
    73. 

  73. 			<span class="search-right">&nbsp;</span>
    74. 

  74. 			</div>
    75. 

  75.           <input type="submit" value="Search" class="searchbutton" />
    76. 

  76.           <input type="hidden" name="check_keywords" value="yes" />
    77. 

  77.           <input type="hidden" name="area" value="default" />
    78. 

  78.         </form>
    79. 

  79.         <p class="searchtip" style="font-size: 90%">
    80. 

  80.         Enter search terms or a module, class or function name.
    81. 

  81.         </p>
    82. 

  82.     </div>
    83. 

  83.     <script type="text/javascript">$('#searchbox').show(0);</script>
    84. 

  84.   </div>
    85. 

  85. </div>
    86. 

  86. 

  87. 

  88. 

  89.     <div class="document">
    90. 

  90.       <div class="documentwrapper">
    91. 

  91.         <div class="bodywrapper">
    92. 

  92.           <div class="body">
    93. 

  93.             
    94. 

  94.   <div class="section" id="template-tags-and-filters">
    95. 

  95. <h1>Template tags and filters<a class="headerlink" href="#template-tags-and-filters" title="Permalink to this headline"></a></h1>
    96. 

  96. <div class="contents local topic" id="contents">
    97. 

  97. <ul class="simple">
    98. 

  98. <li><a class="reference internal" href="#filters" id="id2">Filters</a><ul>
    99. 

  99. <li><a class="reference internal" href="#category-path" id="id3"><tt class="docutils literal"><span class="pre">category_path</span></tt></a></li>
    100. 

  100. <li><a class="reference internal" href="#tree-info" id="id4"><tt class="docutils literal"><span class="pre">tree_info</span></tt></a></li>
    101. 

  101. <li><a class="reference internal" href="#tree-queryset" id="id5"><tt class="docutils literal"><span class="pre">tree_queryset</span></tt></a></li>
    102. 

  102. </ul>
    103. 

  103. </li>
    104. 

  104. <li><a class="reference internal" href="#inclusion-tags" id="id6">Inclusion tags</a><ul>
    105. 

  105. <li><a class="reference internal" href="#display-path-as-ul" id="id7"><tt class="docutils literal"><span class="pre">display_path_as_ul</span></tt></a></li>
    106. 

  106. <li><a class="reference internal" href="#display-drilldown-as-ul" id="id8"><tt class="docutils literal"><span class="pre">display_drilldown_as_ul</span></tt></a></li>
    107. 

  107. <li><a class="reference internal" href="#breadcrumbs-tag" id="id9"><tt class="docutils literal"><span class="pre">breadcrumbs</span> <span class="pre">tag</span></tt></a></li>
    108. 

  108. </ul>
    109. 

  109. </li>
    110. 

  110. <li><a class="reference internal" href="#template-tags" id="id10">Template Tags</a><ul>
    111. 

  111. <li><a class="reference internal" href="#get-top-level-categories" id="id11"><tt class="docutils literal"><span class="pre">get_top_level_categories</span></tt></a></li>
    112. 

  112. <li><a class="reference internal" href="#get-category-drilldown" id="id12"><tt class="docutils literal"><span class="pre">get_category_drilldown</span></tt></a></li>
    113. 

  113. <li><a class="reference internal" href="#recursetree" id="id13"><tt class="docutils literal"><span class="pre">recursetree</span></tt></a></li>
    114. 

  114. </ul>
    115. 

  115. </li>
    116. 

  116. </ul>
    117. 

  117. </div>
    118. 

  118. <div class="section" id="filters">
    119. 

  119. <h2><a class="toc-backref" href="#contents">Filters</a><a class="headerlink" href="#filters" title="Permalink to this headline"></a></h2>
    120. 

  120. <div class="section" id="category-path">
    121. 

  121. <h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">category_path</span></tt></a><a class="headerlink" href="#category-path" title="Permalink to this headline"></a></h3>
    122. 

  122. <p><strong>Optional Parameter:</strong> separator string. <em>Default:</em> <tt class="docutils literal"><span class="pre">&quot;</span> <span class="pre">::</span> <span class="pre">&quot;</span></tt></p>
    123. 

  123. <p>Creates a path represented by a categories by joining the items with a separator.</p>
    124. 

  124. <p>Each path item will be coerced to unicode, so you can pass a list of category instances, if required.</p>
    125. 

  125. <p><strong>Example using a list of categories:</strong></p>
    126. 

  126. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{{</span> <span class="nv">some_list</span><span class="o">|</span><span class="nf">category_path</span> <span class="cp">}}</span><span class="x"></span>
    127. 

  127. </pre></div>
    128. 

  128. </div>
    129. 

  129. <p>If <tt class="docutils literal"><span class="pre">some_list</span></tt> is <tt class="docutils literal"><span class="pre">[</span> <span class="pre">&lt;Category:</span> <span class="pre">Country&gt;,</span> <span class="pre">&lt;Category:</span> <span class="pre">Country</span> <span class="pre">pop&gt;,</span> <span class="pre">&lt;Category:</span> <span class="pre">Urban</span> <span class="pre">Cowboy&gt;]</span></tt> the result will be:</p>
    130. 

  130. <div class="highlight-python"><pre>Country :: Country pop :: Urban Cowboy</pre>
    131. 

  131. </div>
    132. 

  132. <p><strong>Example using a category node and optional separator parameter:</strong></p>
    133. 

  133. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{{</span> <span class="nv">some_node.get_ancestors</span><span class="o">|</span><span class="nf">category_path</span><span class="s2">:&quot; &gt; &quot;</span> <span class="cp">}}</span><span class="x"></span>
    134. 

  134. </pre></div>
    135. 

  135. </div>
    136. 

  136. <p>If <tt class="docutils literal"><span class="pre">some_node</span></tt> was category &#8220;Urban Cowboy&#8221;, the result will be:</p>
    137. 

  137. <div class="highlight-python"><pre>Country &gt; Country pop &gt; Urban Cowboy</pre>
    138. 

  138. </div>
    139. 

  139. </div>
    140. 

  140. <div class="section" id="tree-info">
    141. 

  141. <span id="id1"></span><h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">tree_info</span></tt></a><a class="headerlink" href="#tree-info" title="Permalink to this headline"></a></h3>
    142. 

  142. <p><strong>Optional Parameter:</strong> <tt class="docutils literal"><span class="pre">&quot;ancestors&quot;</span></tt></p>
    143. 

  143. <p>Given a list of categories, it iterates over the list, generating a tuple of the current category and a dict containing information about the tree structure around it, with the following keys:</p>
    144. 

  144. <dl class="docutils">
    145. 

  145. <dt><tt class="docutils literal"><span class="pre">'new_level'</span></tt></dt>
    146. 

  146. <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>
    147. 

  147. <dt><tt class="docutils literal"><span class="pre">'closed_levels'</span></tt></dt>
    148. 

  148. <dd>A list of levels which end after the current item. This will be an empty list if the next category&#8217;s level is the same as or greater than the level of the current item.</dd>
    149. 

  149. </dl>
    150. 

  150. <p>Provide the optional argument, <tt class="docutils literal"><span class="pre">&quot;ancestors&quot;</span></tt>, to add a list of unicode representations of the ancestors of the current category, in descending order (root node first, immediate parent last), under the key &#8216;ancestors&#8217;.</p>
    151. 

  151. <p>For example: given the sample tree below, the contents of the list which would be available under the &#8216;ancestors&#8217; key are given on the right:</p>
    152. 

  152. <div class="highlight-python"><pre>Country             -&gt;  []
    153. 

  153.    Country pop      -&gt;  [u'Country pop']
    154. 

  154.       Urban Cowboy  -&gt;  [u'Country', u'Country pop']</pre>
    155. 

  155. </div>
    156. 

  156. <p>Using this filter with unpacking in a {% for %} tag, you should have enough information about the tree structure to create a hierarchical representation of the tree.</p>
    157. 

  157. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">for</span> <span class="nv">node</span><span class="o">,</span><span class="nv">structure</span> <span class="k">in</span> <span class="nv">objects</span><span class="o">|</span><span class="nf">tree_info</span> <span class="cp">%}</span><span class="x"></span>
    158. 

  158. <span class="x">    </span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">structure.new_level</span> <span class="cp">%}</span><span class="x">&lt;ul&gt;&lt;li&gt;</span><span class="cp">{%</span> <span class="k">else</span> <span class="cp">%}</span><span class="x">&lt;/li&gt;&lt;li&gt;</span><span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span><span class="x"></span>
    159. 

  159. <span class="x">    </span><span class="cp">{{</span> <span class="nv">node.name</span> <span class="cp">}}</span><span class="x"></span>
    160. 

  160. <span class="x">    </span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">level</span> <span class="k">in</span> <span class="nv">structure.closed_levels</span> <span class="cp">%}</span><span class="x">&lt;/li&gt;&lt;/ul&gt;</span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
    161. 

  161. <span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
    162. 

  162. </pre></div>
    163. 

  163. </div>
    164. 

  164. </div>
    165. 

  165. <div class="section" id="tree-queryset">
    166. 

  166. <h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">tree_queryset</span></tt></a><a class="headerlink" href="#tree-queryset" title="Permalink to this headline"></a></h3>
    167. 

  167. <p>Convert a regular category <tt class="xref py py-class docutils literal"><span class="pre">QuerySet</span></tt> into a new, ordered <tt class="xref py py-class docutils literal"><span class="pre">QuerySet</span></tt> that includes the categories selected and their ancestors.</p>
    168. 

  168. <p>This is especially helpful when you have a subset of categories and want to show the hierarchy for all the items.</p>
    169. 

  169. <p>For example, if we add it to the example for <a class="reference internal" href="#tree-info"><em>tree_info</em></a>:</p>
    170. 

  170. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">for</span> <span class="nv">node</span><span class="o">,</span><span class="nv">structure</span> <span class="k">in</span> <span class="nv">objects</span><span class="o">|</span><span class="nf">tree_queryset</span><span class="o">|</span><span class="nf">tree_info</span> <span class="cp">%}</span><span class="x"></span>
    171. 

  171. <span class="x">    </span><span class="cp">{%</span> <span class="k">if</span> <span class="nv">structure.new_level</span> <span class="cp">%}</span><span class="x">&lt;ul&gt;&lt;li&gt;</span><span class="cp">{%</span> <span class="k">else</span> <span class="cp">%}</span><span class="x">&lt;/li&gt;&lt;li&gt;</span><span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span><span class="x"></span>
    172. 

  172. <span class="x">    </span><span class="cp">{{</span> <span class="nv">node.name</span> <span class="cp">}}</span><span class="x"></span>
    173. 

  173. <span class="x">    </span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">level</span> <span class="k">in</span> <span class="nv">structure.closed_levels</span> <span class="cp">%}</span><span class="x">&lt;/li&gt;&lt;/ul&gt;</span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
    174. 

  174. <span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
    175. 

  175. </pre></div>
    176. 

  176. </div>
    177. 

  177. <p>A list of unrelated categories such as <tt class="docutils literal"><span class="pre">[&lt;Category:</span> <span class="pre">Urban</span> <span class="pre">cowboy&gt;,</span> <span class="pre">&lt;Category:</span> <span class="pre">Urban</span> <span class="pre">comtemporary&gt;]</span></tt>, the above template example will output the two categories and their ancestors:</p>
    178. 

  178. <div class="highlight-html"><div class="highlight"><pre><span class="nt">&lt;ul&gt;&lt;li&gt;</span>
    179. 

  179. Country
    180. 

  180. <span class="nt">&lt;ul&gt;&lt;li&gt;</span>
    181. 

  181. Country pop
    182. 

  182. <span class="nt">&lt;ul&gt;&lt;li&gt;</span>
    183. 

  183. Urban cowboy
    184. 

  184. <span class="nt">&lt;/li&gt;&lt;/ul&gt;&lt;/li&gt;&lt;/ul&gt;&lt;/li&gt;&lt;/ul&gt;</span>
    185. 

  185. <span class="nt">&lt;ul&gt;&lt;li&gt;</span>
    186. 

  186. Rhythm and blues
    187. 

  187. <span class="nt">&lt;ul&gt;&lt;li&gt;</span>
    188. 

  188. Urban contemporary
    189. 

  189. <span class="nt">&lt;/li&gt;&lt;/ul&gt;&lt;/li&gt;&lt;/ul&gt;</span>
    190. 

  190. </pre></div>
    191. 

  191. </div>
    192. 

  192. <div class="admonition note">
    193. 

  193. <p class="first admonition-title">Note</p>
    194. 

  194. <p class="last">Categories that have similar ancestors are grouped accordingly. There is no duplication of the ancestor tree.</p>
    195. 

  195. </div>
    196. 

  196. </div>
    197. 

  197. </div>
    198. 

  198. <div class="section" id="inclusion-tags">
    199. 

  199. <h2><a class="toc-backref" href="#contents">Inclusion tags</a><a class="headerlink" href="#inclusion-tags" title="Permalink to this headline"></a></h2>
    200. 

  200. <div class="section" id="display-path-as-ul">
    201. 

  201. <h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">display_path_as_ul</span></tt></a><a class="headerlink" href="#display-path-as-ul" title="Permalink to this headline"></a></h3>
    202. 

  202. <p><strong>Template Rendered:</strong> <tt class="docutils literal"><span class="pre">categories/ul_tree.html</span></tt></p>
    203. 

  203. <p><strong>Syntax 1:</strong> <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">display_path_as_ul</span> <span class="pre">&lt;category_obj&gt;</span> <span class="pre">%}</span></tt></p>
    204. 

  204. <p><strong>Syntax 2:</strong> <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">display_path_as_ul</span> <span class="pre">&lt;path_string&gt;[</span> <span class="pre">using=&quot;app.Model&quot;]</span> <span class="pre">%}</span></tt></p>
    205. 

  205. <p>Render the category with ancestors, but no children.</p>
    206. 

  206. <p>Pass either an object that subclasses <a class="reference internal" href="models.html#CategoryBase" title="CategoryBase"><tt class="xref py py-class docutils literal"><span class="pre">CategoryBase</span></tt></a> or a path string for the category. Add <tt class="docutils literal"><span class="pre">using=&quot;app.Model&quot;</span></tt> to specify which model when using a path string. The default model used is <a class="reference internal" href="models.html#Category" title="Category"><tt class="xref py py-class docutils literal"><span class="pre">Category</span></tt></a>.</p>
    207. 

  207. <p><strong>Example, using Category model:</strong></p>
    208. 

  208. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">display_path_as_ul</span> <span class="s2">&quot;/Grandparent/Parent&quot;</span> <span class="cp">%}</span><span class="x"></span>
    209. 

  209. </pre></div>
    210. 

  210. </div>
    211. 

  211. <p><strong>Example, using custom model:</strong></p>
    212. 

  212. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">display_path_as_ul</span> <span class="s2">&quot;/Grandparent/Parent&quot;</span> <span class="nv">using</span><span class="o">=</span><span class="s2">&quot;coolapp.MusicGenre&quot;</span> <span class="cp">%}</span><span class="x"></span>
    213. 

  213. </pre></div>
    214. 

  214. </div>
    215. 

  215. <p><strong>Example, using an object:</strong></p>
    216. 

  216. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">display_path_as_ul</span> <span class="nv">category_obj</span> <span class="cp">%}</span><span class="x"></span>
    217. 

  217. </pre></div>
    218. 

  218. </div>
    219. 

  219. <p>Returns:</p>
    220. 

  220. <div class="highlight-html"><div class="highlight"><pre><span class="nt">&lt;ul&gt;</span>
    221. 

  221.   <span class="nt">&lt;li&gt;&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/&quot;</span><span class="nt">&gt;</span>Top<span class="nt">&lt;/a&gt;</span>
    222. 

  222.   <span class="nt">&lt;ul&gt;</span>
    223. 

  223.     <span class="nt">&lt;li&gt;&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/grandparent/&quot;</span><span class="nt">&gt;</span>Grandparent<span class="nt">&lt;/a&gt;&lt;/li&gt;</span>
    224. 

  224.   <span class="nt">&lt;/ul&gt;</span>
    225. 

  225.   <span class="nt">&lt;/li&gt;</span>
    226. 

  226. <span class="nt">&lt;/ul&gt;</span>
    227. 

  227. </pre></div>
    228. 

  228. </div>
    229. 

  229. </div>
    230. 

  230. <div class="section" id="display-drilldown-as-ul">
    231. 

  231. <h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">display_drilldown_as_ul</span></tt></a><a class="headerlink" href="#display-drilldown-as-ul" title="Permalink to this headline"></a></h3>
    232. 

  232. <p><strong>Template rendered:</strong> <tt class="docutils literal"><span class="pre">categories/ul_tree.html</span></tt></p>
    233. 

  233. <p><strong>Syntax 1:</strong> <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">display_drilldown_as_ul</span> <span class="pre">category_obj</span> <span class="pre">%}</span></tt></p>
    234. 

  234. <p><strong>Syntax 2:</strong> <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">display_drilldown_as_ul</span> <span class="pre">&quot;/Grandparent/Parent&quot;</span> <span class="pre">[using=&quot;app.Model&quot;]</span> <span class="pre">%}</span></tt></p>
    235. 

  235. <p>Render the category with ancestors and children.</p>
    236. 

  236. <p><strong>Example, using Category model:</strong></p>
    237. 

  237. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">display_drilldown_as_ul</span> <span class="s2">&quot;/Grandparent/Parent&quot;</span> <span class="cp">%}</span><span class="x"></span>
    238. 

  238. </pre></div>
    239. 

  239. </div>
    240. 

  240. <p><strong>Example, using custom model:</strong></p>
    241. 

  241. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">display_drilldown_as_ul</span> <span class="s2">&quot;/Grandparent/Parent&quot;</span> <span class="nv">using</span><span class="o">=</span><span class="s2">&quot;coolapp.MusicGenre&quot;</span> <span class="cp">%}</span><span class="x"></span>
    242. 

  242. </pre></div>
    243. 

  243. </div>
    244. 

  244. <p><strong>Example, using an object:</strong></p>
    245. 

  245. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">display_drilldown_as_ul</span> <span class="nv">category_obj</span> <span class="cp">%}</span><span class="x"></span>
    246. 

  246. </pre></div>
    247. 

  247. </div>
    248. 

  248. <p>Returns:</p>
    249. 

  249. <div class="highlight-html"><div class="highlight"><pre><span class="nt">&lt;ul&gt;</span>
    250. 

  250.   <span class="nt">&lt;li&gt;&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/&quot;</span><span class="nt">&gt;</span>Top<span class="nt">&lt;/a&gt;</span>
    251. 

  251.   <span class="nt">&lt;ul&gt;</span>
    252. 

  252.     <span class="nt">&lt;li&gt;&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/grandparent/&quot;</span><span class="nt">&gt;</span>Grandparent<span class="nt">&lt;/a&gt;</span>
    253. 

  253.     <span class="nt">&lt;ul&gt;</span>
    254. 

  254.       <span class="nt">&lt;li&gt;&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/grandparent/parent/&quot;</span><span class="nt">&gt;</span>Parent<span class="nt">&lt;/a&gt;</span>
    255. 

  255.       <span class="nt">&lt;ul&gt;</span>
    256. 

  256.         <span class="nt">&lt;li&gt;&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/grandparent/parent/child1&quot;</span><span class="nt">&gt;</span>Child1<span class="nt">&lt;/a&gt;&lt;/li&gt;</span>
    257. 

  257.         <span class="nt">&lt;li&gt;&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/grandparent/parent/child2&quot;</span><span class="nt">&gt;</span>Child2<span class="nt">&lt;/a&gt;&lt;/li&gt;</span>
    258. 

  258.         <span class="nt">&lt;li&gt;&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/grandparent/parent/child3&quot;</span><span class="nt">&gt;</span>Child3<span class="nt">&lt;/a&gt;&lt;/li&gt;</span>
    259. 

  259.       <span class="nt">&lt;/ul&gt;</span>
    260. 

  260.       <span class="nt">&lt;/li&gt;</span>
    261. 

  261.     <span class="nt">&lt;/ul&gt;</span>
    262. 

  262.     <span class="nt">&lt;/li&gt;</span>
    263. 

  263.   <span class="nt">&lt;/ul&gt;</span>
    264. 

  264.   <span class="nt">&lt;/li&gt;</span>
    265. 

  265. <span class="nt">&lt;/ul&gt;</span>
    266. 

  266. </pre></div>
    267. 

  267. </div>
    268. 

  268. </div>
    269. 

  269. <div class="section" id="breadcrumbs-tag">
    270. 

  270. <h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">breadcrumbs</span> <span class="pre">tag</span></tt></a><a class="headerlink" href="#breadcrumbs-tag" title="Permalink to this headline"></a></h3>
    271. 

  271. <p><strong>Template rendered:</strong> <tt class="docutils literal"><span class="pre">categories/breadcrumbs.html</span></tt></p>
    272. 

  272. <p><strong>Syntax 1:</strong> <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">breadcrumbs</span> <span class="pre">category_obj</span> <span class="pre">[separator=&quot;</span> <span class="pre">::</span> <span class="pre">&quot;]</span> <span class="pre">%}</span></tt></p>
    273. 

  273. <p><strong>Syntax 2:</strong> <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">breadcrumbs</span> <span class="pre">&quot;/Grandparent/Parent&quot;</span> <span class="pre">[separator=&quot;</span> <span class="pre">::</span> <span class="pre">&quot;]</span> <span class="pre">[using=&quot;app.Model&quot;]</span> <span class="pre">%}</span></tt></p>
    274. 

  274. <p>Render breadcrumbs for the given path using <tt class="docutils literal"><span class="pre">::</span></tt> or the given separator.</p>
    275. 

  275. <p><strong>Example using Category model:</strong></p>
    276. 

  276. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">breadcrumbs</span> <span class="s2">&quot;/Grandparent/Parent&quot;</span> <span class="cp">%}</span><span class="x"></span>
    277. 

  277. </pre></div>
    278. 

  278. </div>
    279. 

  279. <p><strong>Example using a custom model:</strong></p>
    280. 

  280. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">breadcrumbs</span> <span class="s2">&quot;/Grandparent/Parent&quot;</span> <span class="nv">using</span><span class="o">=</span><span class="s2">&quot;coolapp.MusicGenre&quot;</span> <span class="cp">%}</span><span class="x"></span>
    281. 

  281. </pre></div>
    282. 

  282. </div>
    283. 

  283. <p><strong>Example using an object:</strong></p>
    284. 

  284. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">breadcrumbs</span> <span class="nv">category_obj</span> <span class="cp">%}</span><span class="x"></span>
    285. 

  285. </pre></div>
    286. 

  286. </div>
    287. 

  287. <p>Returns:</p>
    288. 

  288. <div class="highlight-html"><div class="highlight"><pre><span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/grandparent/&quot;</span><span class="nt">&gt;</span>Grandparent<span class="nt">&lt;/a&gt;</span> / Parent
    289. 

  289. </pre></div>
    290. 

  290. </div>
    291. 

  291. <p>You can alter the separator used in the template by adding a separator argument:</p>
    292. 

  292. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">breadcrumbs</span> <span class="nv">category_obj</span> <span class="nv">separator</span><span class="o">=</span><span class="s2">&quot; &amp;gt; &quot;</span> <span class="cp">%}</span><span class="x"></span>
    293. 

  293. </pre></div>
    294. 

  294. </div>
    295. 

  295. <p>Returns:</p>
    296. 

  296. <div class="highlight-html"><div class="highlight"><pre><span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">&quot;/categories/grandparent/&quot;</span><span class="nt">&gt;</span>Grandparent<span class="nt">&lt;/a&gt;</span> <span class="ni">&amp;gt;</span> Parent
    297. 

  297. </pre></div>
    298. 

  298. </div>
    299. 

  299. </div>
    300. 

  300. </div>
    301. 

  301. <div class="section" id="template-tags">
    302. 

  302. <h2><a class="toc-backref" href="#contents">Template Tags</a><a class="headerlink" href="#template-tags" title="Permalink to this headline"></a></h2>
    303. 

  303. <div class="section" id="get-top-level-categories">
    304. 

  304. <h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">get_top_level_categories</span></tt></a><a class="headerlink" href="#get-top-level-categories" title="Permalink to this headline"></a></h3>
    305. 

  305. <p>Retrieves an alphabetical list of all the categories that have no parents.</p>
    306. 

  306. <p>Syntax:</p>
    307. 

  307. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">get_top_level_categories</span> <span class="o">[</span><span class="nv">using</span> <span class="s2">&quot;app.Model&quot;</span><span class="o">]</span> <span class="k">as</span> <span class="nv">categories</span> <span class="cp">%}</span><span class="x"></span>
    308. 

  308. </pre></div>
    309. 

  309. </div>
    310. 

  310. <p>Returns an list of categories <tt class="docutils literal"><span class="pre">[&lt;category&gt;,</span> <span class="pre">&lt;category&gt;,</span> <span class="pre">&lt;category,</span> <span class="pre">...]</span></tt></p>
    311. 

  311. </div>
    312. 

  312. <div class="section" id="get-category-drilldown">
    313. 

  313. <h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">get_category_drilldown</span></tt></a><a class="headerlink" href="#get-category-drilldown" title="Permalink to this headline"></a></h3>
    314. 

  314. <p><strong>Syntax 1:</strong> <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">get_category_drilldown</span> <span class="pre">&lt;path_string&gt;</span> <span class="pre">[using</span> <span class="pre">&quot;app.Model&quot;]</span> <span class="pre">as</span> <span class="pre">&lt;varname&gt;</span> <span class="pre">%}</span></tt></p>
    315. 

  315. <p><strong>Syntax 2:</strong> <tt class="docutils literal"><span class="pre">{%</span> <span class="pre">get_category_drilldown</span> <span class="pre">&lt;object&gt;</span> <span class="pre">as</span> <span class="pre">&lt;varname&gt;</span> <span class="pre">%}</span></tt></p>
    316. 

  316. <p>Retrieves the specified category, its ancestors and its immediate children as an iterable. Syntax 1 allows for the retrieval of the category object via a slash-delimited path. The optional <tt class="docutils literal"><span class="pre">using</span> <span class="pre">&quot;app.Model&quot;</span></tt> allows you to specify from which model to retrieve the object.</p>
    317. 

  317. <p>Example:</p>
    318. 

  318. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">get_category_drilldown</span> <span class="s2">&quot;/Grandparent/Parent&quot;</span> <span class="nv">using</span> <span class="s2">&quot;family.Member&quot;</span> <span class="k">as</span> <span class="nv">family</span> <span class="cp">%}</span><span class="x"></span>
    319. 

  319. </pre></div>
    320. 

  320. </div>
    321. 

  321. <p>The second syntax uses an instance of any object that subclasses <a class="reference internal" href="models.html#CategoryBase" title="CategoryBase"><tt class="xref py py-class docutils literal"><span class="pre">CategoryBase</span></tt></a></p>
    322. 

  322. <div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">get_category_drilldown</span> <span class="nv">category_obj</span> <span class="k">as</span> <span class="nv">family</span> <span class="cp">%}</span><span class="x"></span>
    323. 

  323. </pre></div>
    324. 

  324. </div>
    325. 

  325. <p>Both examples sets <tt class="docutils literal"><span class="pre">family</span></tt> to:</p>
    326. 

  326. <div class="highlight-python"><pre>[Grandparent, Parent, Child 1, Child 2, Child n]</pre>
    327. 

  327. </div>
    328. 

  328. </div>
    329. 

  329. <div class="section" id="recursetree">
    330. 

  330. <h3><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">recursetree</span></tt></a><a class="headerlink" href="#recursetree" title="Permalink to this headline"></a></h3>
    331. 

  331. <p>This tag renders a section of your template recursively for each node in your
    332. 

  332. tree.</p>
    333. 

  333. <p>For example:</p>
    334. 

  334. <div class="highlight-django"><div class="highlight"><pre><span class="x">&lt;ul class=&quot;root&quot;&gt;</span>
    335. 

  335. <span class="x">    </span><span class="cp">{%</span> <span class="k">recursetree</span> <span class="nv">nodes</span> <span class="cp">%}</span><span class="x"></span>
    336. 

  336. <span class="x">        &lt;li&gt;</span>
    337. 

  337. <span class="x">            </span><span class="cp">{{</span> <span class="nv">node.name</span> <span class="cp">}}</span><span class="x"></span>
    338. 

  338. <span class="x">            </span><span class="cp">{%</span> <span class="k">if</span> <span class="k">not</span> <span class="nv">node.is_leaf_node</span> <span class="cp">%}</span><span class="x"></span>
    339. 

  339. <span class="x">                &lt;ul class=&quot;children&quot;&gt;</span>
    340. 

  340. <span class="x">                    </span><span class="cp">{{</span> <span class="nv">children</span> <span class="cp">}}</span><span class="x"></span>
    341. 

  341. <span class="x">                &lt;/ul&gt;</span>
    342. 

  342. <span class="x">            </span><span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span><span class="x"></span>
    343. 

  343. <span class="x">        &lt;/li&gt;</span>
    344. 

  344. <span class="x">    </span><span class="cp">{%</span> <span class="k">endrecursetree</span> <span class="cp">%}</span><span class="x"></span>
    345. 

  345. <span class="x">&lt;/ul&gt;</span>
    346. 

  346. </pre></div>
    347. 

  347. </div>
    348. 

  348. <p>Note the special variables <tt class="docutils literal"><span class="pre">node</span></tt> and <tt class="docutils literal"><span class="pre">children</span></tt>.
    349. 

  349. These are magically inserted into your context while you&#8217;re inside the
    350. 

  350. <tt class="docutils literal"><span class="pre">recursetree</span></tt> tag.</p>
    351. 

  351. <blockquote>
    352. 

  352. <div><p><tt class="docutils literal"><span class="pre">node</span></tt> is an instance of your MPTT model.</p>
    353. 

  353. <p><tt class="docutils literal"><span class="pre">children</span></tt> : This variable holds the rendered HTML for the children of
    354. 

  354. <tt class="docutils literal"><span class="pre">node</span></tt>.</p>
    355. 

  355. </div></blockquote>
    356. 

  356. <div class="admonition note">
    357. 

  357. <p class="first admonition-title">Note</p>
    358. 

  358. <p>If you already have variables called <tt class="docutils literal"><span class="pre">node</span></tt> or <tt class="docutils literal"><span class="pre">children</span></tt> in your
    359. 

  359. template, and you need to access them inside the <tt class="docutils literal"><span class="pre">recursetree</span></tt> block,
    360. 

  360. you&#8217;ll need to alias them to some other name first:</p>
    361. 

  361. <div class="last highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">with</span> <span class="nv">node</span> <span class="k">as</span> <span class="nv">friendly_node</span> <span class="cp">%}</span><span class="x"></span>
    362. 

  362. <span class="x">    </span><span class="cp">{%</span> <span class="k">recursetree</span> <span class="nv">nodes</span> <span class="cp">%}</span><span class="x"></span>
    363. 

  363. <span class="x">        </span><span class="cp">{{</span> <span class="nv">node.name</span> <span class="cp">}}</span><span class="x"> is friends with </span><span class="cp">{{</span> <span class="nv">friendly_node.name</span> <span class="cp">}}</span><span class="x"></span>
    364. 

  364. <span class="x">        </span><span class="cp">{{</span> <span class="nv">children</span> <span class="cp">}}</span><span class="x"></span>
    365. 

  365. <span class="x">    </span><span class="cp">{%</span> <span class="k">endrecursetree</span> <span class="cp">%}</span><span class="x"></span>
    366. 

  366. <span class="cp">{%</span> <span class="k">endwith</span> <span class="cp">%}</span><span class="x"></span>
    367. 

  367. </pre></div>
    368. 

  368. </div>
    369. 

  369. </div>
    370. 

  370. </div>
    371. 

  371. </div>
    372. 

  372. </div>
    373. 

  373. 

  374. 

  375.           </div> 
    376. 

  376.         </div>
    377. 

  377.       </div>
    378. 

  378.     <div class="footer">
    379. 

  379.     <p>
    380. 

  380.       &copy; Copyright 2010-2012, Corey Oordt.
    381. 

  381.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    382. 

  382. 	</p>
    383. 

  383.     </div>
    384. 

  384.       <div class="clearer"></div>
    385. 

  385.     </div>
    386. 

  386. 	<div id="breadcrumbs">
    387. 

  387. 		<a href="index.html" accesskey="U">Reference</a><img src="../_static/triangle_closed.png" height="9" width="9" alt="&gt;">
    388. 

  388. 		Template tags and filters
    389. 

  389. 		</ul>
    390. 

  390. 	</div>
    391. 

  391. 	<script type="text/javascript" charset="utf-8" src="../_static/toc.js"></script>
    392. 

  392.   </body>
    393. 

  393. </html>
    394.