2 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
7 * @fileOverview Defines the {@link CKEDITOR.config} object, which holds the
\r
8 * default configuration settings.
\r
11 CKEDITOR.ENTER_P = 1;
\r
12 CKEDITOR.ENTER_BR = 2;
\r
13 CKEDITOR.ENTER_DIV = 3;
\r
16 * Holds the default configuration settings. Changes to this object are
\r
17 * reflected in all editor instances, if not specificaly specified for those
\r
21 * // All editor created after the following setting will not load custom
\r
22 * // configuration files.
\r
23 * CKEDITOR.config.customConfig = '';
\r
28 * The URL path for the custom configuration file to be loaded. If not
\r
29 * overloaded with inline configurations, it defaults to the "config.js"
\r
30 * file present in the root of the CKEditor installation directory.<br /><br />
\r
32 * CKEditor will recursively load custom configuration files defined inside
\r
33 * other custom configuration files.
\r
35 * @default '<CKEditor folder>/config.js'
\r
37 * // Load a specific configuration file.
\r
38 * CKEDITOR.replace( 'myfiled', { customConfig : '/myconfig.js' } );
\r
40 * // Do not load any custom configuration file.
\r
41 * CKEDITOR.replace( 'myfiled', { customConfig : '' } );
\r
43 customConfig : 'config.js',
\r
46 * Whether the replaced element (usually a textarea) is to be updated
\r
47 * automatically when posting the form containing the editor.
\r
51 * config.autoUpdateElement = true;
\r
53 autoUpdateElement : true,
\r
56 * The base href URL used to resolve relative and absolute URLs in the
\r
59 * @default '' (empty string)
\r
61 * config.baseHref = 'http://www.example.com/path/';
\r
66 * The CSS file(s) to be used to apply style to the contents. It should
\r
67 * reflect the CSS used in the final pages where the contents are to be
\r
69 * @type String|Array
\r
70 * @default '<CKEditor folder>/contents.css'
\r
72 * config.contentsCss = '/css/mysitestyles.css';
\r
73 * config.contentsCss = ['/css/mysitestyles.css', '/css/anotherfile.css'];
\r
75 contentsCss : CKEDITOR.basePath + 'contents.css',
\r
78 * The writting direction of the language used to write the editor
\r
79 * contents. Allowed values are:
\r
81 * <li>'ui' - which indicate content direction will be the same with the user interface language direction;</li>
\r
82 * <li>'ltr' - for Left-To-Right language (like English);</li>
\r
83 * <li>'rtl' - for Right-To-Left languages (like Arabic).</li>
\r
88 * config.contentsLangDirection = 'rtl';
\r
90 contentsLangDirection : 'ui',
\r
93 * Language code of the writting language which is used to author the editor
\r
95 * @default Same value with editor's UI language.
\r
98 * config.contentsLanguage = 'fr';
\r
100 contentsLanguage : '',
\r
103 * The user interface language localization to use. If empty, the editor
\r
104 * automatically localize the editor to the user language, if supported,
\r
105 * otherwise the {@link CKEDITOR.config.defaultLanguage} language is used.
\r
106 * @default '' (empty)
\r
109 * // Load the German interface.
\r
110 * config.language = 'de';
\r
115 * The language to be used if {@link CKEDITOR.config.language} is left empty and it's not
\r
116 * possible to localize the editor to the user language.
\r
120 * config.defaultLanguage = 'it';
\r
122 defaultLanguage : 'en',
\r
125 * Sets the behavior for the ENTER key. It also dictates other behaviour
\r
126 * rules in the editor, like whether the <br> element is to be used
\r
127 * as a paragraph separator when indenting text.
\r
128 * The allowed values are the following constants, and their relative
\r
131 * <li>{@link CKEDITOR.ENTER_P} (1): new <p> paragraphs are created;</li>
\r
132 * <li>{@link CKEDITOR.ENTER_BR} (2): lines are broken with <br> elements;</li>
\r
133 * <li>{@link CKEDITOR.ENTER_DIV} (3): new <div> blocks are created.</li>
\r
135 * <strong>Note</strong>: It's recommended to use the
\r
136 * {@link CKEDITOR.ENTER_P} value because of its semantic value and
\r
137 * correctness. The editor is optimized for this value.
\r
139 * @default {@link CKEDITOR.ENTER_P}
\r
141 * // Not recommended.
\r
142 * config.enterMode = CKEDITOR.ENTER_BR;
\r
144 enterMode : CKEDITOR.ENTER_P,
\r
147 * Force the respect of {@link CKEDITOR.config.enterMode} as line break regardless of the context,
\r
148 * E.g. If {@link CKEDITOR.config.enterMode} is set to {@link CKEDITOR.ENTER_P},
\r
149 * press enter key inside a 'div' will create a new paragraph with 'p' instead of 'div'.
\r
153 * // Not recommended.
\r
154 * config.forceEnterMode = true;
\r
156 forceEnterMode : false,
\r
159 * Just like the {@link CKEDITOR.config.enterMode} setting, it defines the behavior for the SHIFT+ENTER key.
\r
160 * The allowed values are the following constants, and their relative
\r
163 * <li>{@link CKEDITOR.ENTER_P} (1): new <p> paragraphs are created;</li>
\r
164 * <li>{@link CKEDITOR.ENTER_BR} (2): lines are broken with <br> elements;</li>
\r
165 * <li>{@link CKEDITOR.ENTER_DIV} (3): new <div> blocks are created.</li>
\r
168 * @default {@link CKEDITOR.ENTER_BR}
\r
170 * config.shiftEnterMode = CKEDITOR.ENTER_P;
\r
172 shiftEnterMode : CKEDITOR.ENTER_BR,
\r
175 * A comma separated list of plugins that are not related to editor
\r
176 * instances. Reserved to plugins that extend the core code only.<br /><br />
\r
178 * There are no ways to override this setting, except by editing the source
\r
179 * code of CKEditor (_source/core/config.js).
\r
186 * Sets the doctype to be used when loading the editor content as HTML.
\r
188 * @default '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
\r
190 * // Set the doctype to the HTML 4 (quirks) mode.
\r
191 * config.docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">';
\r
193 docType : '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
\r
196 * Sets the "id" attribute to be used on the body element of the editing
\r
205 * Sets the "class" attribute to be used on the body element of the editing
\r
214 * Indicates whether the contents to be edited are being inputted as a full
\r
215 * HTML page. A full page includes the <html>, <head> and
\r
216 * <body> tags. The final output will also reflect this setting,
\r
217 * including the <body> contents only if this setting is disabled.
\r
222 * config.fullPage = true;
\r
227 * The height of editing area( content ), in relative or absolute, e.g. 30px, 5em.
\r
228 * Note: Percentage unit is not supported yet. e.g. 30%.
\r
229 * @type Number|String
\r
232 * config.height = 500;
\r
233 * config.height = '25em';
\r
234 * config.height = '300px';
\r
239 * Comma separated list of plugins to load and initialize for an editor
\r
240 * instance. This should be rarely changed, using instead the
\r
241 * {@link CKEDITOR.config.extraPlugins} and
\r
242 * {@link CKEDITOR.config.removePlugins} for customizations.
\r
246 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
249 * List of additional plugins to be loaded. This is a tool setting which
\r
250 * makes it easier to add new plugins, whithout having to touch and
\r
251 * possibly breaking the {@link CKEDITOR.config.plugins} setting.
\r
254 * config.extraPlugins = 'myplugin,anotherplugin';
\r
259 * List of plugins that must not be loaded. This is a tool setting which
\r
260 * makes it easier to avoid loading plugins definied in the
\r
261 * {@link CKEDITOR.config.plugins} setting, whithout having to touch it and
\r
262 * potentially breaking it.
\r
265 * config.removePlugins = 'elementspath,save,font';
\r
267 removePlugins : '',
\r
270 * List of regular expressions to be executed over the input HTML,
\r
271 * indicating code that must stay untouched.
\r
273 * @default [] (empty array)
\r
275 * config.protectedSource.push( /<\?[\s\S]*?\?>/g ); // PHP Code
\r
276 * config.protectedSource.push( /<%[\s\S]*?%>/g ); // ASP Code
\r
277 * config.protectedSource.push( /(<asp:[^\>]+>[\s|\S]*?<\/asp:[^\>]+>)|(<asp:[^\>]+\/>)/gi ); // ASP.Net Code
\r
279 protectedSource : [],
\r
282 * The editor tabindex value.
\r
284 * @default 0 (zero)
\r
286 * config.tabIndex = 1;
\r
291 * The theme to be used to build the UI.
\r
293 * @default 'default'
\r
294 * @see CKEDITOR.config.skin
\r
296 * config.theme = 'default';
\r
301 * The skin to load. It may be the name of the skin folder inside the
\r
302 * editor installation path, or the name and the path separated by a comma.
\r
304 * @default 'default'
\r
306 * config.skin = 'v2';
\r
308 * config.skin = 'myskin,/customstuff/myskin/';
\r
313 * The editor width in CSS size format or pixel integer.
\r
314 * @type String|Number
\r
315 * @default '' (empty)
\r
317 * config.width = 850;
\r
319 * config.width = '75%';
\r
324 * The base Z-index for floating dialogs and popups.
\r
328 * config.baseFloatZIndex = 2000
\r
330 baseFloatZIndex : 10000
\r
333 // PACKAGER_RENAME( CKEDITOR.config )
\r