ckeditor 3.2.1

data/lib/generators/templates/ckeditor/_source/core/command.js

@@ -0,0 +1,73 @@
+/*
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+CKEDITOR.command = function( editor, commandDefinition )
+{
+	this.uiItems = [];
+
+	this.exec = function( data )
+	{
+		if ( this.state == CKEDITOR.TRISTATE_DISABLED )
+			return false;
+
+		if ( this.editorFocus )     // Give editor focus if necessary (#4355).
+			editor.focus();
+
+		return ( commandDefinition.exec.call( this, editor, data ) !== false );
+	};
+
+	CKEDITOR.tools.extend( this, commandDefinition,
+		// Defaults
+		{
+			modes : { wysiwyg : 1 },
+			editorFocus : true,
+			state : CKEDITOR.TRISTATE_OFF
+		});
+
+	// Call the CKEDITOR.event constructor to initialize this instance.
+	CKEDITOR.event.call( this );
+};
+
+CKEDITOR.command.prototype =
+{
+	enable : function()
+	{
+		if ( this.state == CKEDITOR.TRISTATE_DISABLED )
+			this.setState( ( !this.preserveState || ( typeof this.previousState == 'undefined' ) ) ? CKEDITOR.TRISTATE_OFF : this.previousState );
+	},
+
+	disable : function()
+	{
+		this.setState( CKEDITOR.TRISTATE_DISABLED );
+	},
+
+	setState : function( newState )
+	{
+		// Do nothing if there is no state change.
+		if ( this.state == newState )
+			return false;
+
+		this.previousState = this.state;
+
+		// Set the new state.
+		this.state = newState;
+
+		// Fire the "state" event, so other parts of the code can react to the
+		// change.
+		this.fire( 'state' );
+
+		return true;
+	},
+
+	toggleState : function()
+	{
+		if ( this.state == CKEDITOR.TRISTATE_OFF )
+			this.setState( CKEDITOR.TRISTATE_ON );
+		else if ( this.state == CKEDITOR.TRISTATE_ON )
+			this.setState( CKEDITOR.TRISTATE_OFF );
+	}
+};
+
+CKEDITOR.event.implementOn( CKEDITOR.command.prototype, true );

data/lib/generators/templates/ckeditor/_source/core/commanddefinition.js

@@ -0,0 +1,102 @@
+/*
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+/**
+ * @fileOverview Defines the "virtual" {@link CKEDITOR.commandDefinition} class,
+ *		which contains the defintion of a command. This file is for
+ *		documentation purposes only.
+ */
+
+/**
+ * (Virtual Class) Do not call this constructor. This class is not really part
+ *		of the API. It just illustrates the features of command objects to be
+ *		passed to the {@link CKEDITOR.editor.prototype.addCommand} function.
+ * @name CKEDITOR.commandDefinition
+ * @constructor
+ * @example
+ */
+
+ /**
+ * Executes the command.
+ * @name CKEDITOR.commandDefinition.prototype.exec
+ * @function
+ * @param {CKEDITOR.editor} editor The editor within which run the command.
+ * @param {Object} [data] Additional data to be used to execute the command.
+ * @returns {Boolean} Whether the command has been successfully executed.
+ *		Defaults to "true", if nothing is returned.
+ * @example
+ * editorInstance.addCommand( 'sample',
+ * {
+ *     exec : function( editor )
+ *     {
+ *         alert( 'Executing a command for the editor name "' + editor.name + '"!' );
+ *     }
+ * });
+ */
+
+/**
+ * Whether the command need to be hooked into the redo/undo system.
+ * @name  CKEDITOR.commandDefinition.canUndo
+ * @type {Boolean} If not defined or 'true' both hook into undo system, set it
+ *		to 'false' explicitly  keep it out.
+ * @field
+ * @example
+ * editorInstance.addCommand( 'alertName',
+ * {
+ *     exec : function( editor )
+ *     {
+ *         alert( editor.name );
+ *     },
+ *     canUndo : false    // No support for undo/redo
+ * });
+ */
+
+/**
+ * Whether the command is asynchronous, which means the 'afterCommandExec' event
+ * will be fired by the command itself manually, and the 'exec' function return value
+ * of this command is not to be returned.
+ * @name  CKEDITOR.commandDefinition.async
+ * @type {Boolean} If defined as 'true', the command is asynchronous.
+ * @example
+ * editorInstance.addCommand( 'alertName',
+ * {
+ *     exec : function( editor )
+ *     {
+ *         // Asynchronous operation below.
+ *         CKEDITOR.ajax.loadXml( 'data.xml' );
+ *     },
+ *     async : true    // The command need some time to complete after exec function returns.
+ * });
+ */
+
+/**
+ * Whether the command should give focus to the editor before execution.
+ * @name  CKEDITOR.commandDefinition.editorFocus
+ * @type {Boolean}
+ * @example
+ * editorInstance.addCommand( 'maximize',
+ * {
+ *     exec : function( editor )
+ *     {
+ *     },
+ *     editorFocus : false    // The command doesn't require focusing the editing document.
+ * });
+ */
+
+
+/**
+ * Whether the command state should be set to {@link CKEDITOR.TRISTATE_DISABLED} on startup.
+ * @name  CKEDITOR.commandDefinition.startDisabled
+ * @type {Boolean}
+ * @default false
+ * @example
+ * editorInstance.addCommand( 'unlink',
+ * {
+ *     exec : function( editor )
+ *     {
+ *     },
+ *     startDisabled : true    // Command is unavailable until selection is inside a link.
+ * });
+ */

