-
Notifications
You must be signed in to change notification settings - Fork 116
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
21 changed files
with
718 additions
and
609 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 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,75 @@ | ||
Getting started with IvoryCKEditorBundle | ||
======================================== | ||
|
||
.. toctree:: | ||
:hidden: | ||
|
||
installation | ||
usage/config | ||
usage/toolbar | ||
usage/loading | ||
usage/file-browse-upload | ||
usage/jquery | ||
usage/textarea-sync | ||
usage/textarea-fallback | ||
usage/autoinline | ||
usage/inline | ||
usage/skin | ||
usage/style | ||
usage/template | ||
usage/version | ||
|
||
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: | ||
|
||
- :doc:`usage/config` | ||
- :doc:`usage/toolbar` | ||
- :doc:`usage/loading` | ||
- :doc:`usage/file-browse-upload` | ||
- :doc:`usage/jquery` | ||
- :doc:`usage/textarea-sync` | ||
- :doc:`usage/textarea-fallback` | ||
- :doc:`usage/autoinline` | ||
- :doc:`usage/inline` | ||
- :doc:`usage/skin` | ||
- :doc:`usage/style` | ||
- :doc:`usage/template` | ||
- :doc:`usage/version` | ||
|
||
.. _`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.
Oops, something went wrong.