rollerworks/search-metadata

Metadata extension for RollerworksSearch

RollerworksSearch Metadata extension

This package provides a Metadata reader for RollerworksSearch., _(*1)

The Metadata reader uses the Rollerworks Metadata component for loading Metadata from e.g. an XML document, a YAML file or PHP Annotations., _(*2)

RollerworksSearch is a powerful open-source Search system, if you are new to RollerworksSearch, please read the documentation in the main repository., _(*3)

Installation

To install this extension, add the rollerworks/search-metadata package to your composer.json, _(*4)

$ php composer.phar require rollerworks/search-metadata

Documentation

[Read the Documentation for master][4], _(*5)

The documentation for this package is written in reStructuredText and can be built into standard HTML using [Sphinx][4]., _(*6)

To build the documentation do the following:, _(*7)

1. Install [Spinx][4]
2. Change to the doc directory on the command line
3. Run make html

This will build the documentation into the doc/_build/html directory., _(*8)

Further information can be found in The Symfony [documentation format][5] article., _(*9)

The Sphinx extensions and theme are installed sing Git submodules and don't need to be downloaded separately., _(*10)

Contributing

If you'd like to contribute to this project, please see the Rollerworks contributing guide lines for more information., _(*11)

License

The source of this package is subject to the MIT license that is bundled with this source code in the file LICENSE., _(*12)