Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 68 lines (42 sloc) 2.158 kb
9e5c20f @maccesch Updated Docs and install script
authored
1 ==============================
2 Django CMS Contact Form Plugin
3 ==============================
4
bf7eb0d @maccesch Added admin usability candy
authored
5 Contact form plugin for `Django CMS <http://www.django-cms.org/>`_ with spam protection and i18n.
9e5c20f @maccesch Updated Docs and install script
authored
6
7 If you want to use ReCAPTCHA you have to get a Public and Private Key from http://www.google.com/recaptcha. You can get them for free.
8
5e402ca @maccesch You can set recaptcha nad akismet keys by settings now
authored
9 The Akismet spam protection method requires an Akismet API Key which is obtainable from http://akismet.com/ For private persons this is free, too.
9e5c20f @maccesch Updated Docs and install script
authored
10
11 Dependencies
12 ============
13
14 Python Libs
15 -----------
16
1ee57ac @maccesch small read me improvements
authored
17 If you decide to use the ReCAPTCHA spam protection method you need to install the python library ``recaptcha-client`` (package ``python-recaptcha`` in Debian).
9e5c20f @maccesch Updated Docs and install script
authored
18
1ee57ac @maccesch small read me improvements
authored
19 If you use Akismet for spam protection ``akismet`` is needed. You also need to set your domain url in django admin in the section "sites".
9e5c20f @maccesch Updated Docs and install script
authored
20
6527de3 @maccesch added south recommendation to readme
authored
21 Both libraries can be installed by ``pip`` or ``easy_install``.
22
1ee57ac @maccesch small read me improvements
authored
23 It is recommended but not required to use South. Again it can be easily installed by ``pip`` or ``easy_install``.
9e5c20f @maccesch Updated Docs and install script
authored
24
bf7eb0d @maccesch Added admin usability candy
authored
25 Installation
26 ============
9e5c20f @maccesch Updated Docs and install script
authored
27
8229a68 @maccesch setup dependency fixes and smal docs upgrade
authored
28 Download
29 --------
30
7639f18 @maccesch Readying for PyPI
authored
31 From PyPI
8229a68 @maccesch setup dependency fixes and smal docs upgrade
authored
32 '''''''''
7639f18 @maccesch Readying for PyPI
authored
33
34 You can simply type into a terminal ``pip install cmsplugin-contact`` or ``easy_install cmsplugin-contact``.
35
8229a68 @maccesch setup dependency fixes and smal docs upgrade
authored
36 Manually
37 ''''''''
7639f18 @maccesch Readying for PyPI
authored
38
c0f7f34 @maccesch Tiny adjustments to docs and template
authored
39 You can download a zipped archive from http://github.com/maccesch/cmsplugin-contact/downloads.
40
851e3fe @maccesch Small docs update
authored
41 Unzip the file you downloaded. Then go in your terminal and ``cd`` into the unpacked folder. Then type ``python setup.py install`` in your terminal.
9e5c20f @maccesch Updated Docs and install script
authored
42
8229a68 @maccesch setup dependency fixes and smal docs upgrade
authored
43 Setup
44 -----
45
7846a38 @maccesch included glamkit-stopspam for simplicity
authored
46 Put ``'cmsplugin_contact'`` in your ``INSTALLED_APPS`` section in settings.py. Don't forget to syncdb your database or migrate if you're using South.
9e5c20f @maccesch Updated Docs and install script
authored
47
5e402ca @maccesch You can set recaptcha nad akismet keys by settings now
authored
48 Settings
49 ========
50
51 RECAPTCHA_PUBLIC_KEY and RECAPTCHA_PRIVATE_KEY
52 ----------------------------------------------
53
54 If you don't want to enter the ReCATPCHA keys in the admin interface you can provide them through these settings.
55
56 AKISMET_API_KEY
57 ---------------
58
db69ac5 @mitar Template cleaning.
mitar authored
59 The same as for ReCAPTCHA goes fo Akismet.
8ab1532 @dsh2dsh Add ability to subclass the plugin.
dsh2dsh authored
60
61 Extending
62 =========
63
64 See ``examples/cmsplugin_custom_contact`` how to subclass
4a55434 @maccesch small typo
authored
65 ``cmsplugin_contact`` and add custom fields into it. You can override
66 properties of the subclassed ``ContactPlugin`` and use your own templates
8ab1532 @dsh2dsh Add ability to subclass the plugin.
dsh2dsh authored
67 and classes.
Something went wrong with that request. Please try again.