rollerworks/search-metadata

该软件包已被废弃且不再维护。未建议替代软件包。

RollerworksSearch 的元数据扩展

v1.0.3 2015-12-09 09:45 UTC

This package is not auto-updated.

Last update: 2022-02-01 12:51:12 UTC


README

此软件包为 RollerworksSearch 提供元数据读取器。

元数据读取器使用 Rollerworks 元数据组件 从 XML 文档、YAML 文件或 PHP 注释等加载数据。

RollerworksSearch 是一个强大的开源搜索系统,如果您是 RollerworksSearch 的初学者,请阅读 主仓库 中的文档。

安装

要安装此扩展,请将 rollerworks/search-metadata 软件包添加到您的 composer.json 文件中

$ php composer.phar require rollerworks/search-metadata

文档

阅读主版本的文档

此软件包的文档使用 reStructuredText 编写,并可以使用 Sphinx 构建成标准 HTML。

要构建文档,请执行以下操作

  1. 安装 Spinx
  2. 在命令行中切换到 doc 目录
  3. 运行 make html

这将把文档构建到 doc/_build/html 目录中。

更多信息可以在 Symfony [文档格式][5] 文章中找到。

Sphinx 扩展和主题通过 Git 子模块安装,不需要单独下载。

贡献

如果您想为此项目做出贡献,请参阅 Rollerworks 贡献指南 以获取更多信息。

许可证

本软件包的源代码受 MIT 许可证的约束,该许可证与源代码一起包含在文件 LICENSE 中。