data/lib/generators/templates/ckeditor/_source/core/config.js

@@ -0,0 +1,319 @@
+/*
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+/**
+ * @fileOverview Defines the {@link CKEDITOR.config} object, which holds the
+ * default configuration settings.
+ */
+
+CKEDITOR.ENTER_P	= 1;
+CKEDITOR.ENTER_BR	= 2;
+CKEDITOR.ENTER_DIV	= 3;
+
+/**
+ * Holds the default configuration settings. Changes to this object are
+ * reflected in all editor instances, if not specificaly specified for those
+ * instances.
+ * @namespace
+ * @example
+ * // All editor created after the following setting will not load custom
+ * // configuration files.
+ * CKEDITOR.config.customConfig = '';
+ */
+CKEDITOR.config =
+{
+	/**
+	 * The URL path for the custom configuration file to be loaded. If not
+	 * overloaded with inline configurations, it defaults to the "config.js"
+	 * file present in the root of the CKEditor installation directory.<br /><br />
+	 *
+	 * CKEditor will recursively load custom configuration files defined inside
+	 * other custom configuration files.
+	 * @type String
+	 * @default '&lt;CKEditor folder&gt;/config.js'
+	 * @example
+	 * // Load a specific configuration file.
+	 * CKEDITOR.replace( 'myfiled', { customConfig : '/myconfig.js' } );
+	 * @example
+	 * // Do not load any custom configuration file.
+	 * CKEDITOR.replace( 'myfiled', { customConfig : '' } );
+	 */
+	customConfig : 'config.js',
+
+	/**
+	 * Whether the replaced element (usually a textarea) is to be updated
+	 * automatically when posting the form containing the editor.
+	 * @type Boolean
+	 * @default true
+	 * @example
+	 * config.autoUpdateElement = true;
+	 */
+	autoUpdateElement : true,
+
+	/**
+	 * The base href URL used to resolve relative and absolute URLs in the
+	 * editor content.
+	 * @type String
+	 * @default '' (empty string)
+	 * @example
+	 * config.baseHref = 'http://www.example.com/path/';
+	 */
+	baseHref : '',
+
+	/**
+	 * The CSS file(s) to be used to apply style to the contents. It should
+	 * reflect the CSS used in the final pages where the contents are to be
+	 * used.
+	 * @type String|Array
+	 * @default '&lt;CKEditor folder&gt;/contents.css'
+	 * @example
+	 * config.contentsCss = '/css/mysitestyles.css';
+	 * config.contentsCss = ['/css/mysitestyles.css', '/css/anotherfile.css'];
+	 */
+	contentsCss : CKEDITOR.basePath + 'contents.css',
+
+	/**
+	 * The writting direction of the language used to write the editor
+	 * contents. Allowed values are 'ltr' for Left-To-Right language (like
+	 * English), or 'rtl' for Right-To-Left languages (like Arabic).
+	 * @default 'ltr'
+	 * @type String
+	 * @example
+	 * config.contentsLangDirection = 'rtl';
+	 */
+	contentsLangDirection : 'ltr',
+
+	/**
+	 * The user interface language localization to use. If empty, the editor
+	 * automatically localize the editor to the user language, if supported,
+	 * otherwise the {@link CKEDITOR.config.defaultLanguage} language is used.
+	 * @default '' (empty)
+	 * @type String
+	 * @example
+	 * // Load the German interface.
+	 * config.language = 'de';
+	 */
+	language : '',
+
+	/**
+	 * The language to be used if {@link CKEDITOR.config.language} is left empty and it's not
+	 * possible to localize the editor to the user language.
+	 * @default 'en'
+	 * @type String
+	 * @example
+	 * config.defaultLanguage = 'it';
+	 */
+	defaultLanguage : 'en',
+
+	/**
+	 * Sets the behavior for the ENTER key. It also dictates other behaviour
+	 * rules in the editor, like whether the &lt;br&gt; element is to be used
+	 * as a paragraph separator when indenting text.
+	 * The allowed values are the following constants, and their relative
+	 * behavior:
+	 * <ul>
+	 *     <li>{@link CKEDITOR.ENTER_P} (1): new &lt;p&gt; paragraphs are created;</li>
+	 *     <li>{@link CKEDITOR.ENTER_BR} (2): lines are broken with &lt;br&gt; elements;</li>
+	 *     <li>{@link CKEDITOR.ENTER_DIV} (3): new &lt;div&gt; blocks are created.</li>
+	 * </ul>
+	 * <strong>Note</strong>: It's recommended to use the
+	 * {@link CKEDITOR.ENTER_P} value because of its semantic value and
+	 * correctness. The editor is optimized for this value.
+	 * @type Number
+	 * @default {@link CKEDITOR.ENTER_P}
+	 * @example
+	 * // Not recommended.
+	 * config.enterMode = CKEDITOR.ENTER_BR;
+	 */
+	enterMode : CKEDITOR.ENTER_P,
+
+	/**
+	 * Force the respect of {@link CKEDITOR.config.enterMode} as line break regardless of the context,
+	 * E.g. If {@link CKEDITOR.config.enterMode} is set to {@link CKEDITOR.ENTER_P},
+	 * press enter key inside a 'div' will create a new paragraph with 'p' instead of 'div'.
+	 * @since 3.2.1
+	 * @default false
+	 * @example
+	 * // Not recommended.
+	 * config.forceEnterMode = true;
+	 */
+	forceEnterMode : false,
+
+	/**
+	 * Just like the {@link CKEDITOR.config.enterMode} setting, it defines the behavior for the SHIFT+ENTER key.
+	 * The allowed values are the following constants, and their relative
+	 * behavior:
+	 * <ul>
+	 *     <li>{@link CKEDITOR.ENTER_P} (1): new &lt;p&gt; paragraphs are created;</li>
+	 *     <li>{@link CKEDITOR.ENTER_BR} (2): lines are broken with &lt;br&gt; elements;</li>
+	 *     <li>{@link CKEDITOR.ENTER_DIV} (3): new &lt;div&gt; blocks are created.</li>
+	 * </ul>
+	 * @type Number
+	 * @default {@link CKEDITOR.ENTER_BR}
+	 * @example
+	 * config.shiftEnterMode = CKEDITOR.ENTER_P;
+	 */
+	shiftEnterMode : CKEDITOR.ENTER_BR,
+
+	/**
+	 * A comma separated list of plugins that are not related to editor
+	 * instances. Reserved to plugins that extend the core code only.<br /><br />
+	 *
+	 * There are no ways to override this setting, except by editing the source
+	 * code of CKEditor (_source/core/config.js).
+	 * @type String
+	 * @example
+	 */
+	corePlugins : '',
+
+	/**
+	 * Sets the doctype to be used when loading the editor content as HTML.
+	 * @type String
+	 * @default '&lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"&gt;'
+	 * @example
+	 * // Set the doctype to the HTML 4 (quirks) mode.
+	 * config.docType = '&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"&gt;';
+	 */
+	docType : '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
+
+	/**
+	 * Sets the "id" attribute to be used on the body element of the editing
+	 * area.
+	 * @since 3.1
+	 * @type String
+	 * @default ''
+	 */
+	bodyId : '',
+
+	/**
+	 * Sets the "class" attribute to be used on the body element of the editing
+	 * area.
+	 * @since 3.1
+	 * @type String
+	 * @default ''
+	 */
+	bodyClass : '',
+
+	/**
+	 * Indicates whether the contents to be edited are being inputted as a full
+	 * HTML page. A full page includes the &lt;html&gt;, &lt;head&gt; and
+	 * &lt;body&gt; tags. The final output will also reflect this setting,
+	 * including the &lt;body&gt; contents only if this setting is disabled.
+	 * @since 3.1
+	 * @type Boolean
+	 * @default false
+	 * @example
+	 * config.fullPage = true;
+	 */
+	fullPage : false,
+
+	/**
+	 * The height of editing area( content ), in relative or absolute, e.g. 30px, 5em.
+	 * Note: Percentage unit is not supported yet. e.g. 30%.
+	 * @type Number|String
+	 * @default '200'
+	 * @example
+	 * config.height = 500;
+	 * config.height = '25em';
+	 * config.height = '300px';
+	 */
+	height : 200,
+
+	/**
+	 * Comma separated list of plugins to load and initialize for an editor
+	 * instance. This should be rarely changed, using instead the
+	 * {@link CKEDITOR.config.extraPlugins} and
+	 * {@link CKEDITOR.config.removePlugins} for customizations.
+	 * @type String
+	 * @example
+	 */
+	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,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',
+
+	/**
+	 * List of additional plugins to be loaded. This is a tool setting which
+	 * makes it easier to add new plugins, whithout having to touch and
+	 * possibly breaking the {@link CKEDITOR.config.plugins} setting.
+	 * @type String
+	 * @example
+	 * config.extraPlugins = 'myplugin,anotherplugin';
+	 */
+	extraPlugins : '',
+
+	/**
+	 * List of plugins that must not be loaded. This is a tool setting which
+	 * makes it easier to avoid loading plugins definied in the
+	 * {@link CKEDITOR.config.plugins} setting, whithout having to touch it and
+	 * potentially breaking it.
+	 * @type String
+	 * @example
+	 * config.removePlugins = 'elementspath,save,font';
+	 */
+	removePlugins : '',
+
+	/**
+	 * List of regular expressions to be executed over the input HTML,
+	 * indicating code that must stay untouched.
+	 * @type Array
+	 * @default [] (empty array)
+	 * @example
+	 * config.protectedSource.push( /<\?[\s\S]*?\?>/g );   // PHP Code
+	 * config.protectedSource.push( /<%[\s\S]*?%>/g );   // ASP Code
+	 * config.protectedSource.push( /(<asp:[^\>]+>[\s|\S]*?<\/asp:[^\>]+>)|(<asp:[^\>]+\/>)/gi );   // ASP.Net Code
+	 */
+	protectedSource : [],
+
+	/**
+	 * The editor tabindex value.
+	 * @type Number
+	 * @default 0 (zero)
+	 * @example
+	 * config.tabIndex = 1;
+	 */
+	tabIndex : 0,
+
+	/**
+	 * The theme to be used to build the UI.
+	 * @type String
+	 * @default 'default'
+	 * @see CKEDITOR.config.skin
+	 * @example
+	 * config.theme = 'default';
+	 */
+	theme : 'default',
+
+	/**
+	 * The skin to load. It may be the name of the skin folder inside the
+	 * editor installation path, or the name and the path separated by a comma.
+	 * @type String
+	 * @default 'default'
+	 * @example
+	 * config.skin = 'v2';
+	 * @example
+	 * config.skin = 'myskin,/customstuff/myskin/';
+	 */
+	skin : 'kama',
+
+	/**
+	 * The editor width in CSS size format or pixel integer.
+	 * @type String|Number
+	 * @default '' (empty)
+	 * @example
+	 * config.width = 850;
+	 * @example
+	 * config.width = '75%';
+	 */
+	width : '',
+
+	/**
+	 * The base Z-index for floating dialogs and popups.
+	 * @type Number
+	 * @default 10000
+	 * @example
+	 * config.baseFloatZIndex = 2000
+	 */
+	baseFloatZIndex : 10000
+};
+
+// PACKAGER_RENAME( CKEDITOR.config )