holm/django-helpdesk
1
0
Fork 0
forked from extern/django-helpdesk
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8ed7debbdf
django-helpdesk/docs/html/spam.html

145 lines
6.4 KiB
HTML
Raw Normal View History

Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
<!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" />
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<title>Spam Filtering &mdash; django-helpdesk v0.1 documentation</title>
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
<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.1',
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-helpdesk v0.1 documentation" href="index.html" />
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<link rel="next" title="Custom Fields" href="custom_fields.html" />
<link rel="prev" title="Settings" href="settings.html" />
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
</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" >
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<a href="custom_fields.html" title="Custom Fields"
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
accesskey="N">next</a> |</li>
<li class="right" >
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<a href="settings.html" title="Settings"
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
accesskey="P">previous</a> |</li>
<li><a href="index.html">django-helpdesk v0.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<div class="section" id="spam-filtering">
<h1>Spam Filtering<a class="headerlink" href="#spam-filtering" title="Permalink to this headline"></a></h1>
<p>django-helpdesk includes a copy of <tt class="docutils literal"><span class="pre">akismet.py</span></tt> by <a class="reference external" href="http://www.voidspace.org.uk/">Michael Foord</a>, which lets incoming ticket submissions be automatically checked against either the <a class="reference external" href="http://akismet.com/">Akismet</a> or <a class="reference external" href="http://antispam.typepad.com/">TypePad Anti-Spam</a> services.</p>
<p>To enable this functionality, sign up for an API key with one of these two services.</p>
<div class="section" id="id1">
<h2>Akismet<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
<ul class="simple">
<li>Sign up at <a class="reference external" href="http://akismet.com/">http://akismet.com/</a></li>
<li>Save your API key in <tt class="docutils literal"><span class="pre">settings.py</span></tt> as <tt class="docutils literal"><span class="pre">AKISMET_API_KEY</span></tt></li>
</ul>
<p><strong>Note</strong>: Akismet is only free for personal use. Paid commercial accounts are available.</p>
</div>
<div class="section" id="typepad-antispam">
<h2>TypePad AntiSpam<a class="headerlink" href="#typepad-antispam" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Sign up at <a class="reference external" href="http://antispam.typepad.com/">http://antispam.typepad.com/</a></li>
<li>Save your API key in <tt class="docutils literal"><span class="pre">settings.py</span></tt> as <tt class="docutils literal"><span class="pre">TYPEPAD_ANTISPAM_API_KEY</span></tt></li>
</ul>
<p>This service is free to use, within their terms and conditions.</p>
<p>If you have either of these settings enabled, the spam filtering will be done automatically. If you have <em>both</em> settings configured, TypePad will be used instead of Akismet.</p>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline"></a></h2>
<p>A sample configuration in <tt class="docutils literal"><span class="pre">settings.py</span></tt> may be:</p>
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<div class="highlight-python"><div class="highlight"><pre><span class="n">TYPEPAD_ANTISPAM_API_KEY</span> <span class="o">=</span> <span class="s">&#39;abc123&#39;</span>
</pre></div>
</div>
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<li><a class="reference internal" href="#">Spam Filtering</a><ul>
<li><a class="reference internal" href="#id1">Akismet</a></li>
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
<li><a class="reference internal" href="#typepad-antispam">TypePad AntiSpam</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="settings.html"
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
title="previous chapter">Settings</a></p>
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
<h4>Next topic</h4>
<p class="topless"><a href="custom_fields.html"
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
title="next chapter">Custom Fields</a></p>
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/spam.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 class="right" >
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<a href="custom_fields.html" title="Custom Fields"
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
>next</a> |</li>
<li class="right" >
Rebuilt HTML documentation
2011-02-05 06:11:34 +01:00
<a href="settings.html" title="Settings"
Add first round of proper documentation. Mostly taken from the README at this stage.
2011-02-05 00:13:37 +01:00
>previous</a> |</li>
<li><a href="index.html">django-helpdesk v0.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Ross Poulton + Contributors.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
Reference in New Issue Copy Permalink