1 /* 2 * CKEditor - The text editor for Internet - http://ckeditor.com 3 * Copyright (C) 2003-2008 Frederico Caldeira Knabben 4 * 5 * == BEGIN LICENSE == 6 * 7 * Licensed under the terms of any of the following licenses at your 8 * choice: 9 * 10 * - GNU General Public License Version 2 or later (the "GPL") 11 * http://www.gnu.org/licenses/gpl.html 12 * 13 * - GNU Lesser General Public License Version 2.1 or later (the "LGPL") 14 * http://www.gnu.org/licenses/lgpl.html 15 * 16 * - Mozilla Public License Version 1.1 or later (the "MPL") 17 * http://www.mozilla.org/MPL/MPL-1.1.html 18 * 19 * == END LICENSE == 20 */ 21 22 /** 23 * @fileOverview Defines the {@link CKEDITOR.config} object, which holds the 24 * default configuration settings. 25 */ 26 27 /** 28 * Holds the default configuration settings. Changes to this object are 29 * reflected in all editor instances, if not specificaly specified for those 30 * instances. 31 * @namespace 32 * @example 33 * // All editor created after the following setting will not load custom 34 * // configuration files. 35 * CKEDITOR.config.customConfig = ''; 36 */ 37 CKEDITOR.config = 38 { 39 /** 40 * The URL path for the custom configuration file to be loaded. If not 41 * overloaded with inline configurations, it defaults to the "config.js" 42 * file present in the root of the CKEditor installation directory.<br /><br /> 43 * 44 * CKEditor will recursively load custom configuration files defined inside 45 * other custom configuration files. 46 * @type String 47 * @default '<CKEditor folder>/config.js' 48 * @example 49 * // Load a specific configuration file. 50 * CKEDITOR.replace( 'myfiled', { customConfig : '/myconfig.js' } ); 51 * @example 52 * // Do not load any custom configuration file. 53 * CKEDITOR.replace( 'myfiled', { customConfig : '' } ); 54 */ 55 customConfig : CKEDITOR.getUrl( 'config.js' ), 56 57 /** 58 * The base href URL used to resolve relative and absolute URLs in the 59 * editor content. 60 * @type String 61 * @default '' (empty string) 62 * @example 63 * config.baseHref = 'http://www.example.com/path/'; 64 */ 65 baseHref : '', 66 67 /** 68 * The CSS file to be used to apply style to the contents. It should 69 * reflect the CSS used in the final pages where the contents are to be 70 * used. 71 * @type String 72 * @default '<CKEditor folder>/contents.css' 73 * @example 74 * config.contentsCss = '/css/mysitestyles.css'; 75 */ 76 contentsCss : CKEDITOR.basePath + 'contents.css', 77 78 /** 79 * The writting direction of the language used to write the editor 80 * contents. Allowed values are 'ltr' for Left-To-Right language (like 81 * English), or 'rtl' for Right-To-Left languages (like Arabic). 82 * @default 'ltr' 83 * @type String 84 * @example 85 * config.contentsLangDirection = 'rtl'; 86 */ 87 contentsLangDirection : 'ltr', 88 89 /** 90 * A comma separated list of plugins that are not related to editor 91 * instances. Reserved to plugins that extend the core code only.<br /><br /> 92 * 93 * There are no ways to override this setting, except by editing the source 94 * code of CKEditor (_source/core/config.js). 95 * @type String 96 * @example 97 */ 98 corePlugins : '', 99 100 /** 101 * Sets the doctype to be used when loading the editor content as HTML. 102 * @type String 103 * @default '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' 104 * @example 105 * // Set the doctype to the HTML 4 (quirks) mode. 106 * config.docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">'; 107 */ 108 docType : '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">', 109 110 /** 111 * Indicates whether the contents to be edited are being inputted as a full 112 * HTML page. A full page includes the <html>, <head> and 113 * <body> tags. The final output will also reflect this setting, 114 * including the <body> contents only if this setting is disabled. 115 * @type Boolean 116 * @default false 117 * @example 118 * config.fullPage = true; 119 */ 120 fullPage : false, 121 122 /** 123 * The editor height, in CSS size format or pixel integer. 124 * @type String|Number 125 * @default '15em' 126 * @example 127 */ 128 height : '15em', 129 130 /** 131 * Comma separated list of plugins to load and initialize for an editor 132 * instance. 133 * @type String 134 * @default 'editingblock,elementspath,sourcearea,toolbar,wysiwygarea' 135 * @example 136 * config.plugins = 'editingblock,toolbar,wysiwygarea'; 137 */ 138 plugins : 'basicstyles,button,editingblock,elementspath,htmldataprocessor,selection,sourcearea,toolbar,wysiwygarea', 139 140 /** 141 * The theme to be used to build the UI. 142 * @type String 143 * @default 'default' 144 * @see CKEDITOR.config.skin 145 * @example 146 * config.theme = 'default'; 147 */ 148 theme : 'default', 149 150 /** 151 * The skin to load. 152 * @type String 153 * @default 'default' 154 * @example 155 * config.skin = 'v2'; 156 */ 157 skin : 'default', 158 159 /** 160 * The editor width in CSS size format or pixel integer. 161 * @type String|Number 162 * @default '100%' 163 * @example 164 */ 165 width : '100%' 166 }; 167