Improvements to documentation formatting, content etc
authormoodler <moodler>
Tue, 29 Oct 2002 14:48:58 +0000 (14:48 +0000)
committermoodler <moodler>
Tue, 29 Oct 2002 14:48:58 +0000 (14:48 +0000)
doc/background.html
doc/contents.html
doc/contents.php [new file with mode: 0755]
doc/index.php [new file with mode: 0644]
doc/install.html
doc/release.html
doc/top.php [new file with mode: 0644]
doc/view.php

index e25fc17..2d819bc 100755 (executable)
@@ -10,7 +10,7 @@
  \r
 <P>Moodle is an active and evolving work in progress.</P>\r
 <P>I've been working on it, in some way or other, for several years. It started \r
-  in the 90's when I was webmaster at <a href="http://dougiamas.com/">Curtin University \r
+  in the 90's when I was webmaster at <a target=_top href="http://www.curtin.edu.au/">Curtin University \r
   of Technology</a> and a system administrator of their WebCT installation. I \r
   encountered many frustrations with the WebCT beast and developed an itch that \r
   needed scratching - there had to be a better way (no, not Blackboard :-)</P>\r
@@ -24,8 +24,9 @@
   career in Computer Science with newly constructed knowledge about the nature \r
   of learning and collaboration.</P>\r
 <P>Since then Moodle has progressed through several very different prototypes \r
-  to achieve something I'm ready to call version 1.0 and release upon an unsuspecting \r
-  world (August 20, 2002). I've been using it in several courses and find it an \r
+  until the release of version 1.0 upon a largely unsuspecting world on \r
+  August 20, 2002 and a steady series of improved releases since then.\r
+<P>I've been using it in several courses and find it an \r
   extremely usable and reliable tool for building high-quality online courses \r
   - others are reporting the same. Given the context in which it's been designed, \r
   it works particularly well for smaller institutions, or for smaller, more intimate \r
index 52d9521..4bb1002 100755 (executable)
@@ -11,7 +11,7 @@
     \r
 <LI><A TARGET="main" HREF="background.html">Background</A> \r
 <LI><A TARGET="main" HREF="features.html">Features</A> \r
-<LI><A TARGET="main" HREF="release.html">Latest release</A> \r
+<LI><A TARGET="main" HREF="release.html">Release Notes</A> \r
 <LI><A TARGET="main" HREF="install.html">Installation</A>\r
 <LI><A TARGET="main" HREF="upgrade.html">Upgrading</A>\r
 <LI><A TARGET="main" HREF="teacher.html">Teacher Manual</A> \r
diff --git a/doc/contents.php b/doc/contents.php
new file mode 100755 (executable)
index 0000000..56f499e
--- /dev/null
@@ -0,0 +1,21 @@
+<?PHP  // $Id$\r
+\r
+    require("../config.php");\r
+\r
+    print_header();\r
+    \r
+?>\r
+\r
+<FONT SIZE=2 FACE="san-serif">\r
+<LI><A TARGET="main" HREF="intro.html">Introduction</A>\r
+<LI><A TARGET="main" HREF="background.html">Background</A> \r
+<LI><A TARGET="main" HREF="features.html">Features</A> \r
+<LI><A TARGET="main" HREF="release.html">Release Notes</A> \r
+<LI><A TARGET="main" HREF="install.html">Installation</A>\r
+<LI><A TARGET="main" HREF="upgrade.html">Upgrading</A>\r
+<LI><A TARGET="main" HREF="teacher.html">Teacher Manual</A> \r
+<LI><A TARGET="main" HREF="developer.html">Developer Manual</A> \r
+<LI><A TARGET="main" HREF="future.html">Future</A>\r
+<LI><A TARGET="main" HREF="credits.html">Credits</A> \r
+<LI><A TARGET="main" HREF="licence.html">License</A>\r
+</FONT>\r
diff --git a/doc/index.php b/doc/index.php
new file mode 100644 (file)
index 0000000..72b9b39
--- /dev/null
@@ -0,0 +1,25 @@
+<?PHP  // $Id$
+
+    require("../config.php");
+
+    optional_variable($file, "intro.html");    // file in this directory to view
+
+    $file = clean_filename($file);
+
+    if (!file_exists($file)) {
+        error("404 - File not found");
+    }
+
+?>
+
+<HEAD>
+    <TITLE>Moodle Documentation</TITLE>
+</HEAD>
+
+<FRAMESET ROWS="70,*">
+    <FRAME NAME="top" SRC="top.php">
+    <FRAMESET COLS="200,*">
+        <FRAME NAME="contents" SRC="contents.php">
+        <FRAME NAME="main" SRC="<?PHP echo "$file"; ?>">
+    </FRAMESET>
+</FRAMESET>
index ea300dd..4be8df5 100755 (executable)
@@ -5,7 +5,10 @@
 \r
 <BODY BGCOLOR="#FFFFFF">\r
 <H2>Installing Moodle</H2>\r
-<P>This guide explains how to install Moodle for the first time.</P>\r
+<P>This guide explains how to install Moodle for the first time.  It goes into some detail\r
+   about some of the steps, in order to cover the wide variety of small differences between\r
+   web server setups.  Don't be put off by this - on most servers Moodle can be set up \r
+   in a few minutes!</P>\r
 <P>Sections in this document:</P>\r
 <OL>\r
   <LI><A HREF="#requirements">Requirements</A></LI>\r
   </blockquote>\r
   <p>Just make sure index.php is in the list (and preferably towards the start \r
     of the list, for efficiency).</p>\r
