| [ Index ] |
PHP Cross Reference of Drupal 6 (gatewave) |
[Summary view] [Print] [Text view]
1 /* 2 Copyright (c) 2003-2010, 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 : 'config.js', 44 45 /** 46 * Whether the replaced element (usually a textarea) is to be updated 47 * automatically when posting the form containing the editor. 48 * @type Boolean 49 * @default true 50 * @example 51 * config.autoUpdateElement = true; 52 */ 53 autoUpdateElement : true, 54 55 /** 56 * The base href URL used to resolve relative and absolute URLs in the 57 * editor content. 58 * @type String 59 * @default '' (empty string) 60 * @example 61 * config.baseHref = 'http://www.example.com/path/'; 62 */ 63 baseHref : '', 64 65 /** 66 * The CSS file(s) to be used to apply style to the contents. It should 67 * reflect the CSS used in the final pages where the contents are to be 68 * used. 69 * @type String|Array 70 * @default '<CKEditor folder>/contents.css' 71 * @example 72 * config.contentsCss = '/css/mysitestyles.css'; 73 * config.contentsCss = ['/css/mysitestyles.css', '/css/anotherfile.css']; 74 */ 75 contentsCss : CKEDITOR.basePath + 'contents.css', 76 77 /** 78 * The writting direction of the language used to write the editor 79 * contents. Allowed values are: 80 * <ul> 81 * <li>'ui' - which indicate content direction will be the same with the user interface language direction;</li> 82 * <li>'ltr' - for Left-To-Right language (like English);</li> 83 * <li>'rtl' - for Right-To-Left languages (like Arabic).</li> 84 * </ul> 85 * @default 'ui' 86 * @type String 87 * @example 88 * config.contentsLangDirection = 'rtl'; 89 */ 90 contentsLangDirection : 'ui', 91 92 /** 93 * Language code of the writting language which is used to author the editor 94 * contents. 95 * @default Same value with editor's UI language. 96 * @type String 97 * @example 98 * config.contentsLanguage = 'fr'; 99 */ 100 contentsLanguage : '', 101 102 /** 103 * The user interface language localization to use. If empty, the editor 104 * automatically localize the editor to the user language, if supported, 105 * otherwise the {@link CKEDITOR.config.defaultLanguage} language is used. 106 * @default '' (empty) 107 * @type String 108 * @example 109 * // Load the German interface. 110 * config.language = 'de'; 111 */ 112 language : '', 113 114 /** 115 * The language to be used if {@link CKEDITOR.config.language} is left empty and it's not 116 * possible to localize the editor to the user language. 117 * @default 'en' 118 * @type String 119 * @example 120 * config.defaultLanguage = 'it'; 121 */ 122 defaultLanguage : 'en', 123 124 /** 125 * Sets the behavior for the ENTER key. It also dictates other behaviour 126 * rules in the editor, like whether the <br> element is to be used 127 * as a paragraph separator when indenting text. 128 * The allowed values are the following constants, and their relative 129 * behavior: 130 * <ul> 131 * <li>{@link CKEDITOR.ENTER_P} (1): new <p> paragraphs are created;</li> 132 * <li>{@link CKEDITOR.ENTER_BR} (2): lines are broken with <br> elements;</li> 133 * <li>{@link CKEDITOR.ENTER_DIV} (3): new <div> blocks are created.</li> 134 * </ul> 135 * <strong>Note</strong>: It's recommended to use the 136 * {@link CKEDITOR.ENTER_P} value because of its semantic value and 137 * correctness. The editor is optimized for this value. 138 * @type Number 139 * @default {@link CKEDITOR.ENTER_P} 140 * @example 141 * // Not recommended. 142 * config.enterMode = CKEDITOR.ENTER_BR; 143 */ 144 enterMode : CKEDITOR.ENTER_P, 145 146 /** 147 * Force the respect of {@link CKEDITOR.config.enterMode} as line break regardless of the context, 148 * E.g. If {@link CKEDITOR.config.enterMode} is set to {@link CKEDITOR.ENTER_P}, 149 * press enter key inside a 'div' will create a new paragraph with 'p' instead of 'div'. 150 * @since 3.2.1 151 * @default false 152 * @example 153 * // Not recommended. 154 * config.forceEnterMode = true; 155 */ 156 forceEnterMode : false, 157 158 /** 159 * Just like the {@link CKEDITOR.config.enterMode} setting, it defines the behavior for the SHIFT+ENTER key. 160 * The allowed values are the following constants, and their relative 161 * behavior: 162 * <ul> 163 * <li>{@link CKEDITOR.ENTER_P} (1): new <p> paragraphs are created;</li> 164 * <li>{@link CKEDITOR.ENTER_BR} (2): lines are broken with <br> elements;</li> 165 * <li>{@link CKEDITOR.ENTER_DIV} (3): new <div> blocks are created.</li> 166 * </ul> 167 * @type Number 168 * @default {@link CKEDITOR.ENTER_BR} 169 * @example 170 * config.shiftEnterMode = CKEDITOR.ENTER_P; 171 */ 172 shiftEnterMode : CKEDITOR.ENTER_BR, 173 174 /** 175 * A comma separated list of plugins that are not related to editor 176 * instances. Reserved to plugins that extend the core code only.<br /><br /> 177 * 178 * There are no ways to override this setting, except by editing the source 179 * code of CKEditor (_source/core/config.js). 180 * @type String 181 * @example 182 */ 183 corePlugins : '', 184 185 /** 186 * Sets the doctype to be used when loading the editor content as HTML. 187 * @type String 188 * @default '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' 189 * @example 190 * // Set the doctype to the HTML 4 (quirks) mode. 191 * config.docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">'; 192 */ 193 docType : '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">', 194 195 /** 196 * Sets the "id" attribute to be used on the body element of the editing 197 * area. 198 * @since 3.1 199 * @type String 200 * @default '' 201 */ 202 bodyId : '', 203 204 /** 205 * Sets the "class" attribute to be used on the body element of the editing 206 * area. 207 * @since 3.1 208 * @type String 209 * @default '' 210 */ 211 bodyClass : '', 212 213 /** 214 * Indicates whether the contents to be edited are being inputted as a full 215 * HTML page. A full page includes the <html>, <head> and 216 * <body> tags. The final output will also reflect this setting, 217 * including the <body> contents only if this setting is disabled. 218 * @since 3.1 219 * @type Boolean 220 * @default false 221 * @example 222 * config.fullPage = true; 223 */ 224 fullPage : false, 225 226 /** 227 * The height of editing area( content ), in relative or absolute, e.g. 30px, 5em. 228 * Note: Percentage unit is not supported yet. e.g. 30%. 229 * @type Number|String 230 * @default '200' 231 * @example 232 * config.height = 500; 233 * config.height = '25em'; 234 * config.height = '300px'; 235 */ 236 height : 200, 237 238 /** 239 * Comma separated list of plugins to load and initialize for an editor 240 * instance. This should be rarely changed, using instead the 241 * {@link CKEDITOR.config.extraPlugins} and 242 * {@link CKEDITOR.config.removePlugins} for customizations. 243 * @type String 244 * @example 245 */ 246 plugins : 'about,a11yhelp,basicstyles,bidi,blockquote,button,clipboard,colorbutton,colordialog,contextmenu,dialogadvtab,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', 247 248 /** 249 * List of additional plugins to be loaded. This is a tool setting which 250 * makes it easier to add new plugins, whithout having to touch and 251 * possibly breaking the {@link CKEDITOR.config.plugins} setting. 252 * @type String 253 * @example 254 * config.extraPlugins = 'myplugin,anotherplugin'; 255 */ 256 extraPlugins : '', 257 258 /** 259 * List of plugins that must not be loaded. This is a tool setting which 260 * makes it easier to avoid loading plugins definied in the 261 * {@link CKEDITOR.config.plugins} setting, whithout having to touch it and 262 * potentially breaking it. 263 * @type String 264 * @example 265 * config.removePlugins = 'elementspath,save,font'; 266 */ 267 removePlugins : '', 268 269 /** 270 * List of regular expressions to be executed over the input HTML, 271 * indicating code that must stay untouched. 272 * @type Array 273 * @default [] (empty array) 274 * @example 275 * config.protectedSource.push( /<\?[\s\S]*?\?>/g ); // PHP Code 276 * config.protectedSource.push( /<%[\s\S]*?%>/g ); // ASP Code 277 * config.protectedSource.push( /(<asp:[^\>]+>[\s|\S]*?<\/asp:[^\>]+>)|(<asp:[^\>]+\/>)/gi ); // ASP.Net Code 278 */ 279 protectedSource : [], 280 281 /** 282 * The editor tabindex value. 283 * @type Number 284 * @default 0 (zero) 285 * @example 286 * config.tabIndex = 1; 287 */ 288 tabIndex : 0, 289 290 /** 291 * The theme to be used to build the UI. 292 * @type String 293 * @default 'default' 294 * @see CKEDITOR.config.skin 295 * @example 296 * config.theme = 'default'; 297 */ 298 theme : 'default', 299 300 /** 301 * The skin to load. It may be the name of the skin folder inside the 302 * editor installation path, or the name and the path separated by a comma. 303 * @type String 304 * @default 'default' 305 * @example 306 * config.skin = 'v2'; 307 * @example 308 * config.skin = 'myskin,/customstuff/myskin/'; 309 */ 310 skin : 'kama', 311 312 /** 313 * The editor width in CSS size format or pixel integer. 314 * @type String|Number 315 * @default '' (empty) 316 * @example 317 * config.width = 850; 318 * @example 319 * config.width = '75%'; 320 */ 321 width : '', 322 323 /** 324 * The base Z-index for floating dialogs and popups. 325 * @type Number 326 * @default 10000 327 * @example 328 * config.baseFloatZIndex = 2000 329 */ 330 baseFloatZIndex : 10000 331 }; 332 333 /** 334 * Indicates that some of the editor features, like alignement and text 335 * direction, should used the "computed value" of the feature to indicate it's 336 * on/off state, instead of using the "real value". 337 * 338 * If enabled, in a left to right written document, the "Left Justify" 339 * alignment button will show as active, even if the aligment style is not 340 * explicitly applied to the current paragraph in the editor. 341 * @name CKEDITOR.config.useComputedState 342 * @type Boolean 343 * @default true 344 * @since 3.4 345 * @example 346 * config.useComputedState = false; 347 */ 348 349 // PACKAGER_RENAME( CKEDITOR.config )
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Thu Mar 24 11:18:33 2011 | Cross-referenced by PHPXref 0.7 |