X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=_source%2Fplugins%2Fentities%2Fplugin.js;h=54023659a5e7bfde924869a18c3b5d9573eb9dde;hb=refs%2Ftags%2Fv3.6.2;hp=8dac27fd2172842b71d31f5a68dad4f00c9d2da5;hpb=f0610347140239143439a511ee2bd48cb784f470;p=ckeditor.git diff --git a/_source/plugins/entities/plugin.js b/_source/plugins/entities/plugin.js index 8dac27f..5402365 100644 --- a/_source/plugins/entities/plugin.js +++ b/_source/plugins/entities/plugin.js @@ -46,8 +46,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license 'upsih,piv'; /** - * Create a mapping table between one character and it's entity form from a list of entity names. - * @param reverse {Boolean} Whether create a reverse map from the entity string form to actual character. + * Create a mapping table between one character and its entity form from a list of entity names. + * @param reverse {Boolean} Whether to create a reverse map from the entity string form to an actual character. */ function buildTable( entities, reverse ) { @@ -174,16 +174,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license })(); /** - * Whether to escape HTML preserved entities in text, including: + * Whether to escape basic HTML entities in the document, including: * - * Note: It should not be subjected to change unless you're outputting non-HTML data format like BBCode. + * Note: It should not be subject to change unless when outputting a non-HTML data format like BBCode. * @type Boolean - * @default true + * @default true * @example * config.basicEntities = false; */ @@ -193,7 +193,7 @@ CKEDITOR.config.basicEntities = true; * Whether to use HTML entities in the output. * @name CKEDITOR.config.entities * @type Boolean - * @default true + * @default true * @example * config.entities = false; */ @@ -201,11 +201,11 @@ CKEDITOR.config.entities = true; /** * Whether to convert some Latin characters (Latin alphabet No. 1, ISO 8859-1) - * to HTML entities. The list of entities can be found at the + * to HTML entities. The list of entities can be found in the * W3C HTML 4.01 Specification, section 24.2.1. * @name CKEDITOR.config.entities_latin * @type Boolean - * @default true + * @default true * @example * config.entities_latin = false; */ @@ -214,37 +214,37 @@ CKEDITOR.config.entities_latin = true; /** * Whether to convert some symbols, mathematical symbols, and Greek letters to * HTML entities. This may be more relevant for users typing text written in Greek. - * The list of entities can be found at the + * The list of entities can be found in the * W3C HTML 4.01 Specification, section 24.3.1. * @name CKEDITOR.config.entities_greek * @type Boolean - * @default true + * @default true * @example * config.entities_greek = false; */ CKEDITOR.config.entities_greek = true; /** - * Whether to convert all remaining characters, not comprised in the ASCII - * character table, to their relative decimal numeric representation of HTML entity. - * When specified as the value 'force', it will simply convert all entities into the above form. - * For example, the phrase "This is Chinese: 汉语." is outputted + * Whether to convert all remaining characters not included in the ASCII + * character table to their relative decimal numeric representation of HTML entity. + * When set to force, it will convert all entities into this format. + * For example the phrase "This is Chinese: 汉语." is output * as "This is Chinese: 汉语." * @name CKEDITOR.config.entities_processNumerical * @type Boolean|String - * @default false + * @default false * @example * config.entities_processNumerical = true; - * config.entities_processNumerical = 'force'; //Convert from " " into " "; + * config.entities_processNumerical = 'force'; //Converts from " " into " "; */ /** - * An additional list of entities to be used. It's a string containing each - * entry separated by a comma. Entities names or number must be used, exclusing - * the "&" preffix and the ";" termination. + * A comma separated list of additional entities to be used. Entity names + * or numbers must be used in a form that excludes the "&" prefix and the ";" ending. * @name CKEDITOR.config.entities_additional - * @default '#39' // The single quote (') character. + * @default '#39' (The single quote (') character.) * @type String * @example + * config.entities_additional = '#1049'; // Adds Cyrillic capital letter Short I (Й). */ CKEDITOR.config.entities_additional = '#39';