Moodle Docs: Background

From: martin Date: Thu, 6 Dec 2001 04:23:25 +0000 (+0000) Subject: First version of HTML documentation X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=809c6752bdf6547eecb84159e349e86f8d545e91;p=moodle.git First version of HTML documentation --- diff --git a/doc/CHANGES b/doc/CHANGES deleted file mode 100644 index de3a6549b0..0000000000 --- a/doc/CHANGES +++ /dev/null @@ -1,8 +0,0 @@ -0.1 ---- - -Starting to look more complete. -Added news posting and email forwarding of news items. -Changed listing of modules to A,B,C,D - - diff --git a/doc/COPYRIGHT b/doc/COPYRIGHT.txt similarity index 100% rename from doc/COPYRIGHT rename to doc/COPYRIGHT.txt diff --git a/doc/INSTALL b/doc/INSTALL deleted file mode 100644 index 871d481d4e..0000000000 --- a/doc/INSTALL +++ /dev/null @@ -1,95 +0,0 @@ -=========================================================================== -== MOODLE -== -== OPEN-SOURCE SOFTWARE FOR INTERNET-BASED EDUCATION -== -== Copyright (c) Martin Dougiamas, 2001 -== -== Freely available under the GNU License -== -=========================================================================== - - -Directory structure -=================== - -config.php - the only file you need to edit to get started - -lib - libraries of core Moodle code - -user - code to display and manage users -course - code to display and manage courses -login - code to handle login and account creation -admin - code to administrate the whole server -pix - Generic site graphics are in here - -mod - All Moodle modules are in here -theme - All Moodle themes are in here - - - -HOW TO INSTALL MOODLE -===================== - -1. SET UP A DATABASE - - Create an empty database (eg "moodle") in your database system - along with a special user (eg "moodle") that has access to that - database. (Don't use the "root" user for the moodle database - - it's a security hazard). - - eg for MySQL under a Unix system: - - # mysql -u root -p - > CREATE DATABASE moodle; - > GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX,ALTER ON moodle.* - TO moodle@localhost IDENTIFIED BY 'yourpassword'; - > quit - # mysqladmin -p reload - - -2. EDIT config.php - - Edit the configuration file, putting in the database details that you - just defined, as well as changing the site address and so on. - - Make sure you specify what type of database you are using. - - eg: - - $CFG->wwwroot = "http://example.com"; - $CFG->dbtype = "mysqlt"; // eg mysql, mysqlt, postgres ... etc - $CFG->dbhost = "localhost"; // eg localhost - $CFG->dbname = "moodle"; // eg moodle - $CFG->dbuser = "moodle"; - $CFG->dbpass = "yourpassword"; - - -3. GO TO THE ADMIN PAGE - - The admin page should now be working at: http://example.com/admin - - The first time you access this page, Moodle will automagically - create all the tables it needs within your database. - - You will then be asked to create an administration user for - future access to the admin pages.. - - All your further configuration of Moodle can now be done using the - administration web pages, including: - - - creating and deleting courses - - administering teacher accounts - - changing site-wide settings - - adding/deleting modules - - Configuration of each course is done by the teachers of that course. - See the teacher documentation for more information about that. - - Have fun and send me feedback so we can continue improving Moodle! - - -Cheers! - -Martin Dougiamas -martin@moodle.com diff --git a/doc/LICENCE b/doc/LICENCE deleted file mode 100644 index 5d18622b83..0000000000 --- a/doc/LICENCE +++ /dev/null @@ -1,281 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - diff --git a/doc/NOTES b/doc/NOTES deleted file mode 100644 index b3731868c9..0000000000 --- a/doc/NOTES +++ /dev/null @@ -1,3 +0,0 @@ -weeks dates start from 0:00 Monday morning - - diff --git a/doc/ROADMAP b/doc/ROADMAP deleted file mode 100644 index 1096744c54..0000000000 --- a/doc/ROADMAP +++ /dev/null @@ -1,15 +0,0 @@ -Roadmap -------- - -Here are some of the directions I would like to take -Moodle now it has been released. - -- Code audit and clean up. Standardise tabs, wordwrap. - Refactor a few bits. - -- Full internationalisation. To start with I've hardcoded - all the strings just to get things started and reduce - obfuscation during development. Modular "language packs" - need to implemented instead. eg using STPhp. - - diff --git a/doc/background.html b/doc/background.html new file mode 100755 index 0000000000..e239898aac --- /dev/null +++ b/doc/background.html @@ -0,0 +1,22 @@ + + + + Moodle Docs: Background + + + + +

