Seantis Questionnaire 技术文档

1. 安装指南

1.1 创建项目目录

首先，创建一个新的项目目录并进入该目录：

mkdir site
cd site

1.2 创建虚拟环境

为了隔离Python包，创建并激活虚拟环境：

virtualenv .
source bin/activate

1.3 安装Django

安装指定版本的Django：

pip install django==1.8.17

1.4 创建Django项目

使用Django命令创建一个新的项目：

django-admin.py startproject mysite

1.5 克隆问卷项目

进入项目目录并创建一个apps文件夹，然后克隆问卷项目的源代码：

cd mysite
mkdir apps
cd apps
git clone [e-mail]:seantis/seantis-questionnaire.git

1.6 安装问卷项目

进入问卷项目目录并安装：

cd seantis-questionnaire
python setup.py install

如果你使用的是自己的fork版本，可以使用python setup.py develop来避免每次更改后重新安装。

2. 项目的使用说明

2.1 配置语言

打开settings.py文件，添加你需要的语言：

LANGUAGES = (
    ('de', _('German')),
    ('en', _('English')),
)

在文件顶部添加以下内容：

from django.utils.translation import ugettext_lazy as _

2.2 配置中间件和应用

在settings.py中添加以下中间件和应用：

MIDDLEWARE_CLASSES = [
    'django.middleware.locale.LocaleMiddleware',
    'questionnaire.request_cache.RequestCacheMiddleware',
]

INSTALLED_APPS = [
    'django.contrib.sites',
    'django_markup',
    'transmeta',
    'questionnaire',
    'questionnaire.page',
    'mysite'
]

SITE_ID = 1

2.3 配置URL

编辑urls.py文件，添加问卷的URL配置：

from django.conf.urls import include, url
from django.contrib import admin

admin.autodiscover()

urlpatterns = [
    url(r'^admin/', include(admin.site.urls)),
    url(r'q/', include('questionnaire.urls')),
    url(r'^take/(?P<questionnaire_id>[0-9]+)/$', 'questionnaire.views.generate_run'),
    url(r'^$', 'questionnaire.page.views.page', {'page_to_render': 'index'}),
    url(r'^(?P<lang>..)/(?P<page_to_trans>.*)\.html$', 'questionnaire.page.views.langpage'),
    url(r'^(?P<page_to_render>.*)\.html$', 'questionnaire.page.views.page'),
    url(r'^setlang/$', 'questionnaire.views.set_language'),
]

2.4 初始化数据库

运行以下命令初始化数据库：

python manage.py syncdb

2.5 加载示例数据

加载示例问卷数据：

python manage.py loaddata ./apps/seantis-questionnaire/example/fixtures/initial_data.yaml

2.6 运行测试

运行测试以确保问卷正常工作：

python manage.py test questionnaire

2.7 启动开发服务器

启动Django开发服务器：

python manage.py runserver

访问http://127.0.0.1:8000/查看问卷。

3. 项目API使用文档

3.1 设置进度条行为

在settings.py中，可以通过QUESTIONNAIRE_PROGRESS设置进度条的行为：

• default: 进度条会在每个问题集的顶部显示。
• async: 进度条值通过AJAX异步更新。
• none: 不显示进度条。

3.2 使用会话管理问卷

通过QUESTIONNAIRE_USE_SESSION设置问卷和问题集ID的传递方式：

• False: ID在URL中可见。
• True: ID存储在会话中，URL保持不变。

4. 项目安装方式

4.1 通过Git克隆安装

使用Git克隆项目源代码并安装：

git clone [e-mail]:seantis/seantis-questionnaire.git
cd seantis-questionnaire
python setup.py install

4.2 通过PIP安装

如果你有项目的PyPI包，可以直接使用pip安装：

pip install seantis-questionnaire

4.3 开发模式安装

如果你在开发过程中需要频繁更新代码，可以使用开发模式安装：

python setup.py develop

通过以上步骤，你可以成功安装并使用Seantis Questionnaire项目。