JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.5.1
[ckeditor.git] / _samples / autogrow.html
index ccc08b6..e5ac0e0 100644 (file)
@@ -1,20 +1,50 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
 <!--\r
-Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 -->\r
 <html xmlns="http://www.w3.org/1999/xhtml">\r
 <head>\r
-       <title>AutoGrow Plugin - CKEditor Sample</title>\r
+       <title>AutoGrow Plugin &mdash; CKEditor Sample</title>\r
        <meta content="text/html; charset=utf-8" http-equiv="content-type" />\r
        <script type="text/javascript" src="../ckeditor.js"></script>\r
        <script src="sample.js" type="text/javascript"></script>\r
        <link href="sample.css" rel="stylesheet" type="text/css" />\r
 </head>\r
 <body>\r
-       <h1>\r
-               CKEditor Sample\r
+       <h1 class="samples">\r
+               CKEditor Sample &mdash; Using AutoGrow Plugin\r
        </h1>\r
+       <div class="description">\r
+       <p>\r
+               This sample shows how to configure CKEditor instances to use the\r
+               <strong>autogrow</strong> plugin that lets the editor window expand and shrink\r
+               depending on the amount and size of content entered in the editing area.\r
+       </p>\r
+       <p>\r
+               In its default implementation the <strong>AutoGrow feature</strong> can expand the\r
+               CKEditor window infinitely in order to avoid introducing scrollbars to the editing area.\r
+       </p>\r
+       <p>\r
+               It is also possible to set a maximum height for the editor window. Once CKEditor\r
+               editing area reaches the value in pixels specified in the <code>autoGrow_maxHeight</code>\r
+               attribute, scrollbars will be added and the editor window will no longer expand.\r
+       </p>\r
+       <p>\r
+               To add a CKEditor instance using the <strong>autogrow</strong> plugin and its\r
+               <code>autoGrow_maxHeight</code> attribute, insert the following JavaScript call to your code:\r
+       </p>\r
+       <pre class="samples">CKEDITOR.replace( '<em>textarea_id</em>',\r
+       {\r
+               <strong>extraPlugins : 'autogrow',</strong>\r
+               autoGrow_maxHeight : 800\r
+       });</pre>\r
+       <p>\r
+               Note that <code><em>textarea_id</em></code> in the code above is the <code>id</code> attribute of\r
+               the <code>&lt;textarea&gt;</code> element to be replaced with CKEditor. The maximum height should\r
+               be given in pixels.\r
+       </p>\r
+       </div>\r
        <!-- This <div> holds alert messages to be display in the sample page. -->\r
        <div id="alerts">\r
                <noscript>\r
@@ -27,10 +57,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
        </div>\r
        <form action="sample_posteddata.php" method="post">\r
                <p>\r
-                       In this sample the AutoGrow plugin is available. It makes the editor grow to fit the size of the content.</p>\r
-               <p>\r
                        <label for="editor1">\r
-                               With default configuration:</label><br />\r
+                               CKEditor using the <strong>autogrow</strong> plugin with its default configuration:</label>\r
                        <textarea cols="80" id="editor1" name="editor1" rows="10">&lt;p&gt;This is some &lt;strong&gt;sample text&lt;/strong&gt;. You are using &lt;a href="http://ckeditor.com/"&gt;CKEditor&lt;/a&gt;.&lt;/p&gt;</textarea>\r
                        <script type="text/javascript">\r
                        //<![CDATA[\r
@@ -44,7 +72,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                </p>\r
                <p>\r
                        <label for="editor2">\r
-                               With maximum height set to 400:</label><br />\r
+                               CKEditor using the <strong>autogrow</strong> plugin with maximum height set to 400:</label>\r
                        <textarea cols="80" id="editor2" name="editor2" rows="10">&lt;p&gt;This is some &lt;strong&gt;sample text&lt;/strong&gt;. You are using &lt;a href="http://ckeditor.com/"&gt;CKEditor&lt;/a&gt;.&lt;/p&gt;</textarea>\r
                        <script type="text/javascript">\r
                        //<![CDATA[\r
@@ -64,10 +92,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
        <div id="footer">\r
                <hr />\r
                <p>\r
-                       CKEditor - The text editor for Internet - <a href="http://ckeditor.com/">http://ckeditor.com</a>\r
+                       CKEditor - The text editor for the Internet - <a class="samples" href="http://ckeditor.com/">http://ckeditor.com</a>\r
                </p>\r
                <p id="copy">\r
-                       Copyright &copy; 2003-2010, <a href="http://cksource.com/">CKSource</a> - Frederico\r
+                       Copyright &copy; 2003-2011, <a class="samples" href="http://cksource.com/">CKSource</a> - Frederico\r
                        Knabben. All rights reserved.\r
                </p>\r
        </div>\r