Improvements to documentation formatting, content etc

moodle · Oct 29, 2002 · e149249 · e149249
1 parent 533e975
commit e149249
Show file tree

Hide file tree

Showing 8 changed files with 130 additions and 28 deletions.
diff --git a/doc/background.html b/doc/background.html
@@ -10,7 +10,7 @@ <H2>Background</H2>
 
 <P>Moodle is an active and evolving work in progress.</P>
 <P>I've been working on it, in some way or other, for several years. It started 
-  in the 90's when I was webmaster at <a href="http://dougiamas.com/">Curtin University 
+  in the 90's when I was webmaster at <a target=_top href="http://www.curtin.edu.au/">Curtin University 
   of Technology</a> and a system administrator of their WebCT installation. I 
   encountered many frustrations with the WebCT beast and developed an itch that 
   needed scratching - there had to be a better way (no, not Blackboard :-)</P>
@@ -24,8 +24,9 @@ <H2>Background</H2>
   career in Computer Science with newly constructed knowledge about the nature 
   of learning and collaboration.</P>
 <P>Since then Moodle has progressed through several very different prototypes 
-  to achieve something I'm ready to call version 1.0 and release upon an unsuspecting 
-  world (August 20, 2002). I've been using it in several courses and find it an 
+  until the release of version 1.0 upon a largely unsuspecting world on 
+  August 20, 2002 and a steady series of improved releases since then.
+<P>I've been using it in several courses and find it an 
   extremely usable and reliable tool for building high-quality online courses 
   - others are reporting the same. Given the context in which it's been designed, 
   it works particularly well for smaller institutions, or for smaller, more intimate 

diff --git a/doc/contents.html b/doc/contents.html
@@ -11,7 +11,7 @@
 
 <LI><A TARGET="main" HREF="background.html">Background</A> 
 <LI><A TARGET="main" HREF="features.html">Features</A> 
-<LI><A TARGET="main" HREF="release.html">Latest release</A> 
+<LI><A TARGET="main" HREF="release.html">Release Notes</A> 
 <LI><A TARGET="main" HREF="install.html">Installation</A>
 <LI><A TARGET="main" HREF="upgrade.html">Upgrading</A>
 <LI><A TARGET="main" HREF="teacher.html">Teacher Manual</A> 

diff --git a/doc/contents.php b/doc/contents.php
@@ -0,0 +1,21 @@
+<?PHP  // $Id$
+
+    require("../config.php");
+
+    print_header();
+
+?>
+
+<FONT SIZE=2 FACE="san-serif">
+<LI><A TARGET="main" HREF="intro.html">Introduction</A>
+<LI><A TARGET="main" HREF="background.html">Background</A> 
+<LI><A TARGET="main" HREF="features.html">Features</A> 
+<LI><A TARGET="main" HREF="release.html">Release Notes</A> 
+<LI><A TARGET="main" HREF="install.html">Installation</A>
+<LI><A TARGET="main" HREF="upgrade.html">Upgrading</A>
+<LI><A TARGET="main" HREF="teacher.html">Teacher Manual</A> 
+<LI><A TARGET="main" HREF="developer.html">Developer Manual</A> 
+<LI><A TARGET="main" HREF="future.html">Future</A>
+<LI><A TARGET="main" HREF="credits.html">Credits</A> 
+<LI><A TARGET="main" HREF="licence.html">License</A>
+</FONT>
diff --git a/doc/index.php b/doc/index.php
@@ -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>
diff --git a/doc/install.html b/doc/install.html
@@ -5,7 +5,10 @@
 
 <BODY BGCOLOR="#FFFFFF">
 <H2>Installing Moodle</H2>
-<P>This guide explains how to install Moodle for the first time.</P>
+<P>This guide explains how to install Moodle for the first time.  It goes into some detail
+   about some of the steps, in order to cover the wide variety of small differences between
+   web server setups.  Don't be put off by this - on most servers Moodle can be set up 
+   in a few minutes!</P>
 <P>Sections in this document:</P>
 <OL>
   <LI><A HREF="#requirements">Requirements</A></LI>
@@ -126,18 +129,43 @@ <H3><A NAME="webserver" id="webserver"></A>6. Check your web server settings</H3
   </blockquote>
   <p>Just make sure index.php is in the list (and preferably towards the start 
     of the list, for efficiency).</p>
-  <p>Secondly, check your PHP configuration file (usually called php.ini) and 
-    make sure uploading has been turned on:</p>
+  <p>Secondly, Moodle requires a number of PHP settings to be active for it to 
+     work.  <B>On most servers these will already be the default settings.</B>
+     However, some PHP servers (and some of the more recent PHP versions) may 
+     have things set differently.  These are defined in PHP's configuration
+     file (usually called php.ini):</p>
   <blockquote>
-    <pre>file_uploads = On</pre>
+<pre>file_uploads = 1
+magic_quotes_gpc = 1
+short_open_tag = 1
+session.auto_start = 0
+</pre>
+  </blockquote>
+  <p>If you don't have access to httpd.conf or php.ini on your server, or you 
+     have Moodle on a server with other applications that require different 
+     settings, then you can OVERRIDE all of the default settings.
+
+  <p>To do this, you need to create a file called <B>.htaccess</B> in Moodle's
+     main directory that contains definitions for these settings.
+     This only works on Apache servers and only when Overrides have been allowed.
+     <BLOCKQUOTE><PRE>
+DirectoryIndex index.php index.html index.htm
+php_value magic_quotes_gpc 1
+php_value file_uploads 1
+php_value short_open_tag 1
+php_value session.auto_start 0</BLOCKQUOTE></PRE>
+     <P>You can also do things like define the maximum size for uploaded files:
+     <BLOCKQUOTE><PRE>
+php_value upload_max_filesize 2M
+php_value post_max_size 2M
+     </BLOCKQUOTE></PRE>
+
+  <p>The easiest thing to do is just copy the sample file from lib/htaccess 
+     and edit it to suit your needs.  It contains further instructions.  For 
+     example, in a Unix shell:
+  <blockquote>
+    <pre>cp lib/htaccess .htaccess</pre>
   </blockquote>
-  <p>Most distributions of PHP have this turned on by default, but you may want 
-    to check it anyway. </p>
-  <p>If you don't have access to httpd.conf or php.ini on your server, another 
-    way you can set both of the above settings (and more) is to put definitions in a 
-    .htaccess file in Moodle's main directory.  This only works on Apache servers 
-    and only when Overrides have been allowed.  A sample .htaccess file 
-    is included with Moodle (called lib/htaccess) that includes further information.
 
 </blockquote>
 <p>&nbsp;</p>
@@ -157,7 +185,7 @@ <H3><A NAME="config"></A>7. Edit config.php</H3>
 <P>&nbsp;</P>
 <H3><A NAME="admin"></A>8. Go to the admin page</H3>
 <blockquote> 
-  <p>The admin page should now be working at: http://example.com/moodle/admin. 
+  <p>The admin page should now be working at: <u>http://example.com/moodle/admin</u>. 
     If you try and access the front page of your site you'll be taken there automatically 
     anyway. The first time you access this admin page, you will be presented with 
     a GPL agreement with which you need to agree before you can continue with the setup.</p>

diff --git a/doc/release.html b/doc/release.html
@@ -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
@@ -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");
+
+?>
+
diff --git a/doc/view.php b/doc/view.php
@@ -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>";
 
 ?>