django-tailordev-contact 0.5.0

TailorDev Contact
=================

为您的django项目提供的可定制联系表单。

您可以在[readthedocs](http://django-tailordev-contact.readthedocs.org/)上找到此项目的文档。

## 依赖项

目前，此项目在运行生产环境时需要Django >=1.5和python >=2.6。目前，此应用程序与python 3.3不兼容。我们正在努力解决这个问题。

## 安装

要安装TailorDev Contact，请使用pip

$ pip install django-tailordev-contact

如果您打算测试或改进此应用程序，首先克隆此存储库并安装本地依赖项

$ pip install -r requirements/local.txt

## 配置

将`td_contact`及其依赖项添加到您的`INSTALLED_APPS`

INSTALLED_APPS = (
...
'td_contact',
...
)

将`td_contact` URL添加到您的项目URL模式中

urlpatterns = patterns('',
...
url(r'^contact/', include('td_contact.urls')),
...
)

在您的`settings.py`中设置您的`td_contact`规则，例如添加以下内容

# 联系表单
TD_CONTACT_FORM_RULES = {
'default': {
'prefix': "[Foo:contact]",
'subject': "一般信息",
'to': ('contact@foo.com', 'ceo@foo.com'),
},
'partner': {
'prefix': "[Foo:partner]",
'subject': "合作伙伴机会",
'to': ('partner@foo.com', ),
},
'jobs': {
'prefix': "[Foo:jobs]",
'subject': "工作机会",
'to': ('jobs@foo.com', ),
},
}

`TD_CONTACT_FORM_RULES` 是一个简单的字典，其中每个键定义了一条新规则。每个规则也是一个字典，定义了电子邮件前缀和主题以及收件人列表。

> **重要提示**：当联系表单成功填写后，用户将被重定向到网站首页。因此，我们使用 [django messages 框架](https://docs.django.ac.cn/en/1.5/ref/contrib/messages/) 来通知用户其请求状态。请确保启用消息并在您的基模板 DOM 中添加以下内容

{% if messages %}
<ul class="messages">
{% for message in messages %}
<li data-alert{% if message.tags %} class="message {{ message.tags }}"{% endif %}>
{{ message }}
<a href="#" class="close">&times;</a>
</li>
{% endfor %}
</ul>
{% endif %}

此示例与 [zurb foundation 框架](http://foundation.zurb.com/) 兼容。请随意将其适应您喜欢的框架。

## URL

TailorDev 联系表单定义了3个您可以在模板中使用的URL

### `contact_form_rule`

此URL旨在使用您自己的规则初始化表单，例如

{% url 'contact_form_rule' 'jobs' %}

### `user_contact_form_by_slug` 和 `user_contact_form_by_pk`

根据您的应用程序，人们可能希望直接联系注册用户，并且您需要一个优雅的URL来指向。为此，请在模板中使用 `user_contact_form_by_slug`，例如

{% url 'user_contact_form_by_slug' myuser.slug %}

或者，在模板中使用 `user_contact_form_by_id`，例如

{% url 'user_contact_form_by_pk' myuser.pk %}

要使用此功能，请在 `settings.py` 中激活相关选项

TD_CONTACT_FORM_ALLOW_DIRECT_USER_CONTACT = True

### `contact_form`

此基本URL指向您的联系表单。无需添加其他内容。

## 模板

### 使用默认模板

如果您想使用我们的默认模板，请随意使用。但请注意

* 您应该创建一个基模板以继承，可见为 `_layouts/base.html`
* 您的表单将出现在 `content` 块中
* 必须自定义两个部分模板 `contact/partials/contact_recipient.html` 和 `contact/partials/aside.html`

### 使用您自己的模板

用于渲染表单的模板-to-覆盖可见为 `contact/form.html`。模板的核心部分可能如下所示

<div class="form_wrapper">

<h1>{% trans "Contact" %}</h1>

{% if recipient %}
{% include "contact/partials/contact_recipient.html" %}
{% endif %}

<form action="" method="post" class="custom">
{% csrf_token %}
{% for field in form %}
{% if field.is_hidden %}
{{ field }}
{% else %}
<div class="field_wrapper">
<div class="field{% if field.field.required %} required{% endif %}">
<label {% if field.errors %}class="error"{% endif %}>{{ field.label }}</label>
{{ field }}
{% if field.errors %}
<small class="error">{{ field.errors }}</small>
{% endif %}
</div>
</div>
{% endif %}
{% endfor %}

<button type="submit" />{% trans "Send message" %}</button>
</form>
</div>



## 运行测试

您可以通过以下方式运行测试

python setup.py test

或

python runtests.py

### 代码覆盖率

为了估计项目覆盖率

coverage run --source='td_contact' runtests.py
coverage report -m