-  <p>Secondly, check your PHP configuration file (usually called php.ini) and \r
-    make sure uploading has been turned on:</p>\r
+  <p>Secondly, Moodle requires a number of PHP settings to be active for it to \r
+     work.  <B>On most servers these will already be the default settings.</B>\r
+     However, some PHP servers (and some of the more recent PHP versions) may \r
+     have things set differently.  These are defined in PHP's configuration\r
+     file (usually called php.ini):</p>\r
   <blockquote>\r
-    <pre>file_uploads = On</pre>\r
+<pre>file_uploads = 1\r
+magic_quotes_gpc = 1\r
+short_open_tag = 1\r
+session.auto_start = 0\r
+</pre>\r
+  </blockquote>\r
+  <p>If you don't have access to httpd.conf or php.ini on your server, or you \r
+     have Moodle on a server with other applications that require different \r
+     settings, then you can OVERRIDE all of the default settings.\r
+     \r
+  <p>To do this, you need to create a file called <B>.htaccess</B> in Moodle's\r
+     main directory that contains definitions for these settings.\r
+     This only works on Apache servers and only when Overrides have been allowed.\r
+     <BLOCKQUOTE><PRE>\r
+DirectoryIndex index.php index.html index.htm\r
+php_value magic_quotes_gpc 1\r
+php_value file_uploads 1\r
+php_value short_open_tag 1\r
+php_value session.auto_start 0</BLOCKQUOTE></PRE>\r
+     <P>You can also do things like define the maximum size for uploaded files:\r
+     <BLOCKQUOTE><PRE>\r
+php_value upload_max_filesize 2M\r
+php_value post_max_size 2M\r
+     </BLOCKQUOTE></PRE>\r
+\r
+  <p>The easiest thing to do is just copy the sample file from lib/htaccess \r
+     and edit it to suit your needs.  It contains further instructions.  For \r
+     example, in a Unix shell:\r
+  <blockquote>\r
+    <pre>cp lib/htaccess .htaccess</pre>\r
   </blockquote>\r
-  <p>Most distributions of PHP have this turned on by default, but you may want \r
-    to check it anyway. </p>\r
-  <p>If you don't have access to httpd.conf or php.ini on your server, another \r
-    way you can set both of the above settings (and more) is to put definitions in a \r
-    .htaccess file in Moodle's main directory.  This only works on Apache servers \r
-    and only when Overrides have been allowed.  A sample .htaccess file \r
-    is included with Moodle (called lib/htaccess) that includes further information.\r
 \r
 </blockquote>\r
 <p>&nbsp;</p>\r
 <P>&nbsp;</P>\r
 <H3><A NAME="admin"></A>8. Go to the admin page</H3>\r
 <blockquote> \r
-  <p>The admin page should now be working at: http://example.com/moodle/admin\r
+  <p>The admin page should now be working at: <u>http://example.com/moodle/admin</u>\r
     If you try and access the front page of your site you'll be taken there automatically \r
     anyway. The first time you access this admin page, you will be presented with \r
     a GPL agreement with which you need to agree before you can continue with the setup.</p>\r
index 88f2314..6b59dd6 100644 (file)
@@ -1,4 +1,10 @@
-<H3> Release notes for Moodle 1.0.6</H3>
+<HEAD>
+    <TITLE>Moodle Docs: Release notes</TITLE>
+       <LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
+</HEAD>
+
+<BODY BGCOLOR="#FFFFFF">
+<H2> Release notes for Moodle 1.0.6</H2>
 
 <P>  Major changes in this release (since 1.0.5):   </P>
 
diff --git a/doc/top.php b/doc/top.php
new file mode 100644 (file)
index 0000000..65eae35
--- /dev/null
@@ -0,0 +1,12 @@
+<?PHP  // $Id$
+
+    require("../config.php");
+
+    if (! $site = get_site()) {
+        error("Site is misconfigured");
+    }
+    $strdocumentation = get_string("documentation");
+    print_header("$site->shortname: $strdocumentation", "$site->fullname", "$strdocumentation");
+    
+?>
+
index 11ea956..e94f939 100644 (file)
@@ -2,27 +2,36 @@
 
     require("../config.php");
 
-    require_variable($id);      // course context
+    optional_variable($id);      // course context
     require_variable($file);    // file in this directory to view
 
-    if (! $course = get_record("course", "id", $id)) {
-        error("Course is misconfigured");
-    }
+    $file = clean_filename($file);
 
-    if (!isteacher($course->id)) {
-        error("Only teachers can look at this page");
+    if (!file_exists($file)) {
+        error("404 - File not found");
     }
 
-    $file = clean_filename($file);
 
-    if (file_exists($file)) {
+    if ($id) {
+        if (! $course = get_record("course", "id", $id)) {
+            error("Course is misconfigured");
+        }
         $strhelp = get_string("help");
         print_header("$course->shortname: $strhelp", "$course->fullname", 
                      "<A HREF=\"../course/view.php?id=$course->id\">$course->shortname</A> -> $strhelp");
-        echo "<BLOCKQUOTE>";
-        include($file);
-        echo "</BLOCKQUOTE>";
+    } else {
+        if (! $site = get_site()) {
+            error("Site is misconfigured");
+        }
+        $strdocumentation = get_string("documentation");
+        print_header("$site->shortname: $strhelp", "$site->fullname", 
+                     "<A HREF=\"view.php?file=contents.html\">$strdocumentation</A>");
+        
     }
+    
+    echo "<BLOCKQUOTE>";
+    include($file);
+    echo "</BLOCKQUOTE>";
 
 ?>