1 /*
  2 Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
  3 For licensing, see LICENSE.html or http://ckeditor.com/license
  4 */
  5
  6 /**
  7  * @fileOverview Defines the {@link CKEDITOR.config} object, which holds the
  8  * default configuration settings.
  9  */
 10
 11 CKEDITOR.ENTER_P	= 1;
 12 CKEDITOR.ENTER_BR	= 2;
 13 CKEDITOR.ENTER_DIV	= 3;
 14
 15 /**
 16  * Holds the default configuration settings. Changes to this object are
 17  * reflected in all editor instances, if not specificaly specified for those
 18  * instances.
 19  * @namespace
 20  * @example
 21  * // All editor created after the following setting will not load custom
 22  * // configuration files.
 23  * CKEDITOR.config.customConfig = '';
 24  */
 25 CKEDITOR.config =
 26 {
 27 	/**
 28 	 * The URL path for the custom configuration file to be loaded. If not
 29 	 * overloaded with inline configurations, it defaults to the "config.js"
 30 	 * file present in the root of the CKEditor installation directory.<br /><br />
 31 	 *
 32 	 * CKEditor will recursively load custom configuration files defined inside
 33 	 * other custom configuration files.
 34 	 * @type String
 35 	 * @default '<CKEditor folder>/config.js'
 36 	 * @example
 37 	 * // Load a specific configuration file.
 38 	 * CKEDITOR.replace( 'myfiled', { customConfig : '/myconfig.js' } );
 39 	 * @example
 40 	 * // Do not load any custom configuration file.
 41 	 * CKEDITOR.replace( 'myfiled', { customConfig : '' } );
 42 	 */
 43 	customConfig : CKEDITOR.getUrl( 'config.js' ),
 44
 45 	autoUpdateElement : true,
 46
 47 	/**
 48 	 * The base href URL used to resolve relative and absolute URLs in the
 49 	 * editor content.
 50 	 * @type String
 51 	 * @default '' (empty string)
 52 	 * @example
 53 	 * config.baseHref = 'http://www.example.com/path/';
 54 	 */
 55 	baseHref : '',
 56
 57 	/**
 58 	 * The CSS file to be used to apply style to the contents. It should
 59 	 * reflect the CSS used in the final pages where the contents are to be
 60 	 * used.
 61 	 * @type String
 62 	 * @default '<CKEditor folder>/contents.css'
 63 	 * @example
 64 	 * config.contentsCss = '/css/mysitestyles.css';
 65 	 */
 66 	contentsCss : CKEDITOR.basePath + 'contents.css',
 67
 68 	/**
 69 	 * The writting direction of the language used to write the editor
 70 	 * contents. Allowed values are 'ltr' for Left-To-Right language (like
 71 	 * English), or 'rtl' for Right-To-Left languages (like Arabic).
 72 	 * @default 'ltr'
 73 	 * @type String
 74 	 * @example
 75 	 * config.contentsLangDirection = 'rtl';
 76 	 */
 77 	contentsLangDirection : 'ltr',
 78
 79 	/**
 80 	 * The user interface language localization to use. If empty, the editor
 81 	 * automatically localize the editor to the user language, if supported,
 82 	 * otherwise the [@link #defaultLanguage] language is used.
 83 	 * @default true
 84 	 * @type Boolean
 85 	 * @example
 86 	 * // Load the German interface.
 87 	 * config.language = 'de';
 88 	 */
 89 	language : '',
 90
 91 	/**
 92 	 * The language to be used if [@link #language] is left empty and it's not
 93 	 * possible to localize the editor to the user language.
 94 	 * @default 'en'
 95 	 * @type String
 96 	 * @example
 97 	 * config.defaultLanguage = 'it';
 98 	 */
 99 	defaultLanguage : 'en',
100
101 	enterMode : CKEDITOR.ENTER_P,
102 	shiftEnterMode : CKEDITOR.ENTER_BR,
103
104 	/**
105 	 * A comma separated list of plugins that are not related to editor
106 	 * instances. Reserved to plugins that extend the core code only.<br /><br />
107 	 *
108 	 * There are no ways to override this setting, except by editing the source
109 	 * code of CKEditor (_source/core/config.js).
110 	 * @type String
111 	 * @example
112 	 */
113 	corePlugins : '',
114
115 	/**
116 	 * Sets the doctype to be used when loading the editor content as HTML.
117 	 * @type String
118 	 * @default '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
119 	 * @example
120 	 * // Set the doctype to the HTML 4 (quirks) mode.
121 	 * config.docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">';
122 	 */
123 	docType : '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
124
125 	/**
126 	 * Indicates whether the contents to be edited are being inputted as a full
127 	 * HTML page. A full page includes the <html>, <head> and
128 	 * <body> tags. The final output will also reflect this setting,
129 	 * including the <body> contents only if this setting is disabled.
130 	 * @type Boolean
131 	 * @default false
132 	 * @example
133 	 * config.fullPage = true;
134 	 */
135 	fullPage : false,
136
137 	/**
138 	 * The editor height, in CSS size format or pixel integer.
139 	 * @type String|Number
140 	 * @default '200'
141 	 * @example
142 	 */
143 	height : 200,
144
145 	/**
146 	 * Comma separated list of plugins to load and initialize for an editor
147 	 * instance.
148 	 * @type String
149 	 * @example
150 	 * config.plugins = 'basicstyles,button,htmldataprocessor,toolbar,wysiwygarea';
151 	 */
152 	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',
153
154 	/**
155 	 * List of additional plugins to be loaded. This is a tool setting which
156 	 * makes it easier to add new plugins, whithout having to touch and
157 	 * possibly breaking the <i>plugins</i> setting.
158 	 * @type String
159 	 * @example
160 	 * config.extraPlugins = 'myplugin,anotherplugin';
161 	 */
162 	extraPlugins : '',
163
164 	/**
165 	 * List of plugins that must not be loaded. This is a tool setting which
166 	 * makes it easier to avoid loading plugins definied in the <i>plugins</i>
167 	 * setting, whithout having to touch and possibly breaking it.
168 	 * @type String
169 	 * @example
170 	 * config.removePlugins = 'elementspath,save,font';
171 	 */
172 	removePlugins : '',
173
174 	/**
175 	 * List of regular expressions to be executed over the input HTML,
176 	 * indicating code that must stay untouched.
177 	 * @type Array
178 	 * @example
179 	 * config.protectedSource.push( /<\?[\s\S]*?\?>/g );   // PHP Code
180 	 * config.protectedSource.push( /<%[\s\S]*?%>/g );   // ASP Code
181 	 * config.protectedSource.push( /(<asp:[^\>]+>[\s|\S]*?<\/asp:[^\>]+>)|(<asp:[^\>]+\/>)/gi );   // ASP.Net Code
182 	 */
183 	protectedSource : [],
184
185 	/**
186 	 * The editor tabindex value.
187 	 * @type Number
188 	 * @default 0 (zero)
189 	 * @example
190 	 * config.tabIndex = 1;
191 	 */
192 	tabIndex : 0,
193
194 	/**
195 	 * The theme to be used to build the UI.
196 	 * @type String
197 	 * @default 'default'
198 	 * @see CKEDITOR.config.skin
199 	 * @example
200 	 * config.theme = 'default';
201 	 */
202 	theme : 'default',
203
204 	/**
205 	 * The skin to load. It may be the name of the skin folder inside the
206 	 * editor installation path, or the name and the path separated by a comma.
207 	 * @type String
208 	 * @default 'default'
209 	 * @example
210 	 * config.skin = 'v2';
211 	 * @example
212 	 * config.skin = 'myskin,/customstuff/myskin/';
213 	 */
214 	skin : 'kama',
215
216 	/**
217 	 * The editor width in CSS size format or pixel integer.
218 	 * @type String|Number
219 	 * @default '100%'
220 	 * @example
221 	 */
222 	width : '100%',
223
224 	/**
225 	 * The base Z-index for floating dialogs and popups.
226 	 * @type Number
227 	 * @default 10000
228 	 * @example
229 	 * config.baseFloatZIndex = 2000
230 	 */
231 	baseFloatZIndex : 10000
232
233 };
234
235 // PACKAGER_RENAME( CKEDITOR.config )
236