icybee / module-contents
Base module for content nodes such as articles or news.
Installs: 238
Dependents: 3
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Type:icanboogie-module
Requires
- php: >=5.5
- icanboogie/bind-facets: ^0.6
- icanboogie/module-installer: ^1.2
- icybee/module-nodes: ^3.0
- icybee/module-registry: ^3.0
Requires (Dev)
- icybee/core: ^3.0
- icybee/module-cache: ^3.0
This package is auto-updated.
Last update: 2024-10-20 03:14:34 UTC
README
The Contents module (contents
) is the base module for content nodes such as articles or
news. If extends nodes with a body, an excerpt, a subtitle, a date and an additionnal visibility
option. The body can be edited with any of the editors available throught the Editor API.
The rendered body can be cached and the module provides a cache manager for the Cache module that allows the user to control the cache.
Requirement
The package requires PHP 5.4 or later.
Installation
The recommended way to install this package is through Composer.
Create a composer.json
file and run php composer.phar install
command to install it:
{ "minimum-stability": "dev", "require": { "icybee/module-contents": "2.x" } }
Note: The module is part of the modules required by Icybee.
Cloning the repository
The package is available on GitHub, its repository can be cloned with the following command line:
$ git clone git://github.com/Icybee/module-contents.git contents
Documentation
The package is documented as part of the Icybee CMS
documentation. The documentation for the package and its
dependencies can be generated with the make doc
command. The documentation is generated in
the docs
directory using ApiGen. The package directory can later be
cleaned with the make clean
command.
Testing
The test suite is ran with the make test
command. Composer is
automatically installed as well as all the dependencies required to run the suite. The package
directory can later be cleaned with the make clean
command.
The package is continuously tested by Travis CI.
License
The package is licensed under the New BSD License - See the LICENSE file for details.