Background

+ +

Right now, Moodle is still in early development. Some features are unfinished, + and there is a way to go yet before it could be compared to commercial tools + such as WebCT or Blackboard.

That said, it has already been used to successfully conduct a postgraduate + course at Curtin University of Technology, and many improvements are planned + in the near future.

+ +

Moodle Documentation

+ + + diff --git a/doc/config.php b/doc/config.php deleted file mode 100644 index 792570e714..0000000000 --- a/doc/config.php +++ /dev/null @@ -1,48 +0,0 @@ -dbtype = "mysql"; // eg mysql, postgres, oracle, access etc -$CFG->dbhost = "localhost"; // eg localhost -$CFG->dbname = "moodle"; // eg moodle -$CFG->dbuser = "username"; -$CFG->dbpass = "password"; - - -// Next you need to tell Moodle where it is, and where it can save files. - -$CFG->wwwroot = "http://example.com/moodle"; -$CFG->dirroot = "/web/moodle"; -$CFG->dataroot = "/home/moodledata"; // Web-server writeable - - -// Choose a theme from the "themes" folder. Default theme is "standard". - -$CFG->theme = "standard"; - - -// Give the full name (eg mail.example.com) of an SMTP server that the -// web server machine has access to (to send mail). Default: "localhost". - -$CFG->smtphost = "mail.example.com"; - - -// You should not need to change anything below this line -/////////////////////////////////////////////////////////////////////////// - -$CFG->libdir = "$CFG->dirroot/lib"; - -require("$CFG->libdir/setup.php"); // Sets up all libraries, sessions etc - -?> diff --git a/doc/contents.html b/doc/contents.html new file mode 100755 index 0000000000..6e7503f0a6 --- /dev/null +++ b/doc/contents.html @@ -0,0 +1,21 @@ + + + Moodle Docs: Table of Contents + + + + + +

Moodle Documentation

Introduction +

Background +

Installation + +

Teacher Manual +

Developer Manual +

Future +

Credits +

License + + + diff --git a/doc/credits.html b/doc/credits.html new file mode 100755 index 0000000000..4e4a40c26c --- /dev/null +++ b/doc/credits.html @@ -0,0 +1,102 @@ + + + + Moodle Docs: Credits + + + + +

Credits

+ +

Other contributors

+ +

Dr Peter Taylor, at Curtin University of Technology, for working +with the prototype and making many useful suggestions

+
+ +

+ +

Moodle libraries

+ +

+
Some of Moodle's libraries were written by other people, and are being +redistributed as part of Moodle under the LGPL. Copyright information +from this software is included below:
+ +
ADOdb - lib/adodb
+
+ +
+
Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle, +Interbase, Foxpro, Access, ADO, Sybase, DB2 and ODBC.
+ +
Version: 1.54 15 Nov 2001
+ Copyright © 2000, 2001 John Lim (jlim@natsoft.com.my)
+ License: Dual LGPL and BSD-style
+ URL: http://php.weblogs.com/adodb
+
+
+ +
Graph Class - lib/graphlib.php
+ +
+
Class to draw line, point, bar, and area graphs, including numeric + x-axis and double y-axis.
+ +
Version: 1.6.3
+ Copyright © 2000 Herman Veluwenkamp, hermanV@mindless.com
+ License: LGPL
+
+
+ +
PHP mailer - lib/class.phpmailer.php
+
+ +
Class for sending email using either sendmail, PHP mail(), +or SMTP. Methods are based upon the standard AspEmail(tm) classes.
+
+ Version 1.25, Created 07/02/2001
+ Copyright © 2001 Brent R. Matzelle <bmatzelle@yahoo.com>
+ License: LGPL
+
+
+ +
SMTP class - lib/class.smtp.php
+
+ +
Class that can be used to connect and communicate with + any SMTP server.
+ It implements all the SMTP functions defined in RFC821 except TURN.
+
+ Version: 03/26/2001
+ Copyright © 2001 Chris Ryan <chris@greatbridge.com>
+
+
+ +
PHP Simple Excel File Generator - lib/psxlsgen.php
+ +
Class to generate very simple MS Excel files (xls) +via PHP.
+
+ Version: 0.3b
+ Copyright © 2001 Erol Ozcan <eozcan@superonline.com>
+ License: GNU LGPL
+ URL: http://psxlsgen.sourceforge.net
+
+

