Moodle Documentation

From: moodler Date: Tue, 29 Oct 2002 14:48:58 +0000 (+0000) Subject: Improvements to documentation formatting, content etc X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=e149249bd2174c963ab36cb8971bbb5039e150b7;p=moodle.git Improvements to documentation formatting, content etc --- diff --git a/doc/background.html b/doc/background.html index e25fc178fa..2d819bc7da 100755 --- a/doc/background.html +++ b/doc/background.html @@ -10,7 +10,7 @@

Moodle is an active and evolving work in progress.

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 Curtin University + in the 90's when I was webmaster at Curtin University of Technology 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 :-)

@@ -24,8 +24,9 @@ career in Computer Science with newly constructed knowledge about the nature of learning and collaboration.

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. +

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 index 52d952177e..4bb1002b0a 100755 --- a/doc/contents.html +++ b/doc/contents.html @@ -11,7 +11,7 @@

Latest release +

Teacher Manual diff --git a/doc/contents.php b/doc/contents.php new file mode 100755 index 0000000000..56f499e1d5 --- /dev/null +++ b/doc/contents.php @@ -0,0 +1,21 @@ + + + +

Release Notes +

Teacher Manual +

Developer Manual +

License + diff --git a/doc/index.php b/doc/index.php new file mode 100644 index 0000000000..72b9b398c4 --- /dev/null +++ b/doc/index.php @@ -0,0 +1,25 @@ + + + + Moodle Documentation + + + + + + + "> + + diff --git a/doc/install.html b/doc/install.html index ea300dd645..4be8df568f 100755 --- a/doc/install.html +++ b/doc/install.html @@ -5,7 +5,10 @@

Installing Moodle

-

This guide explains how to install Moodle for the first time.

+

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!

Sections in this document:

Requirements

Just make sure index.php is in the list (and preferably towards the start of the list, for efficiency).

Secondly, check your PHP configuration file (usually called php.ini) and - make sure uploading has been turned on:

Secondly, Moodle requires a number of PHP settings to be active for it to + work. On most servers these will already be the default settings. + 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):

-

file_uploads = On

+

file_uploads = 1
+magic_quotes_gpc = 1
+short_open_tag = 1
+session.auto_start = 0
+

+

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. + +

To do this, you need to create a file called .htaccess in Moodle's + main directory that contains definitions for these settings. + This only works on Apache servers and only when Overrides have been allowed. +

+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

You can also do things like define the maximum size for uploaded files: +

+php_value upload_max_filesize 2M
+php_value post_max_size 2M
+

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: +

+

cp lib/htaccess .htaccess

Most distributions of PHP have this turned on by default, but you may want - to check it anyway.

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.

8. Go to the admin page

-
The admin page should now be working at: http://example.com/moodle/admin. +
The admin page should now be working at: http://example.com/moodle/admin. 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.
diff --git a/doc/release.html b/doc/release.html index 88f2314b74..6b59dd62df 100644 --- a/doc/release.html +++ b/doc/release.html @@ -1,4 +1,10 @@ -
Release notes for Moodle 1.0.6
+ + Moodle Docs: Release notes + + + + +
Release notes for Moodle 1.0.6

Major changes in this release (since 1.0.5):
diff --git a/doc/top.php b/doc/top.php new file mode 100644 index 0000000000..65eae35720 --- /dev/null +++ b/doc/top.php @@ -0,0 +1,12 @@ +shortname: $strdocumentation", "$site->fullname", "$strdocumentation"); + +?> + diff --git a/doc/view.php b/doc/view.php index 11ea956a06..e94f939f3d 100644 --- 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", "id\">$course->shortname -> $strhelp"); - echo "
"; - include($file); - echo "
"; + } else { + if (! $site = get_site()) { + error("Site is misconfigured"); + } + $strdocumentation = get_string("documentation"); + print_header("$site->shortname: $strhelp", "$site->fullname", + "$strdocumentation"); + } + + echo "
"; + include($file); + echo "
"; ?>