/usr/share/doc/python-django-mptt/html/utilities.html is in python-django-mptt 0.6.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | <!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>Utilities for working with trees — django-mptt 0.6.0 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: '0.6.0',
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>
<link rel="top" title="django-mptt 0.6.0 documentation" href="index.html" />
<link rel="next" title="Upgrade notes" href="upgrade.html" />
<link rel="prev" title="Working with trees in templates" href="templates.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="upgrade.html" title="Upgrade notes"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="templates.html" title="Working with trees in templates"
accesskey="P">previous</a> |</li>
<li><a href="index.html">django-mptt 0.6.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="utilities-for-working-with-trees">
<h1><a class="toc-backref" href="#id4">Utilities for working with trees</a><a class="headerlink" href="#utilities-for-working-with-trees" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#utilities-for-working-with-trees" id="id4">Utilities for working with trees</a><ul>
<li><a class="reference internal" href="#list-tree-utilities" id="id5">List/tree utilities</a><ul>
<li><a class="reference internal" href="#previous-current-next" id="id6"><tt class="docutils literal"><span class="pre">previous_current_next()</span></tt></a></li>
<li><a class="reference internal" href="#tree-item-iterator" id="id7"><tt class="docutils literal"><span class="pre">tree_item_iterator()</span></tt></a></li>
<li><a class="reference internal" href="#drilldown-tree-for-node" id="id8"><tt class="docutils literal"><span class="pre">drilldown_tree_for_node()</span></tt></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="list-tree-utilities">
<h2><a class="toc-backref" href="#id5">List/tree utilities</a><a class="headerlink" href="#list-tree-utilities" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="docutils literal"><span class="pre">mptt.utils</span></tt> module contains the following functions for working
with and creating lists of model instances which represent trees.</p>
<div class="section" id="previous-current-next">
<h3><a class="toc-backref" href="#id6"><tt class="docutils literal"><span class="pre">previous_current_next()</span></tt></a><a class="headerlink" href="#previous-current-next" title="Permalink to this headline">¶</a></h3>
<p>From <a class="reference external" href="http://www.wordaligned.org/articles/zippy-triples-served-with-python">http://www.wordaligned.org/articles/zippy-triples-served-with-python</a></p>
<p>Creates an iterator which returns (previous, current, next) triples,
with <tt class="docutils literal"><span class="pre">None</span></tt> filling in when there is no previous or next available.</p>
<p>This function is useful if you want to step through a tree one item at a
time and you need to refer to the previous or next item in the tree. It
is used in the implementation of <a class="reference internal" href="#tree-item-iterator">tree_item_iterator()</a>.</p>
<div class="section" id="required-arguments">
<h4>Required arguments<a class="headerlink" href="#required-arguments" title="Permalink to this headline">¶</a></h4>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">items</span></tt></dt>
<dd>A list or other iterable item.</dd>
</dl>
</div>
</div>
<div class="section" id="tree-item-iterator">
<h3><a class="toc-backref" href="#id7"><tt class="docutils literal"><span class="pre">tree_item_iterator()</span></tt></a><a class="headerlink" href="#tree-item-iterator" title="Permalink to this headline">¶</a></h3>
<p>This function is used to implement the <tt class="docutils literal"><span class="pre">tree_info</span></tt> template filter,
yielding two-tuples of (tree item, tree structure information <tt class="docutils literal"><span class="pre">dict</span></tt>).</p>
<p>See the <tt class="docutils literal"><span class="pre">tree_info</span></tt> documentation for more information.</p>
<div class="section" id="id1">
<h4>Required arguments<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">items</span></tt></dt>
<dd>A list or iterable of model instances which represent a tree.</dd>
</dl>
</div>
<div class="section" id="optional-arguments">
<h4>Optional arguments<a class="headerlink" href="#optional-arguments" title="Permalink to this headline">¶</a></h4>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">ancestors</span></tt></dt>
<dd>Boolean. If <tt class="docutils literal"><span class="pre">True</span></tt>, a list of unicode representations of the
ancestors of the current node, in descending order (root node first,
immediate parent last), will be added to the tree structure
information <tt class="docutils literal"><span class="pre">dict`</span> <span class="pre">under</span> <span class="pre">the</span> <span class="pre">key</span> <span class="pre">``'ancestors'</span></tt>.</dd>
</dl>
</div>
</div>
<div class="section" id="drilldown-tree-for-node">
<h3><a class="toc-backref" href="#id8"><tt class="docutils literal"><span class="pre">drilldown_tree_for_node()</span></tt></a><a class="headerlink" href="#drilldown-tree-for-node" title="Permalink to this headline">¶</a></h3>
<p>This function is used in the implementation of the
<tt class="docutils literal"><span class="pre">drilldown_tree_for_node</span></tt> template tag.</p>
<p>It creates an iterable which yields model instances representing a
drilldown tree for a given node.</p>
<p>A drilldown tree consists of a node’s ancestors, itself and its
immediate children, all in tree order.</p>
<p>Optional arguments may be given to specify details of a relationship
between the given node’s class and another model class, for the
purpose of adding related item counts to the node’s children.</p>
<div class="section" id="id2">
<h4>Required arguments<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">node</span></tt></dt>
<dd>A model instance which represents a node in a tree.</dd>
</dl>
</div>
<div class="section" id="id3">
<h4>Optional arguments<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">rel_cls</span></tt></dt>
<dd>A model class which has a relationship to the node’s class.</dd>
<dt><tt class="docutils literal"><span class="pre">rel_field</span></tt></dt>
<dd>The name of the field in <tt class="docutils literal"><span class="pre">rel_cls</span></tt> which holds the relationship
to the node’s class.</dd>
<dt><tt class="docutils literal"><span class="pre">count_attr</span></tt></dt>
<dd>The name of an attribute which should be added to each child of the
node in the drilldown tree (if any), containing a count of how many
instances of <tt class="docutils literal"><span class="pre">rel_cls</span></tt> are related to it through <tt class="docutils literal"><span class="pre">rel_field</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">cumulative</span></tt></dt>
<dd>If <tt class="docutils literal"><span class="pre">True</span></tt>, the count will be for items related to the child
node <em>and</em> all of its descendants. Defaults to <tt class="docutils literal"><span class="pre">False</span></tt>.</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Utilities for working with trees</a><ul>
<li><a class="reference internal" href="#list-tree-utilities">List/tree utilities</a><ul>
<li><a class="reference internal" href="#previous-current-next"><tt class="docutils literal"><span class="pre">previous_current_next()</span></tt></a><ul>
<li><a class="reference internal" href="#required-arguments">Required arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#tree-item-iterator"><tt class="docutils literal"><span class="pre">tree_item_iterator()</span></tt></a><ul>
<li><a class="reference internal" href="#id1">Required arguments</a></li>
<li><a class="reference internal" href="#optional-arguments">Optional arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#drilldown-tree-for-node"><tt class="docutils literal"><span class="pre">drilldown_tree_for_node()</span></tt></a><ul>
<li><a class="reference internal" href="#id2">Required arguments</a></li>
<li><a class="reference internal" href="#id3">Optional arguments</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="templates.html"
title="previous chapter">Working with trees in templates</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="upgrade.html"
title="next chapter">Upgrade notes</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="sources/utilities.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<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="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="upgrade.html" title="Upgrade notes"
>next</a> |</li>
<li class="right" >
<a href="templates.html" title="Working with trees in templates"
>previous</a> |</li>
<li><a href="index.html">django-mptt 0.6.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2007 - 2011, Jonathan Buchanan and others.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
|