L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

First version of HTML documentation

Browse Source
This commit is contained in:
martin
2001-12-06 04:23:25 +00:00
parent 4adbe73bba
commit 809c6752bd
17 changed files with 539 additions and 450 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/CHANGES
-8
View File
@@ -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
doc/COPYRIGHT → doc/COPYRIGHT.txt
View File
doc/INSTALL
-95
View File
@@ -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
[email protected]
doc/LICENCE
-281
View File
@@ -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
doc/NOTES
-3
View File
@@ -1,3 +0,0 @@
weeks dates start from 0:00 Monday morning
doc/ROADMAP
-15
View File
@@ -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.
doc/background.html
Executable
+22
View File
@@ -0,0 +1,22 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Moodle Docs: Background</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>Background</H2>
<P>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.</P>
<P>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.</P>
<P>&nbsp;</P>
<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>
</BODY>
</HTML>
doc/config.php
-48
View File
@@ -1,48 +0,0 @@
<?PHP // $Id$
///////////////////////////////////////////////////////////////////////////
//
// Moodle configuration file
//
// This file should be located in the top-level directory.
//
///////////////////////////////////////////////////////////////////////////
// Site configuration variables are all stored in the CFG object.
// First, we need to configure the database where all Moodle data
// will be stored. This database must already have been created
// and a username/password created to access it. See INSTALL doc.
$CFG->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
?>
doc/contents.html
Executable
+21
View File
@@ -0,0 +1,21 @@
<HEAD>
<!-- $Id$ -->
<TITLE>Moodle Docs: Table of Contents</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<FONT SIZE=2 FACE="san-serif">
<P><B>Moodle Documentation</B></P>
<LI><A TARGET="main" HREF="intro.html">Introduction</A>
<LI><A TARGET="main" HREF="background.html">Background</A>
<LI><A TARGET="main" HREF="install.html">Installation</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>
</BODY>
doc/credits.html
Executable
+102
View File
@@ -0,0 +1,102 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Moodle Docs: Credits</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>Credits</H2>
<P><B>Moodle </B>itself is Copyright &copy; 2001, <A HREF="http://dougiamas.com/">
Martin Dougiamas</A>. &nbsp;It is distributed under the <A HREF="licence.html">
GNU Public License</A>.</P>
<H3>Other contributors</H3>
<UL>
<LI><B>Dr Peter Taylor</B>, at Curtin University of Technology, for working
with the prototype and making many useful suggestions</LI>
</UL>
<BR>
<P></P>
<H3>Moodle libraries</H3>
<BLOCKQUOTE>
<P>Some of Moodle's libraries were written by other people, and are being
redistributed as part of Moodle under the LGPL. &nbsp;Copyright information
from this software is included below:</P>
<P><B>ADOdb &nbsp; </B>- &nbsp;lib/adodb<BR>
</P>
<BLOCKQUOTE>
<P>Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle,
Interbase, Foxpro, Access, ADO, Sybase, DB2 and ODBC.</P>
<P>Version: 1.54 15 Nov 2001&nbsp;<BR>
Copyright &copy; 2000, 2001 John Lim ([email protected])<BR>
License: Dual LGPL and BSD-style<BR>
URL: &nbsp;<A HREF="http://php.weblogs.com/adodb" TARGET="newpage">http://php.weblogs.com/adodb</A><BR>
</P>
</BLOCKQUOTE>
<P><B>Graph Class</B> &nbsp; - &nbsp;lib/graphlib.php </P>
<BLOCKQUOTE>
<P>Class to draw line, point, bar, and area graphs, including numeric
x-axis and double y-axis.</P>
<P> Version: 1.6.3<BR>
Copyright &copy;&nbsp;2000&nbsp; Herman Veluwenkamp,&nbsp;[email protected]<BR>
License: LGPL<BR>
</P>
</BLOCKQUOTE>
<P><B>PHP mailer</B> &nbsp; - &nbsp;lib/class.phpmailer.php<BR>
</P>
<BLOCKQUOTE>Class for sending email using either sendmail, PHP mail(),
or SMTP.&nbsp; Methods are based upon the standard AspEmail(tm) classes.<BR>
<BR>
Version 1.25, Created 07/02/2001<BR>
Copyright &copy; 2001 Brent R. Matzelle &lt;[email protected]&gt;<BR>
License: LGPL<BR>
<BR>
</BLOCKQUOTE>
<P><B>SMTP class &nbsp; </B>- &nbsp;lib/class.smtp.php<BR>
</P>
<BLOCKQUOTE>Class that can be used to connect and communicate with
any SMTP server. <BR>
It implements all the SMTP functions defined in RFC821 except TURN.<BR>
<BR>
Version: 03/26/2001 <BR>
Copyright &copy; 2001 &nbsp;Chris Ryan &lt;[email protected]&gt;<BR>
<BR>
</BLOCKQUOTE>
<P><B>PHP Simple Excel File Generator</B>&nbsp; - &nbsp; lib/psxlsgen.php</P>
<BLOCKQUOTE>Class to generate very simple MS Excel files (xls)
via PHP.<BR>
<BR>
Version: 0.3b<BR>
Copyright &copy; 2001 &nbsp;Erol Ozcan &lt;[email protected]&gt;<BR>
License: GNU LGPL<BR>
URL: <A HREF="http://psxlsgen.sourceforge.net">http://psxlsgen.sourceforge.net</A><BR>
</BLOCKQUOTE>
</BLOCKQUOTE>
<BLOCKQUOTE><BR>
</BLOCKQUOTE>
<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>
</BODY>
</HTML>
doc/developer.html
Executable
+22
View File
@@ -0,0 +1,22 @@
<HEAD>
<TITLE>Moodle Docs: Developers Manual</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H2>Developers Manual</H2>
<H3>Moodle architecture</H3>
<P>This section will describe the overall architecture for Moodle and some of
the major design decisions that were made during development.</P>
<P>&nbsp;</P>
<H3>Plug-in modules</H3>
<P>Moodle has been designed to be modular, so that new learning activities can
be easily written and &quot;plugged-in&quot; to a Moodle installation by the
system administrator.</P>
<P>This section will describe the Plug-in API and provide a simple example of
a Moodle plug-in.</P>
<P>&nbsp;</P>
<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>
</BODY>
doc/future.html
Executable
+63
View File
@@ -0,0 +1,63 @@
<HEAD>
<TITLE>Moodle Docs: Future</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H2>Future</H2>
<P>As Moodle gains in maturity, I hope its directions are strongly influenced
by the community of developers and users.</P>
<P>All unfinished features, proposed improvements and feature requests will be
gathered on this page.</P>
<P><B>General</B></P>
<UL>
<LI>Format of existing code should be checked and cleaned up (tabs etc). Define
a style guide.</LI>
<LI>All table inserts should be converted to use the insert_record function.</LI>
<LI>Full internationalisation of texts using modular "language packs". eg <A HREF="http://stphp.sourceforge.net/">STPhp</A></LI>
<LI>Implement pop-up help windows all over the site (from tiny help icons)</LI>
<LI>Users can specify their timezone so all times displayed are in local time
format.</LI>
<LI>Each course has a private &quot;teacher forum&quot; 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.</LI>
<LI>Assessment system: each module can be marked per student. All assessments
can be combined on one page.</LI>
<LI>More course formats.</LI>
<LI>Better WYSIWYG editing of texts (using Java or Flash).</LI>
<LI>Make this page more interactive. :-)</LI>
</UL>
<P><B>Assignment module</B></P>
<UL>
<LI>Module to allow submission and assessment of assignments (to be written).</LI>
</UL>
<P><B>Chat module</B></P>
<UL>
<LI>Re-implement chat room using Flash, and use user pictures.</LI>
</UL>
<P><B>Choice module</B></P>
<UL>
<LI>Add capability for more than two choices.</LI>
<LI>Add teacher option of publishing results (ie a poll).</LI>
</UL>
<P><B>Discussion module</B></P>
<UL>
<LI>Discussion forums need to have abbreviated topic display and pagination
for when they get very big.</LI>
<LI>Allow files to be attached to discussion posts (images etc).</LI>
</UL>
<P><B>Journal module</B></P>
<UL>
<LI>Journal summary index should show teacher remarks.</LI>
</UL>
<P><B>Survey module</B></P>
<UL>
<LI>Allow teachers to create and share surveys.</LI>
</UL>
<P ALIGN="CENTER">Send your additions, suggestions to <A HREF="mailto:[email protected]">Martin
Dougiamas</A>.</P>
<P ALIGN="CENTER">&nbsp;</P>
<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>
</BODY>
doc/index.html
+8
View File
@@ -0,0 +1,8 @@
<HEAD>
<TITLE>Moodle Documentation</TITLE>
</HEAD>
<FRAMESET COLS="200,*">
<FRAME NAME="contents" SRC="contents.html">
<FRAME NAME="main" SRC="intro.html">
</FRAMESET>
doc/install.html
Executable
+228
View File
@@ -0,0 +1,228 @@
<HEAD>
<TITLE>Moodle Docs: Installation</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H2>Installing Moodle</H2>
<P>This guide explains how to install Moodle for the first time.</P>
<P>Sections in this document:</P>
<OL>
<LI><A HREF="#requirements">Requirements</A></LI>
<LI><A HREF="#downloading">Download</A></LI>
<LI><A HREF="#site">Site structure</A></LI>
<LI><A HREF="#data">Create a data directory</A></LI>
<LI><A HREF="#database">Create a database</A></LI>
<LI><A HREF="#config">Edit config.php</A></LI>
<LI><A HREF="#admin">Go to the admin page</A></LI>
<LI><A HREF="#cron">Set up cron</A></LI>
<LI><A HREF="#course">Create a new course</A></LI>
</OL>
<H3><A NAME="requirements"></A>Requirements</H3>
<P>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.</P>
<P>All you should need are:</P>
<UL>
<LI>a working installation of <A HREF="http://www.php.net/">PHP</A> (version
4.0.6 or better), including the <A HREF="http://www.boutell.com/gd/">GD</A>
library for manipulating images.</LI>
<LI>a working database server (<A HREF="http://www.mysql.com/">MySQL</A>, PostgreSQL,
MSSQL, Oracle, Interbase, Foxpro, Access, ADO, Sybase, DB2 or ODBC)</LI>
</UL>
<P>The quickest way to satisfy these requirements on Windows platforms is to download
<A HREF="http://www.phpgeek.com/">PHPTriad</A> or <A HREF="http://www.foxserv.net/">FoxServ</A>,
which will install Apache, PHP, and MySQL for you.</P>
<P>&nbsp;</P>
<H3><A NAME="downloading"></A>Download</H3>
<P>There are two ways to get Moodle, as a compressed package and via CVS. These
are explained in detail on the download page on <A HREF="http://moodle.com/">http://moodle.com/</A></P>
<P>After downloading and unpacking the archive, or checking out the files via
CVS, you will be left with a directory called &quot;moodle&quot;, containing
a number of files and folders. </P>
<P>You can either place the whole folder in your web server documents directory,
in which case the site will be located at <B>http://yourwebserver.com/moodle</B>,
or you can copy all the contents straight into the main web server documents
directory, in which case the site will be simply <B>http://yourwebserver.com</B>.</P>
<P>&nbsp;</P>
<H3><A NAME="site"></A>Site structure</H3>
<P>Here is a quick summary of the contents of the Moodle folder, to help get you
oriented:</P>
<BLOCKQUOTE>
<P>config.php - the only file you need to edit to get started <BR>
index.php - the front page of the site</P>
<UL>
<LI>admin/ - code to administrate the whole server </LI>
<LI>course/ - code to display and manage courses </LI>
<LI>doc/ - help documentation for Moodle (eg this page)</LI>
<LI>files/ - code to display and manage uploaded files</LI>
<LI>lib/ - libraries of core Moodle code </LI>
<LI>login/ - code to handle login and account creation </LI>
<LI>mod/ - all Moodle course modules</LI>
<LI>pix/ - generic site graphics</LI>
<LI>theme/ - theme packs/skins to change the look of the site.</LI>
<LI>user/ - code to display and manage users</LI>
</UL>
<P>&nbsp;</P>
</BLOCKQUOTE>
<H3><A NAME="data"></A>Create a data directory</H3>
<P>Moodle will also need some space on your hard disk to store uploaded files,
such as course documents and user pictures.</P>
<P>Create a directory for this purpose somewhere <B>away</B> 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 &quot;nobody&quot; or &quot;apache&quot;.</P>
<P>&nbsp;</P>
<H3><A NAME="database"></A>Create a database</H3>
<P>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). </P>
<P>eg for MySQL: </P>
<PRE>
# 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
</PRE>
<P>&nbsp;</P>
<H3><A NAME="config"></A>Edit config.php</H3>
<P>Now you can edit the configuration file, config.php. This file is used by all
other files in Moodle.</P>
<P>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.</P>
<P>For the rest of this installation document we will assume your site is at:
http://example.com/moodle</P>
<P>&nbsp;</P>
<H3><A NAME="admin"></A>Go to the admin page</H3>
<P>The admin page should now be working at: http://example.com/moodle/admin</P>
<P>Go to this page using your favourite web browser.</P>
<P>The first time you access this page, Moodle will set up your database and prompt
you for more information.</P>
<P>Firstly, the main database tables are created. You should see a number of statements
like this (in green):</P>
<BLOCKQUOTE>
<P><FONT COLOR="#006600">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</FONT></P>
<P>...and so on, followed by: <FONT COLOR="#FF0000">Main databases set up successfully</FONT>.
</P>
</BLOCKQUOTE>
<P>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.</P>
<P>Press the &quot;Continue&quot; link at the bottom of the page.</P>
<P>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.</P>
<P>Press the &quot;Continue&quot; link at the bottom of the page.</P>
<P>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
&quot;Update the site&quot;.</P>
<P>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 &quot;Update this user&quot;. You will be returned to the main
admin page, which contain a number of links arranged in a menu.</P>
<P>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.</P>
<P>All your further configuration of Moodle can now be done using the administration
page menu, which includes tasks such as:</P>
<UL>
<LI>creating and deleting courses</LI>
<LI>administering teacher accounts</LI>
<LI>changing site-wide settings</LI>
</UL>
<P>&nbsp;</P>
<H3><A NAME="cron"></A>Set up cron</H3>
<P>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.</P>
<P>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
&quot;heartbeat&quot; so that the script can perform functions at periods defined
by each module.</P>
<P>For security reasons, this script defines a required password. Edit cron.php
with a text editor and change the password to something unique. eg </P>
<BLOCKQUOTE>
<PRE>$PASSWORD = &quot;pword&quot;;
</PRE>
</BLOCKQUOTE>
<P>Test that the script works by running it directly from your browser:</P>
<BLOCKQUOTE>
<PRE>http://example.com/moodle/admin/cron.php?p=pword</PRE>
</BLOCKQUOTE>
<P>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'. </P>
<BLOCKQUOTE>
<H4>External cron</H4>
<P>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':<BR>
</P>
<BLOCKQUOTE>
<PRE>wget -q -O /dev/null 'http://example.com/moodle/admin/cron.php?p=pword'</PRE>
</BLOCKQUOTE>
<P>Note in this example that the output is thrown away (to /dev/null).</P>
<P>To automate the running of this script every 5 minutes you can use Unix <B>cron</B>.
Edit your cron settings from the commandline using &quot;crontab -e&quot;
and add a line like:</P>
<BLOCKQUOTE>
<PRE>*/5 * * * * wget -q -O /dev/null 'http://example.com/moodle/admin/cron.php?p=pword'
</PRE>
</BLOCKQUOTE>
<P>On non-Unix platforms you will need to find another way to do this (and let
me know so I can update this documentation!)</P>
<H4>Internal cron</H4>
<P>To run the cron.php script internally, you need a version of PHP compiled
to be run from the command-line, also called a &quot;cgi&quot; version. On
a Unix machine, you can now run the script with your password as the first
parameter, something like this:</P>
<BLOCKQUOTE>
<PRE>/opt/bin/php /web/moodle/admin/cron.php pword</PRE>
</BLOCKQUOTE>
<P>As before you can automate this using Unix cron (or the equivalent on your
OS):</P>
<BLOCKQUOTE>
<PRE>*/5 * * * * (/opt/bin/php /web/moodle/admin/cron.php pword) &amp;&gt; /dev/null
</PRE>
</BLOCKQUOTE>
</BLOCKQUOTE>
<P>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.</P>
<P>&nbsp;</P>
<H3><A NAME="course"></A>Create a new course</H3>
<P>Now that Moodle is running properly, you can create a course. </P>
<P>Start on the admin page ( http://example.com/moodle/admin ) and select &quot;Create
a new course&quot;.</P>
<P>Fill out the form, paying special attention to the course format. </P>
<P>If you choose a &quot;weekly&quot; format, then course modules will be arranged
by &quot;weeks&quot;. 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.</P>
<P>The &quot;non-weekly&quot; format is for courses that don't have a start or
finish, and so any start/end dates you choose will be ignored.</P>
<P>Press &quot;Update this course&quot;, 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 &quot;Create a user account&quot; on the Admin page.</P>
<P>Once done, your course is ready to customise, and is accessible via the &quot;Courses&quot;
link on the home page.</P>
<P>See the &quot;<A HREF="teacher.html">Teacher Manual</A>&quot; for more details
on course-building.</P>
<P>&nbsp;</P>
<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>
</BODY>
doc/intro.html
Executable
+30
View File
@@ -0,0 +1,30 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Moodle Docs: Introduction</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>Introduction</H2>
<P>Moodle is a software package for producing internet-based courses and web sites.
It's an ongoing development project designed to support a <A HREF="http://dougiamas.com/writing/constructivism.html">constructivist</A>
framework of education. </P>
<P>Moodle is given away freely as <A HREF="http://www.opensource.org/docs/definition_plain.html">
Open Source</A> software (under the <A HREF="http://www.gnu.org/copyleft/gpl.html">
GNU Public License</A>). It will run on any computer that can run <A HREF="http://www.php.net/">
PHP</A>, and supports almost every brand of database.</P>
<P>The word Moodle is an acronym for Modular Object-Oriented Dynamic Learning
Environment, which is mostly useful to programmers and education theorists.&nbsp;
&nbsp;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.</P>
<P><BR>
</P>
<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>
</BODY>
</HTML>
doc/licence.html
Executable
+29
View File
File diff suppressed because one or more lines are too long
doc/teacher.html
Executable
+14
View File
@@ -0,0 +1,14 @@
<HEAD>
<TITLE>Moodle Docs: Teachers Manual</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H2>Teacher Manual</H2>
<P>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.</P>
<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>
</BODY>