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 / php / advanced.php
diff --git a/_samples/php/advanced.php b/_samples/php/advanced.php
index 771cb0c..1d62ce5 100644 (file)
--- a/_samples/php/advanced.php
+++ b/_samples/php/advanced.php
@@ -1,18 +1,52 @@
 <!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>Sample - CKEditor</title>\r
+       <title>Setting Configuration Options &mdash; CKEditor Sample</title>\r
        <meta content="text/html; charset=utf-8" http-equiv="content-type"/>\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; Setting Configuration Options\r
        </h1>\r
+       <p>\r
+               This sample shows how to insert a CKEditor instance with custom configuration options.\r
+       </p>\r
+       <p>\r
+               To set configuration options, use the <a class="samples" href="http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html"><code>config</code></a> property. To set the attributes of a <code>&lt;textarea&gt;</code> element (which is displayed instead of CKEditor in unsupported browsers), use the <code>textareaAttributes</code> property.\r
+       </p>\r
+       <pre class="samples">\r
+&lt;?php\r
+// Include the CKEditor class.\r
+include_once "ckeditor/ckeditor.php";\r
+\r
+// Create a class instance.\r
+$CKEditor = new CKEditor();\r
+\r
+// Path to the CKEditor directory.\r
+$CKEditor->basePath = '/ckeditor/';\r
+\r
+// Set global configuration (used by every instance of CKEditor).\r
+$CKEditor-><strong>config['width']</strong> = 600;\r
+\r
+// Change default textarea attributes.\r
+$CKEditor-><strong>textareaAttributes</strong> = array("cols" => 80, "rows" => 10);\r
+\r
+// The initial value to be displayed in the editor.\r
+$initialValue = 'This is some sample text.';\r
+\r
+// Create the first instance.\r
+$CKEditor->editor("textarea_id", $initialValue);\r
+?&gt;</pre>\r
+       <p>\r
+               Note that <code><em>textarea_id</em></code> in the code above is the <code>name</code> attribute of\r
+               the <code>&lt;textarea&gt;</code> element to be created.\r
+       </p>\r
+\r
        <!-- This <div> holds alert messages to be display in the sample page. -->\r
        <div id="alerts">\r
                <noscript>\r
@@ -23,24 +57,19 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        </p>\r
                </noscript>\r
        </div>\r
-       <!-- This <fieldset> holds the HTML that you will usually find in your pages. -->\r
-       <fieldset title="Output">\r
-               <legend>Output</legend>\r
-               <form action="../sample_posteddata.php" method="post">\r
-                       <p>\r
-                               <label>Editor 1:</label><br/>\r
-                       </p>\r
+       <form action="../sample_posteddata.php" method="post">\r
+                       <label>Editor 1:</label>\r
 <?php\r
-// Include CKEditor class.\r
+// Include the CKEditor class.\r
 include("../../ckeditor.php");\r
 \r
-// Create class instance.\r
+// Create a class instance.\r
 $CKEditor = new CKEditor();\r
 \r
-// Do not print the code directly to the browser, return it instead\r
+// Do not print the code directly to the browser, return it instead.\r
 $CKEditor->returnOutput = true;\r
 \r
-// Path to CKEditor directory, ideally instead of relative dir, use an absolute path:\r
+// Path to the CKEditor directory, ideally use an absolute path instead of a relative dir.\r
 //   $CKEditor->basePath = '/ckeditor/'\r
 // If not set, CKEditor will try to detect the correct path.\r
 $CKEditor->basePath = '../../';\r
@@ -48,22 +77,21 @@ $CKEditor->basePath = '../../';
 // Set global configuration (will be used by all instances of CKEditor).\r
 $CKEditor->config['width'] = 600;\r
 \r
-// Change default textarea attributes\r
+// Change default textarea attributes.\r
 $CKEditor->textareaAttributes = array("cols" => 80, "rows" => 10);\r
 \r
 // The initial value to be displayed in the editor.\r
 $initialValue = '<p>This is some <strong>sample text</strong>. You are using <a href="http://ckeditor.com/">CKEditor</a>.</p>';\r
 \r
-// Create first instance.\r
+// Create the first instance.\r
 $code = $CKEditor->editor("editor1", $initialValue);\r
 \r
 echo $code;\r
 ?>\r
-                       <p>\r
-                               <label>Editor 2:</label><br/>\r
-                       </p>\r
+                               <br />\r
+                               <label>Editor 2:</label>\r
 <?php\r
-// Configuration that will be used only by the second editor.\r
+// Configuration that will only be used by the second editor.\r
 $config['toolbar'] = array(\r
        array( 'Source', '-', 'Bold', 'Italic', 'Underline', 'Strike' ),\r
        array( 'Image', 'Link', 'Unlink', 'Anchor' )\r
@@ -71,21 +99,20 @@ $config['toolbar'] = array(
 \r
 $config['skin'] = 'v2';\r
 \r
-// Create second instance.\r
+// Create the second instance.\r
 echo $CKEditor->editor("editor2", $initialValue, $config);\r
 ?>\r
-                       <p>\r
-                               <input type="submit" value="Submit"/>\r
-                       </p>\r
-               </form>\r
-       </fieldset>\r
+               <p>\r
+                       <input type="submit" value="Submit"/>\r
+               </p>\r
+       </form>\r
        <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