django-reviews / docs / _build / html / index.html

<!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>Welcome to django-reviews’s documentation! &mdash; django-reviews v0.2.1 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.2.1',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="django-reviews v0.2.1 documentation" href="" /> 
  </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><a href="">django-reviews v0.2.1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="welcome-to-django-reviews-s-documentation">
<h1>Welcome to django-reviews&#8217;s documentation!<a class="headerlink" href="#welcome-to-django-reviews-s-documentation" title="Permalink to this headline"></a></h1>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<p>To install just do:</p>
<ol class="arabic simple">
<li><tt class="docutils literal"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span></tt> or <tt class="docutils literal"><span class="pre">easy_install</span> <span class="pre">django-reviews</span></tt></li>
<li>Add reviews to <em>INSTALLED_APPS</em>.</li>
<li>Add django-reviews&#8217; urls to urls.py</li>
<li>Add <em>django.core.context_processors.request</em> to <em>TEMPLATE_CONTEXT_PROCESSORS</em>
(If it isn&#8217;t already).</li>
</ol>
</div>
<div class="section" id="settings">
<h2>Settings<a class="headerlink" href="#settings" title="Permalink to this headline"></a></h2>
<p>There are several settings which you can use within settings.py:</p>
<p>REVIEWS_IS_MODERATED</p>
<blockquote>
If True the admin has to publish a review manually. Otherwise a review is
public right after it has been added.</blockquote>
<p>REVIEWS_SHOW_PREVIEW</p>
<blockquote>
If True a preview is displayed to the user before he can submit the review.</blockquote>
<p>REVIEWS_IS_EMAIL_REQUIRED</p>
<blockquote>
If True the e-mail field of the review is mandatory. (if the user is anonymous)</blockquote>
<p>REVIEWS_IS_NAME_REQUIRED</p>
<blockquote>
If True the name field of the review is mandatory. (if the user is anonymous)</blockquote>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<p>Add the provided tags to your templates:</p>
<div class="highlight-python"><pre>{% load reviews_tags %}

&lt;html&gt;
    &lt;head&gt;
        &lt;title&gt;{{ flatpage.title }}&lt;/title&gt;
    &lt;/head&gt;
    &lt;body&gt;
        {{ flatpage.content }}
        {% average_for_instance flatpage %}

        &lt;hr&gt;
        {% reviews_for_instance flatpage %}

    &lt;/body&gt;
&lt;/html&gt;</pre>
</div>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline"></a></h2>
<p>There is a simple example provided with this product.</p>
<p>To install it just make sure <em>django.contrib.flatpages</em> has been installed (a
flatpage will serve as our test content) and add reviews.example to
<em>INSTALLED_APPS</em>.</p>
<p>Now add a flatpage and browse to it. You should be able to add reviews to the
flatpage now.</p>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
<li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="">Table Of Contents</a></h3>
            <ul>
<li><a class="reference external" href="">Welcome to django-reviews&#8217;s documentation!</a><ul>
<li><a class="reference external" href="#installation">Installation</a></li>
<li><a class="reference external" href="#settings">Settings</a></li>
<li><a class="reference external" href="#usage">Usage</a></li>
<li><a class="reference external" href="#example">Example</a></li>
<li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>

            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/index.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" size="18" />
                <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><a href="">django-reviews v0.2.1 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2009, Kai Diefenbach.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
    </div>
  </body>
</html>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.