Authors: Matt Butcher (lead), Emily Brand, and others
This package is licensed under the GNU LGPL 2.1 (COPYING-LGPL.txt) or, at your choice, an MIT-style license (COPYING-MIT.txt). The licenses should have been distributed with this library.
The following packages of QueryPath are available:
- Minimal (QueryPath-VERSION-minimal.tgz): This contains only the QueryPath library, with no documentation or additional build environment. It is designed for production systems.
- Full (QueryPath-VERSION.tgz): This contains QueryPath, its unit tests, its documentation, examples, and all supporting material. If you are starting with QueryPath, this might be the best package.
- Docs (QueryPath-VERSION-docs.tgz): This package contains only the documentation for QueryPath. Generally, this is useful to install as a complement to the minimal package.
- Phar (QueryPath-VERSION.phar): This is a Phar package which can be used as-is. Its size has been minimized by stripping comments. It is designed for direct inclusion in PHP 5.3 applications.
- PEAR package (pear install QueryPath) coming soon (2.1 release): If you have added the QueryPath channel to your pear repository, you can install the full version of QueryPath with pear.
If in doubt, you probably want the PEAR version or the Full package.
To use QueryPath as a standard PHP library, simply put it somewhere PHP can see it and include
QueryPath/QueryPath.php (that's in
src/ in the full distro).
To use QueryPath as a phar, put the phar somewhere where PHP can see it and include
To use QueryPath as a PEAR package (assuming to have already installed it with PEAR), include
From there, the main functions you will want to use are
htmlqp(). Start with the API docs.