PageRenderTime 27ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/reference/models.html

https://bitbucket.org/forcreation/django-categories
HTML | 252 lines | 223 code | 29 blank | 0 comment | 0 complexity | 9d7cf16395279e6a9810ceff398f7616 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>Models &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="next" title="Settings" href="settings.html" />
    27. 

  27.     <link rel="prev" title="Management Commands" href="management_commands.html" /> 
    28. 

  28.   </head>
    29. 

  29.   <body>
    30. 

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

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

  32. </div>
    33. 

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

  34. 	<div id="title"><h1>Models</h1></div>
    35. 

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

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

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

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

  39. 			<div class="headerButton"><a href="settings.html" title="Settings" accesskey="N">next</a></div>
    40. 

  40. 			<div class="headerButton"><a href="management_commands.html" title="Management Commands" accesskey="P">previous</a></div>
    41. 

  41. 		</li>
    42. 

  42. 	</ul>
    43. 

  43. </div>
    44. 

  44. 

  45. <div id="sphinxsidebar">
    46. 

  46.   <div class="sphinxsidebarwrapper">
    47. 

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

  48. 	<ul class="current">
    49. 

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

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

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

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

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

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

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

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

  57. <li class="toctree-l2 current"><a class="current reference internal" href="">Models</a></li>
    58. 

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

  59. <li class="toctree-l2"><a class="reference internal" href="templatetags.html">Template tags and filters</a></li>
    60. 

  60. </ul>
    61. 

  61. </li>
    62. 

  62. </ul>
    63. 

  63. 

  64.       <h3>This Page</h3>
    65. 

  65.       <ul class="this-page-menu">
    66. 

  66.         <li><a href="../_sources/reference/models.txt"
    67. 

  67.                rel="nofollow">Show Source</a></li>
    68. 

  68.       </ul>
    69. 

  69.     <div id="searchbox" style="display: none">
    70. 

  70.       
    71. 

  71.         <form class="search" action="../search.html" method="get">
    72. 

  72. 			<div class="search-wrapper">
    73. 

  73. 			<span class="search-left"></span>
    74. 

  74. 			<input class="prettysearch" type="text" name="q" size="18" />
    75. 

  75. 			<span class="search-right">&nbsp;</span>
    76. 

  76. 			</div>
    77. 

  77.           <input type="submit" value="Search" class="searchbutton" />
    78. 

  78.           <input type="hidden" name="check_keywords" value="yes" />
    79. 

  79.           <input type="hidden" name="area" value="default" />
    80. 

  80.         </form>
    81. 

  81.         <p class="searchtip" style="font-size: 90%">
    82. 

  82.         Enter search terms or a module, class or function name.
    83. 

  83.         </p>
    84. 

  84.     </div>
    85. 

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

  86.   </div>
    87. 

  87. </div>
    88. 

  88. 

  89. 

  90. 

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

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

  93.         <div class="bodywrapper">
    94. 

  94.           <div class="body">
    95. 

  95.             
    96. 

  96.   <div class="section" id="models">
    97. 

  97. <h1>Models<a class="headerlink" href="#models" title="Permalink to this headline"></a></h1>
    98. 

  98. <div class="section" id="categorybase">
    99. 

  99. <h2>CategoryBase<a class="headerlink" href="#categorybase" title="Permalink to this headline"></a></h2>
    100. 

  100. <dl class="class">
    101. 

  101. <dt id="CategoryBase">
    102. 

  102. <em class="property">class </em><tt class="descname">CategoryBase</tt><a class="headerlink" href="#CategoryBase" title="Permalink to this definition"></a></dt>
    103. 

  103. <dd><dl class="attribute">
    104. 

  104. <dt id="CategoryBase.parent">
    105. 

  105. <tt class="descname">parent</tt><a class="headerlink" href="#CategoryBase.parent" title="Permalink to this definition"></a></dt>
    106. 

  106. <dd><p><tt class="xref py py-class docutils literal"><span class="pre">TreeForeignKey</span></tt> <tt class="docutils literal"><span class="pre">(self)</span></tt></p>
    107. 

  107. <p>The category&#8217;s parent category. Leave this blank for an root category.</p>
    108. 

  108. </dd></dl>
    109. 

  109. 

  110. <dl class="attribute">
    111. 

  111. <dt id="CategoryBase.name">
    112. 

  112. <tt class="descname">name</tt><a class="headerlink" href="#CategoryBase.name" title="Permalink to this definition"></a></dt>
    113. 

  113. <dd><p><strong>Required</strong> <tt class="docutils literal"><span class="pre">CharField(100)</span></tt></p>
    114. 

  114. <p>The name of the category.</p>
    115. 

  115. </dd></dl>
    116. 

  116. 

  117. <dl class="attribute">
    118. 

  118. <dt id="CategoryBase.slug">
    119. 

  119. <tt class="descname">slug</tt><a class="headerlink" href="#CategoryBase.slug" title="Permalink to this definition"></a></dt>
    120. 

  120. <dd><p><strong>Required</strong> <tt class="docutils literal"><span class="pre">SlugField</span></tt></p>
    121. 

  121. <p>URL-friendly title. It is automatically generated from the title.</p>
    122. 

  122. </dd></dl>
    123. 

  123. 

  124. <dl class="attribute">
    125. 

  125. <dt id="CategoryBase.active">
    126. 

  126. <tt class="descname">active</tt><a class="headerlink" href="#CategoryBase.active" title="Permalink to this definition"></a></dt>
    127. 

  127. <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>
    128. 

  128. <p>Is this item active. If it is inactive, all children are set to inactive as well.</p>
    129. 

  129. </dd></dl>
    130. 

  130. 

  131. <dl class="attribute">
    132. 

  132. <dt id="CategoryBase.objects">
    133. 

  133. <tt class="descname">objects</tt><a class="headerlink" href="#CategoryBase.objects" title="Permalink to this definition"></a></dt>
    134. 

  134. <dd><p><tt class="docutils literal"><span class="pre">CategoryManager</span></tt></p>
    135. 

  135. <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>
    136. 

  136. </dd></dl>
    137. 

  137. 

  138. <dl class="attribute">
    139. 

  139. <dt id="CategoryBase.tree">
    140. 

  140. <tt class="descname">tree</tt><a class="headerlink" href="#CategoryBase.tree" title="Permalink to this definition"></a></dt>
    141. 

  141. <dd><p><tt class="docutils literal"><span class="pre">TreeManager</span></tt></p>
    142. 

  142. <p>A Django-MPTT <a class="reference external" href="http://readthedocs.org/docs/django-mptt/en/latest/models.html#the-treemanager-custom-manager">TreeManager</a> instance.</p>
    143. 

  143. </dd></dl>
    144. 

  144. 

  145. </dd></dl>
    146. 

  146. 

  147. </div>
    148. 

  148. <div class="section" id="category">
    149. 

  149. <h2>Category<a class="headerlink" href="#category" title="Permalink to this headline"></a></h2>
    150. 

  150. <dl class="class">
    151. 

  151. <dt id="Category">
    152. 

  152. <em class="property">class </em><tt class="descname">Category</tt><a class="headerlink" href="#Category" title="Permalink to this definition"></a></dt>
    153. 

  153. <dd><p>Category is a subclass of <a class="reference internal" href="#CategoryBase" title="CategoryBase"><tt class="xref py py-class docutils literal"><span class="pre">CategoryBase</span></tt></a> and includes all its attributes.</p>
    154. 

  154. <dl class="attribute">
    155. 

  155. <dt id="Category.thumbnail">
    156. 

  156. <tt class="descname">thumbnail</tt><a class="headerlink" href="#Category.thumbnail" title="Permalink to this definition"></a></dt>
    157. 

  157. <dd><p><tt class="docutils literal"><span class="pre">FileField</span></tt></p>
    158. 

  158. <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>
    159. 

  159. <div class="admonition note">
    160. 

  160. <p class="first admonition-title">Note</p>
    161. 

  161. <p>Why isn&#8217;t this an <tt class="docutils literal"><span class="pre">ImageField</span></tt>?</p>
    162. 

  162. <p>For <tt class="docutils literal"><span class="pre">ImageField</span></tt>s, Django checks the file system for the existance of the files to handle the height and width. In many cases this can lead to problems and impact performance.</p>
    163. 

  163. <p class="last">For these reasons, a <tt class="docutils literal"><span class="pre">FileField</span></tt> that manually manages the width and height was chosen.</p>
    164. 

  164. </div>
    165. 

  165. </dd></dl>
    166. 

  166. 

  167. <dl class="attribute">
    168. 

  168. <dt id="Category.thumbnail_width">
    169. 

  169. <tt class="descname">thumbnail_width</tt><a class="headerlink" href="#Category.thumbnail_width" title="Permalink to this definition"></a></dt>
    170. 

  170. <dd><p><tt class="docutils literal"><span class="pre">IntegerField</span></tt></p>
    171. 

  171. <p>The thumbnail width. Automatically set on save if a thumbnail is uploaded.</p>
    172. 

  172. </dd></dl>
    173. 

  173. 

  174. <dl class="attribute">
    175. 

  175. <dt id="Category.thumbnail_height">
    176. 

  176. <tt class="descname">thumbnail_height</tt><a class="headerlink" href="#Category.thumbnail_height" title="Permalink to this definition"></a></dt>
    177. 

  177. <dd><p><tt class="docutils literal"><span class="pre">IntegerField</span></tt></p>
    178. 

  178. <p>The thumbnail height. Automatically set on save if a thumbnail is uploaded.</p>
    179. 

  179. </dd></dl>
    180. 

  180. 

  181. <dl class="attribute">
    182. 

  182. <dt id="Category.order">
    183. 

  183. <tt class="descname">order</tt><a class="headerlink" href="#Category.order" title="Permalink to this definition"></a></dt>
    184. 

  184. <dd><p><strong>Required</strong> <tt class="docutils literal"><span class="pre">IntegerField</span></tt> <em>default:</em> 0</p>
    185. 

  185. <p>A manually-managed order of this category in the listing. Items with the same order are sorted alphabetically.</p>
    186. 

  186. </dd></dl>
    187. 

  187. 

  188. <dl class="attribute">
    189. 

  189. <dt id="Category.alternate_title">
    190. 

  190. <tt class="descname">alternate_title</tt><a class="headerlink" href="#Category.alternate_title" title="Permalink to this definition"></a></dt>
    191. 

  191. <dd><p><tt class="docutils literal"><span class="pre">CharField(100)</span></tt></p>
    192. 

  192. <p>An alternative title to use on pages with this category.</p>
    193. 

  193. </dd></dl>
    194. 

  194. 

  195. <dl class="attribute">
    196. 

  196. <dt id="Category.alternate_url">
    197. 

  197. <tt class="descname">alternate_url</tt><a class="headerlink" href="#Category.alternate_url" title="Permalink to this definition"></a></dt>
    198. 

  198. <dd><p><tt class="docutils literal"><span class="pre">CharField(200)</span></tt></p>
    199. 

  199. <p>An alternative URL to use instead of the one derived from the category hierarchy.</p>
    200. 

  200. <div class="admonition note">
    201. 

  201. <p class="first admonition-title">Note</p>
    202. 

  202. <p>Why isn&#8217;t this a <tt class="docutils literal"><span class="pre">URLField</span></tt>?</p>
    203. 

  203. <p class="last">For <tt class="docutils literal"><span class="pre">URLField</span></tt>s, Django checks that the URL includes <tt class="docutils literal"><span class="pre">http://</span></tt> and the site name. This makes it impossible to use relative URLs in that field.</p>
    204. 

  204. </div>
    205. 

  205. </dd></dl>
    206. 

  206. 

  207. <dl class="attribute">
    208. 

  208. <dt id="Category.description">
    209. 

  209. <tt class="descname">description</tt><a class="headerlink" href="#Category.description" title="Permalink to this definition"></a></dt>
    210. 

  210. <dd><p><tt class="docutils literal"><span class="pre">TextField</span></tt></p>
    211. 

  211. <p>An optional longer description of the category. Very useful on category landing pages.</p>
    212. 

  212. </dd></dl>
    213. 

  213. 

  214. <dl class="attribute">
    215. 

  215. <dt id="Category.meta_keywords">
    216. 

  216. <tt class="descname">meta_keywords</tt><a class="headerlink" href="#Category.meta_keywords" title="Permalink to this definition"></a></dt>
    217. 

  217. <dd><p><tt class="docutils literal"><span class="pre">CharField(255)</span></tt></p>
    218. 

  218. <p>Comma-separated keywords for search engines.</p>
    219. 

  219. </dd></dl>
    220. 

  220. 

  221. <dl class="attribute">
    222. 

  222. <dt id="Category.meta_extra">
    223. 

  223. <tt class="descname">meta_extra</tt><a class="headerlink" href="#Category.meta_extra" title="Permalink to this definition"></a></dt>
    224. 

  224. <dd><p><tt class="docutils literal"><span class="pre">TextField</span></tt></p>
    225. 

  225. <p>(Advanced) Any additional HTML to be placed verbatim in the <tt class="docutils literal"><span class="pre">&lt;head&gt;</span></tt> of the page.</p>
    226. 

  226. </dd></dl>
    227. 

  227. 

  228. </dd></dl>
    229. 

  229. 

  230. </div>
    231. 

  231. </div>
    232. 

  232. 

  233. 

  234.           </div> 
    235. 

  235.         </div>
    236. 

  236.       </div>
    237. 

  237.     <div class="footer">
    238. 

  238.     <p>
    239. 

  239.       &copy; Copyright 2010-2012, Corey Oordt.
    240. 

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

  241. 	</p>
    242. 

  242.     </div>
    243. 

  243.       <div class="clearer"></div>
    244. 

  244.     </div>
    245. 

  245. 	<div id="breadcrumbs">
    246. 

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

  247. 		Models
    248. 

  248. 		</ul>
    249. 

  249. 	</div>
    250. 

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

  251.   </body>
    252. 

  252. </html>
    253.