/*
Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
For licensing, see LICENSE.html or http://ckeditor.com/license
*/
/**
* @fileOverview Defines the {@link CKEDITOR.config}
object that stores the
* default configuration settings.
*/
/**
* Used in conjunction with {@link CKEDITOR.config.enterMode}
* and {@link CKEDITOR.config.shiftEnterMode}
configuration
* settings to make the editor produce <p>
tags when
* using the Enter key.
* @constant
*/
CKEDITOR.ENTER_P = 1;
/**
* Used in conjunction with {@link CKEDITOR.config.enterMode}
* and {@link CKEDITOR.config.shiftEnterMode}
configuration
* settings to make the editor produce <br>
tags when
* using the Enter key.
* @constant
*/
CKEDITOR.ENTER_BR = 2;
/**
* Used in conjunction with {@link CKEDITOR.config.enterMode}
* and {@link CKEDITOR.config.shiftEnterMode}
configuration
* settings to make the editor produce <div>
tags when
* using the Enter key.
* @constant
*/
CKEDITOR.ENTER_DIV = 3;
/**
* @namespace Stores default configuration settings. Changes to this object are
* reflected in all editor instances, if not specified otherwise for a particular
* instance.
*/
CKEDITOR.config =
{
/**
* The URL path for the custom configuration file to be loaded. If not
* overloaded with inline configuration, it defaults to the config.js
* file present in the root of the CKEditor installation directory.
*
* CKEditor will recursively load custom configuration files defined inside
* other custom configuration files.
* @type String
* @default '<CKEditor folder>/config.js'
* @example
* // Load a specific configuration file.
* CKEDITOR.replace( 'myfield', { customConfig : '/myconfig.js' } );
* @example
* // Do not load any custom configuration file.
* CKEDITOR.replace( 'myfield', { customConfig : '' } );
*/
customConfig : 'config.js',
/**
* Whether the replaced element (usually a <textarea>
)
* is to be updated automatically when posting the form containing the editor.
* @type Boolean
* @default true
* @example
* config.autoUpdateElement = true;
*/
autoUpdateElement : true,
/**
* The base href URL used to resolve relative and absolute URLs in the
* editor content.
* @type String
* @default ''
(empty)
* @example
* config.baseHref = 'http://www.example.com/path/';
*/
baseHref : '',
/**
* The CSS file(s) to be used to apply style to editor contents. It should
* reflect the CSS used in the final pages where the contents are to be
* used.
* @type String|Array
* @default '<CKEditor folder>/contents.css'
* @example
* config.contentsCss = '/css/mysitestyles.css';
* config.contentsCss = ['/css/mysitestyles.css', '/css/anotherfile.css'];
*/
contentsCss : CKEDITOR.basePath + 'contents.css',
/**
* The writing direction of the language used to create the editor
* contents. Allowed values are:
*
'ui'
– indicates that content direction will be the same as the user interface language direction;'ltr'
– for Left-To-Right language (like English);'rtl'
– for Right-To-Left languages (like Arabic).'ui'
* @type String
* @example
* config.contentsLangDirection = 'rtl';
*/
contentsLangDirection : 'ui',
/**
* Language code of the writing language which is used to create the editor
* contents.
* @default Same value as editor UI language.
* @type String
* @example
* config.contentsLanguage = 'fr';
*/
contentsLanguage : '',
/**
* The user interface language localization to use. If left empty, the editor
* will automatically be localized to the user language. If the user language is not supported,
* the language specified in the {@link CKEDITOR.config.defaultLanguage}
* configuration setting is used.
* @default ''
(empty)
* @type String
* @example
* // Load the German interface.
* config.language = 'de';
*/
language : '',
/**
* The language to be used if the {@link CKEDITOR.config.language}
* setting is left empty and it is not possible to localize the editor to the user language.
* @default 'en'
* @type String
* @example
* config.defaultLanguage = 'it';
*/
defaultLanguage : 'en',
/**
* Sets the behavior of the Enter key. It also determines other behavior
* rules of the editor, like whether the <br>
element is to be used
* as a paragraph separator when indenting text.
* The allowed values are the following constants that cause the behavior outlined below:
* {@link CKEDITOR.ENTER_P}
(1) – new <p>
paragraphs are created;{@link CKEDITOR.ENTER_BR}
(2) – lines are broken with <br>
elements;{@link CKEDITOR.ENTER_DIV}
(3) – new <div>
blocks are created.{@link CKEDITOR.ENTER_P}
setting because of its semantic value and
* correctness. The editor is optimized for this setting.
* @type Number
* @default {@link CKEDITOR.ENTER_P}
* @example
* // Not recommended.
* config.enterMode = CKEDITOR.ENTER_BR;
*/
enterMode : CKEDITOR.ENTER_P,
/**
* Force the use of {@link CKEDITOR.config.enterMode}
as line break regardless
* of the context. If, for example, {@link CKEDITOR.config.enterMode}
is set
* to {@link CKEDITOR.ENTER_P}
, pressing the Enter key inside a
* <div>
element will create a new paragraph with <p>
* instead of a <div>
.
* @since 3.2.1
* @type Boolean
* @default false
* @example
* // Not recommended.
* config.forceEnterMode = true;
*/
forceEnterMode : false,
/**
* Similarly to the {@link CKEDITOR.config.enterMode}
setting, it defines the behavior
* of the Shift+Enter key combination.
* The allowed values are the following constants the behavior outlined below:
* {@link CKEDITOR.ENTER_P}
(1) – new <p>
paragraphs are created;{@link CKEDITOR.ENTER_BR}
(2) – lines are broken with <br>
elements;{@link CKEDITOR.ENTER_DIV}
(3) – new <div>
blocks are created.{@link CKEDITOR.ENTER_BR}
* @example
* config.shiftEnterMode = CKEDITOR.ENTER_P;
*/
shiftEnterMode : CKEDITOR.ENTER_BR,
/**
* A comma separated list of plugins that are not related to editor
* instances. Reserved for plugins that extend the core code only._source/core/config.js
).
* @type String
* @example
*/
corePlugins : '',
/**
* Sets the DOCTYPE
to be used when loading the editor content as HTML.
* @type String
* @default '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
* @example
* // Set the DOCTYPE to the HTML 4 (Quirks) mode.
* config.docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">';
*/
docType : '',
/**
* Sets the id
attribute to be used on the body
element
* of the editing area. This can be useful when you intend to reuse the original CSS
* file you are using on your live website and want to assign the editor the same ID
* as the section that will include the contents. In this way ID-specific CSS rules will
* be enabled.
* @since 3.1
* @type String
* @default ''
(empty)
* @example
* config.bodyId = 'contents_id';
*/
bodyId : '',
/**
* Sets the class
attribute to be used on the body
element
* of the editing area. This can be useful when you intend to reuse the original CSS
* file you are using on your live website and want to assign the editor the same class
* as the section that will include the contents. In this way class-specific CSS rules will
* be enabled.
* @since 3.1
* @type String
* @default ''
(empty)
* @example
* config.bodyClass = 'contents';
*/
bodyClass : '',
/**
* Indicates whether the contents to be edited are being input as a full
* HTML page. A full page includes the <html>
,
* <head>
, and <body>
elements.
* The final output will also reflect this setting, including the
* <body>
contents only if this setting is disabled.
* @since 3.1
* @type Boolean
* @default false
* @example
* config.fullPage = true;
*/
fullPage : false,
/**
* The height of the editing area (that includes the editor content),
* in relative or absolute units, e.g. 30px
, 5em
.
* Note: Percentage units, like 30%
, are not supported yet.
* @type Number|String
* @default '200'
* @example
* config.height = 500;
* config.height = '25em';
* config.height = '300px';
*/
height : 200,
/**
* Comma separated list of plugins to be loaded and initialized for an editor
* instance. This setting should rarely be changed. It is recommended to use the
* {@link CKEDITOR.config.extraPlugins}
and
* {@link CKEDITOR.config.removePlugins}
for customization purposes instead.
* @type String
* @example
*/
plugins :
'about,' +
'a11yhelp,' +
'basicstyles,' +
'bidi,' +
'blockquote,' +
'button,' +
'clipboard,' +
'colorbutton,' +
'colordialog,' +
'contextmenu,' +
'dialogadvtab,' +
'div,' +
'elementspath,' +
'enterkey,' +
'entities,' +
'filebrowser,' +
'find,' +
'flash,' +
'font,' +
'format,' +
'forms,' +
'horizontalrule,' +
'htmldataprocessor,' +
'iframe,' +
'image,' +
'indent,' +
'justify,' +
'keystrokes,' +
'link,' +
'list,' +
'liststyle,' +
'maximize,' +
'newpage,' +
'pagebreak,' +
'pastefromword,' +
'pastetext,' +
'popup,' +
'preview,' +
'print,' +
'removeformat,' +
'resize,' +
'save,' +
'scayt,' +
'smiley,' +
'showblocks,' +
'showborders,' +
'sourcearea,' +
'stylescombo,' +
'table,' +
'tabletools,' +
'specialchar,' +
'tab,' +
'templates,' +
'toolbar,' +
'undo,' +
'wysiwygarea,' +
'wsc',
/**
* A list of additional plugins to be loaded. This setting makes it easier
* to add new plugins without having to touch and potentially break the
* {@link CKEDITOR.config.plugins}
setting.
* @type String
* @example
* config.extraPlugins = 'myplugin,anotherplugin';
*/
extraPlugins : '',
/**
* A list of plugins that must not be loaded. This setting makes it possible
* to avoid loading some plugins defined in the {@link CKEDITOR.config.plugins}
* setting, without having to touch it and potentially break it.
* @type String
* @example
* config.removePlugins = 'elementspath,save,font';
*/
removePlugins : '',
/**
* List of regular expressions to be executed on input HTML,
* indicating HTML source code that when matched, must not be available in the WYSIWYG
* mode for editing.
* @type Array
* @default []
(empty array)
* @example
* config.protectedSource.push( /<\?[\s\S]*?\?>/g ); // PHP code
* config.protectedSource.push( /<%[\s\S]*?%>/g ); // ASP code
* config.protectedSource.push( /(tabindex
value.
* @type Number
* @default 0
(zero)
* @example
* config.tabIndex = 1;
*/
tabIndex : 0,
/**
* The theme to be used to build the user interface.
* @type String
* @default 'default'
* @see CKEDITOR.config.skin
* @example
* config.theme = 'default';
*/
theme : 'default',
/**
* The skin to load. It may be the name of the skin folder inside the
* editor installation path, or the name and the path separated by a comma.
* @type String
* @default 'default'
* @example
* config.skin = 'v2';
* @example
* config.skin = 'myskin,/customstuff/myskin/';
*/
skin : 'kama',
/**
* The editor width in CSS-defined units or an integer denoting a value in pixels.
* @type String|Number
* @default ''
(empty)
* @example
* config.width = 850;
* @example
* config.width = '75%';
*/
width : '',
/**
* The base Z-index for floating dialog windows and popups.
* @type Number
* @default 10000
* @example
* config.baseFloatZIndex = 2000
*/
baseFloatZIndex : 10000
};
/**
* Indicates that some of the editor features, like alignment and text
* direction, should use the "computed value" of the feature to indicate its
* on/off state instead of using the "real value".true
* @since 3.4
* @example
* config.useComputedState = false;
*/
// PACKAGER_RENAME( CKEDITOR.config )