-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
782 additions
and
610 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
Getting started with IvoryCKEditorBundle | ||
======================================== | ||
|
||
.. toctree:: | ||
:hidden: | ||
|
||
installation | ||
usage/index | ||
|
||
Overview | ||
-------- | ||
|
||
The bundle integrates `CKEditor`_ into `Symfony`_ via the `Form Component`_. It | ||
automatically registers a new type called ``ckeditor`` which can be easily as | ||
well as highly configured. This type extends the `textarea`_ one, meaning all | ||
textarea options are available. | ||
|
||
Here, an example where we customize the `CKEditor config`_: | ||
|
||
.. code-block:: php | ||
$builder->add('field', 'ckeditor', array( | ||
'config' => array( | ||
'uiColor' => '#ffffff', | ||
//... | ||
), | ||
)); | ||
.. note:: | ||
|
||
As of Symfony 2.8, the second argument of ``$builder->add()`` accepts the | ||
fully qualified class name of the form type and it becomes mandatory to use | ||
it in Symfony 3.0. Depending on your Symfony versions, you should replace | ||
the ``ckeditor`` parameter by | ||
``Ivory\CKEditorBundle\Form\Type\CKEditorType`` or by | ||
``CKEditorType::class`` if your project relies on PHP 5.5+. | ||
|
||
Installation | ||
------------ | ||
|
||
To install the bundle, please, read the :doc:`Installation documentation <installation>`. | ||
|
||
Usage | ||
----- | ||
|
||
If you want to learn more, this documentation covers the following use cases: | ||
|
||
.. include:: usage/index.rst.inc | ||
|
||
.. _`CKEditor`: http://ckeditor.com/ | ||
.. _`Symfony`: http://symfony.com/ | ||
.. _`Form Component`: http://symfony.com/doc/current/book/forms.html | ||
.. _`textarea`: http://symfony.com/doc/current/reference/forms/types/textarea.html | ||
.. _`CKEditor config`: http://docs.ckeditor.com/#!/api/CKEDITOR.config |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
Installation | ||
============ | ||
|
||
Download the Bundle | ||
------------------- | ||
|
||
Require the bundle in your ``composer.json`` file: | ||
|
||
.. code-block:: bash | ||
$ composer require egeloen/ckeditor-bundle | ||
Register the Bundle | ||
------------------- | ||
|
||
Then, update your ``app/AppKernel.php``: | ||
|
||
.. code-block:: php | ||
class AppKernel extends Kernel | ||
{ | ||
public function registerBundles() | ||
{ | ||
$bundles = array( | ||
new Ivory\CKEditorBundle\IvoryCKEditorBundle(), | ||
// ... | ||
); | ||
// ... | ||
} | ||
} | ||
Install the Assets | ||
------------------ | ||
|
||
Once, you have registered the bundle, you need to install the assets in the web | ||
directory: | ||
|
||
.. code-block:: bash | ||
$ php app/console assets:install web |
Oops, something went wrong.