Changeset 4895


Ignore:
Timestamp:
01/06/10 23:00:18 (5 years ago)
Author:
fredck
Message:

Updates to configurations documentation.

Location:
CKEditor/trunk/_source
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • CKEditor/trunk/_source/core/config.js

    r4858 r4895  
    168168 
    169169        /** 
    170          * Sets the 'id' attribute to be used on body if it doesn't have one. 
     170         * Sets the "id" attribute to be used on the body element of the editing 
     171         * area. 
     172         * @since 3.1 
    171173         * @type String 
    172174         * @default '' 
     
    175177 
    176178        /** 
    177          * Sets the 'class' attribute to be used on body if it doesn't have one. 
     179         * Sets the "class" attribute to be used on the body element of the editing 
     180         * area. 
     181         * @since 3.1 
    178182         * @type String 
    179183         * @default '' 
     
    186190         * <body> tags. The final output will also reflect this setting, 
    187191         * including the <body> contents only if this setting is disabled. 
     192         * @since 3.1 
    188193         * @type Boolean 
    189194         * @default false 
  • CKEditor/trunk/_source/core/editor.js

    r4871 r4895  
    686686 * Whether escape HTML when editor update original input element. 
    687687 * @name CKEDITOR.config.htmlEncodeOutput 
     688 * @since 3.1 
    688689 * @type {Boolean} 
    689690 * @default false 
  • CKEditor/trunk/_source/plugins/link/dialogs/link.js

    r4858 r4895  
    13601360 
    13611361/** 
    1362  * The e-mail address anti-spam protection option. 
     1362 * <p>The e-mail address anti-spam protection option. The protection will be 
     1363 * applied when creating or modifying e-mail links through the editor interface.</p> 
     1364 * <p>Two methods of protection can be choosed:</p> 
     1365 * <ol> <li>The e-mail parts (name, domain and any other query string) are 
     1366 *                      assembled into a function call pattern. Such function must be 
     1367 *                      provided by the developer in the pages that will use the contents. 
     1368 *              <li>Only the e-mail address is obfuscated into a special string that 
     1369 *                      has no meaning for humans or spam bots, but which is properly 
     1370 *                      rendered and accepted by the browser.</li></ol> 
     1371 * <p>Both approaches require JavaScript to be enabled.</p> 
    13631372 * @name CKEDITOR.config.emailProtection 
     1373 * @since 3.1 
    13641374 * @type {String} 
    1365  * Two forms of protection could be choosed from : 
    1366  * 1. The whole address parts ( name, domain with any other query string ) are assembled into a 
    1367  *   function call pattern which invoke you own provided function, with the specified arguments. 
    1368  * 2. Only the e-mail address is obfuscated into unicode code point sequences, replacement are 
    1369  *   done by a String.fromCharCode() call. 
    1370  * Note: Both approaches require JavaScript to be enabled. 
    1371  * @default '' 
     1375 * @default '' (empty string = disabled) 
    13721376 * @example 
    1373  *  config.emailProtection = ''; 
    1374  *  // href="mailto:tester@ckeditor.com?subject=subject&body=body" 
    1375  *  config.emailProtection = 'encode'; 
    1376  *  // href="<a href=\"javascript:void(location.href=\'mailto:\'+String.fromCharCode(116,101,115,116,101,114,64,99,107,101,100,105,116,111,114,46,99,111,109)+\'?subject=subject&body=body\')\">e-mail</a>" 
    1377  *  config.emailProtection = 'mt(NAME,DOMAIN,SUBJECT,BODY)'; 
    1378  *  // href="javascript:mt('tester','ckeditor.com','subject','body')" 
     1377 * // href="mailto:tester@ckeditor.com?subject=subject&body=body" 
     1378 * config.emailProtection = ''; 
     1379 * @example 
     1380 * // href="<a href=\"javascript:void(location.href=\'mailto:\'+String.fromCharCode(116,101,115,116,101,114,64,99,107,101,100,105,116,111,114,46,99,111,109)+\'?subject=subject&body=body\')\">e-mail</a>" 
     1381 * config.emailProtection = 'encode'; 
     1382 * @example 
     1383 * // href="javascript:mt('tester','ckeditor.com','subject','body')" 
     1384 * config.emailProtection = 'mt(NAME,DOMAIN,SUBJECT,BODY)'; 
    13791385 */ 
  • CKEditor/trunk/_source/plugins/pastefromword/filter/default.js

    r4893 r4895  
    11451145 
    11461146/** 
    1147  * Whether the ignore all font-related format styles, including: 
    1148  * - font size; 
    1149  * - font family; 
    1150  * - font fore/background color; 
     1147 * Whether to ignore all font related formatting styles, including: 
     1148 * <ul> <li>font size;</li> 
     1149 *              <li>font family;</li> 
     1150 *              <li>font foreground/background color.</li></ul> 
    11511151 * @name CKEDITOR.config.pasteFromWordRemoveFontStyles 
     1152 * @since 3.1 
    11521153 * @type Boolean 
    11531154 * @default true 
     
    11571158 
    11581159/** 
    1159  * Whether transform MS-Word Outline Numbered Heading into html list. 
     1160 * Whether to transform MS Word outline numbered headings into lists. 
    11601161 * @name CKEDITOR.config.pasteFromWordNumberedHeadingToList 
     1162 * @since 3.1 
    11611163 * @type Boolean 
    11621164 * @default false 
     
    11661168 
    11671169/** 
    1168  * Whether remove element styles that can't be managed with editor, note that this 
    1169  * this doesn't handle the font-specific styles, which depends on 
    1170  * how {@link CKEDITOR.config.pasteFromWordRemoveFontStyles} is configured. 
     1170 * Whether to remove element styles that can't be managed with the editor. Note 
     1171 * that this doesn't handle the font specific styles, which depends on the 
     1172 * {@link CKEDITOR.config.pasteFromWordRemoveFontStyles} setting instead. 
    11711173 * @name CKEDITOR.config.pasteFromWordRemoveStyles 
     1174 * @since 3.1 
    11721175 * @type Boolean 
    11731176 * @default true 
  • CKEditor/trunk/_source/plugins/pastefromword/plugin.js

    r4858 r4895  
    9797 
    9898/** 
    99  * Whether prompt the user about the clean-up of content from MS-Word. 
     99 * Whether to prompt the user about the clean up of content being pasted from 
     100 * MS Word. 
    100101 * @name CKEDITOR.config.pasteFromWordPromptCleanup 
     102 * @since 3.1 
    101103 * @type Boolean 
    102104 * @default undefined 
     
    106108 
    107109/** 
    108  * The file that provides the MS-Word Filtering rules. 
    109  * Note: It's a global configuration which are shared by all editor instances. 
     110 * The file that provides the MS Word cleanup function for pasting operations. 
     111 * Note: This is a global configuration shared by all editor instances present 
     112 * in the page. 
    110113 * @name CKEDITOR.config.pasteFromWordCleanupFile 
     114 * @since 3.1 
    111115 * @type String 
    112116 * @default 'default' 
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy