The seo module
Provides search engine optimization., (*1)
Requirement
The package requires PHP 5.3 or later.
The package also requires an installation of Icybee., (*2)
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:, (*3)
{
"minimum-stability": "dev",
"require":
{
"icybee/module-sites": "*"
}
}
Cloning the repository
The package is available on GitHub, its repository can be
cloned with the following command line:, (*4)
$ git clone git://github.com/Icybee/module-sites.git
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 by
cleaned with the make clean command., (*5)
Event hooks
Icybee\Modules\Pages\EditBlock::alter_children
Adds the controls used to edit the SEO title and description of the page., (*6)
Icybee\Modules\Pages\ExportOperation::process
Adds SEO properties to exported pages., (*7)
Icybee\Modules\Pages\PageController::render
Adds the Google Analytics script at the end of the body, unless one of the following
conditions is met:, (*8)
- "localhost" is in the server name.
- The user is the admin.
- The page or the displayed record is offline.
Icybee\Modules\Sites\EditBlock::alter_children
Extends the site edit block with a SEO group and controls for the Google Analytics UA
and the Google Site Verification key., (*9)
Brickrouge\Document::render_title:before
Replaces the title of the document with the SEO title before the title is rendered., (*10)
Adds the Description and google-site-verification metas., (*11)
Adds the canonical address of the document., (*12)
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., (*13)
The package is continuously tested by Travis CI., (*14)
, (*15)
License
The module is licensed under the New BSD License - See the LICENSE file for details., (*16)