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

Full commit
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

<html xmlns="">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Welcome to django-reviews’s documentation! &mdash; django-reviews v0.2.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">
        URL_ROOT:    '',
        VERSION:     '0.2.0',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
    <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.0 documentation" href="" /> 
    <div class="related">
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
        <li><a href="">django-reviews v0.2.0 documentation</a> &raquo;</li> 

    <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"></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 <em>django.core.context_processors.request</em> to <em>TEMPLATE_CONTEXT_PROCESSORS</em>
(If it isn&#8217;t already).</li>
<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</p>
If True the admin has to publish a review manually. Otherwise a review is
public right after it has been added.</blockquote>
If True a preview is displayed to the user before he can submit the review.</blockquote>
If True the e-mail field of the review is mandatory. (if the user is anonymous)</blockquote>
If True the name field of the review is mandatory. (if the user is anonymous)</blockquote>
<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;title&gt;{{ flatpage.title }}&lt;/title&gt;
        {{ flatpage.content }}
        {% average_for_instance flatpage %}

        {% reviews_for_instance flatpage %}

<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
<p>Now add a flatpage and browse to it. You should be able to add reviews to the
flatpage now.</p>
<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>

      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="">Table Of Contents</a></h3>
<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>

            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/index.txt"
                     rel="nofollow">Show Source</a></li>
          <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" />
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
          <script type="text/javascript">$('#searchbox').show(0);</script>
      <div class="clearer"></div>
    <div class="related">
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
        <li><a href="">django-reviews v0.2.0 documentation</a> &raquo;</li> 
    <div class="footer">
      &copy; Copyright 2009, Kai Diefenbach.
      Created using <a href="">Sphinx</a> 0.6.3.