+ +

+

+ +

Moodle Documentation

+ + + + diff --git a/doc/developer.html b/doc/developer.html new file mode 100755 index 0000000000..5033d1b3c3 --- /dev/null +++ b/doc/developer.html @@ -0,0 +1,22 @@ + + Moodle Docs: Developers Manual + + + + + +

Developers Manual

Moodle architecture

This section will describe the overall architecture for Moodle and some of + the major design decisions that were made during development.

Plug-in modules

Moodle has been designed to be modular, so that new learning activities can + be easily written and "plugged-in" to a Moodle installation by the + system administrator.

This section will describe the Plug-in API and provide a simple example of + a Moodle plug-in.

Moodle Documentation

+ + diff --git a/doc/future.html b/doc/future.html new file mode 100755 index 0000000000..ba4784e5bf --- /dev/null +++ b/doc/future.html @@ -0,0 +1,63 @@ + + Moodle Docs: Future + + + + + +

Future

As Moodle gains in maturity, I hope its directions are strongly influenced + by the community of developers and users.

All unfinished features, proposed improvements and feature requests will be + gathered on this page.

General

Format of existing code should be checked and cleaned up (tabs etc). Define + a style guide.
All table inserts should be converted to use the insert_record function.
Full internationalisation of texts using modular "language packs". eg STPhp
Implement pop-up help windows all over the site (from tiny help icons)
Users can specify their timezone so all times displayed are in local time + format.
Each course has a private "teacher forum" where teachers keep + notes on the course for action research purposes. Messages can be posted here + from any module in the course, and they contain links back to their relevant + modules.
Assessment system: each module can be marked per student. All assessments + can be combined on one page.
More course formats.
Better WYSIWYG editing of texts (using Java or Flash).
Make this page more interactive. :-)

Assignment module

Module to allow submission and assessment of assignments (to be written).

Chat module

Re-implement chat room using Flash, and use user pictures.

Choice module

Add capability for more than two choices.
Add teacher option of publishing results (ie a poll).

Discussion module

Discussion forums need to have abbreviated topic display and pagination + for when they get very big.
Allow files to be attached to discussion posts (images etc).

Journal module

Journal summary index should show teacher remarks.

Survey module

Allow teachers to create and share surveys.

Send your additions, suggestions to Martin + Dougiamas.

Moodle Documentation

+ diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000000..99d87fb653 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,8 @@ + + Moodle Documentation + + + + + + diff --git a/doc/install.html b/doc/install.html new file mode 100755 index 0000000000..bbd13c93d9 --- /dev/null +++ b/doc/install.html @@ -0,0 +1,228 @@ + + Moodle Docs: Installation + + + + + +

Installing Moodle

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

Sections in this document:

Requirements
Download
Site structure
Create a data directory
Create a database
Edit config.php
Go to the admin page
Set up cron
Create a new course

Requirements

Moodle is primarily developed in Linux and MacOSX environments using PHP, Apache + and MySQL. However, it has been designed to run on as many platforms as possible.

All you should need are:

