JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
gitweb / ckeditor.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
vanilla ckeditor-3.5.1
[ckeditor.git] / _samples / api.html
diff --git a/_samples/api.html b/_samples/api.html
index 92a9e9d..e9fddac 100644 (file)
--- a/_samples/api.html
+++ b/_samples/api.html
@@ -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>API usage - CKEditor Sample</title>\r
+       <title>API Usage &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
@@ -13,12 +13,12 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
        <script type="text/javascript">\r
        //<![CDATA[\r
 \r
-// The instanceReady event is fired when an instance of CKEditor has finished\r
+// The instanceReady event is fired, when an instance of CKEditor has finished\r
 // its initialization.\r
 CKEDITOR.on( 'instanceReady', function( ev )\r
 {\r
        // Show the editor name and description in the browser status bar.\r
-       document.getElementById( 'eMessage' ).innerHTML = '<p>Instance "' + ev.editor.name + '" loaded.<\/p>';\r
+       document.getElementById( 'eMessage' ).innerHTML = '<p>Instance <code>' + ev.editor.name + '<\/code> loaded.<\/p>';\r
 \r
        // Show this sample buttons.\r
        document.getElementById( 'eButtons' ).style.visibility = '';\r
@@ -33,11 +33,12 @@ function InsertHTML()
        // Check the active editing mode.\r
        if ( oEditor.mode == 'wysiwyg' )\r
        {\r
-               // Insert the desired HTML.\r
+               // Insert HTML code.\r
+               // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#insertHtml\r
                oEditor.insertHtml( value );\r
        }\r
        else\r
-               alert( 'You must be on WYSIWYG mode!' );\r
+               alert( 'You must be in WYSIWYG mode!' );\r
 }\r
 \r
 function InsertText()\r
@@ -50,10 +51,11 @@ function InsertText()
        if ( oEditor.mode == 'wysiwyg' )\r
        {\r
                // Insert as plain text.\r
+               // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#insertText\r
                oEditor.insertText( value );\r
        }\r
        else\r
-               alert( 'You must be on WYSIWYG mode!' );\r
+               alert( 'You must be in WYSIWYG mode!' );\r
 }\r
 \r
 function SetContents()\r
@@ -62,16 +64,18 @@ function SetContents()
        var oEditor = CKEDITOR.instances.editor1;\r
        var value = document.getElementById( 'htmlArea' ).value;\r
 \r
-       // Set the editor contents (replace the actual one).\r
+       // Set editor contents (replace current contents).\r
+       // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#setData\r
        oEditor.setData( value );\r
 }\r
 \r
 function GetContents()\r
 {\r
-       // Get the editor instance that we want to interact with.\r
+       // Get the editor instance that you want to interact with.\r
        var oEditor = CKEDITOR.instances.editor1;\r
 \r
-       // Get the editor contents\r
+       // Get editor contents\r
+       // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#getData\r
        alert( oEditor.getData() );\r
 }\r
 \r
@@ -84,16 +88,20 @@ function ExecuteCommand( commandName )
        if ( oEditor.mode == 'wysiwyg' )\r
        {\r
                // Execute the command.\r
+               // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#execCommand\r
                oEditor.execCommand( commandName );\r
        }\r
        else\r
-               alert( 'You must be on WYSIWYG mode!' );\r
+               alert( 'You must be in WYSIWYG mode!' );\r
 }\r
 \r
 function CheckDirty()\r
 {\r
        // Get the editor instance that we want to interact with.\r
        var oEditor = CKEDITOR.instances.editor1;\r
+       // Checks whether the current editor contents present changes when compared\r
+       // to the contents loaded into the editor at startup\r
+       // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#checkDirty\r
        alert( oEditor.checkDirty() );\r
 }\r
 \r
@@ -101,6 +109,8 @@ function ResetDirty()
 {\r
        // Get the editor instance that we want to interact with.\r
        var oEditor = CKEDITOR.instances.editor1;\r
+       // Resets the "dirty state" of the editor (see CheckDirty())\r
+       // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#resetDirty\r
        oEditor.resetDirty();\r
        alert( 'The "IsDirty" status has been reset' );\r
 }\r
@@ -110,9 +120,20 @@ function ResetDirty()
 \r
 </head>\r
 <body>\r
-       <h1>\r
-               CKEditor Sample\r
+       <h1 class="samples">\r
+               CKEditor Sample &mdash; Using CKEditor JavaScript API\r
        </h1>\r
+       <div class="description">\r
+       <p>\r
+               This sample shows how to use the\r
+               <a class="samples" href="http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html">CKEditor JavaScript API</a>\r
+               to interact with the editor at runtime.\r
+       </p>\r
+       <p>\r
+               For details on how to create this setup check the source code of this sample page.\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
@@ -124,10 +145,7 @@ function ResetDirty()
                </noscript>\r
        </div>\r
        <form action="sample_posteddata.php" method="post">\r
-               <p>\r
-                       This sample shows how to use the CKEditor JavaScript API to interact with the editor\r
-                       at runtime.</p>\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
+               <textarea cols="100" 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
 \r
                <script type="text/javascript">\r
                //<![CDATA[\r
@@ -143,14 +161,14 @@ function ResetDirty()
                        <input onclick="SetContents();" type="button" value="Set Editor Contents" />\r
                        <input onclick="GetContents();" type="button" value="Get Editor Contents (XHTML)" />\r
                        <br />\r
-                       <textarea cols="80" id="htmlArea" rows="3">&lt;h2&gt;Test&lt;/h2&gt;&lt;p&gt;This is some &lt;a href="/Test1.html"&gt;sample&lt;/a&gt; HTML&lt;/p&gt;</textarea>\r
+                       <textarea cols="100" id="htmlArea" rows="3">&lt;h2&gt;Test&lt;/h2&gt;&lt;p&gt;This is some &lt;a href="/Test1.html"&gt;sample&lt;/a&gt; HTML code.&lt;/p&gt;</textarea>\r
                        <br />\r
                        <br />\r
                        <input onclick="InsertText();" type="button" value="Insert Text" />\r
                        <br />\r
-                       <textarea cols="80" id="txtArea" rows="3">   First line with some leading whitespaces.\r
+                       <textarea cols="100" id="txtArea" rows="3">   First line with some leading whitespaces.\r
 \r
-Second line of text preceding by two line-breaks.</textarea>\r
+Second line of text preceded by two line breaks.</textarea>\r
                        <br />\r
                        <input onclick="ExecuteCommand('bold');" type="button" value="Execute &quot;bold&quot; Command" />\r
                        <input onclick="ExecuteCommand('link');" type="button" value="Execute &quot;link&quot; Command" />\r
@@ -163,10 +181,10 @@ Second line of text preceding by two line-breaks.</textarea>
        <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
ckeditor; unchanged from upstream, one commit/tag per release