http://atutor.ca/atutor/mantis/view.php?id=4823
authorcindy li <cli@ocad.ca>
Tue, 23 Aug 2011 17:25:37 +0000 (17:25 -0000)
committercindy li <cli@ocad.ca>
Tue, 23 Aug 2011 17:25:37 +0000 (17:25 -0000)
Update variable description of $_base_href & $_base_path at developer documentation.

docs/documentation/developer/guidelines.html

index ca43df3..d005fa3 100644 (file)
@@ -1035,21 +1035,21 @@ $msg->printAll();
                <h4>Example 1</h4>\r
                <p>To alter a text to lowercase:\r
                <pre class="code">\r
-               $str = 'Î\91Ï\81Ï\87αίο Î Î½ÎµÏ\8dμα';\r
+               $str = 'Ã\8eâ\80\98Ã\8f�Ã\8fâ\80¡Ã\8e±Ã\8e¯Ã\8e¿ Ã\8e Ã\8e½Ã\8eµÃ\8f�Ã\8e¼Ã\8e±';\r
                echo $strtolower($str);\r
                </pre></p>\r
 \r
                <h4>Example 2</h4>\r
                <p>To alter a text to uppercase:\r
                <pre class="code">\r
-               $str = 'Î\91Ï\81Ï\87αίο Î Î½ÎµÏ\8dμα';\r
+               $str = 'Ã\8eâ\80\98Ã\8f�Ã\8fâ\80¡Ã\8e±Ã\8e¯Ã\8e¿ Ã\8e Ã\8e½Ã\8eµÃ\8f�Ã\8e¼Ã\8e±';\r
                echo $strtoupper($str);\r
                </pre></p>\r
 \r
                <h4>Example 3</h4>\r
                <p>To find the middle character of a string:\r
                <pre class="code">\r
-               $str = 'Î\91Ï\81Ï\87αίο Î Î½ÎµÏ\8dμα';\r
+               $str = 'Ã\8eâ\80\98Ã\8f�Ã\8fâ\80¡Ã\8e±Ã\8e¯Ã\8e¿ Ã\8e Ã\8e½Ã\8eµÃ\8f�Ã\8e¼Ã\8e±';\r
                $mid = $strlen;\r
                echo $strpos($mid, $str);\r
                </pre></p>\r
@@ -1057,7 +1057,7 @@ $msg->printAll();
                <h4>Example 4</h4>\r
                <p>To check if the string has the appropriate length:\r
                <pre class="code">\r
-               $str = 'Î\91Ï\81Ï\87αίο Î Î½ÎµÏ\8dμα';\r
+               $str = 'Ã\8eâ\80\98Ã\8f�Ã\8fâ\80¡Ã\8e±Ã\8e¯Ã\8e¿ Ã\8e Ã\8e½Ã\8eµÃ\8f�Ã\8e¼Ã\8e±';\r
                $title = validate_length($str, 40);\r
                //now the title is safe to insert into the db\r
                </pre></p>\r
@@ -1081,7 +1081,7 @@ $msg->printAll();
        <h3><a name="var-base_href"></a>17.3 $_base_href</h3>\r
                <h4>Description</h4>\r
                <p><kbd>constant string $_base_href</kbd></p>\r
-               <p>The full URL to ATutor's base installation. Supports both regular and SSL protocols. Example: <kbd>http://myserver.org/files/ATutor/</kbd>.</p>\r
+               <p>The full URL to the base href of the current page, an equivalence of the "href" attribute value in the page html <base> tag. Supports both regular and SSL protocols. Example: <kbd>http://myserver.org/files/ATutor/</kbd>.</p>\r
 \r
                <h4>Location</h4>\r
                        <p><kbd>`include/lib/constants.inc.php`</kbd></p>\r
@@ -1089,7 +1089,7 @@ $msg->printAll();
        <h3><a name="var-base_path"></a>17.4 $_base_path</h3>\r
                <h4>Description</h4>\r
                <p><kbd>constant string $_base_path</kbd></p>\r
-               <p>The full absolute path to ATutor's base installation. Example: <kbd>/files/ATutor/</kbd>.</p>\r
+               <p>Extracted from $_base_href, the full absolute base path of the current page. Example: <kbd>/files/ATutor/</kbd>.</p>\r
 \r
                <h4>Location</h4>\r
                        <p><kbd>`include/lib/constants.inc.php`</kbd></p>\r
@@ -1363,7 +1363,7 @@ The second month in French is: &lt;?php echo AT_date('%F', 2, AT_DATE_INDEX_VALU
 \r
                <p>Result:\r
 <pre class="code">\r
-The second month in French is: frier\r
+The second month in French is: fæ†�rier\r
 </pre></p>\r
 \r
        <h3><a name="fn-addslashes"></a>18.5 $addslashes()</h3>\r