a working installation of PHP (version + 4.0.6 or better), including the GD + library for manipulating images.
a working database server (MySQL, PostgreSQL, + MSSQL, Oracle, Interbase, Foxpro, Access, ADO, Sybase, DB2 or ODBC)

The quickest way to satisfy these requirements on Windows platforms is to download + PHPTriad or FoxServ, + which will install Apache, PHP, and MySQL for you.

Download

There are two ways to get Moodle, as a compressed package and via CVS. These + are explained in detail on the download page on http://moodle.com/

After downloading and unpacking the archive, or checking out the files via + CVS, you will be left with a directory called "moodle", containing + a number of files and folders.

You can either place the whole folder in your web server documents directory, + in which case the site will be located at http://yourwebserver.com/moodle, + or you can copy all the contents straight into the main web server documents + directory, in which case the site will be simply http://yourwebserver.com.

Site structure

Here is a quick summary of the contents of the Moodle folder, to help get you + oriented:

+
config.php - the only file you need to edit to get started
+ index.php - the front page of the site
+
+
admin/ - code to administrate the whole server
+
course/ - code to display and manage courses
+
doc/ - help documentation for Moodle (eg this page)
+
files/ - code to display and manage uploaded files
+
lib/ - libraries of core Moodle code
+
login/ - code to handle login and account creation
+
mod/ - all Moodle course modules
+
pix/ - generic site graphics
+
theme/ - theme packs/skins to change the look of the site.
+
user/ - code to display and manage users
+
+

+

Create a data directory

Moodle will also need some space on your hard disk to store uploaded files, + such as course documents and user pictures.

