kobotoolbox/kpi

KPI

Python 依赖

Python 依赖通过 pip-tools 包中的 pip-compile 和 pip-sync 进行管理。依赖项列于 dependencies/pip/ 目录，核心需求在 dependencies/pip/requirements.in 中。你可以直接使用 pip 和某个已编译的 dependencies/pip/*.txt 文件，但建议使用 pip-sync。不要直接向已编译的 dependencies/pip/*.txt 文件添加新依赖；应更新相关的源文件 dependencies/pip/*.in，并在修改后执行 make pip_compile。可通过例如 make pip_compile ARGS='--upgrade-package=xlwt' 向 pip-compile 传递参数。如需强制构建，使用 make --always-make ...。

Ubuntu 16.04 apt 依赖

Ubuntu 16.04 的 apt 依赖列于 dependencies/apt_requirements.txt，可通过例如 apt-get install $(cat dependencies/apt_requirements.txt) 安装。

下载和编译翻译

• 通过 git submodule update 将子模块拉取到 locale 目录。
• 可选：配置 transifex 以将最新翻译拉取到 locale 目录，执行 tx pull --all。
• 运行 python manage.py compilemessages 将 .po 文件转换为 .mo 文件。
• 要在界面中测试语言环境，双击左侧导航栏中的“账户操作”，使用下拉菜单选择语言并刷新页面。

搜索资产和集合

顶级（无父级）资产和集合可通过在查询字符串中包含 parent= 来查找。对于其他搜索，使用 Whoosh 查询语言 构建字符串并作为 q 参数传递，例如 /assets/?q=name:sanitation。Whoosh 索引的字段包括：

• name：名称的分词化*表示；
• name__exact：名称的空格和逗号转义表示，例如“Fun, Exciting Asset”会被索引为“Fun--Exciting-Asset”；
• owner__username：所有者用户名的分词化*表示；
• owner__username__exact：所有者用户名的空格和逗号转义表示；
• parent__name：父对象名称的分词化*表示；
• parent__name__exact：父对象名称的空格和逗号转义表示；
• parent__uid：父集合的 UID；
• ancestor__uid：包含所有祖先集合 UID 的多值字段；
• tag：包含每个分配给对象的标签的空格和逗号转义表示的多值字段；
• asset_type（仅资产）：资产类型字符串的空格和逗号转义表示。

当 q 参数包含未指定字段的搜索词时（例如 /collections/?q=health），该词将匹配搜索“文档”（text 字段）。

搜索标签

使用 Whoosh 查询语言 构建字符串并作为 q 参数传递，例如 /tags/?q=asset_type:block。Whoosh 索引的字段包括：

• name__ngram：标签名称分解为 n-gram，例如 ?q=name__ngram:cat 会匹配名称为“dogs/cats”和“education”的标签；
• asset_type：包含所有标记资产类型（如 form、question、block）的多值字段；
• kind：包含“asset”（当资产被标记时）、“collection”（当集合被标记时）或两者的多值字段；
• text：名称的分词化*表示，作为搜索“文档”（见下方说明）。

当 q 参数包含未指定字段的搜索词时（例如 /tags/?q=health），该词将匹配搜索“文档”（text 字段）。

* 由 Haystack 实现为 https://github.com/django-haystack/django-haystack/blob/ad90028a22b4274b8df1f4698dd59ac0643f03d5/haystack/backends/whoosh_backend.py#L174%EF%BC%8C%E4%B8%8D%E9%80%82%E5%90%88%E7%B2%BE%E7%A1%AE%E5%8C%B9%E9%85%8D%E3%80%82

管理员报告

超级用户可使用多种数据报告：

• 包含用户注册详情、已部署项目数（XForm 计数）、提交数、加入日期和最后登录时间的完整用户列表：<kpi 基础 URL>/superuser_stats/user_report/。生成的文件为 CSV，请勿立即下载，需等待服务器完成文件写入（即使未完成也会下载）。
• 表单数、已部署项目数和提交数的月度汇总数据（来自 kobocat）：<kc 服务器域名>/<超级用户名>/superuser_stats/。

Django 管理界面

由于这是 Django 项目，你可能会发现位于 <kpi 基础 URL>/admin 的管理面板很有用，例如配置用户账户或无需知道密码即可以其他用户身份登录。必须使用超级用户账户访问管理面板。

图标

所有项目图标均保存在 jsapp/svg-icons/ 目录。添加新图标需在此处添加新的 svg 文件并通过 npm run generate-icons 重新生成图标。文件名用于图标字体类名，例如 arrow-last.svg 对应 .k-icon-arrow-last（请使用 kebab-case 命名）。可通过运行 npm run show-icons 在浏览器中查看所有可用图标。

支持的浏览器

参见 浏览器列表配置