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.basePath + '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 	 * A comma separated list of plugins that are not related to editor
 69 	 * instances. Reserved to plugins that extend the core code only.<br /><br />
 70 	 *
 71 	 * There are no ways to override this setting, except by editing the source
 72 	 * code of CKEditor (_source/core/config.js).
 73 	 * @example
 74 	 */
 75 	corePlugins : '',
 76
 77 	/**
 78 	 * Comma separated list of plugins to load and initialize for an editor
 79 	 * instance.
 80 	 * @type String
 81 	 * @default 'editingblock,elementspath,sourcearea,toolbar,wysiwygarea'
 82 	 * @example
 83 	 * config.plugins = 'editingblock,toolbar,wysiwygarea';
 84 	 */
 85 	plugins : 'editingblock,elementspath,sourcearea,toolbar,wysiwygarea',
 86
 87 	/**
 88 	 * The theme to be used to build the UI.
 89 	 * @type String
 90 	 * @default 'default'
 91 	 * @example
 92 	 * config.theme = 'default';
 93 	 */
 94 	theme : 'default',
 95
 96 	/**
 97 	 * The "theme space" to which rendering the toolbar. For the default theme,
 98 	 * the recommended options are "top" and "bottom".
 99 	 * @type String
100 	 * @default 'top'
101 	 * @see CKEDITOR.config.theme
102 	 * @example
103 	 * config.toolbarLocation = 'bottom';
104 	 */
105 	toolbarLocation : 'top',
106
107 	/**
108 	 * The mode to load at the editor startup. It depends on the plugins
109 	 * loaded. By default, the "wysiwyg" and "source" modes are available.
110 	 * @type String
111 	 * @default 'wysiwyg'
112 	 * @example
113 	 * config.toolbarLocation = 'source';
114 	 */
115 	startupMode : 'wysiwyg'
116 };
117