Create a directory for this purpose somewhere away from the web server + documents directory (we don't want these files to be accessible from the web), + and ensure that the web server software has permission to write to this directory. + On Unix machines, this means setting the owner of the directory to be something + like "nobody" or "apache".

Create a database

You need to create an empty database (eg "moodle") in your database system + along with a special user (eg "moodleuser") that has access to that database + (and that database only. For example, don't use the "root" user for the moodle + database - it's a security hazard).

eg for MySQL:

+   # mysql -u root -p
+   > CREATE DATABASE moodle; 
+   > GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX,ALTER ON moodle.* 
+           TO moodleuser@localhost IDENTIFIED BY 'yourpassword'; 
+   > quit 
+   # mysqladmin -p reload
+

+ +

Edit config.php

Now you can edit the configuration file, config.php. This file is used by all + other files in Moodle.

In it you specify the database details that you just defined, as well as the + site address, file system directory, data directory and so on. The config file + has detailed directions.

For the rest of this installation document we will assume your site is at: + http://example.com/moodle

Go to the admin page

The admin page should now be working at: http://example.com/moodle/admin

Go to this page using your favourite web browser.

The first time you access this page, Moodle will set up your database and prompt + you for more information.

Firstly, the main database tables are created. You should see a number of statements + like this (in green):

+
SUCCESS: CREATE TABLE course ( id int(10) unsigned + NOT NULL auto_increment, category int(10) unsigned NOT NULL default '0', password + varchar(50) NOT NULL default '', fullname varchar(254) NOT NULL default '', + shortname varchar(15) NOT NULL default '', summary text NOT NULL, format tinyint(4) + NOT NULL default '1', teacher varchar(100) NOT NULL default 'Teacher', startdate + int(10) unsigned NOT NULL default '0', enddate int(10) unsigned NOT NULL default + '0', timemodified int(10) unsigned NOT NULL default '0', PRIMARY KEY (id)) + TYPE=MyISAM
+
...and so on, followed by: Main databases set up successfully. +
+

If you don't see this, then there must have been some problem with the database + or the configuration settings you defined in config.php. Check these and try + this page again.

Press the "Continue" link at the bottom of the page.

Next you will see a similar page that sets up all the tables required by each + Moodle module. As before, they should all be green, otherwise you may be a problem + in the module code.

Press the "Continue" link at the bottom of the page.

You should now see a form where you can define more parameters for your Moodle + site, such as the name, the description shown on the front page, and so on. + Fill this out (you can always go back and change these later) and then press + "Update the site".

Finally, you will then be asked to create an administration user for future + access to the admin pages. Fill out the details with your own name, email etc + and then click "Update this user". You will be returned to the main + admin page, which contain a number of links arranged in a menu.

Make sure you remember the username and password you chose for the administration + user, as they will be necessary to access the administration page in future.

All your further configuration of Moodle can now be done using the administration + page menu, which includes tasks such as:

creating and deleting courses
administering teacher accounts
changing site-wide settings

Set up cron

Some of Moodle's modules require continual checks to perform tasks. For example, + Moodle needs to check the discussion forums so it can mail out copies of posts + to people who have subscribed.

The script that does all this is located in the admin directory, and is called + cron.php. However, it can not run itself, so you need to set up a mechanism + where this script is run regularly (eg every five minutes). This provides a + "heartbeat" so that the script can perform functions at periods defined + by each module.

For security reasons, this script defines a required password. Edit cron.php + with a text editor and change the password to something unique. eg

$PASSWORD = "pword";
+

Test that the script works by running it directly from your browser:

http://example.com/moodle/admin/cron.php?p=pword

Now, you need to set up some of way of running the script automatically. There + are two main ways of doing this, 'externally' and 'internally'.

+
External cron
+
You can set up a program to call the page just as you did in the example + above. For example, you can use a Unix utility like 'wget':
+
+
+
wget -q -O /dev/null 'http://example.com/moodle/admin/cron.php?p=pword'
+
+
Note in this example that the output is thrown away (to /dev/null).
+
To automate the running of this script every 5 minutes you can use Unix cron. + Edit your cron settings from the commandline using "crontab -e" + and add a line like:
+
+
*/5 * * * * wget -q -O /dev/null 'http://example.com/moodle/admin/cron.php?p=pword'
+
+
+
On non-Unix platforms you will need to find another way to do this (and let + me know so I can update this documentation!)
+
Internal cron
+
To run the cron.php script internally, you need a version of PHP compiled + to be run from the command-line, also called a "cgi" version. On + a Unix machine, you can now run the script with your password as the first + parameter, something like this:
+
+
/opt/bin/php /web/moodle/admin/cron.php pword
+
+
As before you can automate this using Unix cron (or the equivalent on your + OS):
+
+
*/5 * * * * (/opt/bin/php /web/moodle/admin/cron.php pword) &> /dev/null
+
+
+

The advantage with running the script internally is that your web server logs + aren't filled with constant requests to cron.php. The disadvantage is that you + need to have access to a command-line version of php.

Create a new course

Now that Moodle is running properly, you can create a course.

Start on the admin page ( http://example.com/moodle/admin ) and select "Create + a new course".

Fill out the form, paying special attention to the course format.

If you choose a "weekly" format, then course modules will be arranged + by "weeks". The weeks in your course are defined by the start and + end dates you choose on this form. The idea is that the next time you run this + course, you can just change the dates and keep the essential course format.

The "non-weekly" format is for courses that don't have a start or + finish, and so any start/end dates you choose will be ignored.

Press "Update this course", and you will be taken to a new form where + you can add teachers to the course. You can only add existing user accounts + from this form - if you want to create a new teacher account then either ask + the teacher to create one for themselves (see the login page), or create one + for them using the "Create a user account" on the Admin page.

Once done, your course is ready to customise, and is accessible via the "Courses" + link on the home page.

See the "Teacher Manual" for more details + on course-building.

Moodle Documentation

+ + diff --git a/doc/intro.html b/doc/intro.html new file mode 100755 index 0000000000..6743bed06d --- /dev/null +++ b/doc/intro.html @@ -0,0 +1,30 @@ + + + + Moodle Docs: Introduction + + + + +

Introduction

+ +

Moodle is a software package for producing internet-based courses and web sites. + It's an ongoing development project designed to support a constructivist + framework of education.

Moodle is given away freely as + Open Source software (under the + GNU Public License). It will run on any computer that can run + PHP, and supports almost every brand of database.

The word Moodle is an acronym for Modular Object-Oriented Dynamic Learning + Environment, which is mostly useful to programmers and education theorists. + It's also a verb that describes the process of lazily meandering through + something, doing things as it occurs to you to do them, an enjoyable tinkering + that often leads to insight and creativity. As such it applies both to the way + Moodle was developed, and to the way a student or teacher might approach studying + or teaching an online course.

Moodle Documentation

+ + + diff --git a/doc/licence.html b/doc/licence.html new file mode 100755 index 0000000000..9da12465a4 --- /dev/null +++ b/doc/licence.html @@ -0,0 +1,29 @@ + + + + Moodle Docs: Copyright License + + + + +

Copyright License for Moodle

+ +

This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.

This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details (attached below).
+

+ +

		    GNU GENERAL PUBLIC LICENSE
		       Version 2, June 1991

 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

			    Preamble

  The licenses for most software are designed to take away your
freedom to share and change it.  By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users.  This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it.  (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.)  You can apply it to
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.

  To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have.  You must make sure that they, too, receive or can get the
source code.  And you must show them these terms so they know their
rights.

  We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.

  Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software.  If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.

  Finally, any free program is threatened constantly by software
patents.  We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary.  To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.

  The precise terms and conditions for copying, distribution and
modification follow.

		    GNU GENERAL PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License.  The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language.  (Hereinafter, translation is included without limitation in
the term "modification".)  Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope.  The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.

  1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.

You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.

  2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:

    a) You must cause the modified files to carry prominent notices
    stating that you changed the files and the date of any change.

    b) You must cause any work that you distribute or publish, that in
    whole or in part contains or is derived from the Program or any
    part thereof, to be licensed as a whole at no charge to all third
    parties under the terms of this License.

    c) If the modified program normally reads commands interactively
    when run, you must cause it, when started running for such
    interactive use in the most ordinary way, to print or display an
    announcement including an appropriate copyright notice and a
    notice that there is no warranty (or else, saying that you provide
    a warranty) and that users may redistribute the program under
    these conditions, and telling the user how to view a copy of this
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole.  If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works.  But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.

