Skip to content

Commit

Permalink
Cleaned up guides' images.
Browse files Browse the repository at this point in the history
  • Loading branch information
Reinmar committed Mar 5, 2013
1 parent 98525c8 commit e3f52c8
Show file tree
Hide file tree
Showing 18 changed files with 438 additions and 444 deletions.
26 changes: 10 additions & 16 deletions guides/dev/configuration/file_browse_upload/README.md
Expand Up @@ -4,14 +4,13 @@ CKEditor can be easily integrated with an external file
browser/uploader.

Once properly set up, all file browser features will automatically
become available. This includes the **Upload** tab^(1) in the **Link**,
become available. This includes the **Upload** tab `(1)` in the **Link**,
**Image**, and **Flash Properties** dialog windows as well as the
**Browse Server** button^(2).
**Browse Server** button `(2)`.

![File browser features available for images in CKEditor](guides/dev_file_browse_upload/image_dialog_browser_upload.png)
{@img image_dialog_browser_upload.png File browser features available for images in CKEditor}

## Basic Configuration
-------------------

* The {@link CKEDITOR.config#filebrowserBrowseUrl filebrowserBrowseUrl} setting contains the location of an external file browser that should be
launched when the **Browse Server** button is pressed.
Expand Down Expand Up @@ -54,7 +53,6 @@ will be used by default. In the **Image Properties** dialog window CKEditor will
use the `filebrowserImageBrowseUrl` and `filebrowserImageUploadUrl` configuration settings instead.

## File Browser Window Size
--------------------------------------------------------------------------------------------------------

The default width of the file browser window in CKEditor is set to 80%
of the screen width, while the default height is set to 70% of the
Expand Down Expand Up @@ -137,14 +135,10 @@ is a base path to the CKFinder installation directory.
If you are using CKFinder for ASP, ASP.NET, or ColdFusion, remember to
change `php` above to the right extension:

- asp – [CKFinder for
ASP](CKFinder/Developers_Guide/ASP/CKEditor_Integration)
- aspx – [CKFinder for
ASP.NET](CKFinder/Developers_Guide/ASP.NET/CKEditor_Integration)
- cfm – [CKFinder for
ColdFusion](CKFinder/Developers_Guide/ColdFusion/CKEditor_Integration)
- php – [CKFinder for
PHP](CKFinder/Developers_Guide/PHP/CKEditor_Integration)
- asp – [CKFinder for ASP](CKFinder/Developers_Guide/ASP/CKEditor_Integration)
- aspx – [CKFinder for ASP.NET](CKFinder/Developers_Guide/ASP.NET/CKEditor_Integration)
- cfm – [CKFinder for ColdFusion](CKFinder/Developers_Guide/ColdFusion/CKEditor_Integration)
- php – [CKFinder for PHP](CKFinder/Developers_Guide/PHP/CKEditor_Integration)

### Example 6

Expand All @@ -160,7 +154,7 @@ CKFinder installation.
Please check the `_samples/js/ckeditor.html` sample distributed with
CKFinder to see the full working example of this integration method.

![CKFinder integrated with CKEditor](guides/dev_file_browse_upload/ckeditor_with_ckfinder.png "CKFinder integrated with CKEditor")
{@img ckeditor_with_ckfinder.png CKFinder integrated with CKEditor}

### PHP API

Expand All @@ -175,5 +169,5 @@ documentation for more details.
For more advanced information on integrating CKEditor with a file
browser refer to the following articles:

- [Creating a Custom File Browser](#!/guide/dev_file_browser_api)
- [Adding the File Browser to Dialog Windows](#!/guide/dev_dialog_add_file_browser)
- [Creating a Custom File Browser](#!/guide/dev_file_browser_api)
- [Adding the File Browser to Dialog Windows](#!/guide/dev_dialog_add_file_browser)
8 changes: 4 additions & 4 deletions guides/dev/framed/README.md
Expand Up @@ -12,15 +12,15 @@ As a matter of fact, CKEditor uses the `textarea` to transfer its data to the se

<textarea name="editor1">&lt;p&gt;Initial value.&lt;/p&gt;</textarea>

Note that if you want to load data into the editor, for example from a database, you need to put that data inside the `<textarea>` element, just like the HTML-encoded <p> element in the example above. In this case the textarea element was named `editor1`. This name can be used in the server-side code later, when receiving the posted data.
Note that if you want to load data into the editor, for example from a database, you need to put that data inside the `<textarea>` element, just like the HTML-encoded `<p>` element in the example above. In this case the textarea element was named `editor1`. This name can be used in the server-side code later, when receiving the posted data.

After the textarea element is inserted, you can use the [CKEditor JavaScript API](!#/api) to replace this HTML element with an editor instance. A simple CKEDITOR.replace method call is needed for that:

<script>
CKEDITOR.replace( 'editor1' );
</script>

This script block must be included at any point after the `<textarea>` tag in the source code of the page. You can also call the replace function inside the <head> section, but in this case you will need to listen for the `window.onload` event:
This script block must be included at any point after the `<textarea>` tag in the source code of the page. You can also call the replace function inside the `<head>` section, but in this case you will need to listen for the `window.onload` event:

<script>
window.onload = function() {
Expand All @@ -30,9 +30,9 @@ This script block must be included at any point after the `<textarea>` tag in th

## Saving the Editor Data

As stated above, the editor works just like a `<textarea>` field. This means that when submitting a form containing an editor instance, its data will be simply posted, using the `<textarea>` element name as the key to retrieve it.
As stated above, the editor works just like a `<textarea>` field. This means that when submitting a form containing an editor instance, its data will be simply posted, using the `<textarea>` element name as the key to retrieve it.

For example, following the above example, we could create the following PHP code:
For example, following the above example, we could create the following PHP code:

<?php
$editor_data = $_POST[ 'editor1' ];
Expand Down
2 changes: 1 addition & 1 deletion guides/dev/howtos/basic_configuration/README.md
Expand Up @@ -35,4 +35,4 @@ If you are interested in learning how to create your own code to embed, configur

The figure below presents one of the CKEditor samples, Massive inline editing (`inlineall.html`), opened in a browser.

{@img ../../images/inlineall.png One of the CKEditor samples as viewed in Google Chrome}
{@img inlineall.png One of the CKEditor samples as viewed in Google Chrome}
File renamed without changes
8 changes: 4 additions & 4 deletions guides/dev/howtos/dialog_windows/README.md
Expand Up @@ -26,7 +26,7 @@ In order to assign a default value to a dialog window field, use the 'default' p

The code above creates the following UI elements in a sample dialog window tab.

{@img ../../images/dialog_custom_1.png Sample dialog window tab containing two field with default values}
{@img dialog_custom_1.png Sample dialog window tab containing two field with default values}

You can also customize existing dialog windows and give them default values. The following code sets the default **URL** field value for the **Link** dialog window.

Expand All @@ -48,7 +48,7 @@ You can also customize existing dialog windows and give them default values. The

After this customization the **Link** dialog window will contain the `www.example.com` default value in the **URL** field.

{@img ../../images/dialog_custom_2.png Link dialog window with a default value for the URL field}
{@img dialog_custom_2.png Link dialog window with a default value for the URL field}

For more examples on setting a default field value refer to the **Using the JavaScript API to customize dialog windows** [sample](http://nightly.ckeditor.com/latest/ckeditor/samples/plugins/dialog/dialog.html) and its [source code](https://github.com/ckeditor/ckeditor-dev/blob/master/plugins/dialog/samples/dialog.html) from your CKEditor installation.

Expand Down Expand Up @@ -88,14 +88,14 @@ If you want to customize a [dialog window](#!/guide/user_interace_dialog_windows

The following figure shows the tooltip that describes the **URL** field of the **Link** dialog window that is displayed after the **Developer Tools** plugin was enabled.

{@img ../../images/dialog_dev_tools.png Element information displayed with the Developer Tools plugin in CKEditor}
{@img dialog_dev_tools.png Element information displayed with the Developer Tools plugin in CKEditor}


## How Do I Remove the Ability to Resize All CKEditor Dialog Windows?

Dialog windows of CKEditor can be resized by using the resizing grip located in the bottom right-hand corner of a dialog window (for RTL languages — in the bottom left-hand corner).

{@img ../../images/dialog_resize.png The resizing grip of a CKEditor dialog window}
{@img dialog_resize.png The resizing grip of a CKEditor dialog window}

You can disable the resizing feature completely by setting the {@link CKEDITOR.dialog.definition#resizable resizable} parameter to {@link CKEDITOR#DIALOG_RESIZE_NONE}.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
14 changes: 7 additions & 7 deletions guides/dev/howtos/interface/README.md
Expand Up @@ -5,7 +5,7 @@

The **elements path** displays information about the HTML elements of the document for the position of the cursor.

{@img ../../images/ui_elements_path.png The elements path of CKEditor}
{@img ui_elements_path.png The elements path of CKEditor}

If you want to get rid of it, use the CKEDITOR.config.removePlugins setting to remove the `elementspath` plugin.

Expand Down Expand Up @@ -47,7 +47,7 @@ While setting the height value, use the `isContentHeight` parameter to decide wh

The editor window can be resized by using the resizing grip located in the bottom right-hand corner of CKEditor interface (for RTL languages — in the bottom left-hand corner).

{@img ../../images/ui_resizer.png The resizing grip of CKEditor}
{@img ui_resizer.png The resizing grip of CKEditor}

To prevent the editor from being resized you can use the {@link CKEDITOR.config#removePlugins removePlugins} setting to remove the `resize` plugin.

Expand Down Expand Up @@ -90,21 +90,21 @@ If you set the resize_dir configuration value to `'horizontal'`, CKEditor window
config.resize_dir = 'horizontal';


## How Do I Remove the Toolbar Collapse Button?
## How Do I Add the Toolbar Collapse Button?

CKEditor toolbar can be collapsed and restored by using the **Collapse Toolbar** button located in the bottom right-hand corner of the toolbar (for RTL languages — in the bottom left-hand corner).

{@img ../../images/ui_collapse.png The Collapse Toolbar button in CKEditor}
{@img ui_collapse.png The Collapse Toolbar button in CKEditor}

If you want to disable the this feature, you need to set the {@link CKEDITOR.config#toolbarCanCollapse toolbarCanCollapse} parameter to `false`.
If you want to enable this feature, you need to set the {@link CKEDITOR.config#toolbarCanCollapse toolbarCanCollapse} parameter to `true`.

config.toolbarCanCollapse = false;
config.toolbarCanCollapse = true;

## How Do I Add or Remove Toolbar Buttons?

CKEditor {@link CKEDITOR.config#toolbar toolbar} is an array of button elements that you can freely add or remove.

{@img ../../images/ui_toolbar.png The CKEditor toolbar}
{@img ui_toolbar.png The CKEditor toolbar}

Check the [Toolbar Customization](#!/guide/dev_toolbar) section of this guide for more information on how to customize it.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit e3f52c8

Please sign in to comment.