JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.5.1
[ckeditor.git] / _samples / enterkey.html
index def67ae..e6e6c8f 100644 (file)
@@ -1,11 +1,11 @@
 <!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>ENTER Key Configuration - CKEditor Sample</title>\r
+       <title>ENTER Key Configuration &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
@@ -35,9 +35,36 @@ window.onload = changeEnter;
        </script>\r
 </head>\r
 <body>\r
-       <h1>\r
-               CKEditor Sample\r
+       <h1 class="samples">\r
+               CKEditor Sample &mdash; ENTER Key Configuration\r
        </h1>\r
+       <div class="description">\r
+       <p>\r
+               This sample shows how to configure the <em>Enter</em> and <em>Shift+Enter</em> keys\r
+               to perform actions specified in the\r
+               <a class="samples" href="http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.enterMode"><code>enterMode</code></a>\r
+               and <a class="samples" href="http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.shiftEnterMode"><code>shiftEnterMode</code></a>\r
+               parameters, respectively.\r
+               You can choose from the following options:\r
+       </p>\r
+       <ul class="samples">\r
+               <li><strong><code>ENTER_P</code></strong> &ndash; new <code>&lt;p&gt;</code> paragraphs are created;</li>\r
+               <li><strong><code>ENTER_BR</code></strong> &ndash; lines are broken with <code>&lt;br&gt;</code> elements;</li>\r
+               <li><strong><code>ENTER_DIV</code></strong> &ndash; new <code>&lt;div&gt;</code> blocks are created.</li>\r
+       </ul>\r
+       <p>\r
+               The sample code below shows how to configure CKEditor to create a <code>&lt;div&gt;</code> block when <em>Enter</em> key is pressed.\r
+       </p>\r
+       <pre class="samples">CKEDITOR.replace( '<em>textarea_id</em>',\r
+       {\r
+               <strong>enterMode : CKEDITOR.ENTER_DIV</strong>\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.\r
+       </p>\r
+       </div>\r
+\r
        <!-- This <div> holds alert messages to be display in the sample page. -->\r
        <div id="alerts">\r
                <noscript>\r
@@ -49,18 +76,18 @@ window.onload = changeEnter;
                </noscript>\r
        </div>\r
        <div style="float: left; margin-right: 20px">\r
-               When ENTER is pressed:<br />\r
+               When <em>Enter</em> is pressed:<br />\r
                <select id="xEnter" onchange="changeEnter();">\r
-                       <option selected="selected" value="1">Create new &lt;P&gt; (recommended)</option>\r
-                       <option value="3">Create new &lt;DIV&gt;</option>\r
+                       <option selected="selected" value="1">Create a new &lt;P&gt; (recommended)</option>\r
+                       <option value="3">Create a new &lt;DIV&gt;</option>\r
                        <option value="2">Break the line with a &lt;BR&gt;</option>\r
                </select>\r
        </div>\r
        <div style="float: left">\r
-               When SHIFT + ENTER is pressed:<br />\r
+               When <em>Shift+Enter</em> is pressed:<br />\r
                <select id="xShiftEnter" onchange="changeEnter();">\r
-                       <option value="1">Create new &lt;P&gt;</option>\r
-                       <option value="3">Create new &lt;DIV&gt;</option>\r
+                       <option value="1">Create a new &lt;P&gt;</option>\r
+                       <option value="3">Create a new &lt;DIV&gt;</option>\r
                        <option selected="selected" value="2">Break the line with a &lt;BR&gt; (recommended)</option>\r
                </select>\r
        </div>\r
@@ -77,10 +104,10 @@ window.onload = changeEnter;
        <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