In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.

  3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:

    a) Accompany it with the complete corresponding machine-readable
    source code, which must be distributed under the terms of Sections
    1 and 2 above on a medium customarily used for software interchange; or,

    b) Accompany it with a written offer, valid for at least three
    years, to give any third party, for a charge no more than your
    cost of physically performing source distribution, a complete
    machine-readable copy of the corresponding source code, to be
    distributed under the terms of Sections 1 and 2 above on a medium
    customarily used for software interchange; or,

    c) Accompany it with the information you received as to the offer
    to distribute corresponding source code.  (This alternative is
    allowed only for noncommercial distribution and only if you
    received the program in object code or executable form with such
    an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for
making modifications to it.  For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable.  However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.

If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.

  4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License.  Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.

  5. You are not required to accept this License, since you have not
signed it.  However, nothing else grants you permission to modify or
distribute the Program or its derivative works.  These actions are
prohibited by law if you do not accept this License.  Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.

  6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions.  You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.

  7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all.  For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.

It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices.  Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.

This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.

  8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded.  In such case, this License incorporates
the limitation as if written in the body of this License.

  9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number.  If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation.  If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.

  10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission.  For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this.  Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.

			    NO WARRANTY

  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.

  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.

		     END OF TERMS AND CONDITIONS

+ + +

Moodle Documentation

+ + + diff --git a/doc/teacher.html b/doc/teacher.html new file mode 100755 index 0000000000..518024ed0c --- /dev/null +++ b/doc/teacher.html @@ -0,0 +1,14 @@ + + Moodle Docs: Teachers Manual + + + + + +

Teacher Manual

This page will provide a way to learn about creating online courses with Moodle. + It will include not only descriptions of the various functions, but discussions + of philosophy and pedagogical decisions that need to be made by teachers.

Moodle Documentation

+ +