Ticket #4134: 4134.patch

File 4134.patch, 41.9 KB (added by Frederico Caldeira Knabben, 11 years ago)
  • _dev/docs_build/docs_build.conf

     
    1616        [
    1717                '../../_source/core/',
    1818                '../../_source/plugins/',
     19                '../../_source/skins/kama/skin.js',
    1920                '../../_source/lang/en.js'
    2021        ],
    2122
  • _source/core/config.js

     
    4242         */
    4343        customConfig : CKEDITOR.getUrl( 'config.js' ),
    4444
     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         */
    4553        autoUpdateElement : true,
    4654
    4755        /**
     
    98106         */
    99107        defaultLanguage : 'en',
    100108
     109        /**
     110         * Sets the behavior for the ENTER key. It also dictates other behaviour
     111         * rules in the editor, like whether the <br> element is to be used
     112         * as a paragraph separator when indenting text.
     113         * The allowed values are the following constants, and their relative
     114         * behavior:
     115         * <ul>
     116         *     <li>{@link CKEDITOR.ENTER_P} (1): new &lt;p&gt; paragraphs are created;</li>
     117         *     <li>{@link CKEDITOR.ENTER_BR} (2): lines are broken with &lt;br&gt; elements;</li>
     118         *     <li>{@link CKEDITOR.ENTER_DIV} (3): new &lt;div&gt; blocks are created.</li>
     119         * </ul>
     120         * <strong>Note</strong>: It's recommended to use the
     121         * {@link CKEDITOR.ENTER_P} value because of its semantic value and
     122         * correctness. The editor is optimized for this value.
     123         * @type Number
     124         * @default {@link CKEDITOR.ENTER_P}
     125         * @example
     126         * // Not recommended.
     127         * config.enterMode = CKEDITOR.ENTER_BR;
     128         */
    101129        enterMode : CKEDITOR.ENTER_P,
     130
     131        /**
     132         * Just like the {@link CKEDITOR.config.enterMode} setting, it defines the behavior for the SHIFT+ENTER key.
     133         * The allowed values are the following constants, and their relative
     134         * behavior:
     135         * <ul>
     136         *     <li>{@link CKEDITOR.ENTER_P} (1): new &lt;p&gt; paragraphs are created;</li>
     137         *     <li>{@link CKEDITOR.ENTER_BR} (2): lines are broken with &lt;br&gt; elements;</li>
     138         *     <li>{@link CKEDITOR.ENTER_DIV} (3): new &lt;div&gt; blocks are created.</li>
     139         * </ul>
     140         * @type Number
     141         * @default {@link CKEDITOR.ENTER_BR}
     142         * @example
     143         * config.shiftEnterMode = CKEDITOR.ENTER_P;
     144         */
    102145        shiftEnterMode : CKEDITOR.ENTER_BR,
    103146
    104147        /**
     
    136179
    137180        /**
    138181         * The editor height, in CSS size format or pixel integer.
    139          * @type String|Number
     182         * @type Number|String
    140183         * @default '200'
    141184         * @example
     185         * config.height = 500;
     186         * @example
     187         * config.height = '25em';
    142188         */
    143189        height : 200,
    144190
    145191        /**
    146192         * Comma separated list of plugins to load and initialize for an editor
    147          * instance.
     193         * instance. This should be rarely changed, using instead the
     194         * {@link CKEDITOR.config.extraPlugins} and
     195         * {@link CKEDITOR.config.removePlugins} for customizations.
    148196         * @type String
    149197         * @example
    150          * config.plugins = 'basicstyles,button,htmldataprocessor,toolbar,wysiwygarea';
    151198         */
    152199        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',
    153200
    154201        /**
    155202         * List of additional plugins to be loaded. This is a tool setting which
    156203         * makes it easier to add new plugins, whithout having to touch and
    157          * possibly breaking the <i>plugins</i> setting.
     204         * possibly breaking the {@link CKEDITOR.config.plugins} setting.
    158205         * @type String
    159206         * @example
    160207         * config.extraPlugins = 'myplugin,anotherplugin';
     
    163210
    164211        /**
    165212         * 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.
     213         * makes it easier to avoid loading plugins definied in the
     214         * {@link CKEDITOR.config.plugins} setting, whithout having to touch it and
     215         * potentially breaking it.
    168216         * @type String
    169217         * @example
    170218         * config.removePlugins = 'elementspath,save,font';
     
    175223         * List of regular expressions to be executed over the input HTML,
    176224         * indicating code that must stay untouched.
    177225         * @type Array
     226         * @default [] (empty array)
    178227         * @example
    179228         * config.protectedSource.push( /<\?[\s\S]*?\?>/g );   // PHP Code
    180229         * config.protectedSource.push( /<%[\s\S]*?%>/g );   // ASP Code
     
    216265        /**
    217266         * The editor width in CSS size format or pixel integer.
    218267         * @type String|Number
    219          * @default ''
     268         * @default '' (empty)
    220269         * @example
     270         * config.width = 850;
     271         * @example
     272         * config.width = '75%';
    221273         */
    222274        width : '',
    223275
  • _source/plugins/colorbutton/plugin.js

     
    141141        }
    142142});
    143143
     144/**
     145 * Whether to enable the "More Colors..." button in the color selectors.
     146 * @default false
     147 * @type Boolean
     148 * @example
     149 * config.colorButton_enableMore = false;
     150 */
    144151CKEDITOR.config.colorButton_enableMore = false;
     152
     153/**
     154 * Defines the colors to be displayed in the color selectors. It's a string
     155 * containing the hexadecimal notation for HTML colors, without the "#" prefix.
     156 * @type String
     157 * @default '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,A9A9A9,FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF'
     158 * @example
     159 * // Brazil colors only.
     160 * config.colorButton_colors = '00923E,F8C100,28166F';
     161 */
    145162CKEDITOR.config.colorButton_colors =
    146163        '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,' +
    147164        'B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,' +
     
    149166        'FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,' +
    150167        'FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF';
    151168
     169/**
     170 * Holds the style definition to be used to apply the text foreground color.
     171 * @type Object
     172 * @example
     173 * // This is basically the default setting value.
     174 * config.colorButton_foreStyle =
     175 *     {
     176 *         element : 'span',
     177 *         styles : { 'color' : '#(color)' }
     178 *     };
     179 */
    152180CKEDITOR.config.colorButton_foreStyle =
    153181        {
    154182                element         : 'span',
     
    156184                overrides       : [ { element : 'font', attributes : { 'color' : null } } ]
    157185        };
    158186
     187/**
     188 * Holds the style definition to be used to apply the text background color.
     189 * @type Object
     190 * @example
     191 * // This is basically the default setting value.
     192 * config.colorButton_backStyle =
     193 *     {
     194 *         element : 'span',
     195 *         styles : { 'background-color' : '#(color)' }
     196 *     };
     197 */
    159198CKEDITOR.config.colorButton_backStyle =
    160199        {
    161200                element         : 'span',
  • _source/plugins/editingblock/plugin.js

     
    213213 * @type String
    214214 * @default 'wysiwyg'
    215215 * @example
    216  * config.toolbarLocation = 'source';
     216 * config.startupMode = 'source';
    217217 */
    218218CKEDITOR.config.startupMode = 'wysiwyg';
    219219
     
    221221 * Sets whether the editor should have the focus when the page loads.
    222222 * @type Boolean
    223223 * @default false
     224 * @example
     225 * config.startupFocus = true;
    224226 */
    225227CKEDITOR.config.startupFocus = false;
    226228
     229/**
     230 * Whether to render or not the editing block area in the editor interface.
     231 * @type Boolean
     232 * @default true
     233 * @example
     234 * config.editingBlock = false;
     235 */
    227236CKEDITOR.config.editingBlock = true;
  • _source/plugins/entities/plugin.js

     
    145145        });
    146146})();
    147147
     148/**
     149 * Whether to use HTML entities in the output.
     150 * @type Boolean
     151 * @default true
     152 * @example
     153 * config.entities = false;
     154 */
    148155CKEDITOR.config.entities = true;
     156
     157/**
     158 * Whether to convert some Latin characters (Latin alphabet No. 1, ISO 8859-1)
     159 * to HTML entities. The list of entities can be found at the
     160 * <a href="http://www.w3.org/TR/html4/sgml/entities.html#h-24.2.1">W3C HTML 4.01 Specification, section 24.2.1</a>.
     161 * @type Boolean
     162 * @default true
     163 * @example
     164 * config.entities_latin = false;
     165 */
    149166CKEDITOR.config.entities_latin = true;
     167
     168/**
     169 * Whether to convert some symbols, mathematical symbols, and Greek letters to
     170 * HTML entities. This may be more relevant for users typing text written in Greek.
     171 * The list of entities can be found at the
     172 * <a href="http://www.w3.org/TR/html4/sgml/entities.html#h-24.3.1">W3C HTML 4.01 Specification, section 24.3.1</a>.
     173 * @type Boolean
     174 * @default true
     175 * @example
     176 * config.entities_greek = false;
     177 */
    150178CKEDITOR.config.entities_greek = true;
     179
     180/**
     181 * Whether to convert all remaining characters, not comprised in the ASCII
     182 * character table, to their relative numeric representation of HTML entity.
     183 * For example, the phrase "This is Chinese: &#27721;&#35821;." is outputted
     184 * as "This is Chinese: &amp;#27721;&amp;#35821;."
     185 * @type Boolean
     186 * @default false
     187 * @example
     188 * config.entities_processNumerical = true;
     189 */
    151190CKEDITOR.config.entities_processNumerical = false;
     191
     192/**
     193 * An additional list of entities to be used. It's a string containing each
     194 * entry separated by a comma. Entities names or number must be used, exclusing
     195 * the "&amp;" preffix and the ";" termination.
     196 * @default '#39'  // The single quote (') character.
     197 * @type String
     198 * @example
     199 */
    152200CKEDITOR.config.entities_additional = '#39';
  • _source/plugins/find/plugin.js

     
    3131        requires : [ 'styles' ]
    3232} );
    3333
    34 // Styles for highlighting search results.
     34/**
     35 * Defines the style to be used to highlight results with the find dialog.
     36 * @type Object
     37 * @default { element : 'span', styles : { 'background-color' : '#004', 'color' : '#fff' } }
     38 * @example
     39 * // Highlight search results with blue on yellow.
     40 * config.find_highlight =
     41 *     {
     42 *         element : 'span',
     43 *         styles : { 'background-color' : '#ff0', 'color' : '#00f' }
     44 *     };
     45 */
    3546CKEDITOR.config.find_highlight = { element : 'span', styles : { 'background-color' : '#004', 'color' : '#fff' } };
  • _source/plugins/font/plugin.js

     
    117117        });
    118118})();
    119119
    120 // Font settings.
    121 
     120/**
     121 * The list of fonts names to be displayed in the Font combo in the toolbar.
     122 * Entries are separated by semi-colons (;), while it's possible to have more
     123 * than one font for each entry, in the HTML way (separated by comma).
     124 *
     125 * A display name may be optionally defined by prefixing the entries with the
     126 * name and the slash character. For example, "Arial/Arial, Helvetica, sans-serif"
     127 * will be displayed as "Arial" in the list, but will be outputted as
     128 * "Arial, Helvetica, sans-serif".
     129 * @type String
     130 * @example
     131 * config.font_names =
     132 *     'Arial/Arial, Helvetica, sans-serif;' +
     133 *     'Times New Roman/Times New Roman, Times, serif;' +
     134 *     'Verdana';
     135 * @example
     136 * config.font_names = 'Arial;Times New Roman;Verdana';
     137 */
    122138CKEDITOR.config.font_names =
    123139        'Arial/Arial, Helvetica, sans-serif;' +
    124140        'Comic Sans MS/Comic Sans MS, cursive;' +
     
    130146        'Trebuchet MS/Trebuchet MS, Helvetica, sans-serif;' +
    131147        'Verdana/Verdana, Geneva, sans-serif';
    132148
     149/**
     150 * The text to be displayed in the Font combo is none of the available values
     151 * matches the current cursor position or text selection.
     152 * @type String
     153 * @example
     154 * // If the default site font is Arial, we may making it more explicit to the end user.
     155 * config.font_defaultLabel = 'Arial';
     156 */
    133157CKEDITOR.config.font_defaultLabel = '';
     158
     159/**
     160 * The style definition to be used to apply the font in the text.
     161 * @type Object
     162 * @example
     163 * // This is actually the default value for it.
     164 * config.font_style =
     165 *     {
     166 *         element              : 'span',
     167 *         styles               : { 'font-family' : '#(family)' },
     168 *         overrides    : [ { element : 'font', attributes : { 'face' : null } } ]
     169 *     };
     170 */
    134171CKEDITOR.config.font_style =
    135172        {
    136173                element         : 'span',
     
    138175                overrides       : [ { element : 'font', attributes : { 'face' : null } } ]
    139176        };
    140177
    141 // Font Size setting.
    142 
     178/**
     179 * The list of fonts size to be displayed in the Font Size combo in the
     180 * toolbar. Entries are separated by semi-colons (;).
     181 *
     182 * Any kind of "CSS like" size can be used, like "12px", "2.3em", "130%",
     183 * "larger" or "x-small".
     184 *
     185 * A display name may be optionally defined by prefixing the entries with the
     186 * name and the slash character. For example, "Bigger Font/14px" will be
     187 * displayed as "Bigger Font" in the list, but will be outputted as "14px".
     188 * @type String
     189 * @default '8/8px;9/9px;10/10px;11/11px;12/12px;14/14px;16/16px;18/18px;20/20px;22/22px;24/24px;26/26px;28/28px;36/36px;48/48px;72/72px'
     190 * @example
     191 * config.fontSize_sizes = '16/16px;24/24px;48/48px;';
     192 * @example
     193 * config.fontSize_sizes = '12px;2.3em;130%;larger;x-small';
     194 * @example
     195 * config.fontSize_sizes = '12 Pixels/12px;Big/2.3em;30 Percent More/130%;Bigger/larger;Very Small/x-small';
     196 */
    143197CKEDITOR.config.fontSize_sizes =
    144198        '8/8px;9/9px;10/10px;11/11px;12/12px;14/14px;16/16px;18/18px;20/20px;22/22px;24/24px;26/26px;28/28px;36/36px;48/48px;72/72px';
    145199
     200/**
     201 * The text to be displayed in the Font Size combo is none of the available
     202 * values matches the current cursor position or text selection.
     203 * @type String
     204 * @example
     205 * // If the default site font size is 12px, we may making it more explicit to the end user.
     206 * config.fontSize_defaultLabel = '12px';
     207 */
    146208CKEDITOR.config.fontSize_defaultLabel = '';
     209
     210/**
     211 * The style definition to be used to apply the font size in the text.
     212 * @type Object
     213 * @example
     214 * // This is actually the default value for it.
     215 * config.fontSize_style =
     216 *     {
     217 *         element              : 'span',
     218 *         styles               : { 'font-size' : '#(size)' },
     219 *         overrides    : [ { element : 'font', attributes : { 'size' : null } } ]
     220 *     };
     221 */
    147222CKEDITOR.config.fontSize_style =
    148223        {
    149224                element         : 'span',
    150225                styles          : { 'font-size' : '#(size)' },
    151                 overrides       : [ { element : 'font', attributes : { 'face' : null } } ]
     226                overrides       : [ { element : 'font', attributes : { 'size' : null } } ]
    152227        };
  • _source/plugins/format/plugin.js

     
    8787        }
    8888});
    8989
     90/**
     91 * A list of semi colon separated style names (by default tags) representing
     92 * the style definition for each entry to be displayed in the Format combo in
     93 * the toolbar. Each entry must have its relative definition configuration in a
     94 * setting named "format_(tagName)". For example, the "p" entry has its
     95 * definition taken from config.format_p.
     96 * @type String
     97 * @default 'p;h1;h2;h3;h4;h5;h6;pre;address;div'
     98 * @example
     99 * config.format_tags = 'p;h2;h3;pre'
     100 */
    90101CKEDITOR.config.format_tags = 'p;h1;h2;h3;h4;h5;h6;pre;address;div';
    91102
    92 CKEDITOR.config.format_p                = { element : 'p' };
    93 CKEDITOR.config.format_div              = { element : 'div' };
    94 CKEDITOR.config.format_pre              = { element : 'pre' };
    95 CKEDITOR.config.format_address  = { element : 'address' };
    96 CKEDITOR.config.format_h1               = { element : 'h1' };
    97 CKEDITOR.config.format_h2               = { element : 'h2' };
    98 CKEDITOR.config.format_h3               = { element : 'h3' };
    99 CKEDITOR.config.format_h4               = { element : 'h4' };
    100 CKEDITOR.config.format_h5               = { element : 'h5' };
    101 CKEDITOR.config.format_h6               = { element : 'h6' };
     103/**
     104 * The style definition to be used to apply the "Normal" format.
     105 * @type Object
     106 * @default { element : 'p' }
     107 * @example
     108 * config.format_p = { element : 'p', attributes : { class : 'normalPara' } };
     109 */
     110CKEDITOR.config.format_p = { element : 'p' };
     111
     112/**
     113 * The style definition to be used to apply the "Normal (DIV)" format.
     114 * @type Object
     115 * @default { element : 'div' }
     116 * @example
     117 * config.format_div = { element : 'div', attributes : { class : 'normalDiv' } };
     118 */
     119CKEDITOR.config.format_div = { element : 'div' };
     120
     121/**
     122 * The style definition to be used to apply the "Formatted" format.
     123 * @type Object
     124 * @default { element : 'pre' }
     125 * @example
     126 * config.format_pre = { element : 'pre', attributes : { class : 'code' } };
     127 */
     128CKEDITOR.config.format_pre = { element : 'pre' };
     129
     130/**
     131 * The style definition to be used to apply the "Address" format.
     132 * @type Object
     133 * @default { element : 'address' }
     134 * @example
     135 * config.format_address = { element : 'address', attributes : { class : 'styledAddress' } };
     136 */
     137CKEDITOR.config.format_address = { element : 'address' };
     138
     139/**
     140 * The style definition to be used to apply the "Heading 1" format.
     141 * @type Object
     142 * @default { element : 'h1' }
     143 * @example
     144 * config.format_h1 = { element : 'h1', attributes : { class : 'contentTitle1' } };
     145 */
     146CKEDITOR.config.format_h1 = { element : 'h1' };
     147
     148/**
     149 * The style definition to be used to apply the "Heading 1" format.
     150 * @type Object
     151 * @default { element : 'h2' }
     152 * @example
     153 * config.format_h2 = { element : 'h2', attributes : { class : 'contentTitle2' } };
     154 */
     155CKEDITOR.config.format_h2 = { element : 'h2' };
     156
     157/**
     158 * The style definition to be used to apply the "Heading 1" format.
     159 * @type Object
     160 * @default { element : 'h3' }
     161 * @example
     162 * config.format_h3 = { element : 'h3', attributes : { class : 'contentTitle3' } };
     163 */
     164CKEDITOR.config.format_h3 = { element : 'h3' };
     165
     166/**
     167 * The style definition to be used to apply the "Heading 1" format.
     168 * @type Object
     169 * @default { element : 'h4' }
     170 * @example
     171 * config.format_h4 = { element : 'h4', attributes : { class : 'contentTitle4' } };
     172 */
     173CKEDITOR.config.format_h4 = { element : 'h4' };
     174
     175/**
     176 * The style definition to be used to apply the "Heading 1" format.
     177 * @type Object
     178 * @default { element : 'h5' }
     179 * @example
     180 * config.format_h5 = { element : 'h5', attributes : { class : 'contentTitle5' } };
     181 */
     182CKEDITOR.config.format_h5 = { element : 'h5' };
     183
     184/**
     185 * The style definition to be used to apply the "Heading 1" format.
     186 * @type Object
     187 * @default { element : 'h6' }
     188 * @example
     189 * config.format_h6 = { element : 'h6', attributes : { class : 'contentTitle6' } };
     190 */
     191CKEDITOR.config.format_h6 = { element : 'h6' };
  • _source/plugins/htmldataprocessor/plugin.js

     
    359359        };
    360360})();
    361361
     362/**
     363 * Whether to force using "&" instead of "&amp;amp;" in elements attributes
     364 * values. It's not recommended to change this setting for compliance with the
     365 * W3C XHTML 1.0 standards
     366 * (<a href="http://www.w3.org/TR/xhtml1/#C_12">C.12, XHTML 1.0</a>).
     367 * @type Boolean
     368 * @default false
     369 * @example
     370 * config.forceSimpleAmpersand = false;
     371 */
    362372CKEDITOR.config.forceSimpleAmpersand = false;
  • _source/plugins/image/plugin.js

     
    5454        }
    5555} );
    5656
     57/**
     58 * Whether to remove links when emptying the link URL field in the image dialog.
     59 * @type Boolean
     60 * @default true
     61 * @example
     62 * config.image_removeLinkByEmptyURL = false;
     63 */
    5764CKEDITOR.config.image_removeLinkByEmptyURL = true;
  • _source/plugins/keystrokes/plugin.js

     
    147147})();
    148148
    149149/**
    150  * A list of keystrokes to be blocked if not defined in the {@link #keystrokes}
     150 * A list of keystrokes to be blocked if not defined in the {@link CKEDITOR.config.keystrokes}
    151151 * setting. In this way it is possible to block the default browser behavior
    152152 * for those keystrokes.
    153153 * @type Array
     154 * @default (see example)
    154155 * @example
     156 * // This is actually the default value.
     157 * config.blockedKeystrokes =
     158 * [
     159 *     CKEDITOR.CTRL + 66 &#47;*B*&#47;,
     160 *     CKEDITOR.CTRL + 73 &#47;*I*&#47;,
     161 *     CKEDITOR.CTRL + 85 &#47;*U*&#47;
     162 * ];
    155163 */
    156164CKEDITOR.config.blockedKeystrokes =
    157165[
     
    163171/**
    164172 * A list associating keystrokes to editor commands. Each element in the list
    165173 * is an array where the first item is the keystroke, and the second is the
    166  * command to be executed.
     174 * name of the command to be executed.
    167175 * @type Array
     176 * @default (see example)
    168177 * @example
     178 * // This is actually the default value.
     179 * config.keystrokes =
     180 * [
     181 *     [ CKEDITOR.ALT + 121 &#47;*F10*&#47;, 'toolbarFocus' ],
     182 *     [ CKEDITOR.ALT + 122 &#47;*F11*&#47;, 'elementsPathFocus' ],
     183 *
     184 *     [ CKEDITOR.SHIFT + 121 &#47;*F10*&#47;, 'contextMenu' ],
     185 *
     186 *     [ CKEDITOR.CTRL + 90 &#47;*Z*&#47;, 'undo' ],
     187 *     [ CKEDITOR.CTRL + 89 &#47;*Y*&#47;, 'redo' ],
     188 *     [ CKEDITOR.CTRL + CKEDITOR.SHIFT + 90 &#47;*Z*&#47;, 'redo' ],
     189 *
     190 *     [ CKEDITOR.CTRL + 76 &#47;*L*&#47;, 'link' ],
     191 *
     192 *     [ CKEDITOR.CTRL + 66 &#47;*B*&#47;, 'bold' ],
     193 *     [ CKEDITOR.CTRL + 73 &#47;*I*&#47;, 'italic' ],
     194 *     [ CKEDITOR.CTRL + 85 &#47;*U*&#47;, 'underline' ],
     195 *
     196 *     [ CKEDITOR.ALT + 109 &#47;*-*&#47;, 'toolbarCollapse' ]
     197 * ];
    169198 */
    170199CKEDITOR.config.keystrokes =
    171200[
  • _source/plugins/menu/plugin.js

     
    348348        }
    349349});
    350350
     351/**
     352 * The amount of time, in milliseconds, the editor waits before showing submenu
     353 * options when moving the mouse over options that contains submenus, like the
     354 * "Cell Properties" entry for tables.
     355 * @type Number
     356 * @default 400
     357 * @example
     358 * // Remove the submenu delay.
     359 * config.menu_subMenuDelay = 0;
     360 */
    351361CKEDITOR.config.menu_subMenuDelay = 400;
     362
     363/**
     364 * A comma separated list of items group names to be displayed in the context
     365 * menu. The items order will reflect the order in this list if no priority
     366 * has been definted in the groups.
     367 * @type String
     368 * @default 'clipboard,form,tablecell,tablecellproperties,tablerow,tablecolumn,table,anchor,link,image,flash,checkbox,radio,textfield,hiddenfield,imagebutton,button,select,textarea'
     369 * @example
     370 * config.menu_groups = 'clipboard,table,anchor,link,image';
     371 */
    352372CKEDITOR.config.menu_groups =
    353373        'clipboard,' +
    354374        'form,' +
  • _source/plugins/newpage/plugin.js

     
    5555                        });
    5656        }
    5757});
    58 
     58/**
     59 * The HTML to load in the editor when the "new page" command is executed.
     60 * @type String
     61 * @default ''
     62 * @example
     63 * config.newpage_html = '&lt;p&gt;Type your text here.&lt;/p&gt;';
     64 */
    5965CKEDITOR.config.newpage_html = '';
  • _source/plugins/pastefromword/plugin.js

     
    2222        }
    2323} );
    2424
     25/**
     26 * Whether the "Ignore font face definitions" checkbox is enabled by default in
     27 * the Paste from Word dialog.
     28 * @type Boolean
     29 * @default true
     30 * @example
     31 * config.pasteFromWordIgnoreFontFace = false;
     32 */
    2533CKEDITOR.config.pasteFromWordIgnoreFontFace = true;
     34
     35/**
     36 * Whether the "Remove styles definitions" checkbox is enabled by default in
     37 * the Paste from Word dialog.
     38 * @type Boolean
     39 * @default false
     40 * @example
     41 * config.pasteFromWordRemoveStyle = true;
     42 */
    2643CKEDITOR.config.pasteFromWordRemoveStyle = false;
     44
     45/**
     46 * Whether to keep structure markup (&lt;h1&gt;, &lt;h2&gt;, etc.) or replace
     47 * it with elements that create more similar pasting results when pasting
     48 * content from Microsoft Word into the Paste from Word dialog.
     49 * @type Boolean
     50 * @default false
     51 * @example
     52 * config.pasteFromWordKeepsStructure = true;
     53 */
    2754CKEDITOR.config.pasteFromWordKeepsStructure = false;
  • _source/plugins/pastetext/plugin.js

     
    127127        this.insertHtml( text );
    128128};
    129129
     130/**
     131 * Whether to force all pasting operations to insert on plain text into the
     132 * editor, loosing any formatting information possibly available in the source
     133 * text.
     134 * @type Boolean
     135 * @default false
     136 * @example
     137 * config.forcePasteAsPlainText = true;
     138 */
    130139CKEDITOR.config.forcePasteAsPlainText = false;
  • _source/plugins/removeformat/plugin.js

     
    113113        }
    114114};
    115115
    116 // Only inline elements are valid.
     116/**
     117 * A comma separated list of elements to be removed when executing the "remove
     118 " format" command. Note that only inline elements are allowed.
     119 * @type String
     120 * @default 'b,big,code,del,dfn,em,font,i,ins,kbd,q,samp,small,span,strike,strong,sub,sup,tt,u,var'
     121 * @example
     122 */
    117123CKEDITOR.config.removeFormatTags = 'b,big,code,del,dfn,em,font,i,ins,kbd,q,samp,small,span,strike,strong,sub,sup,tt,u,var';
    118124
     125/**
     126 * A comma separated list of elements attributes to be removed when executing
     127 * the "remove format" command.
     128 * @type String
     129 * @default 'class,style,lang,width,height,align,hspace,valign'
     130 * @example
     131 */
    119132CKEDITOR.config.removeFormatAttributes = 'class,style,lang,width,height,align,hspace,valign';
  • _source/plugins/resize/plugin.js

     
    6969        }
    7070} );
    7171
     72/**
     73 * The minimum editor width, in pixels, when resizing it with the resize handle.
     74 * @type Number
     75 * @default 750
     76 * @example
     77 * config.resize_minWidth = 500;
     78 */
    7279CKEDITOR.config.resize_minWidth = 750;
     80
     81/**
     82 * The minimum editor height, in pixels, when resizing it with the resize handle.
     83 * @type Number
     84 * @default 250
     85 * @example
     86 * config.resize_minHeight = 600;
     87 */
    7388CKEDITOR.config.resize_minHeight = 250;
     89
     90/**
     91 * The maximum editor width, in pixels, when resizing it with the resize handle.
     92 * @type Number
     93 * @default 3000
     94 * @example
     95 * config.resize_maxWidth = 750;
     96 */
    7497CKEDITOR.config.resize_maxWidth = 3000;
     98
     99/**
     100 * The maximum editor height, in pixels, when resizing it with the resize handle.
     101 * @type Number
     102 * @default 3000
     103 * @example
     104 * config.resize_maxHeight = 600;
     105 */
    75106CKEDITOR.config.resize_maxHeight = 3000;
     107
     108/**
     109 * Whether to enable the resizing feature. If disabed the resize handler will not be visible.
     110 * @type Boolean
     111 * @default true
     112 * @example
     113 * config.resize_enabled = false;
     114 */
    76115CKEDITOR.config.resize_enabled = true;
  • _source/plugins/showblocks/plugin.js

     
    142142        });
    143143} )();
    144144
     145/**
     146 * Whether to automaticaly enable the "show block" command when the editor
     147 * loads.
     148 * @type Boolean
     149 * @default false
     150 * @example
     151 * config.startupOutlineBlocks = true;
     152 */
    145153CKEDITOR.config.startupOutlineBlocks = false;
  • _source/plugins/smiley/dialogs/smiley.js

     
    77{
    88        var config = editor.config,
    99                images = config.smiley_images,
    10                 columns = config.smiley_columns,
     10                columns = 8,
    1111                i;
    1212
    1313        /**
  • _source/plugins/smiley/plugin.js

     
    1919        }
    2020} );
    2121
     22/**
     23 * The base path used to build the URL for the smiley images. It must end with
     24 * a slash.
     25 * @type String
     26 * @default {@link CKEDITOR.basePath} + 'plugins/smiley/images/'
     27 * @example
     28 * config.smiley_path = 'http://www.example.com/images/smileys/';
     29 * @example
     30 * config.smiley_path = '/images/smileys/';
     31 */
    2232CKEDITOR.config.smiley_path = CKEDITOR.basePath +
    2333        '_source/' +            // %REMOVE_LINE%
    2434        'plugins/smiley/images/';
    2535
    26 CKEDITOR.config.smiley_images = [ 'regular_smile.gif','sad_smile.gif','wink_smile.gif','teeth_smile.gif','confused_smile.gif','tounge_smile.gif',
     36/**
     37 * The file names for the smileys to be displayed. These files must be
     38 * contained inside the URL path defined with the
     39 * {@link CKEDITOR.config.smiley_path} setting.
     40 * @type Array
     41 * @default (see example)
     42 * @example
     43 * // This is actually the default value.
     44 * config.smiley_images = [
     45 *     'regular_smile.gif','sad_smile.gif','wink_smile.gif','teeth_smile.gif','confused_smile.gif','tounge_smile.gif',
     46 *     'embaressed_smile.gif','omg_smile.gif','whatchutalkingabout_smile.gif','angry_smile.gif','angel_smile.gif','shades_smile.gif',
     47 *     'devil_smile.gif','cry_smile.gif','lightbulb.gif','thumbs_down.gif','thumbs_up.gif','heart.gif',
     48 *     'broken_heart.gif','kiss.gif','envelope.gif'];
     49 */
     50CKEDITOR.config.smiley_images = [
     51        'regular_smile.gif','sad_smile.gif','wink_smile.gif','teeth_smile.gif','confused_smile.gif','tounge_smile.gif',
    2752        'embaressed_smile.gif','omg_smile.gif','whatchutalkingabout_smile.gif','angry_smile.gif','angel_smile.gif','shades_smile.gif',
    2853        'devil_smile.gif','cry_smile.gif','lightbulb.gif','thumbs_down.gif','thumbs_up.gif','heart.gif',
    2954        'broken_heart.gif','kiss.gif','envelope.gif'];
    3055
    31 CKEDITOR.config.smiley_descriptions = [ ':)', ':(', ';)', ':D', ':/', ':P', '', '', '', '', '', '', '', ';(', '', '', '', '', ':kiss', '' ];
    32 
    33 CKEDITOR.config.smiley_columns = 8;
     56/**
     57 * The description to be used for each of the smileys defined in the
     58 * {@link CKEDITOR.config.smiley_images} setting. Each entry in this array list
     59 * must match its relative pair in the {@link CKEDITOR.config.smiley_images}
     60 * setting.
     61 * @type Array
     62 * @default (see example)
     63 * @example
     64 * // This is actually the default value.
     65 * config.smiley_descriptions = [
     66 *     ':)', ':(', ';)', ':D', ':/', ':P',
     67 *     '', '', '', '', '', '',
     68 *     '', ';(', '', '', '', '',
     69 *     '', ':kiss', '' ];
     70 */
     71CKEDITOR.config.smiley_descriptions = [
     72        ':)', ':(', ';)', ':D', ':/', ':P',
     73        '', '', '', '', '', '',
     74        '', ';(', '', '', '', '',
     75        '', ':kiss', '' ];
  • _source/plugins/stylescombo/plugin.js

     
    272272        }
    273273})();
    274274
     275/**
     276 * The "styles definition set" to load into the styles combo. The styles may
     277 * be defined in the page containing the editor, or can be loaded on demand
     278 * from an external file when opening the styles combo for the fist time. In
     279 * the second case, if this setting contains only a name, the styles definition
     280 * file will be loaded from the "styles" folder inside the stylescombo plugin
     281 * folder. Otherwise, this setting has the "name:url" syntax, making it
     282 * possible to set the URL from which loading the styles file.
     283 * @type string
     284 * @default 'default'
     285 * @example
     286 * // Load from the stylescombo styles folder (mystyles.js file).
     287 * config.stylesCombo_stylesSet = 'mystyles';
     288 * @example
     289 * // Load from a relative URL.
     290 * config.stylesCombo_stylesSet = 'mystyles:/editorstyles/styles.js';
     291 * @example
     292 * // Load from a full URL.
     293 * config.stylesCombo_stylesSet = 'mystyles:http://www.example.com/editorstyles/styles.js';
     294 */
    275295CKEDITOR.config.stylesCombo_stylesSet = 'default';
  • _source/plugins/tab/plugin.js

     
    256256
    257257/**
    258258 * Intructs the editor to add a number of spaces (&amp;nbsp;) to the text when
    259  * hitting the TAB key. If set to zero, the TAB key will have its default
    260  * behavior instead (like moving out of the editor).
    261  * @type {Number}
     259 * hitting the TAB key. If set to zero, the TAB key will be used to move the
     260 * cursor focus to the next element in the page, out of the editor focus.
     261 * @type Number
    262262 * @default 0
    263263 * @example
    264264 * config.tabSpaces = 4;
  • _source/plugins/templates/plugin.js

     
    6565 * comma. It must match definitions loaded with the templates_files setting.
    6666 * @type String
    6767 * @default 'default'
     68 * @example
     69 * config.templates = 'my_templates';
    6870 */
    6971CKEDITOR.config.templates = 'default';
    7072
     
    7274 * The list of templates definition files to load.
    7375 * @type (String) Array
    7476 * @default [ 'plugins/templates/templates/default.js' ]
     77 * @example
     78 * config.templates_files =
     79 *     [
     80 *         '/editor_templates/site_default.js',
     81 *         'http://www.example.com/user_templates.js
     82 *     ];
     83 *
    7584 */
    7685CKEDITOR.config.templates_files =
    7786        [
     
    8190        ];
    8291
    8392/**
    84  * Whether replace the current document content OR insert current
    85  * editing position.
     93 * Whether the "Replace actual contents" checkbox is checked by default in the
     94 * Templates dialog.
    8695 * @type Boolean
    8796 * @default true
     97 * @example
     98 * config.templates_replaceContent = false;
    8899 */
    89100CKEDITOR.config.templates_replaceContent = true;
  • _source/plugins/toolbar/plugin.js

     
    311311/**
    312312 * The toolbar definition. It is an array of toolbars (strips),
    313313 * each one being also an array, containing a list of UI items.
     314 * Note that this setting is composed by "toolbar_" added by the toolbar name,
     315 * which in this case is called "Basic". This second part of the setting name
     316 * can be anything. You must use this name in the
     317 * {@link CKEDITOR.config.toolbar} setting, so you instruct the editor which
     318 * toolbar_(name) setting to you.
    314319 * @type Array
    315320 * @example
    316321 * // Defines a toolbar with only one strip containing the "Source" button, a
    317322 * // separator and the "Bold" and "Italic" buttons.
    318  * <b>CKEDITOR.config.toolbar_Basic =
     323 * <b>config.toolbar_Basic =
    319324 * [
    320325 *     [ 'Source', '-', 'Bold', 'Italic' ]
    321326 * ]</b>;
     327 * config.toolbar = 'Basic';
    322328 */
    323329CKEDITOR.config.toolbar_Basic =
    324330[
    325331        ['Bold', 'Italic', '-', 'NumberedList', 'BulletedList', '-', 'Link', 'Unlink','-','About']
    326332];
    327333
     334/**
     335 * This is the default toolbar definition used by the editor. It contains all
     336 * editor features.
     337 * @type Array
     338 * @default (see example)
     339 * @example
     340 * // This is actually the default value.
     341 * config.toolbar_Full =
     342 * [
     343 *     ['Source','-','Save','NewPage','Preview','-','Templates'],
     344 *     ['Cut','Copy','Paste','PasteText','PasteFromWord','-','Print', 'SpellChecker', 'Scayt'],
     345 *     ['Undo','Redo','-','Find','Replace','-','SelectAll','RemoveFormat'],
     346 *     ['Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField'],
     347 *     '/',
     348 *     ['Bold','Italic','Underline','Strike','-','Subscript','Superscript'],
     349 *     ['NumberedList','BulletedList','-','Outdent','Indent','Blockquote'],
     350 *     ['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
     351 *     ['Link','Unlink','Anchor'],
     352 *     ['Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak'],
     353 *     '/',
     354 *     ['Styles','Format','Font','FontSize'],
     355 *     ['TextColor','BGColor'],
     356 *     ['Maximize', 'ShowBlocks','-','About']
     357 * ];
     358 */
    328359CKEDITOR.config.toolbar_Full =
    329360[
    330361        ['Source','-','Save','NewPage','Preview','-','Templates'],
     
    335366        ['Bold','Italic','Underline','Strike','-','Subscript','Superscript'],
    336367        ['NumberedList','BulletedList','-','Outdent','Indent','Blockquote'],
    337368        ['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
    338         ['Link','Unlink','Anchor'],     ['Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak'],
     369        ['Link','Unlink','Anchor'],
     370        ['Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak'],
    339371        '/',
    340372        ['Styles','Format','Font','FontSize'],
    341373        ['TextColor','BGColor'],
     
    343375];
    344376
    345377/**
    346  * The toolbox (alias toolbar) definition. It is a toolbar name or an array of toolbars (strips),
    347  * each one being also an array, containing a list of UI items.
    348  * @type Array or String
     378 * The toolbox (alias toolbar) definition. It is a toolbar name or an array of
     379 * toolbars (strips), each one being also an array, containing a list of UI items.
     380 * @type Array|String
     381 * @default 'Full'
    349382 * @example
    350383 * // Defines a toolbar with only one strip containing the "Source" button, a
    351384 * // separator and the "Bold" and "Italic" buttons.
    352  * <b>CKEDITOR.config.toolbar =
     385 * config.toolbar =
    353386 * [
    354387 *     [ 'Source', '-', 'Bold', 'Italic' ]
    355  * ]</b>;
     388 * ];
     389 * @example
    356390 * // Load toolbar_Name where Name = Basic.
    357  * <b>CKEDITOR.config.toolbar = 'Basic';
     391 * config.toolbar = 'Basic';
    358392 */
    359393CKEDITOR.config.toolbar = 'Full';
    360394
     395/**
     396 * Whether the toolbar can be collapsed by the user. If disabled, the collapser
     397 * button will not be displayed.
     398 * @type Boolean
     399 * @default true
     400 * @example
     401 * config.toolbarCanCollapse = false;
     402 */
    361403CKEDITOR.config.toolbarCanCollapse = true;
     404
     405/**
     406 * Whether the toolbar must start expanded when the editor is loaded.
     407 * @type Boolean
     408 * @default true
     409 * @example
     410 * config.toolbarStartupExpanded = false;
     411 */
    362412CKEDITOR.config.toolbarStartupExpanded = true;
  • _source/plugins/undo/plugin.js

     
    479479        };
    480480})();
    481481
     482/**
     483 * The number of undo steps to be saved. The higher this setting value the more
     484 * memory is used for it.
     485 * @type Number
     486 * @default 20
     487 * @example
     488 * config.undoStackSize = 50;
     489 */
    482490CKEDITOR.config.undoStackSize = 20;
  • _source/plugins/wysiwygarea/plugin.js

     
    590590
    591591/**
    592592 * Disables the ability of resize objects (image and tables) in the editing
    593  * area
     593 * area.
    594594 * @type Boolean
    595595 * @default false
    596596 * @example
     
    624624 * config.disableNativeSpellChecker = false;
    625625 */
    626626CKEDITOR.config.disableNativeSpellChecker = true;
     627
    627628/**
    628  * The editor will post an empty value ("") if you have just an empty paragraph on it, like this:
     629 * Whether the editor must output an empty value ("") if it's contents is made
     630 * by an empty paragraph only.
     631 * @type Boolean
     632 * @default true
    629633 * @example
    630  * <p></p>
    631  * <p><br /></p>
    632  * <p><b></b></p>
     634 * config.ignoreEmptyParagraph = false;
    633635 */
    634636CKEDITOR.config.ignoreEmptyParagraph = true;
  • _source/skins/kama/skin.js

     
    275275                                100 );
    276276                });
    277277}
     278
     279/**
     280 * The base user interface color to be used by the editor. Not all skins are
     281 * compatible with this setting.
     282 * @name CKEDITOR.config.uiColor
     283 * @type String
     284 * @default '' (empty)
     285 * @example
     286 * // Using a color code.
     287 * config.uiColor = '#AADC6E';
     288 * @example
     289 * // Using an HTML color name.
     290 * config.uiColor = 'Gold';
     291 */
  • config.js

     
    77{
    88        // Define changes to default configuration here. For example:
    99        // config.language = 'fr';
    10         // config.skin = 'office2003';
     10        // config.uiColor = '#AADC6E';
    1111};
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy