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