django-cms-aldryn-search 2.0.2

贡献

这是一个开源项目。我们期待收到您以问题和拉取请求形式提供的反馈。在提交您的拉取请求之前，请查阅我们的 贡献指南。

我们对所有帮助创建和维护此包的贡献者表示感激。贡献者名单列在 贡献者 部分。

用法

通过您选择的包管理器安装 aldryn-search 后，将 aldryn_search 添加到您的 INSTALLED_APPS 中。如果您运行的是多语言 CMS 设置，必须为每种使用的语言定义一个 haystack 后端。

HAYSTACK_CONNECTIONS = {
    'en': {
        'ENGINE': 'haystack.backends.solr_backend.SolrEngine',
        'URL': 'http://my-solr-server/solr/my-site-en/',
        'TIMEOUT': 60 * 5,
        'INCLUDE_SPELLING': True,
        'BATCH_SIZE': 100,
    },
    'fr': {
        'ENGINE': 'haystack.backends.solr_backend.SolrEngine',
        'URL': 'http://my-solr-server/solr/my-site-fr/',
        'TIMEOUT': 60 * 5,
        'INCLUDE_SPELLING': True,
        'BATCH_SIZE': 100,
    },
}

为确保在搜索过程中使用正确的后端，请将 aldryn_search.router.LanguageRouter 添加到您的 HAYSTACK_ROUTERS 设置中。

HAYSTACK_ROUTERS = ['aldryn_search.router.LanguageRouter',]

在使用多种语言时，通常每种语言有一个搜索后端，在索引时知道当前使用的是哪种语言很重要，这可以通过 ALDRYN_SEARCH_LANGUAGE_FROM_ALIAS 设置来实现，此设置可以是可调用对象或指向一个的字符串路径。

请记住，通常在设置中导入东西不是一个好主意，然而在某些情况下，创建一个处理别名的函数似乎有点过度，例如

ALDRYN_SEARCH_LANGUAGE_FROM_ALIAS = lambda alias: alias.split('-')[-1]

上面的例子可以在使用多种语言和站点时使用，所有后端都可以有语言后缀。

这也可以通过在代码的其他地方定义一个函数来实现

ALDRYN_SEARCH_LANGUAGE_FROM_ALIAS = "my_app.helpers.language_from_alias"

如果上述任何返回 None，则使用 settings.LANGUAGE_CODE。

默认情况下，此设置评估为检查别名字典是否在 settings.LANGUAGES 中，如果是，则使用别名字符串作为语言。

有关完整的 Haystack 设置，请参阅其 文档。

有关更多信息，请参阅 文档文件夹。

与 django CMS 的集成

aldryn-search 附带了 django CMS 的 App Hook 和使用 Django 类视图的搜索视图。如果您想使用此应用钩子，您可以选择子类化它并自己注册它，或者将 ALDRYN_SEARCH_REGISTER_APPHOOK 设置为 True。

如果您想排除一些 CMS 插件进行索引，可以指定 ALDRYN_SEARCH_PLUGINS_EXCLUDE 设置如下

ALDRYN_SEARCH_EXCLUDED_PLUGINS = [
    "PluginA", "PluginB"
]

对于分页，aldryn-search 使用 aldryn_common.paginator.DiggPaginator。如果您想使用此内置分页，请确保安装 django-spurl，然后将 spurl 添加到 INSTALLED_APPS。

分页

结果根据 ALDRYN_SEARCH_PAGINATION 设置进行分页（默认：10）。如果设置为 None，则禁用分页。