JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.3
[ckeditor.git] / _source / core / config.js
index caa8d53..f3938d8 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -40,7 +40,7 @@ CKEDITOR.config =
         * // Do not load any custom configuration file.\r
         * CKEDITOR.replace( 'myfiled', { customConfig : '' } );\r
         */\r
-       customConfig : CKEDITOR.getUrl( 'config.js' ),\r
+       customConfig : 'config.js',\r
 \r
        /**\r
         * Whether the replaced element (usually a textarea) is to be updated\r
@@ -63,33 +63,48 @@ CKEDITOR.config =
        baseHref : '',\r
 \r
        /**\r
-        * The CSS file to be used to apply style to the contents. It should\r
+        * The CSS file(s) to be used to apply style to the contents. It should\r
         * reflect the CSS used in the final pages where the contents are to be\r
         * used.\r
-        * @type String\r
+        * @type String|Array\r
         * @default '<CKEditor folder>/contents.css'\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 writting direction of the language used to write the editor\r
-        * contents. Allowed values are 'ltr' for Left-To-Right language (like\r
-        * English), or 'rtl' for Right-To-Left languages (like Arabic).\r
-        * @default 'ltr'\r
+        * contents. Allowed values are:\r
+        * <ul>\r
+        *     <li>'ui' - which indicate content direction will be the same with the user interface language direction;</li>\r
+        *     <li>'ltr' - for Left-To-Right language (like English);</li>\r
+        *     <li>'rtl' - for Right-To-Left languages (like Arabic).</li>\r
+        * </ul>\r
+        * @default 'ui'\r
         * @type String\r
         * @example\r
         * config.contentsLangDirection = 'rtl';\r
         */\r
-       contentsLangDirection : 'ltr',\r
+       contentsLangDirection : 'ui',\r
+\r
+       /**\r
+        * Language code of  the writting language which is used to author the editor\r
+        * contents.\r
+        * @default Same value with editor's 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 empty, the editor\r
         * automatically localize the editor to the user language, if supported,\r
         * otherwise the {@link CKEDITOR.config.defaultLanguage} language is used.\r
-        * @default true\r
-        * @type Boolean\r
+        * @default '' (empty)\r
+        * @type String\r
         * @example\r
         * // Load the German interface.\r
         * config.language = 'de';\r
@@ -129,6 +144,18 @@ CKEDITOR.config =
        enterMode : CKEDITOR.ENTER_P,\r
 \r
        /**\r
+        * Force the respect of {@link CKEDITOR.config.enterMode} as line break regardless of the context,\r
+        * E.g. If {@link CKEDITOR.config.enterMode} is set to {@link CKEDITOR.ENTER_P},\r
+        * press enter key inside a 'div' will create a new paragraph with 'p' instead of 'div'.\r
+        * @since 3.2.1\r
+        * @default false\r
+        * @example\r
+        * // Not recommended.\r
+        * config.forceEnterMode = true;\r
+        */\r
+       forceEnterMode : false,\r
+\r
+       /**\r
         * Just like the {@link CKEDITOR.config.enterMode} setting, it defines the behavior for the SHIFT+ENTER key.\r
         * The allowed values are the following constants, and their relative\r
         * behavior:\r
@@ -166,10 +193,29 @@ CKEDITOR.config =
        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 "id" attribute to be used on the body element of the editing\r
+        * area.\r
+        * @since 3.1\r
+        * @type String\r
+        * @default ''\r
+        */\r
+       bodyId : '',\r
+\r
+       /**\r
+        * Sets the "class" attribute to be used on the body element of the editing\r
+        * area.\r
+        * @since 3.1\r
+        * @type String\r
+        * @default ''\r
+        */\r
+       bodyClass : '',\r
+\r
+       /**\r
         * Indicates whether the contents to be edited are being inputted as a full\r
         * HTML page. A full page includes the &lt;html&gt;, &lt;head&gt; and\r
         * &lt;body&gt; tags. The final output will also reflect this setting,\r
         * including the &lt;body&gt; contents only if this setting is disabled.\r
+        * @since 3.1\r
         * @type Boolean\r
         * @default false\r
         * @example\r
@@ -178,13 +224,14 @@ CKEDITOR.config =
        fullPage : false,\r
 \r
        /**\r
-        * The editor height, in CSS size format or pixel integer.\r
+        * The height of editing area( content ), in relative or absolute, e.g. 30px, 5em.\r
+        * Note: Percentage unit is not supported yet. e.g. 30%.\r
         * @type Number|String\r
         * @default '200'\r
         * @example\r
         * config.height = 500;\r
-        * @example\r
         * config.height = '25em';\r
+        * config.height = '300px';\r
         */\r
        height : 200,\r
 \r
@@ -196,7 +243,7 @@ CKEDITOR.config =
         * @type String\r
         * @example\r
         */\r
-       plugins : 'about,basicstyles,blockquote,button,clipboard,colorbutton,contextmenu,elementspath,enterkey,entities,filebrowser,find,flash,font,format,forms,horizontalrule,htmldataprocessor,image,indent,justify,keystrokes,link,list,maximize,newpage,pagebreak,pastefromword,pastetext,popup,preview,print,removeformat,resize,save,scayt,smiley,showblocks,sourcearea,stylescombo,table,tabletools,specialchar,tab,templates,toolbar,undo,wysiwygarea,wsc',\r
+       plugins : 'about,a11yhelp,basicstyles,blockquote,button,clipboard,colorbutton,colordialog,contextmenu,div,elementspath,enterkey,entities,filebrowser,find,flash,font,format,forms,horizontalrule,htmldataprocessor,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',\r
 \r
        /**\r
         * List of additional plugins to be loaded. This is a tool setting which\r
@@ -281,7 +328,6 @@ CKEDITOR.config =
         * config.baseFloatZIndex = 2000\r
         */\r
        baseFloatZIndex : 10000\r
-\r
 };\r
 \r
 // PACKAGER_RENAME( CKEDITOR.config )\r