rewrite some documention, still needs work.

diff --git a/docs/documentation/web_service_api.php b/docs/documentation/web_service_api.php
index bcfc230..86c4916 100644 (file)
--- a/docs/documentation/web_service_api.php
+++ b/docs/documentation/web_service_api.php
@@ -18,11 +18,10 @@ include(TR_INCLUDE_PATH.'header.inc.php');
 <div class="output-form" style="line-height:150%">\r
 \r
 <h1>AContent Web Service API</h1>\r
-<p>Interface applications with the AContent through its experimental API. This is version 0.1, dated Jun 2010.</p>\r
-<p>AContent provides search web service API that allows users to send request to AContent to search through \r
-the repository by keywords. AContent returns the search results in REST format. AContent also provides URLs and \r
-<a href="<?php echo TR_BASE_HREF;?>documentation/oauth_web_server">OAuth web service API</a> to view, download, import, \r
-export courses at AContent. </p>\r
+<p>Access AContent from remote applications through its web service API. This is version 0.1, dated Jun 2010.</p>\r
+<p>AContent provides a search API that allows users to send search requests to AContent. AContent returns results in REST format. AContent also has an \r
+<a href="<?php echo TR_BASE_HREF;?>documentation/oauth_web_server">OAuth web service API</a> for viewing, downloading, importing and \r
+exporting content from remote applications. </p>\r
 \r
 <h2 id="TableOfContents">Table of Contents</h2>\r
 \r
@@ -47,12 +46,12 @@ export courses at AContent. </p>
 <div id="search">\r
 <h2 id="request_format">Search request format</h2>\r
 \r
-<p>Below is a table of the parameter you can use to send a request to AContent to search through the repository\r
+<p>Below is a table of the parameters you can use to send a request to AContent to search through the repository\r
 by keywords. AContent returns the matching results in REST format.</p>\r
 \r
 <p>URL:<br />\r
 <kbd><?php echo TR_BASE_HREF; ?>search.php</kbd> <br />\r
-(replace with the address of your own server if you want to call a private instance of the AContent)</p>\r
+(replace with the address of your own server if you want to call a private instance of AContent)</p>\r
 \r
 <table class="data" rules="all">\r
 <tbody><tr>\r
@@ -62,7 +61,7 @@ by keywords. AContent returns the matching results in REST format.</p>
 <tr>\r
   <th>id</th>\r
   <td>The "Web Service ID" generated once successfully registering into AContent. \r
-  This ID is a 32 characters long string. It can always be retrieved from user's "Profile" page.</td>\r
+  This ID is a 32 characters long string. It can always be found on your "Profile" page.</td>\r
   <td>None, must be given.</td>\r
 </tr>\r
 \r
@@ -153,7 +152,7 @@ by keywords. AContent returns the matching results in REST format.</p>
 \r
 <div id="urls">\r
 <h2 id="view">View course URL</h2>\r
-<kbd><?php echo TR_BASE_HREF;?>home/course/index.php?_course_id=10</kbd><br />\r
+<kbd><?php echo TR_BFSE_HREF;?>home/course/index.php?_course_id=10</kbd><br />\r
 <p>_course_id is the "courseID" element returned in the REST search result</p>\r
 <p>This URL leads to the first content page of the course.</p>\r
 \r
@@ -164,23 +163,23 @@ by keywords. AContent returns the matching results in REST format.</p>
 </div>\r
 \r
 <h2 id="import">Import common cartridge or content package into AContent</h2>\r
-<p>A AContent user ID with author privilege is required for this action. If you\r
-don't have an AContent ID yet, register at <a href="<?php echo TR_BASE_HREF;?>register.php">here</a>.</p> \r
+<p>An AContent user ID with author privilege is required for this action. If you\r
+don't have an AContent ID yet, <a href="<?php echo TR_BASE_HREF;?>register.php">register</a>.</p> \r
 \r
-<p>Once the AContent user ID is ready, the first step is to go through \r
+<p>After an AContent user ID has been created, the first step is to go through the\r
 <a href="<?php echo TR_BASE_HREF;?>documentation/oauth_server_api.php">\r
-AContent OAuth authentication process</a> to get an OAuth access token. The \r
-authentication process prompts user to login with the AContent user ID and an\r
-access token is returned at the end of the authentication process. This access \r
-token must be sent along with the import request for user privilege check. The access\r
-token can be used repeatedly till its expire threshold is reached. After the\r
-user is confirmed as an valid author, the common cartridge or content package retrieved\r
-from the request "url" parameter is imported as a new AContent course. The course\r
+OAuth authentication process</a> to get an OAuth access token. The \r
+authentication process prompts users to login with an AContent user ID, after which an\r
+access token is returned. This access \r
+token must be sent along with the import request as a user privilege check. The access\r
+token can be used repeatedly until its expiration. After the\r
+user is confirmed as an valid author, the common cartridge or content package is retrieved\r
+from the request "url" parameter and imported as a new AContent course. The course\r
 ID of the newly-imported course is returned at success.</p>\r
 \r
 <kbd><?php echo TR_BASE_HREF;?>home/ims/ims_import.php?oauth_token=xxx&url=xxx</kbd><br />\r
 \r
-<p>oauth_token is the valid access token returned by AContent OAuth server.<br />\r
+<p>oauth_token is the valid access token returned by an AContent OAuth server.<br />\r
 url points to a zip file of a common cartridge or a content package.<br />\r
 Refer to <a href="<?php echo TR_BASE_HREF;?>documentation/oauth_server_api.php#import">\r
 Import Common Cartridge or Content Package into AContent via OAuth</a> for detailed \r