JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.6.3
[ckeditor.git] / _source / core / config.js
index db77f76..962f33b 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -256,15 +256,18 @@ CKEDITOR.config =
        fullPage : false,\r
 \r
        /**\r
-        * The height of the editing area (that includes the editor content),\r
-        * in relative or absolute units, e.g. <code>30px</code>, <code>5em</code>.\r
-        * <strong>Note:</strong> Percentage units, like <code>30%</code>, are not supported yet.\r
+        * The height of the editing area (that includes the editor content). This\r
+        * can be an integer, for pixel sizes, or any CSS-defined length unit.<br>\r
+        * <br>\r
+        * <strong>Note:</strong> Percent units (%) are not supported.\r
         * @type Number|String\r
-        * @default <code>'200'</code>\r
+        * @default <code>200</code>\r
         * @example\r
-        * config.height = 500;\r
-        * config.height = '25em';\r
-        * config.height = '300px';\r
+        * config.height = 500; // 500 pixels.\r
+        * @example\r
+        * config.height = '25em'; // CSS length.\r
+        * @example\r
+        * config.height = '300px'; // CSS length.\r
         */\r
        height : 200,\r
 \r
@@ -400,13 +403,18 @@ CKEDITOR.config =
        skin : 'kama',\r
 \r
        /**\r
-        * The editor width in CSS-defined units or an integer denoting a value in pixels.\r
+        * The editor UI outer width. This can be an integer, for pixel sizes, or\r
+        * any CSS-defined unit.<br>\r
+        * <br>\r
+        * Unlike the <code>{@link CKEDITOR.config.height}</code> setting, this\r
+        * one will set the outer width of the entire editor UI, not for the\r
+        * editing area only.\r
         * @type String|Number\r
         * @default <code>''</code> (empty)\r
         * @example\r
-        * config.width = 850;\r
+        * config.width = 850; // 850 pixels wide.\r
         * @example\r
-        * config.width = '75%';\r
+        * config.width = '75%'; // CSS unit.\r
         */\r
        width : '',\r
 \r