diff options
author | Greg Aker <greg@gregaker.net> | 2011-08-20 18:58:58 +0200 |
---|---|---|
committer | Greg Aker <greg@gregaker.net> | 2011-08-20 18:58:58 +0200 |
commit | abbad9ea53e81c6e3211029711ac5b2ab4f1978d (patch) | |
tree | 9a4d5a8587da1dd3a365251afa37be2f835a53c2 /user_guide/libraries/trackback.html | |
parent | 71644d683d0a15a6f7e04fabd0f51a4200d620b4 (diff) | |
parent | d56be70257696d0bbf2dcc880888d8dc17cba21c (diff) |
Merge branch 'develop' into feature/unit-tests
Conflicts:
.hgignore
Diffstat (limited to 'user_guide/libraries/trackback.html')
-rw-r--r-- | user_guide/libraries/trackback.html | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/user_guide/libraries/trackback.html b/user_guide/libraries/trackback.html index 4f5ca6ce1..a2912a594 100644 --- a/user_guide/libraries/trackback.html +++ b/user_guide/libraries/trackback.html @@ -28,7 +28,7 @@ <div id="masthead"> <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> <tr> -<td><h1>CodeIgniter User Guide Version 2.0.2</h1></td> +<td><h1>CodeIgniter User Guide Version 2.0.3</h1></td> <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> </tr> </table> @@ -101,29 +101,29 @@ else<br /> <li><strong>ping_url</strong> - The URL of the site you are sending the Trackback to. You can send Trackbacks to multiple URLs by separating each URL with a comma.</li> <li><strong>url</strong> - The URL to YOUR site where the weblog entry can be seen.</li> <li><strong>title</strong> - The title of your weblog entry.</li> -<li><strong>excerpt</strong> - The content of your weblog entry. Note: the Trackback class will automatically send only the first 500 characters of your entry. It will also strip all HTML.</li> +<li><strong>excerpt</strong> - The content of your weblog entry. Note: the Trackback class will automatically send only the first 500 characters of your entry. It will also strip all HTML.</li> <li><strong>blog_name</strong> - The name of your weblog.</li> -<li><strong>charset</strong> - The character encoding your weblog is written in. If omitted, UTF-8 will be used.</li> +<li><strong>charset</strong> - The character encoding your weblog is written in. If omitted, UTF-8 will be used.</li> </ul> -<p>The Trackback sending function returns TRUE/FALSE (boolean) on success or failure. If it fails, you can retrieve the error message using:</p> +<p>The Trackback sending function returns TRUE/FALSE (boolean) on success or failure. If it fails, you can retrieve the error message using:</p> <code>$this->trackback->display_errors();</code> <h2>Receiving Trackbacks</h2> -<p>Before you can receive Trackbacks you must create a weblog. If you don't have a blog yet there's no point in continuing.</p> +<p>Before you can receive Trackbacks you must create a weblog. If you don't have a blog yet there's no point in continuing.</p> <p>Receiving Trackbacks is a little more complex than sending them, only because you will need a database table in which to store them, -and you will need to validate the incoming trackback data. You are encouraged to implement a thorough validation process to -guard against spam and duplicate data. You may also want to limit the number of Trackbacks you allow from a particular IP within -a given span of time to further curtail spam. The process of receiving a Trackback is quite simple; +and you will need to validate the incoming trackback data. You are encouraged to implement a thorough validation process to +guard against spam and duplicate data. You may also want to limit the number of Trackbacks you allow from a particular IP within +a given span of time to further curtail spam. The process of receiving a Trackback is quite simple; the validation is what takes most of the effort.</p> <h2>Your Ping URL</h2> -<p>In order to accept Trackbacks you must display a Trackback URL next to each one of your weblog entries. This will be the URL +<p>In order to accept Trackbacks you must display a Trackback URL next to each one of your weblog entries. This will be the URL that people will use to send you Trackbacks (we will refer to this as your "Ping URL").</p> <p>Your Ping URL must point to a controller function where your Trackback receiving code is located, and the URL @@ -140,7 +140,7 @@ Ping URLs will look something like this:</p> <h2>Creating a Trackback Table</h2> -<p>Before you can receive Trackbacks you must create a table in which to store them. Here is a basic prototype for such a table:</p> +<p>Before you can receive Trackbacks you must create a table in which to store them. Here is a basic prototype for such a table:</p> <textarea class="textarea" style="width:100%" cols="50" rows="13"> CREATE TABLE trackbacks ( @@ -162,7 +162,7 @@ but to make the data more useful we've added a few more fields in the above tabl <h2>Processing a Trackback</h2> -<p>Here is an example showing how you will receive and process a Trackback. The following +<p>Here is an example showing how you will receive and process a Trackback. The following code is intended for use within the controller function where you expect to receive Trackbacks.</p> <code>$this->load->library('trackback');<br /> @@ -196,7 +196,7 @@ $this->trackback->send_success();</code> <h4>Notes:</h4> -<p>The entry ID number is expected in the third segment of your URL. This is based on the URI example we gave earlier:</p> +<p>The entry ID number is expected in the third segment of your URL. This is based on the URI example we gave earlier:</p> <code>http://example.com/index.php/trackback/receive/<samp>entry_id</samp></code> @@ -204,12 +204,12 @@ $this->trackback->send_success();</code> <code>$this->uri->segment(3);</code> -<p>In our Trackback receiving code above, if the third segment is missing, we will issue an error. Without a valid entry ID, there's no +<p>In our Trackback receiving code above, if the third segment is missing, we will issue an error. Without a valid entry ID, there's no reason to continue.</p> <p>The <dfn>$this->trackback->receive()</dfn> function is simply a validation function that looks at the incoming data and makes sure it contains the four pieces of data that are required (url, title, excerpt, blog_name). -It returns TRUE on success and FALSE on failure. If it fails you will issue an error message.</p> +It returns TRUE on success and FALSE on failure. If it fails you will issue an error message.</p> <p>The incoming Trackback data can be retrieved using this function:</p> |