MDL-4912 docs directory clean-up
This commit is contained in:
wildgirl
@@ -1,48 +1,13 @@
|
||||
Moodle documentation
|
||||
--------------------
|
||||
This directory used to contain lots of documentation in HTML form.
|
||||
|
||||
If you want to translate this documentation into another language,
|
||||
I would suggest that you:
|
||||
|
||||
1) don't include English versions of the files in this directory
|
||||
because they will be used automatically anyway if it is missing
|
||||
from your language pack.
|
||||
|
||||
2) translate them in this order (starting with the important ones):
|
||||
|
||||
MOST IMPORTANT
|
||||
|-------------------
|
||||
|
|
||||
| - files.php
|
||||
| - install.html
|
||||
| - installamp.html
|
||||
| - upgrade.html
|
||||
| - faq.html
|
||||
|
|
||||
| -----------------
|
||||
|
|
||||
| - teacher.html
|
||||
| - module_files.txt
|
||||
|
|
||||
| -----------------
|
||||
|
|
||||
| - intro.html
|
||||
| - features.html
|
||||
| - release.html
|
||||
|
|
||||
| -----------------
|
||||
|
|
||||
| - developer.html
|
||||
| - cvs.html
|
||||
| - future.html
|
||||
|
|
||||
| -----------------
|
||||
|
|
||||
| - license.html
|
||||
|
|
||||
|-------------------
|
||||
LEAST IMPORTANT
|
||||
|
||||
3) Please don't translate credits.html at all - it changes too much.
|
||||
All of it has gone now because we now use the Moodle Docs wiki.
|
||||
|
||||
|
||||
To find out the new locations for all the information that was here, see:
|
||||
|
||||
http://docs.moodle.org/en/MoodleDocs_and_lang_packs
|
||||
|
||||
http://tracker.moodle.org/browse/MDL-4912
|
||||
|
||||
Cheers,
|
||||
Martin Dougiamas, 10th July 2007
|
||||
|
||||
@@ -1,80 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Background</title>
|
||||
<link rel="stylesheet" href="./docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Background</h1>
|
||||
|
||||
<blockquote>
|
||||
<p>Moodle is an active and evolving work in progress. Development was started
|
||||
by <a href="http://moodle.org/user/view.php?id=1&course=1" target="_top">Martin
|
||||
Dougiamas</a> who continues to lead the project:</p>
|
||||
<blockquote>
|
||||
<p><em>I've been working on it, in some way or other, for several years. It
|
||||
started in the 90's when I was webmaster at <a target="_top" href="http://www.curtin.edu.au/">Curtin
|
||||
University of Technology</a> and a system administrator of their WebCT installation.
|
||||
I encountered many frustrations with the WebCT beast and developed an itch
|
||||
that needed scratching - there had to be a better way (no, not Blackboard
|
||||
:-)</em></p>
|
||||
<p><em>I also know a lot of people in schools and smaller institutions (and
|
||||
some big ones!) who want to make better use of the Internet but don't know
|
||||
where to start in the maze of technologies and pedagogies that are out there.
|
||||
I've always hoped there would be a Free alternative that such people could
|
||||
use to help them move their teaching skills into the online environment. </em></p>
|
||||
<p><em>My strong beliefs in the unrealised possibilities of Internet-based education
|
||||
led me to complete a Masters and then a PhD in Education, combining my former
|
||||
career in Computer Science with newly constructed knowledge about the nature
|
||||
of learning and collaboration. In particular, I am particularly influenced
|
||||
by the epistemology of social constructionism - which not only treats learning
|
||||
as a social activity, but focusses attention on the learning that occurs while
|
||||
actively constructing artifacts (such as texts) for others to see or use.
|
||||
</em></p>
|
||||
<p><em>It is crucial to me that this software be easy to use - in fact it should
|
||||
be as intuitive as possible. </em></p>
|
||||
<p><em>I'm committed to continuing my work on Moodle and on keeping it Open
|
||||
and Free. I have a deeply-held belief in the importance of unrestricted education
|
||||
and empowered teaching, and Moodle is the main way I can contribute to the
|
||||
realisation of these ideals.</em></p>
|
||||
</blockquote>
|
||||
<p>A number of early prototypes were produced and discarded before he released
|
||||
version 1.0 upon a largely unsuspecting world on August 20, 2002. This version
|
||||
was targeted towards smaller, more intimate classes at University level, and
|
||||
was the subject of research case studies that closely analysed the nature of
|
||||
collaboration and reflection that occurred among these small groups of adult
|
||||
participants.
|
||||
</p>
|
||||
<p>Since then there has been steady series of new releases adding new features,
|
||||
better scalability and improved performance.
|
||||
</p>
|
||||
<p>As Moodle has spread and the community has grown, more input is being drawn
|
||||
from a wider variety of people in different teaching situations. For example,
|
||||
Moodle is now used not only in Universities, but in high schools, primary schools,
|
||||
non-profit organisations, private companies, by independent teachers and even
|
||||
homeschooling parents. A growing number of people from around the world are
|
||||
contributing to Moodle in different ways - for more details see the <a href="?file=credits.html">Credits</a>
|
||||
page.
|
||||
</p>
|
||||
<p>An important feature of the Moodle project is the <a href="http://moodle.org" target="_top">moodle.org</a>
|
||||
web site, which provides a central point for information, discussion and collaboration
|
||||
among Moodle users, who include system administrators, teachers, researchers,
|
||||
instructional designers and of course, developers. Like Moodle, this site is
|
||||
always evolving to suit the needs of the community, and like Moodle it will
|
||||
always be Free.
|
||||
</p>
|
||||
<p>In 2003, the company <a href="http://moodle.com/" target="_top">moodle.com</a>
|
||||
was launched to provide additional commercial support for those who need it, as
|
||||
well as managed hosting, consulting and other services.
|
||||
</p>
|
||||
<p>For more about our future plans for Moodle, see the <a href="?file=future.html">Future</a>
|
||||
roadmap.</p>
|
||||
</blockquote>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,270 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Coding Guidelines</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
<body>
|
||||
<h1>Moodle Coding Guidelines</h1>
|
||||
<p class="normaltext">Any collaborative project needs consistency and stability
|
||||
to stay strong.</p>
|
||||
<p class="normaltext">These guidelines are to provide a goal for all Moodle code
|
||||
to strive to. It's true that some of the older existing code falls short in
|
||||
a few areas, but it will all be fixed eventually. All new code definitely must
|
||||
adhere to these standards as closely as possible.</p>
|
||||
<h2>General Rules</h2>
|
||||
<ol class="normaltext">
|
||||
<li class="spaced">All code files should use the .php extension.</li>
|
||||
<li class="spaced">All template files should use the .html extension.</li>
|
||||
<li class="spaced">All text files should use Unix-style text format (most text
|
||||
editors have this as an option).</li>
|
||||
<li class="spaced">All php tags must be 'full' tags like <font color="#339900"><?php
|
||||
?></font> ... not 'short' tags like <font color="#339900"><? ?></font>.
|
||||
</li>
|
||||
<li class="spaced">All existing copyright notices must be retained. You can
|
||||
add your own if necessary.</li>
|
||||
<li class="spaced">Each file should include the main config.php file.</li>
|
||||
<li class="spaced">Each file should check that the user is authenticated correctly,
|
||||
using the correct has_capability() or required_capability() checks.</li>
|
||||
<li class="spaced">All access to databases should use the functions in lib/datalib.php
|
||||
whenever possible - this allows compatibility across a wide range of databases.
|
||||
You should find that almost anything is possible using these functions. If you must write SQL code then make sure it is: cross-platform; restricted to specific functions
|
||||
within your code (usually a lib.php file); and clearly marked.</li>
|
||||
<li class="spaced">Don't create or use global variables except for the standard
|
||||
$CFG, $SESSION, $THEME and $USER.</li>
|
||||
<li class="spaced">All variables should be initialised or at least tested for
|
||||
existence using isset() or empty() before they are used.</li>
|
||||
<li class="spaced">All strings should be translatable - create new texts in
|
||||
the "lang/en" files with concise English lowercase names and retrieve them
|
||||
from your code using get_string() or print_string().</li>
|
||||
<li class="spaced">All help files should be translatable - create new texts
|
||||
in the "en/help" directory and call them using helpbutton().
|
||||
<p>If you need to update a help file: </p>
|
||||
<ul>
|
||||
<li>with a minor change, where an old translation of the
|
||||
file would still make sense, then it's OK to make the change
|
||||
but you should notify [email protected]</li>
|
||||
<li>for a major change you should create a new file by adding
|
||||
an incrementing number (eg filename2.html) so that translators
|
||||
can easily see it's a new version of the file. Obviously the
|
||||
new code and the help index files should also be modified to point
|
||||
to the newest versions.</li>
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
<li class="spaced">Incoming data from the browser (sent via GET or POST) automatically
|
||||
has magic_quotes applied (regardless of the PHP settings) so that you can safely
|
||||
insert it straight into the database. All other raw data (from files, or from databases)
|
||||
must be escaped with <font color="#339900">addslashes()</font> before inserting it into the database.</li>
|
||||
<li class="spaced">IMPORTANT: All texts within Moodle, especially those that have
|
||||
come from users, should be printed using the format_text() function. This ensures that
|
||||
text is filtered and cleaned correctly.</li>
|
||||
</ol>
|
||||
<p> </p>
|
||||
<h2>Coding Style</h2>
|
||||
<p class="normaltext">I know it can be a little annoying to change your style
|
||||
if you're used to something else, but balance that annoyance against the annoyance
|
||||
of all the people trying later on to make sense of Moodle code with mixed styles.
|
||||
There are obviously many good points for and against any style that people use,
|
||||
but the current style just <strong>is</strong>, so please stick to it. </p>
|
||||
<ol class="normaltext">
|
||||
<li class="spaced"><strong>Indenting</strong> should be consistently 4 spaces.
|
||||
Don't use tabs AT ALL. </li>
|
||||
<li class="spaced"><strong>Variable names</strong> should always be easy-to-read,
|
||||
meaningful lowercase English words. If you really need more than one word
|
||||
then run them together, but keep them short as possible. Use
|
||||
plural names for arrays of objects.
|
||||
<p class="examplecode"><font color="#006600">GOOD: $quiz<br />
|
||||
GOOD: $errorstring<br />
|
||||
GOOD: $assignments (for an array of objects)<br />
|
||||
GOOD: $i (but only in little loops)<br />
|
||||
<br />
|
||||
BAD: $Quiz <br />
|
||||
BAD: $aReallyLongVariableNameWithoutAGoodReason<br />
|
||||
BAD: $error_string</font></p>
|
||||
</li>
|
||||
<li class="spaced"><strong>Constants</strong> should always be in upper case,
|
||||
and always start with the name of the module. They should have words separated
|
||||
by underscores.
|
||||
<p class="examplecode"><font color="#006600">define("FORUM_MODE_FLATOLDEST",
|
||||
1);</font></p>
|
||||
</li>
|
||||
<li class="spaced"><strong>Function names</strong> should be simple English
|
||||
lowercase words, and start with the name of the module to avoid conflicts between modules.
|
||||
Words should be separated by underscores. Parameters should always have sensible
|
||||
defaults if possible. Note there is no space between the function name and
|
||||
the following (brackets). <br />
|
||||
<p class="examplecode"> <font color="#007700">function </font><font color="#0000BB">forum_set_display_mode</font><font color="#007700">(</font><font color="#0000BB">$mode</font><font color="#007700">=</font><font color="#0000BB">0</font><font color="#007700">)
|
||||
{<br />
|
||||
global </font><font color="#0000BB">$USER</font><font color="#007700">,
|
||||
</font><font color="#0000BB">$CFG</font><font color="#007700">;<br />
|
||||
<br />
|
||||
if (</font><font color="#0000BB">$mode</font><font color="#007700">)
|
||||
{<br />
|
||||
</font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode
|
||||
</font><font color="#007700">= </font><font color="#0000BB">$mode</font><font color="#007700">;<br />
|
||||
} else if (empty(</font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode</font><font color="#007700">))
|
||||
{<br />
|
||||
</font><font color="#0000BB">$USER</font><font color="#007700">-></font><font color="#0000BB">mode
|
||||
</font><font color="#007700">= </font><font color="#0000BB">$CFG</font><font color="#007700">-></font><font color="#0000BB">forum_displaymode</font><font color="#007700">;<br />
|
||||
}<br />
|
||||
}</font></p>
|
||||
</li>
|
||||
<li class="spaced"><strong>Blocks</strong> must always be enclosed in curly
|
||||
braces (even if there is only one line). Moodle uses this style:
|
||||
<p class="examplecode"> <font color="#006600">if (</font><font color="#0000CC">$quiz</font><font color="#006600">-></font><font color="#0000CC">attempts</font><font color="#006600">)
|
||||
{<br />
|
||||
if (</font><font color="#0000CC">$numattempts </font><font color="#006600">>
|
||||
</font><font color="#0000CC">$quiz</font><font color="#006600">-></font><font color="#0000CC">attempts</font><font color="#006600">)
|
||||
{<br />
|
||||
</font><font color="#0000CC">error</font><font color="#006600">(</font><font color="#0000BB">$strtoomanyattempts</font><font color="#006600">,
|
||||
</font><font color="#CC0000">"view.php?id=$cm</font><font color="#006600">-></font><font color="#CC0000">id"</font><font color="#006600">);<br />
|
||||
}<br />
|
||||
}</font></p>
|
||||
</li>
|
||||
<li class="spaced"><strong>Strings</strong> should be defined using single quotes
|
||||
where possible, for increased speed.<br />
|
||||
<p class="examplecode"> <font color="#006600">$var = 'some text without any
|
||||
variables';<br />
|
||||
$var = "with special characters like a new line \n";<br />
|
||||
$var = 'a very, very long string with a '.$single.' variable in it';<br />
|
||||
$var = "some $text with $many variables $within it"; </font></p>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="spaced"><strong>Comments</strong> should be added as much as is
|
||||
practical, to explain the code flow and the purpose of functions and variables.
|
||||
<ul>
|
||||
<li>Every function (and class) should use the popular
|
||||
<a target="_blank" href="http://www.phpdoc.org/">phpDoc format</a>.
|
||||
This allows code documentation to be generated automatically.</li>
|
||||
<li>Inline comments should use the // style, laid out neatly
|
||||
so that it fits among the code and lines up with it.</li>
|
||||
</ul>
|
||||
|
||||
<p class="examplecode"><font color="#FF8000">
|
||||
/**<br />
|
||||
* The description should be first, with asterisks laid out exactly<br />
|
||||
* like this example. If you want to refer to a another function,<br />
|
||||
* do it like this: {@link clean_param()}. Then, add descriptions <br />
|
||||
* for each parameter as follows.<br />
|
||||
*<br />
|
||||
* @param int $postid The PHP type is followed by the variable name<br />
|
||||
* @param array $scale The PHP type is followed by the variable name<br />
|
||||
* @param array $ratings The PHP type is followed by the variable name<br />
|
||||
* @return mixed<br />
|
||||
*/</font><br />
|
||||
<font color="#006600">function </font><font color="#0000BB">forum_get_ratings_mean</font><font color="#007700">(</font><font color="#0000BB">$postid</font><font color="#007700">,
|
||||
</font><font color="#0000BB">$scale</font><font color="#007700">, </font><font color="#0000BB">$ratings</font><font color="#007700">=</font><font color="#0000BB">NULL</font><font color="#007700">)
|
||||
{<br /></font>
|
||||
<font color="#007700">if (!</font><font color="#0000BB">$ratings</font><font color="#007700">)
|
||||
{<br />
|
||||
</font><font color="#0000BB">$ratings
|
||||
</font><font color="#007700">= array(); </font><font color="#FF8000">//
|
||||
Initialize the empty array</font><font color="#007700"><br />
|
||||
if (</font><font color="#0000BB">$rates
|
||||
</font><font color="#007700">= </font><font color="#0000BB">get_records</font><font color="#007700">(</font><font color="#DD0000">"forum_ratings"</font><font color="#007700">,
|
||||
</font><font color="#DD0000">"post"</font><font color="#007700">, </font><font color="#0000BB">$postid</font><font color="#007700">))
|
||||
{<br />
|
||||
</font><font color="#FF8000">//
|
||||
Process each rating in turn</font><font color="#007700"><br />
|
||||
foreach
|
||||
(</font><font color="#0000BB">$rates </font><font color="#007700">as </font><font color="#0000BB">$rate</font><font color="#007700">)
|
||||
{</font> <br />
|
||||
....etc </p>
|
||||
</li>
|
||||
|
||||
<li class="spaced"><strong>Space</strong> should be used liberally - don't be
|
||||
afraid to spread things out a little to gain some clarity. Generally, there
|
||||
should be one space between brackets and normal statements, but no space between
|
||||
brackets and variables or functions:<br />
|
||||
<p class="examplecode"> <font color="#007700">foreach (</font><font color="#0000BB">$objects
|
||||
</font><font color="#007700">as </font><font color="#0000BB">$key </font><font color="#007700">=></font><font color="#0000BB">
|
||||
$thing</font><font color="#007700">)</font><font color="#006600"> {<br />
|
||||
</font><font color="#007700"> </font><font color="#0000BB">process($thing);</font><font color="#006600">
|
||||
<br />
|
||||
} <br />
|
||||
<br />
|
||||
</font><font color="#007700">if (</font><font color="#0000BB">$x </font><font color="#007700">==
|
||||
</font><font color="#0000BB">$y</font><font color="#007700">)</font><font color="#006600">
|
||||
{<br />
|
||||
</font><font color="#007700"> </font><font color="#0000BB">$a
|
||||
</font><font color="#007700">= </font><font color="#0000BB">$b</font><font color="#007700">;</font><font color="#006600"><br />
|
||||
} else if (</font><font color="#0000BB">$x </font><font color="#007700">==
|
||||
</font><font color="#0000BB">$z</font><font color="#006600">) {<br />
|
||||
</font><font color="#007700"> </font><font color="#0000BB">$a
|
||||
</font><font color="#007700">= </font><font color="#0000BB">$c</font><font color="#007700">;</font><font color="#006600"><br />
|
||||
} else {<br />
|
||||
</font><font color="#007700"> </font><font color="#0000BB">$a
|
||||
</font><font color="#007700">= </font><font color="#0000BB">$d</font><font color="#007700">;</font><font color="#006600"><br />
|
||||
} </font></p>
|
||||
</li>
|
||||
</ol>
|
||||
<p> </p>
|
||||
<h2>Database structures</h2>
|
||||
<ol class="normaltext">
|
||||
<li class="spaced">Every table must have an auto-incrementing <strong>id</strong> field (INT10) as primary index.</li>
|
||||
<li class="spaced">The main table containing instances of each module must have the same name as the module (eg <strong>widget</strong>) and contain the following minimum fields:
|
||||
<ul>
|
||||
<li><strong>id</strong> - as described above</li>
|
||||
<li><strong>course</strong> - the id of the course that each instance belongs to</li>
|
||||
<li><strong>name</strong> - the full name of each instance of the module</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="spaced">Other tables associated with a module that contain information about 'things' should be named <strong>widget_things</strong> (note the plural).</li>
|
||||
<li class="spaced">Column names should be simple and short, following the same rules as for variable names.</li>
|
||||
<li class="spaced">Where possible, columns that contain a reference to the id field of another table (eg <strong>widget</strong>) should be called <strong>widgetid</strong>. (Note that this convention is newish and not followed in some older tables)</li>
|
||||
<li class="spaced">Boolean fields should be implemented as small integer fields (eg INT4) containing 0 or 1, to allow for later expansion of values if necessary.</li>
|
||||
<li class="spaced">Most tables should have a <strong>timemodified</strong> field (INT10) which is updated with a current timestamp obtained with the PHP <strong>time</strong>() function.</li>
|
||||
</ol>
|
||||
<p> </p>
|
||||
<h2>Security Issues (and handling form and URL data)</h2>
|
||||
<ol class="normaltext">
|
||||
<li class="spaced">Do not rely on 'register_globals'. <strong>Every</strong> variable must be
|
||||
properly initialised in <strong>every</strong> code file. It must be obvious where the variable
|
||||
came from</li>
|
||||
<li class="spaced">Initialise all arrays and objects, even if empty. <code>$a = array()</code>
|
||||
or <code>$obj = new stdClass();</code>.</li>
|
||||
<li class="spaced">Do not use the <code>optional_variable()</code> function. Use the <code>optional_param()</code>
|
||||
function instead. Pick the correct PARAM_XXXX value for the data type you expect. To check and set an optional
|
||||
value for a variable, use the <code>set_default()</code> function.</li>
|
||||
<li class="spaced">Do not use the <code>require_variable()</code> function. Use the <code>required_param()</code>
|
||||
function instead. Pick the correct PARAM_XXXX value for the data type you expect.</li>
|
||||
<li class="spaced">Use <code>data_submitted()</code>, with care. Data must still be cleaned before use.</li>
|
||||
<li class="spaced">Do not use <code>$_GET</code>, <code>$_POST</code> or <code>$_REQUEST</code>. Use the
|
||||
appropriate <code>required_param()</code> or <code>optional_param()</code> appropriate to your need.</li>
|
||||
<li class="spaced">Do not check for an action using something like <code>if (isset($_GET['something']))</code>.
|
||||
Use, e.g., <code>$something = optional_param( 'something',-1,PARAM_INT )</code> and then perform
|
||||
proper test for it being in its expected range of values e.g., <code>if ($something>=0) {...</code>.</li>
|
||||
<li class="spaced">Wherever possible group all your <code>required_param()</code>, <code>optional_param()</code>
|
||||
and other variables initialisation at the beginning of each file to make them easy to find.</li>
|
||||
<li class="spaced">Use 'sesskey' mechanism to protect form handling routines from attack.
|
||||
Basic example of use: when form is generated,
|
||||
include <code><input type="hidden" name="sesskey" value="<?php echo sesskey(); ?>" /></code>.
|
||||
When you process the form check with <code>if (!confirm_sesskey()) {error('Bad Session Key');}</code>.</li>
|
||||
<li class="spaced">All filenames must be 'cleaned' using the <code>clean_filename()</code> function, if this
|
||||
has not been done already by appropriate use of <code>required_param()</code> or <code>optional_param()</code>
|
||||
</li>
|
||||
<li class="spaced">Any data read from the database must have <code>addslashes()</code> applied to it before it
|
||||
can be written back. A whole object of data can be hit at once with <code>addslashes_object()</code>.</li>
|
||||
<li class="spaced">Wherever possible, data to be stored in the database must come from <code>POST</code>
|
||||
data (from a form with <code>method="POST"</code>) as opposed to <code>GET</code> data (ie, data from the URL line).</li>
|
||||
<li class="spaced">Do not use data from <code>$_SERVER</code> if you can avoid it. This has portability
|
||||
issues.</li>
|
||||
<li class="spaced">If it hasn't been done somewhere else, make sure all data written to the database has
|
||||
been through the <code>clean_param()</code> function using the appropriate PARAM_XXXX for the datatype.</li>
|
||||
<li class="spaced">If you write custom SQL code, make very sure it is correct. In particular watch out for
|
||||
missing quotes around values. Possible SQL 'injection' exploit.</li>
|
||||
<li class="spaced">Check all data (particularly that written to the database) in <strong>every</strong>
|
||||
file it is used. Do not expect or rely on it being done somewhere else.</li>
|
||||
<li class="spaced">Blocks of code to be included should contain a definite PHP structure (e.g,
|
||||
a class declaration, function definition(s) etc.) - straight blocks of code promote uninitialised
|
||||
variable usage.</li>
|
||||
</ol>
|
||||
<hr />
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,287 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Credits</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
<body>
|
||||
<h1>Credits</h1>
|
||||
<blockquote>
|
||||
<h2>Overall guidance</h2>
|
||||
<blockquote>
|
||||
<p><a href="http://dougiamas.com/" target="_top">Martin Dougiamas</a> is the originator, lead developer, project manager, release manager and general teaboy for the whole Moodle project. Do you take sugar?</p>
|
||||
<p>The Moodle software package is <a href="?file=licence.html">Copyright © 1999-2004, Martin Dougiamas under the GNU GPL</a>.</p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h2>Main Developers</h2>
|
||||
<blockquote>
|
||||
<p>A special thanks from all of us goes to those who have contributed substantial and ongoing amounts of time
|
||||
to writing Moodle code and helping it grow. These are people who "get" what developing Moodle is all about and without whom Moodle would be a far lesser thing:</p>
|
||||
<blockquote>
|
||||
<p>
|
||||
<strong> Eloy Lafuente (stronk7), Ray Kingdon, Williams Castillo, Petri Asikainen, Henrik Kaipe, Zbigniew Fiedorowicz, Gustav Delius, Thomas Robb, Janne Mikkonen, Jon Papaioannou (pj), Scott Elliott, Shane Elliott, Roberto Pinna (Bobo), Mike Churchward, Petr Škoda (skodak), Penny Leach, Martin Langhoff</strong></p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h2>Other Contributors</h2>
|
||||
<blockquote>
|
||||
<p>Many other people have contributed (and are still contributing) with constructive
|
||||
discussions, support, testing and various chunks of code and documentation. This list is long and always
|
||||
changing, but some names include (in the order they were added):
|
||||
</p>
|
||||
<blockquote>
|
||||
<p>
|
||||
<strong>Peter C. Taylor, Art Lader, Matt Hope, Tom Murdock, Sébastien Namèche, James Miller, Dustin
|
||||
Rue, Holger Schadeck, Giovanni Tummarello, John Windmueller, Sean Keogh, Mitsuhiro
|
||||
Yoshida, Greg Barnett, Mark Kimes, Mary Hunter, Russell Jungwirth, Przemyslaw Stencel,
|
||||
John "Captain" Eyre, Paula Edmiston, Howard Miller, Claudio Tavares, P. Timothy Ervin,
|
||||
Bob Calder, Ursula Raab, David Delgado, Mad Alex, Gaëtan Frenoy, Bernard Boucher,
|
||||
Bryan Williams, Rob Butner, Koen Roggemans, David Scotson, Torsten Anderson, Eamon Costello, Hannes Gassert, Andrew Walker, Urs Hunkler.</strong></p>
|
||||
</blockquote>
|
||||
<p>Sorry if we've forgotten to include your name here - the Moodle community is large and active so this list is difficult
|
||||
to maintain! Please email Martin and make your suggestions! :-) </p>
|
||||
<p>Thanks also to <strong>everyone</strong> of you who have
|
||||
</p>
|
||||
<ul>
|
||||
<li>donated via the <a target="_top" href="http://moodle.org/donations">Donations
|
||||
page</a>,
|
||||
</li>
|
||||
<li>contributed to the <a target="_top" href="http://moodle.org/bugs">bug tracker</a>,
|
||||
and
|
||||
</li>
|
||||
<li>participated in the <a target="_top" href="http://moodle.org/community">Moodle
|
||||
Community</a> </li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h2>Translators</h2>
|
||||
<blockquote>
|
||||
<p>One of Moodle's strengths is the number of translations it has. Each translation takes many hours of work, as there are
|
||||
over 1000 phrases to translate (plus hundreds of help files!). Many of the languages
|
||||
have more than one contributor, sometimes working together and sometimes working serially.
|
||||
</p>
|
||||
<p>Maintaining a list of all these wonderful people is too difficult, so please look at the <a target="_top" href="http://moodle.org/download/lang/">Language
|
||||
download page</a> for names and details.</p>
|
||||
<p>The Translation Coordinator is Koen Roggemans (<a href="mailto:tra%6es%6ca%74%69o%6e%40%6d%6f%6f%64%6c%65.org">translation@moodle.org</a>).</p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h2>Themes</h2>
|
||||
<blockquote>
|
||||
<p>Themes give Moodle sites some colour and life. Here are all the themes carried
|
||||
as part of the Moodle distribution, along with their authors:
|
||||
</p>
|
||||
<ul>
|
||||
<li><b>cornflower</b>, by Thomas Murdock, <a target="_top" href="http://thinkingdistance.com/">http://thinkingdistance.com/</a>
|
||||
</li>
|
||||
<li><strong>formal_white</strong>, by Andrea Bicciolo, <a target="_top" href="http://www.mediatouch.it/">http://www.mediatouch.it/</a>
|
||||
</li>
|
||||
<li><b>metal</b>, by A. Chavan, updated for Moodle 1.5 by Martin Dougiamas
|
||||
</li>
|
||||
<li><b>oceanblue</b>, by Mitsuhiro Yoshida, <a target="_top" href="http://mitstek.com">http://mitstek.com</a>
|
||||
</li>
|
||||
<li><b>orangewhite, orangewhitepda</b>, by Urs Hunkler, <a target="_top" href="http://unodo.de">http://unodo.de</a>
|
||||
</li>
|
||||
<li><b>standard and all standard* themes</b>, by Martin Dougiamas
|
||||
</li>
|
||||
<li><b>wood</b>, by Eloy Lafuente (stronk7)
|
||||
</li>
|
||||
</ul>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h2>Moodle libraries</h2>
|
||||
<blockquote>
|
||||
<p>Some of Moodle's libraries were written by other people, and are being redistributed
|
||||
as part of Moodle under their respective open source licenses that thankfully
|
||||
allow us to do so. My thanks go out to the authors of all these excellent
|
||||
products - without them Moodle would be missing important functionality. Copyright
|
||||
information for each package is included below:</p>
|
||||
|
||||
<p><b>ADOdb </b>- lib/adodb</p>
|
||||
<blockquote>
|
||||
<p>Database abstraction library for MySQL, PostgreSQL, MSSQL, Oracle, Interbase,
|
||||
Foxpro, Access, ADO, Sybase, DB2 and ODBC.</p>
|
||||
<p>Version: 4.71<br />
|
||||
Copyright © 2000-2006 John Lim ([email protected])<br />
|
||||
License: Dual LGPL and BSD-style<br />
|
||||
URL: <a href="http://adodb.sourceforge.net" target="newpage">http://adodb.sourceforge.net</a>
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>FPDF Class</b> - lib/fpdf</p>
|
||||
<blockquote>
|
||||
<p>Class to generate PDF files</p>
|
||||
<p>Version: 1.53<br />
|
||||
Copyright Olivier PLATHEY
|
||||
License: Freeware
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>Graph Class</b> - 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 (with modifications)<br />
|
||||
Copyright © 2000 Herman Veluwenkamp, [email protected]<br />
|
||||
License: LGPL
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>html2text</b> - lib/html2text.php</p>
|
||||
<blockquote>
|
||||
<p>PHP script to convert HTML into an approximate text equivalent</p>
|
||||
<p> Version: 1.0 (with modifications)<br />
|
||||
Copyright © 2002 Mark Wilton-Jones<br />
|
||||
License: <a href="http://www.howtocreate.co.uk/jslibs/termsOfUse.html">HowToCreate script license</a> with written permission<br />
|
||||
URL: <a href="http://www.howtocreate.co.uk/php/">http://www.howtocreate.co.uk/php/</a><br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>htmlArea</b> - lib/editor</p>
|
||||
<blockquote>
|
||||
<p>Javascript/HTML script to put a GUI editor in textareas on Internet Explorer and Mozilla</p>
|
||||
<p> Version: 3.0 beta (with modifications)<br />
|
||||
Copyright © 2002 <a href="http://interactivetools.com">interactivetools.com</a>, inc.<br />
|
||||
License: htmlArea License (based on BSD license)<br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>IP-Atlas</b> - lib/ipatlas</p>
|
||||
<blockquote>
|
||||
<p>PHP scripts to show the location of an IP address on a map.<br />
|
||||
<br />
|
||||
Version: 1.0 (with modifications)<br />
|
||||
Copyright © 2002 Ivan Kozik<br />
|
||||
License: GNU GPL<br />
|
||||
URL: <a href="http://www.xpenguin.com/ip-atlas.php" target="newpage">http://www.xpenguin.com/ip-atlas.php</a>
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>kses</b> - lib/kses.php</p>
|
||||
<blockquote>
|
||||
<p>HTML/XHTML filter that only allows some elements and attributes</p>
|
||||
<p>Version: 0.2.2<br />
|
||||
Copyright © 2002, 2003, 2005 Ulf Harnhammar <br />
|
||||
License: GNU GPL<br />
|
||||
URL: <a href="http://sourceforge.net/projects/kses" target="newpage">http://sourceforge.net/projects/kses</a>
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>mimeTeX</b> - filter/tex</p>
|
||||
<blockquote>
|
||||
<p>Compiled C program to convert TeX into GIFs<br />
|
||||
<br />
|
||||
Version: 1.4 <br />
|
||||
Copyright © 2002-2004 John Forkosh Associates, Inc<br />
|
||||
License: GNU GPL<br />
|
||||
URL: <a href="http://www.forkosh.com/mimetex.html">http://www.forkosh.com/mimetex.html</a><br />
|
||||
URL: <a href="http://moodle.org/download/mimetex">http://moodle.org/download/mimetex</a>
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>mp3player</b> - lib/mp3player</p>
|
||||
<blockquote>
|
||||
<p>Flash movie to play streaming MP3s<br />
|
||||
<br />
|
||||
Copyright © 2005 Andrew Walker<br />
|
||||
License: GNU GPL</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>overlibmws</b> - lib/overlib.js</p>
|
||||
<blockquote>
|
||||
<p>Javascript library to enable DHTML popups, floating windows, events etc<br />
|
||||
<br />
|
||||
Version: July 2004<br />
|
||||
Copyright © 2002-2004 Foteos Macrides<br />
|
||||
Copyright © 1998-2004 Erik Bosrup<br />
|
||||
License: Artistic Open Source License<br />
|
||||
URL: <a href="http://www.macridesweb.com/oltest/">http://www.macridesweb.com/oltest/</a>
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>PclZip</b> - lib/pclzip</p>
|
||||
<blockquote>
|
||||
<p>Class to create, manage and unpack zip files.<br />
|
||||
<br />
|
||||
Version: 2.4<br />
|
||||
Copyright © 2004 Vincent Blavet <[email protected]><br />
|
||||
License: GNU GPL<br />
|
||||
URL: <a href="http://www.phpconcept.net" target="newpage">http://www.phpconcept.net</a><br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>PHP mailer</b> - lib/class.phpmailer.php</p>
|
||||
<blockquote>
|
||||
<p>Class for sending email using either sendmail, PHP mail(), or SMTP.
|
||||
Methods are based upon the standard AspEmail(tm) classes.<br />
|
||||
<br />
|
||||
Version 1.71,<br />
|
||||
Copyright © 2003 Brent R. Matzelle <[email protected]><br />
|
||||
License: LGPL<br />
|
||||
URL: <a href="http://phpmailer.sourceforge.net" target="newpage">http://phpmailer.sourceforge.net</a><br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>PHP Markdown</b> - lib/markdown.php </p>
|
||||
<blockquote>
|
||||
<p>Functions to convert from the Markdown text format into clean XHTML.</p>
|
||||
<p> Version: 1.0b9 (with modifications)<br />
|
||||
Copyright © 2003-2004 , John Gruber<br />
|
||||
Copyright © 2004 , Michel Fortin<br />
|
||||
License: LGPL<br />
|
||||
URL: <a href="http://www.michelf.com/projects/php-markdown/" target="newpage">http://www.michelf.com/projects/php-markdown/</a><br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>Snoopy</b> - lib/snoopy</p>
|
||||
<blockquote>
|
||||
<p>A PHP net client<br />
|
||||
<br />
|
||||
Version: 1.2<br />
|
||||
Copyright © 1999-2000 Monte Ohrt <[email protected]><br />
|
||||
License: GNU LGPL<br />
|
||||
URL: <a href="http://snoopy.sourceforge.com">http://snoopy.sourceforge.net/</a><br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>Spreadsheet::WriteExcel</b> - lib/excel</p>
|
||||
<blockquote>
|
||||
<p>A library for generating Excel Spreadsheets.<br />
|
||||
<br />
|
||||
Version: 2002-11-28<br />
|
||||
Copyright © 2002 Xavier Noguer <[email protected]><br />
|
||||
License: GNU LGPL<br />
|
||||
URL: <a href="http://jeffn.users.phpclasses.org/browse.html/package/767.html" target="newpage">http://jeffn.users.phpclasses.org/browse.html/package/767.html</a><br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>SMTP class </b>- lib/class.smtp.php</p>
|
||||
<blockquote>
|
||||
<p>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 © 2001 Chris Ryan <[email protected]><br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
<p><b>Typo3 Character Set Class</b> - lib/typo3</p>
|
||||
<blockquote>
|
||||
<p>Class for conversion between charsets and multibyte-savy operations
|
||||
with strings.<br />
|
||||
<br />
|
||||
CVS version: 1.54<br />
|
||||
Copyright © 2003-2005 Kasper Skaarhoj<br />
|
||||
License: GNU GPL<br />
|
||||
URL: <a href="http://typo3.org/">http://typo3.org/</a><br />
|
||||
</p>
|
||||
</blockquote>
|
||||
|
||||
</blockquote>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</blockquote>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,216 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: How to use CVS</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
<style type="text/css">
|
||||
<!--
|
||||
style ol {margin-left:40px;}
|
||||
.style1 {color: #990000}
|
||||
.style3 {color: #990000; font-weight: bold; }
|
||||
.style4 {
|
||||
color: #0000CC;
|
||||
font-weight: bold;
|
||||
}
|
||||
-->
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>CVS for Moodle Developers</h1>
|
||||
<blockquote>
|
||||
<p>CVS is the <strong>Concurrent Versioning System</strong>, a commonly-used way of managing source code for large software projects. CVS keeps all versions of all files so that nothing is ever lost, and usage by different people is tracked. It also provides ways to merge code if two or more people are working on the same file. All code and all versions are stored on a central server (in the case of Moodle, at <a target="_top" href="http://www.sf.net/">Sourceforge</a>). </p>
|
||||
<p>If you just want to download Moodle using CVS to run a site, then you probably don't need this page - just follow the simpler CVS instructions on the <a target="_top" href="http://moodle.org/download">Moodle download page</a>.</p>
|
||||
<p> </p>
|
||||
<ol>
|
||||
<li><a href="#n1">Joining the project as a developer</a></li>
|
||||
<li><a href="#n2">CVS Modules</a> </li>
|
||||
<li><a href="#n3">Basic CVS Commands</a> <br />
|
||||
3.1. <a href="#n3.1">CVS on Unix</a> <br />
|
||||
3.2. <a href="#n3.2">CVS on Windows</a></li>
|
||||
<li> <a href="#n4">Working with Branches</a><br />
|
||||
4.1. <a href="#n4.1">Trunk development</a><br />
|
||||
4.2. <a href="#n4.2">Stable branches for each release</a><br />
|
||||
4.3. <a href="#n4.3">Feature branches for large changes</a> </li>
|
||||
</ol>
|
||||
</blockquote>
|
||||
<br />
|
||||
<h2><a name="n1" id="n1"></a>1. Joining the project as a developer</h2>
|
||||
<blockquote>
|
||||
<p>So, you've been offered CVS write access to help us develop and maintain Moodle! <a href="http://sourceforge.net/project/memberlist.php?group_id=30935">Welcome aboard</a>!</p>
|
||||
<p>To be able to write changes into <a target="_top" href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/moodle/moodle/">Moodle's CVS archive</a>, you first need to have an account at Sourceforge (<a href="http://sourceforge.net/account/register.php">registration is free and easy</a>). For the examples on this page, let's assume your username is <strong><font color="#990000">myusername</font></strong> and your password is <strong><font color="#990000">mypassword</font></strong>. Take special note of the sourceforge instructions to <a target="_top" href="http://sourceforge.net/docman/display_doc.php?docid=768&group_id=1#develhomedir">create your CVS home directory</a> - something you have to do with every new account to "enable" it for CVS. Basically you just have to use ssh to interactively connect to cvs.sourceforge.net.</p>
|
||||
<p>Once you have a working Sourceforge account, contact <a
|
||||
target="_top" href="http://moodle.org/user/view.php?id=1&course=1">Martin Dougiamas</a> so he can set up your account with write access to particular Moodle directories.</p>
|
||||
<p>To avoid being prompted for <strong><font color="#990000">mypassword</font></strong> every time you run a CVS command, follow the <a target="_top" href="http://sourceforge.net/account/editsshkeys.php">Sourceforge directions for using authorized keys</a>. This step is optional, but it can make your CVS experience a lot nicer.</p>
|
||||
<p>With that done, you should have all the permissions you need, so you just need to set up your machine and download the current sources so you can start working on them. </p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h2><a name="n2" id="n2"></a>2. CVS Modules</h2>
|
||||
<blockquote>
|
||||
<p>Within CVS, the word "modules" refers to separate collections of code. In Moodle we have the following modules within our repository:</p>
|
||||
<blockquote>
|
||||
<p><strong>moodle</strong> - the main Moodle source code</p>
|
||||
<p><strong>contrib</strong> - user contributions and other assorted code in development</p>
|
||||
<p><strong>mysql</strong> - a customised phpMyAdmin to plug into Moodle for database admin</p>
|
||||
<p><strong>windows-cron</strong> - a small package that makes cron possible on Windows systems</p>
|
||||
<p><strong>docs</strong> - various extra user-contributed documentation</p>
|
||||
</blockquote>
|
||||
<p>Most people are working on the existing features in the <strong>moodle</strong> module, but many are also contributing new ideas in the <strong>contrib</strong> modules. Once code reaches a certain level of maturity in the <strong>contrib</strong> area, it can be migrated over into the main <strong>moodle</strong> tree. </p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h2><a name="n3" id="n3"></a>3. Basic CVS Commands </h2>
|
||||
<blockquote>
|
||||
<h3><a name="n3.1" id="n3.1"></a>3.1 CVS on Unix </h3>
|
||||
<blockquote>
|
||||
<p>Sourceforge CVS uses ssh as a transport layer for security, so you will have to set a CVS_RSH environment variable in your Unix shell. It's best to put these commands in your .bashrc or .cshrc so you don't have to type it all the time<strong>:</strong></p>
|
||||
<div class="commandline">setenv CVS_RSH ssh <em>(for csh, tcsh etc)</em><br />
|
||||
export CVS_RSH=ssh <em>(for sh, bash etc)</em></div>
|
||||
<p>Next, you can check out the latest development version of Moodle using this (all one line): </p>
|
||||
<div class="commandline">cvs -z3 -d:ext:<span class="style1">myusername</span>@cvs.sourceforge.net:/cvsroot/moodle co moodle</div>
|
||||
<p>The command is similar for other CVS modules:</p>
|
||||
<div class="commandline">cvs -z3 -d:ext:[email protected]:/cvsroot/moodle co contrib</div>
|
||||
<p>Don't try to do run this first CVS command over an existing moodle installation: start fresh with a new directory.</p>
|
||||
<p>Note that you will be prompted for <strong><font color="#990000">mypassword</font></strong> for each command unless you set up <a target="_top" href="http://sourceforge.net/account/editsshkeys.php">authorized keys</a>.</p>
|
||||
<p>Now, you should have a new 'moodle' directory. You can rename it and move it around if you like. Go into it: </p>
|
||||
<div class="commandline">cd moodle </div>
|
||||
<p>All the latest Moodle files should be in there. You can now change files in your copy. To compare your files and directories against the main CVS copy on the server use cvs diff, e.g.: </p>
|
||||
<div class="commandline">cvs diff -c config-dist.php<br />
|
||||
cvs diff -c lang </div>
|
||||
<p>To fetch the latest updates from the server use: </p>
|
||||
<div class="commandline">cvs update -dP</div>
|
||||
<p>To copy your new files back to the server you would do something like: </p>
|
||||
<div class="commandline">cd lang/ca <br />
|
||||
cvs commit</div>
|
||||
<p>You will be prompted to add some comments (depends on your default text editor) ... add a meaningful comment and close the editor ... the files will be sent to Sourceforge and stored. Done! </p>
|
||||
<p>To save more time you can put default arguments into a file called .cvsrc in your home directory. For example, mine contains: </p>
|
||||
<div class="commandline">diff -c <br />
|
||||
update -dP</div>
|
||||
<p>Try 'cvs help' for more details ... </p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3><a name="n3.2" id="n3.2"></a>3.2 CVS on Windows </h3>
|
||||
<blockquote>
|
||||
<p>First, you need to download a completely fresh copy of Moodle using your developer account.</p>
|
||||
</blockquote>
|
||||
<ol>
|
||||
<li> Get TortoiseCVS from <a target="_top" href="http://www.tortoisecvs.org/">tortoisecvs.org</a> and install it, then reboot.</li>
|
||||
<li>Find or create a new folder somewhere where you want Moodle to be downloaded to.</li>
|
||||
<li>Right-mouse-click that folder and choose "<strong>CVS Checkout</strong>" from the menu. You should see a dialog box.</li>
|
||||
<li>Copy this text into the CVSROOT field (using your own username!):
|
||||
<pre> :ext:<font color="#990000">myusername</font>@cvs.sourceforge.net:/cvsroot/moodle</pre>
|
||||
</li>
|
||||
<li>Under the "Module" field, type "<strong>moodle</strong>" to get the latest development version of Moodle, "<strong>contrib</strong>" to get the contributions directory, or "<strong>mysql</strong>" to get the MySQL Admin module.</li>
|
||||
<li>Press the button: "<strong>OK</strong>" and everything should be downloaded.<br />
|
||||
</li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>A dialog box should show all the files being downloaded, and after a while you should have a complete copy of Moodle. After this first checkout, you can fetch the latest updated files from the CVS server:</p>
|
||||
</blockquote>
|
||||
<ol>
|
||||
<li> Right-mouse-click on your Moodle folder (or any file) and select "<strong>CVS Update</strong>". </li>
|
||||
<li>Sit back and watch the logs scroll by. Take note of conflicts that may occur if your local code has changes that conflict with the incoming versions - you will need to edit these files and resolve the conflicts manually. <br />
|
||||
</li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>After modifying files (you will notice their icons change from green to red!), you can commit them back to the CVS server like this:</p>
|
||||
</blockquote>
|
||||
<ol>
|
||||
<li> Right-mouse-click on your Moodle folder (or any file) and select "<strong>CVS Commit...</strong>".</li>
|
||||
<li>In the dialog box, type a clear description of the changes you are committing.</li>
|
||||
<li>Click "OK". Your changes will be sent to the server.<br />
|
||||
</li>
|
||||
</ol>
|
||||
<br />
|
||||
</blockquote>
|
||||
<h2><a name="n4" id="n4"></a>4. Working with Branches</h2>
|
||||
<blockquote>
|
||||
<p>This diagram shows how the main <strong>moodle</strong> module branches into different versions over time.</p>
|
||||
<p align="center"><img src="pix/cvstree.png" width="500" height="200" /></p>
|
||||
<p align="left">To see all the current tags and branches that are available, use this command on any old file (such as index.php in the top moodle directory):</p>
|
||||
<div class="commandline">cvs status -v index.php</div>
|
||||
<p>Some tagging guidelines:</p>
|
||||
<ul>
|
||||
<li>Tag and branch names should always be all upper-case.</li>
|
||||
<li>Tags and branches should ALWAYS be applied to the <strong>entire module</strong> (all of Moodle). Don't tag individual files or directories. </li>
|
||||
<li>We don't allow renaming of tags because people may be relying on them, so get them right the first time! </li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<br />
|
||||
<h3><a name="n4.1" id="n4.1"></a>4.1 Trunk development</h3>
|
||||
<blockquote>
|
||||
<p>The Trunk of CVS is the main development version of Moodle. In CVS it is also known as the <span class="style4">HEAD</span>, or default branch.</p>
|
||||
<p>Moodle developers try to keep this stable as possible, but as it usually contains new code it probably has bugs and small instabilities.</p>
|
||||
<p>Every now and then we decide the product has enough features to make a release. At this time, the trunk is tagged with a <strong>MOODLE_XX_BETA</strong> tag (in case we ever want to roll back to that point) and a new branch is formed for the release, called <span class="style1">MOODLE_XX_STABLE</span>. </p>
|
||||
<p>A Beta package is also released at this point - it's for testers who don't use CVS but want to test the latest features and report bugs.</p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h3><a name="n4.2" id="n4.2"></a>4.2 Stable branches for each release</h3>
|
||||
<blockquote>
|
||||
<p>As soon as the stable branch <span class="style3">MOODLE_XX_STABLE</span> is created, development efforts will fork into two streams for a while. Some people may continue working on new features in the trunk for the next release, but most developers should be concentrating on using the current <span class="style1"><strong>STABLE</strong></span> branch and fixing bugs that are found in it. </p>
|
||||
<p>You can switch your local copy of Moodle to the STABLE version using the following command in Unix from the root directory:</p>
|
||||
<div class="commandline">cvs update -dP -r <span class="style1">MOODLE_XX_STABLE</span></div>
|
||||
<p>After that, all the commands described above will apply to that stable version. To return to the trunk version just issue:</p>
|
||||
<div class="commandline">cvs update -dPA</div>
|
||||
<p>On Windows clients you should have a menu from which you can choose the branch. </p>
|
||||
<p>Once the new STABLE branch really stabilises, a release can be declared. Packages are created for distribution and the branch will be tagged (by Martin) with a tag named: <strong>MOODLE_XXX</strong></p>
|
||||
<p>Periodically, bug fixes in the STABLE branch should be merged into the trunk so that they become available in future versions of Moodle. A floating tag called MOODLE_XX_MERGED will be maintained to keep track of the last merge. The procedure for such a merge is as follows:</p>
|
||||
<ol>
|
||||
<li>Get out the very latest trunk version.<br />
|
||||
<br />
|
||||
<div class="commandline">cvs update -dPA</div>
|
||||
</li>
|
||||
<li>Merge everything on the branch since the last merge, into your trunk version<br /><br />
|
||||
<div class="commandline">cvs update -kk -j MOODLE_13_MERGED -j MOODLE_13_STABLE</div>
|
||||
</li>
|
||||
<li>Carefully watch the update logs for conflicts, and fix every file that you see with a conflict</li>
|
||||
<li>Check the merged copy back into CVS trunk version<br />
|
||||
<br />
|
||||
<div class="commandline">cvs commit</div>
|
||||
</li>
|
||||
<li>Go back to the branch version<br /><br />
|
||||
<div class="commandline">cvs update -dPr MOODLE_13_STABLE</div>
|
||||
</li>
|
||||
<li>Update the floating merge tag so that this process can be repeated next time<br /><br />
|
||||
<div class="commandline">cvs tag -RF MOODLE_13_MERGED</div>
|
||||
</li>
|
||||
</ol>
|
||||
<p><br />
|
||||
Finally, the values for <em>$version</em> in all the Moodle version.php files within the stable branch should not be updated at all if possible (except the last digit if necessary). The reason is that someone updating from a very stable version to the next very stable version could miss database upgrades that happened on the trunk. </p>
|
||||
</blockquote>
|
||||
<br />
|
||||
<h3><a name="n4.3" id="n4.3"></a>4.3 Feature branches for large changes </h3>
|
||||
<blockquote>
|
||||
<p>Occasionally, there may be a very large feature that needs to be checked in so several people can work on it, but it is too unstable to be included in the main development trunk.</p>
|
||||
<p>In these cases a short-term branch can be created to work on the feature, and then merged back into the main trunk as soon as possible. An example called <span class="style1"><strong>MOODLE_14_WIDGET</strong></span> branch can be seen in the above diagram.</p>
|
||||
<p>If you need to do this for your new WIDGET feature, follow these steps:</p>
|
||||
<ol>
|
||||
<li>Discuss with other developers to make sure it's necessary!</li>
|
||||
<li>Make a new tag on the <strong>trunk</strong> (for all of moodle) called <strong>MOODLE_XX_WIDGET_PRE</strong>
|
||||
<br /><br />
|
||||
<div class="commandline">cvs tag -R MOODLE_XX_WIDGET_PRE</div></li>
|
||||
<li>Create your branch called <span class="style1"><strong>MOODLE_XX_WIDGET</strong></span>
|
||||
<br /><br />
|
||||
<div class="commandline">cvs tag -Rb <span class="style1">MOODLE_XX_WIDGET</span></div></li>
|
||||
<li>Work in that branch until the feature is reasonably stable. Commit as necessary.
|
||||
<br /><br />
|
||||
<div class="commandline">cvs commit</div></li>
|
||||
<li>When ready, merge the whole branch into the trunk, fix conflicts, commit it to the trunk and then abandon the branch.
|
||||
<br />
|
||||
<br />
|
||||
<div class="commandline">
|
||||
<strong>cvs update -dPA</strong><br />
|
||||
<strong>cvs update -kk -j <span class="style1">MOODLE_XX_WIDGET</span></strong><br />
|
||||
<strong>cvs commit </strong></div>
|
||||
</li>
|
||||
</ol>
|
||||
</blockquote>
|
||||
<br />
|
||||
<blockquote>
|
||||
<p align="center">Good luck, be careful and have fun!</p>
|
||||
</blockquote>
|
||||
<br />
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,289 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Developers Manual</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Developers Manual</h1>
|
||||
<blockquote>
|
||||
<p>This document describes some of Moodle's design and how you can contribute.</p>
|
||||
<p>It's a bit thin at the moment - better documentation will come eventually!</p>
|
||||
<p>Sections in this document:</p>
|
||||
<ol>
|
||||
<li><a href="#architecture">Moodle architecture</a></li>
|
||||
<li><a href="#contribute">How you can contribute</a>
|
||||
<ul>
|
||||
<li><a href="#activities">Learning activities</a></li>
|
||||
<li><a href="#themes">Themes</a></li>
|
||||
<li><a href="#languages">Languages</a></li>
|
||||
<li><a href="#database">Database Schemas</a></li>
|
||||
<li><a href="#courseformats">Course formats</a></li>
|
||||
<li><a href="#doc">Documentation and articles</a></li>
|
||||
<li><a href="#bugs">Participating in the bug tracker</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h2><a name="architecture"></a>1. Moodle architecture</h2>
|
||||
<blockquote>
|
||||
<p>From a system administrator's perspective, Moodle has been designed according
|
||||
to the following criteria:</p>
|
||||
<ol>
|
||||
<li><strong>Moodle should run on the widest variety of platforms</strong><br />
|
||||
<br />
|
||||
The web application platform that runs on most platforms is PHP combined
|
||||
with MySQL, and this is the environment that Moodle has been developed in
|
||||
(on Linux, Windows, and Mac OS X). Moodle also uses the ADOdb library for
|
||||
database abstraction, which means Moodle can use <a href="http://php.weblogs.com/ADOdb_manual#drivers">more
|
||||
than ten different brands of database</a> (unfortunately, though, it can
|
||||
not yet <em><strong>set up tables</strong></em> in all these databases -
|
||||
more on this later). <br />
|
||||
<br />
|
||||
</li>
|
||||
<li><strong>Moodle should be easy to install, learn and modify</strong><br />
|
||||
<br />
|
||||
Early prototypes of Moodle (1999) were built using <a target="_top" href="http://www.zope.org/">Zope</a>
|
||||
- an advanced object-oriented web application server. Unfortunately I found
|
||||
that although the technology was pretty cool, it had a very steep learning
|
||||
curve and was not very flexible in terms of system administration. The PHP
|
||||
scripting language, on the other hand, is very easy to get into (especially
|
||||
if you've done any programming using any other scripting language). Early
|
||||
on I made the decision to avoid using a class-oriented design - again, to
|
||||
keep it simple to understand for novices. Code reuse is instead achieved
|
||||
by libraries of clearly-named functions and consistent layout of script
|
||||
files. PHP is also easy to install (binaries are available for every platform)
|
||||
and is widely available to the point that most web hosting services provide
|
||||
it as standard.<br />
|
||||
<br />
|
||||
</li>
|
||||
<li><strong>It should be easy to upgrade from one version to the next</strong><br />
|
||||
<br />
|
||||
Moodle knows what version it is (as well as the versions of all plug-in
|
||||
modules) and a mechanism has been built-in so that Moodle can properly upgrade
|
||||
itself to new versions (for example it can rename database tables or add
|
||||
new fields). If using CVS in Unix for example, one can just do a "cvs
|
||||
update -d" and then visit the site home page to complete an upgrade.<br />
|
||||
<br />
|
||||
</li>
|
||||
<li><strong>It should be modular to allow for growth</strong><br />
|
||||
<br />
|
||||
Moodle has a number of features that are modular, including themes, activities,
|
||||
interface languages, database schemas and course formats. This allows anyone
|
||||
to add features to the main codebase or to even distribute them separately.
|
||||
More on this below in the next section.<br />
|
||||
<br />
|
||||
</li>
|
||||
<li><strong>It should be able to be used in conjunction with other systems</strong><br />
|
||||
<br />
|
||||
One thing Moodle does is keep all files for one course within a single,
|
||||
normal directory on the server. This would allow a system administrator
|
||||
to provide seamless forms of file-level access for each teacher, such as
|
||||
Appletalk, SMB, NFS, FTP, WebDAV and so on. The authentication modules allow
|
||||
Moodle to use LDAP, IMAP, POP3, NNTP and other databases as sources for
|
||||
user information. Otherwise, there is work yet to do. Features planned for
|
||||
Moodle in future versions include: import and export of Moodle data using
|
||||
XML-based formats (including IMS and SCORM); and increased use of style
|
||||
sheets for interface formatting (so that it can be integrated visually into
|
||||
other web sites).</li>
|
||||
</ol>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h2><a name="contribute" id="contribute"></a>2. How you can contribute</h2>
|
||||
<blockquote>
|
||||
<p>As mentioned above, Moodle has a number of features that are modular. Even
|
||||
if you are not a programmer there are things you can change or help with.</p>
|
||||
<h3><a name="activities" id="activities"></a>Learning Activities</h3>
|
||||
<blockquote>
|
||||
<p>These are by far the most important modules, and reside in the 'mod' directory.
|
||||
There are a number of default modules: assignment, choice, forum, quiz, survey, wiki, etc. Each module is in a separate subdirectory and consists
|
||||
of the following mandatory elements (plus extra scripts unique to each module):</p>
|
||||
<ul>
|
||||
<li>mod.html: a form to set up or update an instance of this module</li>
|
||||
<li>version.php: defines some meta-info and provides upgrading code</li>
|
||||
<li>icon.gif: a 16x16 icon for the module</li>
|
||||
<li>db/: SQL dumps of all the required db tables and data (for each database
|
||||
type) </li>
|
||||
<li>index.php: a page to list all instances in a course</li>
|
||||
<li>view.php: a page to view a particular instance</li>
|
||||
<li>lib.php: any/all functions defined by the module should be in here.
|
||||
If the modulename if called widget, then the required functions include:
|
||||
<ul>
|
||||
<li>widget_add_instance() - code to add a new instance of widget</li>
|
||||
<li>widget_update_instance() - code to update an existing instance</li>
|
||||
<li>widget_delete_instance() - code to delete an instance</li>
|
||||
<li>widget_user_outline() - given an instance, return a summary of a
|
||||
user's contribution</li>
|
||||
<li>widget_user_complete() - given an instance, print details of a user's
|
||||
contribution<br />
|
||||
</li>
|
||||
<li>To avoid possible conflict, any module functions should be named
|
||||
starting with widget_ and any constants you define should start with
|
||||
WIDGET_ </li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Lastly, each module will have some language files that contain strings
|
||||
for that module. See below.</li>
|
||||
</ul>
|
||||
<p>The easiest way to start a new learning activity module is to use the template
|
||||
in <strong><a href="http://moodle.org/mod/newmodule_template.zip">mod/newmodule_template.zip</a>.</strong>
|
||||
Unzip it and follow the README inside. </p>
|
||||
<p>You might also like to post first in the <a href="http://moodle.org/mod/forum/view.php?id=44" target="_top">Activities
|
||||
modules forum on Using Moodle</a>.</p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3><a name="themes" id="themes"></a>Themes</h3>
|
||||
<blockquote>
|
||||
<p>Themes (or skins) define the look of a site. A number of simple themes
|
||||
are provided in the main distribution, but you may want to create your own
|
||||
theme with your own colours, logo, styles and graphics. </p>
|
||||
<p>Each theme is in a subdirectory of the "theme" directory, and
|
||||
contains at least the following files:</p>
|
||||
<ul>
|
||||
<li><strong>config.php</strong>: to configure how the CSS files work together. You can build your theme onto the standard or onto any parent theme, can include or exclude several CSS files.</li>
|
||||
<li><strong>styles.php</strong>: Builds the bridge to the CSS files. You don't need to edit anything.</li>
|
||||
<li><strong>header.html</strong>: Included at the top of each page. This
|
||||
is what you need to edit to add a logo at the top of pages, for example.</li>
|
||||
<li><strong>footer.html</strong>: Included at the bottom of each page.</li>
|
||||
<li><strong>styles_color.css</strong>: CSS styles for all colour properties.</li>
|
||||
<li><strong>styles_fonts.css</strong>: CSS styles for fonts, font-size, line-height etc.</li>
|
||||
<li><strong>styles_layout.css</strong>: CSS styles for the page layout, positioning etc.</li>
|
||||
<li><strong>styles_moz.css</strong>: CSS styles for Mozilla special rounded corners.</li>
|
||||
</ul>
|
||||
<p>To create your own themes for the current versions of Moodle:</p>
|
||||
<ol>
|
||||
<li>Copy one of the existing theme folders to one with a new name. I recommend
|
||||
starting with one of the standard themes. </li>
|
||||
<li>Edit config.php to meet your demands. </li>
|
||||
<li>Edit the CSS files with your styles. </li>
|
||||
<li>Edit header.html and footer.html to add new logos, or change the layout.
|
||||
</li>
|
||||
</ol>
|
||||
<p>Note also that Moodle upgrades <em>may</em> break themes slightly, so check
|
||||
the release notes carefully if you are using a custom theme.</p>
|
||||
<p>Please read the detailed description of Moodle themes in the Themes documentation in <a href="http://docs.moodle.org/wiki/Themes">Moodle Docs</a>.</p>
|
||||
<p>More discussion about themes in the <a target="_top" href="http://moodle.org/mod/forum/view.php?id=46">Themes
|
||||
forum on Using Moodle</a>. If you create a nice theme that you think others
|
||||
might want to use, please post your zip file on the themes forum!<br />
|
||||
</p>
|
||||
</blockquote>
|
||||
<h3><a name="languages" id="languages"></a>Languages</h3>
|
||||
<blockquote>
|
||||
<p>Moodle has been designed for internationalisation. Each 'string' or 'page'
|
||||
of text that is displayed as part of the interface is drawn from a set of
|
||||
language files. Each language is a subdirectory of the directory 'lang'.
|
||||
The structure of the lang directory is as follows:</p>
|
||||
<p><strong>lang/en</strong> - directory containing all files for one language
|
||||
(eg English)</p>
|
||||
<ul>
|
||||
<li>moodle.php - strings for main interface</li>
|
||||
<li>assignment.php - strings for assignment module</li>
|
||||
<li>choice.php - strings for choice module</li>
|
||||
<li>forum.php - strings for forum module</li>
|
||||
<li>quiz.php - strings for quiz module</li>
|
||||
<li>resource.php - strings for resource module</li>
|
||||
<li>survey.php - strings for survey module</li>
|
||||
<li>.... plus other modules if any.<br />
|
||||
<br />
|
||||
A string is called from these files using the <strong><em>get_string()</em></strong> or<em> <strong>print_string()</strong> </em>functions. Each string
|
||||
supports variable substitution, to support variable ordering in different
|
||||
languages.<em><br />
|
||||
<br />
|
||||
</em>eg $strdueby = get_string("assignmentdueby", "assignment",
|
||||
userdate($date)); <br />
|
||||
<br />
|
||||
If a string doesn't exist in a particular language, then the equivalent
|
||||
in English will automatically be used instead.</li>
|
||||
</ul>
|
||||
<p><strong>lang/en/help</strong> - contains whole help pages (for popup context-sensitive
|
||||
help)</p>
|
||||
<blockquote>
|
||||
<p>Main help pages are situated here, while help pages specific to each
|
||||
module are located in subdirectories with the module's name.</p>
|
||||
<p>You can insert a helpbutton in a page with the helpbutton function.</p>
|
||||
<p>eg helpbutton("text", "Click here for help about text");</p>
|
||||
<p>and for modules:</p>
|
||||
<p>helpbutton("forumtypes", "Forum types", "forum");</p>
|
||||
</blockquote>
|
||||
<p>Note that you can edit languages online, using the administration web tools
|
||||
under "Check this language". This makes it easy to not to only
|
||||
create new languages but to refine existing ones. If you are starting a
|
||||
new language, please contact me, <a target="_top" href="http://dougiamas.com/">Martin
|
||||
Dougiamas</a>. </p>
|
||||
<p>You might also like to post in the <a target="_top" href="http://moodle.org/mod/forum/view.php?id=43">Languages
|
||||
forum on Using Moodle</a>. </p>
|
||||
<p>If you are maintaining a language an ongoing basis, I can give you <a href="?file=cvs.html">CVS
|
||||
write access to the Moodle source code</a> so that you can directly maintain
|
||||
the files.</p>
|
||||
</blockquote>
|
||||
<h3><a name="database" id="database"></a>Database Schemas</h3>
|
||||
<blockquote>
|
||||
<p>Given a working database with defined tables, the intentionally simple
|
||||
SQL used in Moodle should work fine with a wide variety of database brands.</p>
|
||||
<p>A problem exists with <strong>automatically creating</strong> new tables
|
||||
in a database, which is what Moodle tries to do upon initial installation.
|
||||
Because every database is very different, there doesn't yet exist any way
|
||||
to do this in a platform-independent way. To support this automation in
|
||||
each database, schemas can be created that list the required SQL to create
|
||||
Moodle tables in a particular database. These are files in <strong>lib/db</strong>
|
||||
and inside the <strong>db</strong> subdirectory of each module.</p>
|
||||
<p>Currently, only MySQL and PostgreSQL are fully supported in this way (no-one
|
||||
wrote the schemas for other brands).</p>
|
||||
<p>Moodle 1.2 will use a new method of database-independent XML schemas that
|
||||
will make all this unnecessary.</p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h3><a name="courseformats" id="courseformats"></a>Course Formats</h3>
|
||||
<blockquote>
|
||||
<p>Moodle currently supports three different course formats: weekly, topics
|
||||
and social. </p>
|
||||
<p>These are a little more connected to the rest of the code (and hence, less
|
||||
"pluggable") but it is still quite easy to add new ones.</p>
|
||||
<p>If you have any ideas for different formats that you need or would like
|
||||
to see, get in touch with me and I'll do my absolute best to have them available
|
||||
in future releases.</p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h3><a name="doc" id="doc"></a>Documentation and articles</h3>
|
||||
<blockquote>
|
||||
<p>If you feel like writing a tutorial, an article, an academic paper or anything
|
||||
else about Moodle, please do! </p>
|
||||
<p>Put it on the web and make sure you include links to <a target="_top" href="http://moodle.org/">http://moodle.org/</a></p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h3><a name="bugs" id="bugs"></a>Participating in the bug tracker</h3>
|
||||
<blockquote>
|
||||
<p>Finally, I would like to invite you to register on the "bug tracker"
|
||||
at <a target="_top" href="http://moodle.org/bugs/">http://moodle.org/bugs</a>
|
||||
so you can file any bugs that you find and perhaps participate in discussing
|
||||
and fixing them. </p>
|
||||
<p>"Bugs" not only includes software bugs with current versions
|
||||
of Moodle, but also new ideas, feature requests and even constructive criticism
|
||||
of existing features. The beauty of open source is that anyone can participate
|
||||
in some way and help to create a better product for all of us to enjoy.
|
||||
In this project, your input is very welcome!</p>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<blockquote>
|
||||
<blockquote>
|
||||
<blockquote>
|
||||
<p align="center">Thanks for using Moodle!<br />
|
||||
<br />
|
||||
<a target="_top" href="http://dougiamas.com/">Martin Dougiamas</a>, Lead
|
||||
Developer </p>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<blockquote>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,134 +0,0 @@
|
||||
body, td, th, li {
|
||||
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
|
||||
background-color: #FFFFFF;
|
||||
}
|
||||
|
||||
th {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
a:link {
|
||||
text-decoration: none;
|
||||
color: blue;
|
||||
}
|
||||
|
||||
a:visited {
|
||||
text-decoration: none;
|
||||
color: blue;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
color: red;
|
||||
}
|
||||
|
||||
form {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
|
||||
li {
|
||||
margin-bottom: 10px;
|
||||
|
||||
}
|
||||
|
||||
.question {
|
||||
font-size: medium;
|
||||
font-weight: bold;
|
||||
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
|
||||
border: 1px dotted;
|
||||
padding: 10px;
|
||||
background-color: #EEEEEE;
|
||||
}
|
||||
|
||||
.answer {
|
||||
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
|
||||
font-size: medium;
|
||||
border: none;
|
||||
padding-left: 40px;
|
||||
}
|
||||
|
||||
.normaltext {
|
||||
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
|
||||
font-size: medium;
|
||||
border: none;
|
||||
margin-left: 30px;
|
||||
|
||||
}
|
||||
|
||||
.answercode {
|
||||
font-family: "Courier New", Courier, mono;
|
||||
font-size: small;
|
||||
border: none;
|
||||
padding-left: 60px;
|
||||
}
|
||||
|
||||
.questionlink {
|
||||
font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif;
|
||||
font-size: medium;
|
||||
border: none;
|
||||
padding-left: 40px;
|
||||
}
|
||||
|
||||
.examplecode {
|
||||
font-family: "Courier New", Courier, mono;
|
||||
font-size: small;
|
||||
border: thin dashed #999999;
|
||||
background-color: #FBFBFB;
|
||||
margin: auto;
|
||||
padding: 30px;
|
||||
height: auto;
|
||||
width: auto;
|
||||
}
|
||||
h1 {
|
||||
font-weight: bold;
|
||||
color: #000000;
|
||||
background-color: #CCCCCC;
|
||||
padding: 5px;
|
||||
font-size: large;
|
||||
border-width: 1px;
|
||||
border-color: #CCCCCC;
|
||||
-moz-border-radius: 10px;
|
||||
}
|
||||
h2 {
|
||||
font-weight: bold;
|
||||
color: #FFFFFF;
|
||||
background-color: #666666;
|
||||
padding: 5px;
|
||||
font-size: medium;
|
||||
border-width: 1px;
|
||||
border-color: #666666;
|
||||
-moz-border-radius: 10px;
|
||||
}
|
||||
h3 {
|
||||
font-weight: normal;
|
||||
color: #FFFFFF;
|
||||
background-color: #666666;
|
||||
padding: 5px;
|
||||
font-size: medium;
|
||||
-moz-border-radius: 10px;
|
||||
}
|
||||
.spaced {
|
||||
|
||||
margin-bottom: 30px;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin-top: 10px;
|
||||
|
||||
}
|
||||
.commandline {
|
||||
font-family: "Courier New", Courier, mono;
|
||||
font-size: x-small;
|
||||
background-color: #FBFBFB;
|
||||
margin: auto auto 20px 30px;
|
||||
padding: 5px;
|
||||
height: auto;
|
||||
width: auto;
|
||||
font-weight: bold;
|
||||
border: 1px solid #999999;
|
||||
white-space: nowrap;
|
||||
display: compact;
|
||||
clear: both;
|
||||
float: none;
|
||||
}
|
||||
@@ -1,806 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Frequently Asked Questions (FAQ)</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Frequently Asked Questions (FAQ)</h1>
|
||||
<p class="normaltext">This page contains answers to some of the most
|
||||
frequently asked questions by people installing Moodle. If you have
|
||||
followed the <a href="./?file=install.html">installation instructions</a> but
|
||||
you still have a problem, then this page is probably the best place to be. </p>
|
||||
|
||||
<p class="normaltext">If you don't find your answer here try the <a href="http://moodle.org/mod/forum/index.php?id=5" target="_top">Using
|
||||
Moodle</a> course on moodle.org. Start by searching the forums using a few keywords,
|
||||
in case your problem has already been discussed. If you don't find
|
||||
anything, then try posting your question into the appropriate forum - somebody will
|
||||
usually be able to help you.</p>
|
||||
|
||||
|
||||
<p class="normaltext">If you have tried a number of solutions without resolving an issue,
|
||||
and you are running behind a firewall, it may be advisable to try re-configuring your
|
||||
firewall to ensure that it is not blocking a required function or necessary communication.
|
||||
Firewalls very rarely cause problems with Moodle but are occasionally responsible for
|
||||
reduced functionality due to a mis-configuration in the firewall settings.
|
||||
|
||||
|
||||
|
||||
<p class="normaltext">Use this list to jump to the appropriate answer below:</p>
|
||||
|
||||
<p class="questionlink"><a href="#filenotfound">Whenever I try to access or view a file that I uploaded, I get an error "File not Found"</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#php">PHP - is it installed and what version do I have?</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#blankpages">Why are all my pages blank?</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#errorgetstring">My pages show fatal errors such as : call to undefined function: get_string()</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#headerssent">Why do I keep getting error messages about "headers already sent"?</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#failedopen">I keep getting this error: Failed opening required '/web/moodle/lib/setup.php'</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#quotes">Any text I add with an apostrophe (') or a quote (") causes errors or comes up with a slash added</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#sessiontmp">I keep getting error messages about session_start</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#fixdirroot">When I go to the admin page, I get told to make dirroot blank!</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#loginsetting">I login but the login link doesn't change. I am logged in and can navigate freely.</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#resource1">When trying to add a resource I receive error messages.</a></p>
|
||||
|
||||
|
||||
|
||||
<p class="questionlink"><a href="#noadmin">During the initial setting-up process, I never get asked to create an admin account!</a></p>
|
||||
|
||||
<p class="questionlink"><a href="#nologin">I can't log in at all- I just stay stuck on the login screen.</a></p>
|
||||
|
||||
<p class="questionlink"><a href="#backup">How do I backup my Moodle site?</a></p>
|
||||
|
||||
<p class="questionlink"><a href="#locale">Why doesn't my Moodle site display the
|
||||
|
||||
time & date correctly?</a></p>
|
||||
|
||||
<p class="questionlink"><a href="#cron">Email copies are not being sent
|
||||
|
||||
from my forums</a></p>
|
||||
|
||||
<p class="questionlink"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="filenotfound"></a>Whenever I try to access or view
|
||||
|
||||
|
||||
|
||||
a file that I uploaded, I get an error "File not Found"</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">For example: Not Found: The requested URL /moodle/file.php/2/myfile.jpg
|
||||
|
||||
|
||||
|
||||
was not found on this server. </p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Your web server needs to be configured to allow the part of
|
||||
|
||||
|
||||
|
||||
the URL after a script name to be passed directly to the script. This is usually
|
||||
|
||||
|
||||
|
||||
enabled in Apache 1, but is usually disabled by default in Apache 2. To turn
|
||||
|
||||
|
||||
|
||||
it on, add this line to your httpd.conf, or to a .htaccess file in your local
|
||||
|
||||
|
||||
|
||||
directory (see the <a href="./?file=install.html#webserver">Install documentation</a>
|
||||
|
||||
|
||||
|
||||
for more details): </p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode"><b>AcceptPathInfo</b> on</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Note, this will ONLY work for Apache versions 2.x. </p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">If you are not using Apache 2 and you still have this problem
|
||||
|
||||
|
||||
|
||||
(unlikely) then you can switch Moodle to use an alternative method. The disadvantages
|
||||
|
||||
|
||||
|
||||
are a slight loss of performance for your users and you won't be able to use
|
||||
|
||||
|
||||
|
||||
relative links within HTML resources. </p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">To use this alternative method: login as Admin, go into the
|
||||
|
||||
|
||||
|
||||
"Configure Variables" page and change the setting for "<b>slasharguments</b>".
|
||||
|
||||
|
||||
|
||||
You should now be able to access your uploaded files.</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="php"></a>PHP - is it installed and what version
|
||||
|
||||
|
||||
|
||||
do I have?</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Make a new file on your web site called info.php, containing the following
|
||||
|
||||
|
||||
|
||||
text, and call it from your browser:</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="answercode"><?PHP phpinfo() ?></p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">If nothing happens then you don't have PHP installed. See the
|
||||
|
||||
|
||||
|
||||
installation docs for some information about where to download it for your computer.</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
<h3><a name="blankpages"></a>Why are all my pages blank? </h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Check the dirroot variable in config.php. You must use complete,
|
||||
|
||||
|
||||
|
||||
absolute pathnames, eg:</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode"> $CFG->dirroot = "d:\inetpub\sites\www.yoursite.com\web\moodle";</p>
|
||||
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Redhat Linux platform please see: <a href="http://moodle.org/doc/?file=installamp.html">Redhat Linux</a></p>
|
||||
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
|
||||
<h3><a name="errorgetstring"></a>My pages show fatal errors such
|
||||
|
||||
|
||||
|
||||
as : call to undefined function: get_string()</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">If you see errors like:</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">Parse error: parse error, unexpected T_VARIABLE in c:\program
|
||||
|
||||
|
||||
|
||||
files\easyphp\www\moodle\config.php on line 94 <br />
|
||||
|
||||
|
||||
|
||||
Fatal error: Call to undefined function: get_string() in c:\program files\easyphp\www\moodle\mod\resource\lib.php
|
||||
|
||||
|
||||
|
||||
on line 11</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">then it's likely you have left out a semi-colon or ending quote
|
||||
|
||||
|
||||
|
||||
from a line in config.php (previous to line 94).</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Another reason could be that you have opened config.php in a
|
||||
|
||||
|
||||
|
||||
program like Word to edit it, and saved it as a HTML web page, instead of a
|
||||
|
||||
|
||||
|
||||
proper text file.</p>
|
||||
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
|
||||
<h3><a name="headerssent"></a>Why do I keep getting error messages
|
||||
|
||||
|
||||
|
||||
about "headers already sent"?</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">If you see errors like this:</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">Warning: Cannot add header information - headers already
|
||||
|
||||
|
||||
|
||||
sent by (output started at /webs/moodle/config.php:87) in /webs/moodle/lib/moodlelib.php
|
||||
|
||||
|
||||
|
||||
on line 1322 </p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode"> Warning: Cannot add header information - headers already
|
||||
|
||||
|
||||
|
||||
sent by (output started at /webs/moodle/config.php:87) in /webs/moodle/lib/moodlelib.php
|
||||
|
||||
|
||||
|
||||
on line 1323 </p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode"> Warning: Cannot add header information - headers already
|
||||
|
||||
|
||||
|
||||
sent by (output started at /webs/moodle/config.php:87) in /webs/moodle/login/index.php
|
||||
|
||||
|
||||
|
||||
on line 54 </p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">You have blank lines or spaces after the final ?> in your config.php
|
||||
|
||||
|
||||
|
||||
file. Sometimes text editors add these - for example Notepad on Windows - so
|
||||
|
||||
|
||||
|
||||
you may have to try a different text editor to remove these spaces or blank
|
||||
|
||||
|
||||
|
||||
lines completely. </p>
|
||||
|
||||
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
<h3><a name="failedopen"></a>I keep getting this error: Failed
|
||||
|
||||
|
||||
|
||||
opening required '/web/moodle/lib/setup.php'</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">In your config.php, the setting that you use for the dirroot
|
||||
|
||||
|
||||
|
||||
variable must be the <strong>complete path from the root of your server's hard
|
||||
|
||||
|
||||
|
||||
drive</strong>.</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Sometimes people only use the path from their home directory,
|
||||
|
||||
|
||||
|
||||
or relative to the root of the web server directory.</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
<h3><a name="quotes" id="quotes"></a>Any text I add with an apostrophe
|
||||
|
||||
|
||||
|
||||
(') or a quote (") causes errors or comes up with a slash added</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Problems caused by apostrophes are caused by incorrect "magic
|
||||
|
||||
|
||||
|
||||
quotes" settings. Moodle requires the following settings (which are usually
|
||||
|
||||
|
||||
|
||||
the default):</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">magic_quotes_gpc = On<br />
|
||||
|
||||
|
||||
|
||||
magic_quotes_runtime = Off</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">See the section on <a href="./?file=install.html#webserver">webserver
|
||||
|
||||
configuration</a> in the Installation docs for more details.</p>
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="sessiontmp"></a>I keep getting error messages about session_start</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">If you see errors like this:</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">Warning: session_start() [function.session-start]: open(/tmp\sess_d40f380d37d431fc1516e9a895ad9ce0, O_RDWR) failed: No such file or directory (2) in G:\web\moodle\lib\setup.php on line 123</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">Warning: session_start() [function.session-start]: open(/tmp\sess_d40f380d37d431fc1516e9a895ad9ce0, O_RDWR) failed: No such file or directory (2) in G:\web\moodle\lib\setup.php on line 123</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">Warning: session_start() [function.session-start]: Cannot send session cache limiter - headers already sent (output started at G:\web\moodle\lib\setup.php:1) in G:\web\moodle\lib\setup.php on line 123</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="answer">... these are all related to the fact that PHP is failing to save
|
||||
|
||||
|
||||
|
||||
"session" files on your hard disk (in a directory called /tmp). Usually the
|
||||
|
||||
|
||||
|
||||
reason is that you don't HAVE a directory called /tmp on your computer. This
|
||||
|
||||
|
||||
|
||||
is usually the case with Windows installations.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="answer">The solution is to fix the PHP setting for this path to point to a real directory. You can do this in your php.ini file:</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">session.save_path = C:\temp</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">or otherwise in a .htaccess file in your main moodle directory:</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">php_value session.save_path "/home/moodle/sessions"</p>
|
||||
|
||||
<p class="answercode"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="fixdirroot"></a>When I go to the admin page, I get told to make dirroot blank!</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">If you see errors like this in Moodle 1.0.9:</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<table class="generalbox" cellspacing="0" cellpadding="5" align="center" border="0">
|
||||
|
||||
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
|
||||
|
||||
<td bgcolor=#ffbbbb>Please fix your settings in config.php:
|
||||
|
||||
|
||||
|
||||
<p>You have:
|
||||
|
||||
|
||||
|
||||
<p>$CFG->dirroot = "/home/users/fred/public_html/moodle";
|
||||
|
||||
|
||||
|
||||
<p>but it should be:
|
||||
|
||||
|
||||
|
||||
<p>$CFG->dirroot = "";</p></td></tr></tbody></table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="answer">then you have encountered a small bug that occurs on some servers. The problem is with the error-checking mechanism, not with your actual path. To fix it, find this line (line 66) in the file admin/index.php: </p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">if ($dirroot != $CFG->dirroot) {</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">and change it to this:</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">if (!empty($dirroot) and $dirroot != $CFG->dirroot) {</p>
|
||||
|
||||
<p class="answercode"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="loginsetting"></a>I login but don't appear to be. I am logged in and can navigate freely.</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Make sure the URL in your $CFG->wwwroot setting is exactly the
|
||||
|
||||
same as the one you are actually using to access the site.</p>
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
<h3><a name="resource1"></a>When trying to add a resource I receive error messages.</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Assuming you are using Apache, then it's quite likely that your
|
||||
|
||||
setting in config.php for $CFG->wwwroot is different from the actual URL you
|
||||
|
||||
are using to access the site. Also try turning off "<b>secureforms</b>" in the
|
||||
|
||||
admin settings.</p>
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="noadmin"></a>During the initial setting-up process, I never get asked to create an admin account!</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">This is a known bug in versions of Moodle up to 1.0.9, now fixed in the main code and version 1.1.</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">It doesn't affect all people, it only occurs when the person installing Moodle has a
|
||||
|
||||
cookie in their browser from another program on the same site, called "user", "admin", or "teacher".</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Quick fixes include deleting those cookies from your browser before installing, using a different browser, or editing the file moodle/admin/user.php to insert these lines near the top:</p>
|
||||
|
||||
|
||||
|
||||
<p class="answercode">unset($user);<br />unset($admin);<br />unset($teacher);</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">After performing any of these fixes it might be a good idea
|
||||
|
||||
to drop all the tables in your database and re-install again from scratch.</p>
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="nologin"></a>I can't log in - I just stay stuck on the login screen.</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">The most common cause for this is that your own computer (not your Moodle server)
|
||||
|
||||
has a firewall that is stripping referrer information from the browser. Here are
|
||||
|
||||
some instructions for fixing <a href="http://service1.symantec.com/SUPPORT/nip.nsf/46f26a2d6dafb0a788256bc7005c3fa3/b9b47ad7eddd343b88256c6b006a85a8?OpenDocument&src=bar_sch_nam">Norton firewall products</a>.</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">The server admin can also fix this for everyone by editing the Moodle configuration
|
||||
|
||||
page and changing the variable "<b>secureforms</b>" to "No".</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Another possible cause of this problem is that sessions are
|
||||
|
||||
not configured properly on the server. You can test this by calling the script
|
||||
|
||||
http://yourserver/moodle/lib/session-test.php.</p>
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="backup"></a>How do I backup my whole Moodle site?</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">There are two main things you need to make a copy of: the database and the uploaded files. The Moodle scripts themselves are less important, since you can always download a fresh copy if you have to.</p>
|
||||
|
||||
|
||||
|
||||
<p class="answer">There are many ways to do such backups. Here is an outline of a little script you can run on Unix to backup the database (it works well to have such a script run daily via a cron task</p>
|
||||
|
||||
<p class="answercode">cd /my/backup/directory</p>
|
||||
|
||||
<p class="answercode">mv moodle-database.sql.gz moodle-database-old.sql.gz</p>
|
||||
|
||||
<p class="answercode">mysqldump -h example.com -u myusername --password=mypassword -C -Q -e -a mydatabasename > moodle-database.sql</p>
|
||||
|
||||
<p class="answercode">gzip moodle-database.sql</p>
|
||||
|
||||
<p class="answer">For the files, you can use rsync regularly to copy only the changed files to another host:</p>
|
||||
|
||||
<p class="answercode">rsync -auvtz --delete -e ssh [email protected]:/my/server/directory
|
||||
|
||||
/my/backup/directory/</p>
|
||||
|
||||
<p class="answercode"> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3><a name="locale"></a>Why doesn't my Moodle site display the time & date correctly?</h3>
|
||||
|
||||
|
||||
|
||||
<p class="answer">Each language requires a specific language code (called a <strong>locale</strong>
|
||||
|
||||
code) to allow dates to be displayed correctly. The language packs contain default
|
||||
|
||||
standard codes, but sometimes these don't work on Windows servers. </p>
|
||||
|
||||
<p class="answer">You can find the correct locale codes for Windows on these two
|
||||
|
||||
pages: <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_language_strings.asp" target="_blank">Language
|
||||
|
||||
codes</a> and <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_country_strings.asp" target="_blank">Country/region
|
||||
|
||||
codes</a>.(eg "esp_esp" for spanish)</p>
|
||||
|
||||
<p class="answer">These new locale codes can be entered on the Admin -> Configure
|
||||
|
||||
-> Variables page, where they override the ones in the currently chosen language
|
||||
|
||||
pack.</p>
|
||||
|
||||
<p class="answer"> </p>
|
||||
|
||||
<h3><a name="cron"></a>Email copies are not being sent
|
||||
|
||||
from my forums </h3>
|
||||
|
||||
<p class="answer">You <strong>must</strong> set up cron properly if you want Moodle
|
||||
|
||||
to send out automatic email from forums, assignments etc. This same
|
||||
|
||||
process also performs a number of clean-up tasks such as deleting old unconfirmed
|
||||
|
||||
users, unenrolling old students and so on.</p>
|
||||
|
||||
<p class="answer">Basically, you need to set up a process to regularly call the
|
||||
|
||||
script http://yoursite/admin/cron.php. Please see <a href="./?file=install.html#cron">the
|
||||
|
||||
section on cron in the Installation documentation</a>.</p>
|
||||
|
||||
<p class="answer">Tip: Try the default setting in Moodle variables page. Leave the smtphost blank.
|
||||
|
||||
This will be acceptable for the majority of users.
|
||||
<p class="answer">
|
||||
<p class="answer">
|
||||
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
|
||||
<p align="center" class="normaltext"><a href='mailto:ma%72%74in@%6d%6fo%64%6c%65.o%72g' title='martin@moodle.org'>Suggest
|
||||
|
||||
|
||||
|
||||
a new FAQ</a> (include the answer!)</p>
|
||||
|
||||
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
|
||||
<p align="right"><strong><em>Thanks to John Eyre for helping to maintain this
|
||||
|
||||
|
||||
|
||||
FAQ.</em></strong></p>
|
||||
|
||||
|
||||
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
|
||||
|
||||
|
||||
<p align="center"><font size="1">Version: $Id: faq.html,v 1.6 2003/03/30 13:54:28
|
||||
|
||||
|
||||
|
||||
moodler Exp $</font></p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
|
||||
|
||||
</html>
|
||||
|
||||
@@ -1,211 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
|
||||
<title>Moodle Docs: Features</title>
|
||||
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Features</h1>
|
||||
<blockquote>
|
||||
<p>Moodle is an active and evolving product. This page lists just some of the
|
||||
many features it contains:</p>
|
||||
<h3>Overall design</h3>
|
||||
<ul>
|
||||
<li>Promotes a social constructionist pedagogy (collaboration, activities, critical
|
||||
reflection, etc)</li>
|
||||
<li>Suitable for 100% online classes as well as supplementing face-to-face learning
|
||||
</li>
|
||||
<li>Simple, lightweight, efficient, compatible, low-tech browser interface</li>
|
||||
<li>Easy to install on almost any platform that supports PHP. Requires only
|
||||
one database (and can share it).</li>
|
||||
<li>Full database abstraction supports all major brands of database (except
|
||||
for initial table definition)</li>
|
||||
<li>Course listing shows descriptions for every course on the server, including
|
||||
accessibility to guests.</li>
|
||||
<li>Courses can be categorised and searched - one Moodle site can support thousands
|
||||
of courses</li>
|
||||
<li>Emphasis on strong security throughout. Forms are all checked, data validated,
|
||||
cookies encrypted etc</li>
|
||||
<li>Most text entry areas (resources, forum postings etc) can
|
||||
be edited using an embedded WYSIWYG HTML editor</li>
|
||||
</ul>
|
||||
<h3 >Site management</h3>
|
||||
<ul>
|
||||
<li>Site is managed by an admin user, defined during setup</li>
|
||||
<li>Plug-in "themes" allow the admin to customise the site colours, fonts, layout
|
||||
etc to suit local needs</li>
|
||||
<li>Plug-in activity modules can be added to existing Moodle installations</li>
|
||||
<li>Plug-in language packs allow full localisation to any language. These can
|
||||
be edited using a built-in web-based editor. Currently there are language
|
||||
packs for over <a href="http://moodle.org/download/lang/" target="_top">43
|
||||
languages</a>.</li>
|
||||
<li>The code is clearly-written PHP under a GPL license - easy to modify to
|
||||
suit your needs</li>
|
||||
</ul>
|
||||
<h3 >User management</h3>
|
||||
<ul>
|
||||
<li>Goals are to reduce admin involvement to a minimum, while retaining high
|
||||
security</li>
|
||||
<li>Supports a range of authentication mechanisms through plug-in authentication
|
||||
modules, allowing easy integration with existing systems.</li>
|
||||
<li>Standard email method: students can create their own login accounts. Email
|
||||
addresses are verified by confirmation.</li>
|
||||
<li>LDAP method: account logins can be checked against an LDAP server. Admin
|
||||
can specify which fields to use.</li>
|
||||
<li>IMAP, POP3, NNTP: account logins are checked against a mail or news server.
|
||||
SSL, certificates and TLS are supported.</li>
|
||||
<li>External database: any database containing at least two fields can be used
|
||||
as an external authentication source.</li>
|
||||
<li>Each person requires only one account for the whole server - each account
|
||||
can have different access</li>
|
||||
<li>An admin account controls the creation of courses and creates teachers by
|
||||
assigning users to courses</li>
|
||||
<li>A course creator account is only allowed to create courses and teach in
|
||||
them</li>
|
||||
<li>Teachers may have editing privileges removed so that they can't modify the
|
||||
course (eg for part-time tutors)</li>
|
||||
<li>Security - teachers can add an "enrolment key" to their courses to keep
|
||||
out non-students. They can give out this key face-to-face or via personal
|
||||
email etc</li>
|
||||
<li>Teachers can enrol students manually if desired</li>
|
||||
<li>Teachers can unenrol students manually if desired, otherwise they are automatically
|
||||
unenrolled after a certain period of inactivity (set by the admin)</li>
|
||||
<li>Students are encouraged to build an online profile including photos, description.
|
||||
Email addresses can be protected from display if required.</li>
|
||||
<li>Every user can specify their own timezone, and every date in Moodle is translated
|
||||
to that timezone (eg posting dates, assignment due dates etc)</li>
|
||||
<li>Every user can choose the language used for the Moodle interface (English,
|
||||
French, German, Spanish, Portuguese etc)</li>
|
||||
</ul>
|
||||
<h3 >Course management</h3>
|
||||
<ul>
|
||||
<li>A full teacher has full control over all settings for a course, including
|
||||
restricting other teachers</li>
|
||||
<li>Choice of course formats such as by week, by topic or a discussion-focussed
|
||||
social format</li>
|
||||
<li>Flexible array of course activities - Forums, Quizzes, Resources,
|
||||
Choices, Surveys, Assignments, Chats, Workshops</li>
|
||||
<li>Recent changes to the course since the last login can be displayed on the
|
||||
course home page - helps give sense of community</li>
|
||||
<li>Most text entry areas (resources, forum postings etc) can
|
||||
be edited using an embedded WYSIWYG HTML editor</li>
|
||||
<li>All grades for Forums, Quizzes and Assignments can be viewed on
|
||||
one page (and downloaded as a spreadsheet file)</li>
|
||||
<li>Full user logging and tracking - activity reports for each student are available
|
||||
with graphs and details about each module (last access, number of times read)
|
||||
as well as a detailed "story" of each students involvement including postings
|
||||
etc on one page.</li>
|
||||
<li>Mail integration - copies of forum posts, teacher feedback etc can be mailed
|
||||
in HTML or plain text.</li>
|
||||
<li>Custom scales - teachers can define their own scales to be used for grading
|
||||
forums and assignments</li>
|
||||
<li>Courses can be packaged as a single zip file using the Backup function.
|
||||
These can be restored on any Moodle server.</li>
|
||||
</ul>
|
||||
<h3 >Assignment Module</h3>
|
||||
<ul>
|
||||
<li>Assignments can be specified with a due date and a maximum grade.</li>
|
||||
<li>Students can upload their assignments (any file format) to the server -
|
||||
they are date-stamped.</li>
|
||||
<li>Late assignments are allowed, but the amount of lateness is shown clearly
|
||||
to the teacher</li>
|
||||
<li>For each particular assignment, the whole class can be assessed (grade and
|
||||
comment) on one page in one form.</li>
|
||||
<li>Teacher feedback is appended to the assignment page for each student, and
|
||||
notification is mailed out.</li>
|
||||
<li>The teacher can choose to allow resubmission of assignments after grading
|
||||
(for regrading)</li>
|
||||
</ul>
|
||||
</ul>
|
||||
<h3 >Chat Module</h3>
|
||||
<ul>
|
||||
<li>Allows smooth, synchronous text interaction</li>
|
||||
<li>Includes profile pictures in the chat window</li>
|
||||
<li>Supports URLs, smilies, embedded HTML, images etc</li>
|
||||
<li>All sessions are logged for later viewing, and these can also be made available
|
||||
to students</li>
|
||||
</ul>
|
||||
<h3 >Choice Module</h3>
|
||||
<ul>
|
||||
<li>Like a poll. Can either be used to vote on something, or to get feedback
|
||||
from every student (eg research consent)</li>
|
||||
<li>Teacher sees intuitive table view of who chose what</li>
|
||||
<li>Students can optionally be allowed to see an up-to-date graph of results</li>
|
||||
</ul>
|
||||
<h3 >Forum Module</h3>
|
||||
<ul>
|
||||
<li>Different types of forums are available, such as teacher-only, course news,
|
||||
open-to-all, and one-thread-per-user.</li>
|
||||
<li>All postings have the authors photo attached.</li>
|
||||
<li>Discussions can be viewed nested, flat or threaded, oldest or newest first.</li>
|
||||
<li>Individual forums can be subscribed to by each person so that copies are
|
||||
forwarded via email, or the teacher can force subscription for all</li>
|
||||
<li>The teacher can choose not to allow replies (eg for an announcements-only
|
||||
forum)</li>
|
||||
<li>Discussion threads can be easily moved between forums by the teacher</li>
|
||||
<li>Attached images are shown inline</li>
|
||||
<li>If forum ratings are being used, these can be restricted to a range of dates</li>
|
||||
</ul>
|
||||
<h3 >Quiz Module</h3>
|
||||
<ul>
|
||||
<li>Teachers can define a database of questions for re-use in different quizzes</li>
|
||||
<li>Questions can be stored in categories for easy access, and these categories
|
||||
can be "published" to make them accessible from any course on the
|
||||
site. </li>
|
||||
<li>Quizzes are automatically graded, and can be re-graded if questions are
|
||||
modified </li>
|
||||
<li>Quizzes can have a limited time window outside of which they are not available</li>
|
||||
<li>At the teacher's option, quizzes can be attempted multiple times, and can
|
||||
show feedback and/or correct answers</li>
|
||||
<li>Quiz questions and quiz answers can be shuffled (randomised) to reduce cheating</li>
|
||||
<li>Questions allow HTML and images</li>
|
||||
<li>Questions can be imported from external text files</li>
|
||||
<li>Attempts can be cumulative, if desired, and finished over several sessions</li>
|
||||
<li>Multiple-choice questions supporting single or multiple answers</li>
|
||||
<li>Short Answer questions (words or phrases)</li>
|
||||
<li>True-False questions </li>
|
||||
<li>Matching questions</li>
|
||||
<li>Random questions</li>
|
||||
<li>Numerical questions (with allowable ranges)</li>
|
||||
<li>Embedded-answer questions (cloze style) with answers within passages of
|
||||
text </li>
|
||||
<li>Embedded descriptive text and graphics</li>
|
||||
</ul>
|
||||
<h3 >Resource Module</h3>
|
||||
<ul>
|
||||
<li>Supports display of any electronic content, Word, Powerpoint, Flash, Video,
|
||||
Sounds etc</li>
|
||||
<li>Files can be uploaded and managed on the server, or created on the fly using
|
||||
web forms (text or HTML)</li>
|
||||
<li>External content on the web can be linked to or seamlessly included within
|
||||
the course interface.</li>
|
||||
<li>External web applications can be linked in with data passed to them</li>
|
||||
</ul>
|
||||
<h3 >Survey Module</h3>
|
||||
<ul>
|
||||
<li>Built-in surveys (COLLES, ATTLS) have been proven as instruments for analysing online classes</li>
|
||||
<li>Online survey reports always available, including many graphs. Data is downloadable as an Excel spreadsheet or CSV text file.</li>
|
||||
<li>Survey interface prevents partly-finished surveys.</li>
|
||||
<li>Feedback is provided to the student of their results compared to the class averages
|
||||
</li>
|
||||
</ul>
|
||||
<h3 >Workshop Module</h3>
|
||||
<ul>
|
||||
<li>Allows peer assessement of documents, and the teacher can manage and grade
|
||||
the assessment.</li>
|
||||
<li>Supports a wide range of possible grading scales</li>
|
||||
<li>Teacher can provide sample documents for students to practice grading</li>
|
||||
<li>Very flexible with many options.</li>
|
||||
</ul>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,32 +0,0 @@
|
||||
<?php // $Id$
|
||||
// Names of the documentation files
|
||||
// Files with a definition "-" are treated as spacers
|
||||
|
||||
$string['-about'] = "About Moodle";
|
||||
$string['intro.html'] = "Introduction";
|
||||
$string['background.html'] = "Background";
|
||||
$string['philosophy.html'] = "Philosophy";
|
||||
$string['licence.html'] = "License";
|
||||
$string['features.html'] = "Features";
|
||||
$string['release.html'] = "Release Notes";
|
||||
$string['future.html'] = "Future";
|
||||
$string['credits.html'] = "Credits";
|
||||
|
||||
$string['-installation'] = "Administration";
|
||||
$string['install.html'] = "Installation";
|
||||
$string['faq.html'] = "Installation FAQ";
|
||||
$string['installamp.html'] = "Apache, MySQL, PHP";
|
||||
$string['upgrade.html'] = "Upgrading";
|
||||
|
||||
$string['-usage'] = "Using Moodle";
|
||||
$string['teacher.html'] = "Teacher Manual";
|
||||
$string['other.html'] = "Other Docs";
|
||||
|
||||
$string['-development'] = "Development";
|
||||
$string['developer.html'] = "Developer Manual";
|
||||
$string['coding.html'] = "Coding Guide";
|
||||
$string['cvs.html'] = "Using CVS";
|
||||
$string['translation.html'] = "Translation";
|
||||
|
||||
|
||||
?>
|
||||
@@ -1,62 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
|
||||
<title>Moodle Docs: Future</title>
|
||||
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<h1>Future</h1>
|
||||
<blockquote>
|
||||
<p>As Moodle gains in maturity, its directions are increasingly influenced by
|
||||
the community of developers and users. A dynamic database of proposed features
|
||||
and their status can be found at <a target="_top" href="http://moodle.org/bugs/">moodle.org/bugs</a>.
|
||||
Your <a href="?file=credits.html">contributions</a> in the form of ideas, code,
|
||||
feedback and promotion are all very welcome - see the <a href="?file=developer.html">Developers
|
||||
manual</a> and the <a href="http://moodle.org/help" target="_top">community forums</a> for more details. You can also pay to have certain features developed sooner- see <a href="http://moodle.com/development/" target="_top">moodle.com/development</a> for information and a quote. </p>
|
||||
|
||||
<p>Here is the current roadmap of the future, though this is always subject to change depending on <a href="http://moodle.org/donations/" target="_blank">sponsors</a> and <a href="?file=credits.html">developers</a>. </p>
|
||||
|
||||
<h3>Version 1.6</h3>
|
||||
<blockquote>
|
||||
<p>Blogs as the main tool for reflective activities (providing user, course and site feeds).</p>
|
||||
<p>Database module, a general purpose tool for collaborative data entry, searching and browsing</p>
|
||||
<p>Integration with LAMS as an activity or course format</p>
|
||||
<p>Some better statistics</p>
|
||||
<p>Incoming email handling</p>
|
||||
<p>Basic Web Services API</p>
|
||||
</blockquote>
|
||||
|
||||
<h3>Version 1.7</h3>
|
||||
<blockquote>
|
||||
<p>My Moodle page providing a customisable overview of all courses, plus RSS feeds and so on.</p>
|
||||
<p>Improved User Profile page, integrating Blogs, feeds etc in a semi-public home page</p>
|
||||
<p>Preliminary support for IMS LD Level A, allowing import and export</p>
|
||||
<p>Full support for SCORM 2004</p>
|
||||
<p>Improved Web Services API</p>
|
||||
<p>Integration with some repositories</p>
|
||||
</blockquote>
|
||||
|
||||
<h3>Version 2.0</h3>
|
||||
<blockquote>
|
||||
<p>Conditional activities, allowing dependencies and forced paths</p>
|
||||
<p>Complete support for IMS LD standard</p>
|
||||
<p>Improved Groups, allowing groups to be defined at site and activity level</p>
|
||||
<p>Improved Roles implementation, allowing custom roles at site, course and activity level</p>
|
||||
<p>Many of the main pages customisable using HTML templates. </p>
|
||||
<p>Some exciting developments in making Moodle more network-aware,
|
||||
with a natural evolution of Moodle's focus on collaboration. More on this here later. </p>
|
||||
</blockquote>
|
||||
|
||||
</blockquote>
|
||||
|
||||
<p align="center"> </p>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
@@ -1,448 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
|
||||
<title>Moodle Docs: Basic Installation</title>
|
||||
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
<style type="text/css">
|
||||
<!--
|
||||
.style3 {color: #660000}
|
||||
-->
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Installing Moodle</h1>
|
||||
<h2>Dont panic! <img src="http://moodle.org/pix/s/smiley.gif" /></h2>
|
||||
<blockquote>
|
||||
<p>This guide explains how to install Moodle for the first time. For some of these steps it goes into a lot of detail to try and cover the majority of possible
|
||||
web server setups, so this document may look long and complicated. Don't panic, once you know how to do it you can install Moodle in minutes!</p>
|
||||
<p>If you have problems please read this document carefully - most common issues are answered in here.
|
||||
If you still have trouble, you can seek help from
|
||||
<a target="_blank" href="http://moodle.org/help">Moodle Help</a></p>
|
||||
<p>Another option is to contact a <a target="_blank" href="http://moodle.com/hosting/">web hosting company</a>
|
||||
who can completely maintain Moodle for you, so that you can ignore all this and get straight into educating!
|
||||
</p>
|
||||
<p> </p>
|
||||
<p>Sections in this document:</p>
|
||||
<ol>
|
||||
<li><a href="#requirements">Requirements</a></li>
|
||||
<li><a href="#downloading">Download and copy files into place</a> </li>
|
||||
<li><a href="#site">Site structure</a></li>
|
||||
<li><a href="#installer">Run the installer script to create config.php</a> <ul>
|
||||
<li><a href="#webserver">Check web server settings</a></li>
|
||||
<li><a href="#database">Creating a database</a></li>
|
||||
<li><a href="#data">Creating a data directory</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#admin">Go to the admin page to continue configuration</a></li>
|
||||
<li><a href="#cron">Set up cron</a></li>
|
||||
<li><a href="#course">Create a new course</a></li>
|
||||
</ol>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="requirements"></a>1. Requirements</h3>
|
||||
<blockquote>
|
||||
<p>Moodle is primarily developed in Linux using Apache, MySQL and PHP (also
|
||||
sometimes known as the LAMP platform), but is also regularly tested with PostgreSQL
|
||||
and on Windows XP, Mac OS X and Netware 6 operating systems</p>
|
||||
<p>The requirements for Moodle are as follows:</p>
|
||||
<ol>
|
||||
<li>Web server software. Most people use <a href="http://www.apache.org/" target="_blank">Apache</a>,
|
||||
but Moodle should work fine under any web server that supports PHP, such
|
||||
as IIS on Windows platforms.</li>
|
||||
<li><a href="http://www.php.net/" target="_blank">PHP</a> scripting language (version 4.1.0
|
||||
or later). PHP 5 is supported as of Moodle 1.4. </li>
|
||||
<li>a working database server: <a href="http://www.mysql.com/" target="_blank">MySQL</a>
|
||||
or <a href="http://www.postgresql.org/" target="_blank">PostgreSQL</a> are
|
||||
completely supported and recommended for use with Moodle. </li>
|
||||
</ol>
|
||||
<p>Most web hosts support all of this by default. If you are signed up with
|
||||
one of the few webhosts that does not support these features ask them why,
|
||||
and consider taking your business elsewhere.</p>
|
||||
<p>If you want to run Moodle on your own computer and all this looks a bit daunting,
|
||||
then please see our guide: <a href="http://moodle.org/doc/?file=installamp.html">Installing
|
||||
Apache, MySQL and PHP</a>. It provides some step-by-step instructions to install
|
||||
all this on most popular platforms.</p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="downloading"></a>2. Download and copy files into place </h3>
|
||||
<blockquote>
|
||||
<p>There are two ways to get Moodle, as a compressed package and via CVS. These
|
||||
are explained in detail on the download page: <a href="http://moodle.org/download/" target="_blank">http://moodle.org/download/</a></p>
|
||||
<p>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.</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>If you are downloading Moodle to your local computer and then uploading it to your web site, it is usually better to upload the whole archive as one file, and then do the unpacking on the server. Even web hosting interfaces like Cpanel allow you to uncompress archives in the "File Manager". </p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h3 class="sectionheading"><a name="site"></a>3. Site structure</h3>
|
||||
<blockquote>
|
||||
<p>You can safely skip this section, but here is a quick summary of the contents of the Moodle folder, to help get
|
||||
you oriented:</p>
|
||||
<blockquote>
|
||||
<table><tr>
|
||||
<td width="130" valign="top">config.php</td>
|
||||
<td valign="top">-</td>
|
||||
<td valign="top">
|
||||
contains basic settings. This file does not come with Moodle - you will create it. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">install.php</td>
|
||||
<td valign="top">-</td>
|
||||
<td valign="top">the script you will run to create config.php </td>
|
||||
</tr>
|
||||
<tr><td valign="top">version.php</td>
|
||||
<td valign="top">-</td>
|
||||
<td valign="top">
|
||||
defines the current version of Moodle code
|
||||
</td></tr>
|
||||
<tr><td valign="top">index.php</td>
|
||||
<td valign="top">-</td>
|
||||
<td valign="top">
|
||||
the front page of the site
|
||||
</td></tr></table>
|
||||
<ul>
|
||||
<li>admin/ - code to administrate the whole server </li>
|
||||
<li>auth/ - plugin modules to authenticate users </li>
|
||||
<li>blocks/ - plugin modules for the little side blocks on many pages</li>
|
||||
<li>calendar/ - all the code for managing and displaying calendars</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>lang/ - texts in different languages, one directory per language </li>
|
||||
<li>lib/ - libraries of core Moodle code </li>
|
||||
<li>login/ - code to handle login and account creation </li>
|
||||
<li>mod/ - all the main Moodle course modules are in here </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> </p>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="installer"></a>4. Run the Installer script to create config.php </h3>
|
||||
<blockquote>
|
||||
<p>To run the installer script (install.php), just try to access your Moodle main URL using a web browser, or access <strong>http://yourserver/install.php</strong> directly. </p>
|
||||
<p>(The Installer will try to set a session cookie. If you get a popup warning in your browser make sure you accept that cookie!) </p>
|
||||
<p>Moodle will detect that configuration is necessary and will lead you through some screens to help you create a new configuration file called <strong>config.php. </strong>At the end of the process Moodle will try and write the file into the right location, otherwise you can press a button to download it from the installer and then upload config.php into the main Moodle directory on the server. </p>
|
||||
<p>Along the way the installer will test your server environment and give you suggestions about how to fix any problems. For most common issues these suggestions should be sufficient, but if you get stuck, look below for more information about some of common things that might be holding you up. <br />
|
||||
</p>
|
||||
</blockquote>
|
||||
<blockquote>
|
||||
|
||||
<h3 class="sectionheading"><a name="webserver" id="webserver"></a>4.1 General web server settings </h3>
|
||||
<blockquote>
|
||||
<p>Firstly, make sure that your web server is set up to use index.php as a default
|
||||
page (perhaps in addition to index.html, default.htm and so on).</p>
|
||||
<p>In Apache, this is done using a DirectoryIndex parameter in your httpd.conf
|
||||
file. Mine usually looks like this:</p>
|
||||
<blockquote>
|
||||
<pre><strong>DirectoryIndex</strong> index.php index.html index.htm </pre>
|
||||
</blockquote>
|
||||
<p>Just make sure index.php is in the list (and preferably towards the start
|
||||
of the list, for efficiency).</p>
|
||||
<p>Secondly, <b>if you are using Apache 2</b>, then you should turn on the <i>AcceptPathInfo</i>
|
||||
variable, which allows scripts to be passed arguments like http://server/file.php/arg1/arg2.
|
||||
This is essential to allow relative links between your resources, and also
|
||||
provides a performance boost for people using your Moodle web site. You can
|
||||
turn this on by adding these lines to your httpd.conf file.</p>
|
||||
<blockquote>
|
||||
<pre><strong>AcceptPathInfo</strong> on </pre>
|
||||
</blockquote>
|
||||
<p>Thirdly, Moodle requires a number of PHP settings to be active for it to
|
||||
work. <b>On most servers these will already be the default settings.</b>
|
||||
However, some PHP servers (and some of the more recent PHP versions) may
|
||||
have things set differently. These are defined in PHP's configuration
|
||||
file (usually called php.ini):</p>
|
||||
<blockquote>
|
||||
<pre>magic_quotes_gpc = 1 (preferred but not necessary)
|
||||
magic_quotes_runtime = 0 (necessary)
|
||||
file_uploads = 1
|
||||
session.auto_start = 0
|
||||
session.bug_compat_warn = 0
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>If you don't have access to httpd.conf or php.ini on your server, or you
|
||||
have Moodle on a server with other applications that require different settings,
|
||||
then don't worry, you can often still OVERRIDE the default settings.
|
||||
</p>
|
||||
<p>To do this, you need to create a file called <b>.htaccess</b> in Moodle's
|
||||
main directory that contains lines like the following.
|
||||
This only works on Apache servers and only when Overrides have been allowed in the main configuration. </p>
|
||||
<blockquote>
|
||||
<pre>
|
||||
DirectoryIndex index.php index.html index.htm
|
||||
|
||||
<IfDefine APACHE2>
|
||||
<b>AcceptPathInfo</b> on
|
||||
</IfDefine>
|
||||
|
||||
php_flag magic_quotes_gpc 1
|
||||
php_flag magic_quotes_runtime 0
|
||||
php_flag file_uploads 1
|
||||
php_flag session.auto_start 0
|
||||
php_flag session.bug_compat_warn 0</pre>
|
||||
</blockquote>
|
||||
<p>You can also do things like define the maximum size for uploaded files:
|
||||
|
||||
</p>
|
||||
<blockquote>
|
||||
<pre>
|
||||
LimitRequestBody 0
|
||||
php_value upload_max_filesize 2M
|
||||
php_value post_max_size 2M
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>The easiest thing to do is just copy the sample file from <strong>lib/htaccess</strong> and edit it to suit your needs. It contains further instructions. For
|
||||
example, in a Unix shell:
|
||||
</p>
|
||||
<blockquote>
|
||||
<pre>cp lib/htaccess .htaccess</pre>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h3 class="sectionheading"><a name="database"></a>4.2 Creating a database</h3>
|
||||
|
||||
<blockquote>
|
||||
<p>You need to create an empty database (eg "<em>moodle</em>") in your database system
|
||||
along with a special user (eg "moodleuser") that has access to that database
|
||||
(and that database only). You could use the "root" user if you wanted to for a test server, but
|
||||
this is not recommended for a production system: if hackers manage to discover
|
||||
the password then your whole database system would be at risk, rather than
|
||||
just one database. </p>
|
||||
<p>If you are using a webhost, they will probably have a control panel web interface for you to create your database. </p>
|
||||
<p>The <strong>Cpanel</strong> system is one of the most popular of these. To create a database in Cpanel, </p>
|
||||
<ol>
|
||||
<li>Click on the "<strong>MySQL Databases</strong>" icon.</li>
|
||||
<li>Type "moodle" in the database field and click "<strong>Add Database</strong>".</li>
|
||||
<li> Type a username and password (not one you use elsewhere) in the respective fields and click "<strong>Add User</strong>".</li>
|
||||
<li> Now use the "<strong>Add User to Database</strong>" button to give this new user account "<strong>ALL</strong>" rights to the new database.</li>
|
||||
<li>Note that the username and database names may be prefixed by your Cpanel account name. When entering this information into the Moodle installer - use the full names.</li>
|
||||
</ol>
|
||||
<p>If you have access to Unix command lines then you can do the same sort of thing by typing commands. </p>
|
||||
<p>Here are some example Unix command lines 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>And some example command lines for PostgreSQL: </p>
|
||||
<pre>
|
||||
# su - postgres
|
||||
> psql -c "create user moodleuser createdb;" template1
|
||||
> psql -c "create database moodle;" -U moodleuser template1
|
||||
> psql -c "alter user moodleuser nocreatedb;" template1</pre>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
|
||||
<h3 class="sectionheading"><a name="data"></a>4.3 Creating a data directory </h3>
|
||||
|
||||
<blockquote>
|
||||
<p>Moodle will also need some space on your server's hard disk to store uploaded files, such as course documents and user pictures. </p>
|
||||
<p>The Moodle installer tries hard to create this directory for you but if it fails then you will have to create a directory for this purpose manually. </p>
|
||||
<p>For security, it's best that this directory is NOT accessible directly via the web. The easiest way to do this is to simply locate it OUTSIDE the web directory, but if you must have it in the web directory then protect it by creating a file in the data directory called .htaccess, containing this line: </p>
|
||||
<blockquote>
|
||||
<pre>deny from all<br />AllowOverride None</pre>
|
||||
</blockquote>
|
||||
<p>To make sure that Moodle can save uploaded files in this directory, check that the web server software (eg Apache) has permission to read, write and execute in this directory. </p>
|
||||
<p>On Unix machines, this means setting the owner of the directory to be something like "nobody" or "apache", and then giving that user read, write and execute permissions.</p>
|
||||
<p>On Cpanel systems you can use the "File Manager" to find the folder, click on it, then choose "Change Permissions". On many shared hosting servers, you will probably need to restrict all file access to your "group" (to prevent other webhost customers from looking at or changing your files), but provide full read/write access to everyone else (which will allow the web server to access your files). </p>
|
||||
<p>Speak to your server administrator if you are having trouble setting this up securely. In particular some sites that use a PHP feature known as "Safe Mode" may <em>require</em> the administrator to create this directory properly for you. </p>
|
||||
</blockquote>
|
||||
|
||||
</blockquote>
|
||||
|
||||
|
||||
<h3 class="sectionheading"><a name="admin"></a>5. Go to the admin page to continue configuration </h3>
|
||||
<blockquote>
|
||||
<p>Once the basic <strong>config.php</strong> has been correctly created in the previous step, trying to access the front page of your site will take you the "admin" page for the rest of the configuration.</p>
|
||||
<p>The first time you access this admin page, you will be presented with
|
||||
a GPL "shrinkwrap" agreement with which you <strong>must</strong> agree before you
|
||||
can continue with the setup.</p>
|
||||
<p>Now Moodle will start setting up your database and creating tables to store
|
||||
data. Firstly, the main database tables are created. You should see a number
|
||||
of SQL statements followed by status messages (in green or red) that look
|
||||
like this:</p>
|
||||
<blockquote>
|
||||
<p>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</p>
|
||||
<p><font color="#006600">SUCCESS</font></p>
|
||||
</blockquote>
|
||||
<p>...and so on, followed by: <font color="#006600">Main databases set up
|
||||
successfully.</font> </p>
|
||||
<blockquote>
|
||||
<p class="style3">If you don't see these, then there must have been some problem with the database
|
||||
or the configuration settings you defined in config.php. Check that PHP isn't
|
||||
in a restricted "Safe Mode" (commercial web hosts sometimes have safe mode
|
||||
turned on). You can check PHP variables by creating a little file containing <strong><?php phpinfo() ?></strong> and looking at it through a browser. Check all these and
|
||||
try this page again.</p>
|
||||
</blockquote>
|
||||
<p>Scroll down the very bottom of the page and press the "Continue"
|
||||
link.</p>
|
||||
<p>You should now see a form where you can define more configuration variables
|
||||
for your installation, such as the default language, SMTP hosts and so on.
|
||||
Don't worry too much about getting everything right just now - you can always
|
||||
come back and edit these later on using the admin interface. The defaults are designed to be useful and secure for most sites. Scroll down to
|
||||
the bottom and click "Save changes".</p>
|
||||
<blockquote>
|
||||
<p class="style3">If (and only if) you find yourself getting stuck on this page, unable to
|
||||
continue, then your server probably has what I call the "buggy referrer" problem.
|
||||
This is easy to fix: just turn off the "secureforms" setting, then
|
||||
try to continue again.</p>
|
||||
</blockquote>
|
||||
<p>Next you will see more pages that print lots of status messages as they set up all the tables required by the various Moodle module. As before, they should all be <font color="#006600">green</font>.</p>
|
||||
<p>Scroll down the very bottom of the page and press the "Continue" link.</p>
|
||||
<p>The next page is a form where you can define parameters for your Moodle site
|
||||
and the front page, such as the name, format, description and so on. Fill
|
||||
this out (you can always come back and change these later) and then press
|
||||
"Save changes".</p>
|
||||
<p>Finally, you will then be asked to create a top-level administration user
|
||||
for future access to the admin pages. Fill out the details with your own name,
|
||||
email etc and then click "Save changes". Not all the fields are
|
||||
required, but if you miss any important fields you'll be re-prompted for them.
|
||||
</p>
|
||||
<blockquote>
|
||||
<blockquote>
|
||||
<blockquote>
|
||||
<blockquote>
|
||||
<blockquote>
|
||||
<p><strong>Make sure you remember the username and password you chose
|
||||
for the administration user account, as they will be necessary to
|
||||
access the administration page in future.</strong></p>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p class="style3">(If for any reason your install is interrupted, or there is a system error
|
||||
of some kind that prevents you from logging in using the admin account, you
|
||||
can usually log in using the default username of "<strong>admin</strong>",
|
||||
with password "<strong>admin</strong>".)</p>
|
||||
</blockquote>
|
||||
<p>Once successful, you will be returned to the home page of your new site! Note the
|
||||
administration links that appear down the left hand side of the page (these
|
||||
items also appear on a separate Admin page) - these items are only visible
|
||||
to you because you are logged in as the admin user. All your further administration
|
||||
of Moodle can now be done using this menu, such as:</p>
|
||||
<ul>
|
||||
<li>creating and deleting courses</li>
|
||||
<li>creating and editing user accounts</li>
|
||||
<li>administering teacher accounts</li>
|
||||
<li>changing site-wide settings like themes etc</li>
|
||||
</ul>
|
||||
<p>But you are not done installing yet! There is one very important thing still to do (see the next section on cron). </p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h3 class="sectionheading"><a name="cron"></a>6. Set up cron -- IMPORTANT! </h3>
|
||||
<blockquote>
|
||||
<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 or ten minutes). This provides
|
||||
a "heartbeat" so that the script can perform functions at periods
|
||||
defined by each module. This kind of regular mechanism is known as a <strong>cron service</strong>. </p>
|
||||
<p>Note that the machine performing the cron <b>does not need to be the same
|
||||
machine that is running Moodle</b>. For example, if you have a limited web
|
||||
hosting service that does not have a cron service, then you can might choose to run
|
||||
cron on another server or on your home computer. All that matters is that
|
||||
the cron.php file is called regularly. </p>
|
||||
<p>The load of this script is not very high, so 5 minutes is usually reasonable,
|
||||
but if you're worried about it you can reduce the time period to something
|
||||
like 15 minutes or even 30 minutes. It's best not to make the time period
|
||||
too long, as delaying mail-outs can slow down activity within the course.</p>
|
||||
<p>First, test that the script works by running it directly from your browser:</p>
|
||||
<blockquote>
|
||||
<pre>http://example.com/moodle/admin/cron.php</pre>
|
||||
</blockquote>
|
||||
<p>Now, you need to set up some of way of running the script automatically and
|
||||
regularly.</p>
|
||||
<p><b>On Windows systems</b></p>
|
||||
<blockquote>
|
||||
<p>The simplest way is to use this little package <a href="http://moodle.org/download/modules/moodle-cron-for-windows.zip" title="Click to download this package (150k)" target="_blank"><strong>moodle-cron-for-windows.zip</strong></a> which makes this whole thing very easy by installing a small Windows service. Run it and forget about it!</p>
|
||||
</blockquote>
|
||||
<p><strong>On web hosting services</strong></p>
|
||||
<blockquote>
|
||||
<p> Your web-based control panel may have a web page that allows you to set up this cron process. For example, on Cpanel system, look for a button called "Cron jobs". In there you can put the same sort of Unix commands as listed below. </p>
|
||||
</blockquote>
|
||||
<h4> Using the command line on Unix </h4>
|
||||
<blockquote>
|
||||
<p>There are different command line programs you can use to call the page from the command line. Not all of them may be available on a given server.</p>
|
||||
<p>For example, you can use a Unix utility like 'wget':</p>
|
||||
<blockquote>
|
||||
<pre>wget -q -O /dev/null http://example.com/moodle/admin/cron.php</pre>
|
||||
</blockquote>
|
||||
<p>Note in this example that the output is thrown away (to /dev/null).</p>
|
||||
<p>The same thing using lynx:</p>
|
||||
<blockquote>
|
||||
<pre>lynx -dump http://example.com/moodle/admin/cron.php > /dev/null</pre>
|
||||
</blockquote>
|
||||
<p>Alternatively you could use a standalone version of PHP, compiled to be run
|
||||
on the command line. The advantage with doing this 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>
|
||||
<blockquote>
|
||||
<pre>/opt/bin/php /web/moodle/admin/cron.php
|
||||
|
||||
</pre>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<h4>Using the crontab program on Unix </h4>
|
||||
<blockquote>
|
||||
<p> All that Cpanel does is provide a web interface to a Unix utility known as crontab. If you have a command line, you can set up crontab yourself using the command:</p>
|
||||
<blockquote>
|
||||
<pre>crontab -e</pre>
|
||||
</blockquote>
|
||||
<p>and then adding one of the above commands like:</p>
|
||||
<blockquote>
|
||||
<pre>*/5 * * * * wget -q -O /dev/null http://example.com/moodle/admin/cron.php</pre>
|
||||
</blockquote>
|
||||
<p>Usually, the "crontab" command will put you into the 'vi' editor. You enter
|
||||
"insert mode" by pressing "i", then type in the line as above, then exit insert mode by
|
||||
pressing ESC. You save and exit by typing ":wq", or quit without saving using ":q!" (without the quotes).</p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="course"></a>7. Create a new course</h3>
|
||||
<blockquote>
|
||||
<p>Now that Moodle is running properly, you can try creating a new course to play with. </p>
|
||||
<p>Select "Create a new course" from the Admin page (or the admin
|
||||
links on the home page).</p>
|
||||
<p>Fill out the form, paying special attention to the course format. You don't
|
||||
have to worry about the details too much at this stage, as everything can
|
||||
be changed later by the teacher. Note that the yellow help icons are everywhere to provide contextual help on any aspect. </p>
|
||||
<p>Press "Save changes", and you will be taken to a new form where
|
||||
you can assign 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 "Add a new user" on the Admin page.</p>
|
||||
<p>Once done, the course is ready to customise, and is accessible via the "Courses"
|
||||
link on the home page.</p>
|
||||
<p>See the "<a href="./?file=teacher.html">Teacher Manual</a>" for more details
|
||||
on course-building.</p>
|
||||
<p> </p>
|
||||
<p align="center"><strong>Happy exploring and happy Moodling!</strong></p>
|
||||
<p align="center"><strong>If you like Moodle, please consider <a href="http://moodle.org/donations/" target="_blank">donating</a> to help us cover our costs! </strong></p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
@@ -1,158 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Installing PHP and MySQL</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Installing Apache, MySQL and PHP</h1>
|
||||
<blockquote>
|
||||
<p>Moodle is written in a scripting language called PHP, and stores most of its
|
||||
data in a database. The database we recommend is MySQL. Before installing Moodle
|
||||
you must have a working PHP installation and a working database to turn your
|
||||
computer into a functional web server platform. These packages can be tricky
|
||||
to set up for average computer users, so this page has been written to try to
|
||||
make this process as simple as possible for different platforms:</p>
|
||||
<ul>
|
||||
<li><a href="#host" class="questionlink">Hosting Service</a></li>
|
||||
<li><a href="#mac" class="questionlink">Mac OS X</a></li>
|
||||
<li><a href="#redhat" class="questionlink">Redhat Linux</a></li>
|
||||
<li><a href="#windows" class="questionlink">Windows</a></li>
|
||||
</ul>
|
||||
<p class="questionlink"> </p>
|
||||
<h3 class="sectionheading"><a name="host" id="host"></a>Hosting Service</h3>
|
||||
<blockquote>
|
||||
<p>Unfortunately hosting services vary quite a lot in the way they work. Some
|
||||
will even install Moodle for you.</p>
|
||||
<p>Most will offer a web-based control panel to control your site, create databases
|
||||
and set up cron. Some may also offer terminal access via ssh, so that you
|
||||
can use the command shell to do things.</p>
|
||||
<p>You should work your way through the <a href="./?file=install.html">Installation
|
||||
guide</a> and take each step at a time. Ask your hosting provider if you get
|
||||
stuck. </p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="mac" id="mac"></a>Mac OS X</h3>
|
||||
<blockquote>
|
||||
<p>The easiest way to do this is use the Apache server that Apple provides,
|
||||
and add PHP and MySQL using Marc Liyanage's packages. Both of the pages below
|
||||
come with good instructions that we won't duplicate here:</p>
|
||||
<blockquote>
|
||||
<p><strong>PHP</strong>: Download from here: <a href="http://www.entropy.ch/software/macosx/php/" target="_top">http://www.entropy.ch/software/macosx/php/</a></p>
|
||||
<p><strong>MySQL</strong>: Download here: <a href="http://www.entropy.ch/software/macosx/mysql/" target="_top">http://www.entropy.ch/software/macosx/mysql/</a></p>
|
||||
</blockquote>
|
||||
<p>Once these are installed the standard <a href="./?file=install.html">Installation
|
||||
guide</a> should be fairly straightforward.</p>
|
||||
<p>A more detailed walkthrough is here: <a href="http://moodle.org/wiki/index.php/InstallingMoodle">http://moodle.org/wiki/index.php/InstallingMoodle</a></p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="redhat"></a>Redhat Linux</h3>
|
||||
<blockquote>
|
||||
<p>You should install all available RPM packages for Apache, PHP and MySQL.
|
||||
One package that people frequently forget is the php-mysql package which is
|
||||
necessary for PHP to talk to MySQL.</p>
|
||||
<p>Once these are installed the standard <a href="./?file=install.html">Installation
|
||||
guide</a> should be fairly straightforward.</p>
|
||||
<p>A more detailed walkthrough is here: <a href="http://moodle.org/wiki/index.php/InstallingMoodle">http://moodle.org/wiki/index.php/InstallingMoodle</a></p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<h3 class="sectionheading"><a name="windows" id="windows"></a>Windows</h3>
|
||||
<blockquote>
|
||||
<p>The easiest way to do this is use <a href="http://www.easyphp.org/" target="_blank">EasyPHP</a>,
|
||||
a package that bundles all the software you need into a single Windows application.
|
||||
Here are the steps from start to finish:</p>
|
||||
<ol>
|
||||
<li> Firstly, if you have ever installed MySQL before (even as part of another
|
||||
package), uninstall it all, delete all the MySQL files and make sure you
|
||||
delete <strong>c:\my.cnf</strong> and <strong>c:\windows\my.ini</strong>.You
|
||||
might want to do a search and delete ANY file called <strong>my.cnf</strong>
|
||||
or <strong>my.ini</strong>.</li>
|
||||
<li> If you've ever installed PHP before delete any files called <strong>php4ts.dll</strong>
|
||||
from around your Windows directory, as well as any files called <strong>php.ini</strong>.</li>
|
||||
<li> Download EasyPHP from here: <a href="http://www.easyphp.org/telechargements/dn.php?F=easyphp1-7">http://www.easyphp.org/telechargements/dn.php?F=easyphp1-7</a>
|
||||
(approx 10 Mb)</li>
|
||||
<li> Run the downloaded file: <strong>easyphp1-7_setup.exe</strong>. The installation
|
||||
process is in French but is otherwise much like installing any other Windows
|
||||
program - I advise accepting the defaults and letting it all install. Note
|
||||
that "Suivant" means Next and "Oui" means Yes.</li>
|
||||
<li>At the end of the install leave the checkbox selected to "Lancer
|
||||
EasyPHP" (Start EasyPHP) and hit the 'Terminer" button. You might
|
||||
be taken to a information web page which you can safely ignore. </li>
|
||||
<li>If all went well - congratulations! Apache, PHP and MySQL are all installed
|
||||
and running! You should see a black E in your toolbar tray. You can right
|
||||
click on it to get a menu which will let you control the running programs.</li>
|
||||
<li>Some things may be in French and you may prefer English. You can download this file <a href="http://www.easyphp.org/telechargements/dn.php?F=indexUS_1.7">http://www.easyphp.org/telechargements/dn.php?F=indexUS_1.7</a> which contains English versions of www and home folder in the EasyPHP1-7 folder. These can be copied over the default files.</li>
|
||||
<li> The next thing you need to do is to set up a database for Moodle to use.
|
||||
Right-click the black E in the toolbar tray and choose Administration, then click DB Management (beside PHPMyAdmin).</li>
|
||||
<li>If asked for a username, use "<strong>root</strong>" with a <strong>blank password</strong>. You
|
||||
should see a phpMyAdmin web interface that allows you to create a new databases
|
||||
and user accounts. </li>
|
||||
<li>Create a new database by typing "moodle" into the field and
|
||||
hitting the "Create" button. That was easy!</li>
|
||||
<li>You can also create a new user to access your database if you want. This
|
||||
can be a bit tricky for a first-time user, so you might just want to use
|
||||
the existing user "root" with no password in your Moodle config
|
||||
for now, and fix this later.</li>
|
||||
<li> You're ready to install Moodle! Download the latest release of Moodle
|
||||
from <a href="http://moodle.org/download" target="_blank">http://moodle.org/download</a>,
|
||||
then unzip the archive.</li>
|
||||
<li>Copy your moodle files into <strong>C:\Program Files\EasyPHP\www. </strong>You
|
||||
can either copy the entire moodle directory (ie C:\Program Files\EasyPHP\www\moodle)
|
||||
or copy all the <em>contents</em> of the moodle directory. If you choose
|
||||
this second option then you will be able to access your Moodle home page
|
||||
using http://localhost/ instead of http://localhost/moodle/.</li>
|
||||
<li> Make a new empty folder somewhere else for Moodle to store uploaded files
|
||||
in, eg: <strong>C:\moodledata</strong></li>
|
||||
<li> Go into your Moodle folder. Make a copy of config-dist.php, and call
|
||||
it config.php</li>
|
||||
<li> Edit config.php using a text editor (Notepad will do, just be careful
|
||||
that it doesn't add unwanted spaces at the end). </li>
|
||||
<li>Put in all your new database info:<br />
|
||||
$CFG->dbtype = 'mysql';<br />
|
||||
$CFG->dbhost = 'localhost';<br />
|
||||
$CFG->dbname = 'moodle';<br />
|
||||
$CFG->dbuser = 'root'; <br />
|
||||
$CFG->dbpass = '';<br />
|
||||
$CFG->dbpersist = true;<br />
|
||||
$CFG->prefix = 'mdl_';</li>
|
||||
<li>And put in all your file paths:<br />
|
||||
$CFG->wwwroot = 'http://localhost/moodle'; // Use an external address
|
||||
if you know it. <br />
|
||||
$CFG->dirroot = 'C:\Program Files\EasyPHP\www\moodle'; <br />
|
||||
$CFG->dataroot = 'C:\moodledata';</li>
|
||||
<li>Save config.php - you can ignore the other settings if there are any.</li>
|
||||
<li>You're nearly there now! The rest of the setup is all web-based. Visit
|
||||
<a href="http://localhost/moodle/admin/" target="_blank">http://localhost/moodle/admin/</a>
|
||||
with your browser to continue the setup via your browser.</li>
|
||||
<li>To use zip files with Moodle (for example the backups use zip) you might
|
||||
need to enable "zlib". You can do this by going to your EasyPHP
|
||||
directory (<strong>C:\Program Files\EasyPHP</strong>), and running the program
|
||||
phpini.exe in there. Put a mark in the checkbox next to "zlib.dll".
|
||||
Close that window, then go to the black E in your toolbar and right-click
|
||||
it to get a menu - select "Restart" from this menu.</li>
|
||||
<li>Lastly, you need to set up some sort of cron. See the <a href="./?file=install.html">Installation
|
||||
guide</a> for more details on this.</li>
|
||||
</ol>
|
||||
<p>If you don't or can't use EasyPHP, here are some a few tips to make sure
|
||||
your PHP is set up correctly and avoid common problems:</p>
|
||||
<ul>
|
||||
<li>Make sure you enable the GD module so Moodle can process images - you
|
||||
may have to edit php.ini and remove the comment (;) from this line: 'extension=php_gd2.dll'.
|
||||
</li>
|
||||
<li>Make sure you enable the Zlib module so that you can create and unpack
|
||||
zip files from within Moodle.</li>
|
||||
<li>Make sure sessions is turned on - you may have to edit php.ini and fix
|
||||
the directory for <strong>session.save_path</strong> - instead of the default
|
||||
"/tmp" use a Windows directory like "c:/temp".</li>
|
||||
</ul>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,44 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
|
||||
<title>Moodle Docs: Introduction</title>
|
||||
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Introduction</h1>
|
||||
<blockquote>
|
||||
<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="?file=philosophy.html">social constructionist</a> framework of education. </p>
|
||||
<p>Moodle is provided freely as <a href="http://www.opensource.org/docs/definition_plain.html" target="_top">
|
||||
Open Source</a> software (under the <a href="http://www.gnu.org/copyleft/gpl.html" target="_top">
|
||||
GNU Public License</a>). Basically this means Moodle is copyrighted, but that
|
||||
you have additional freedoms. You are allowed to copy, use and modify Moodle
|
||||
provided that you agree to: <strong>provide the source to others</strong>; <strong>not
|
||||
modify or remove the original license and copyrights</strong>, and <strong>apply
|
||||
this same license to any derivative work</strong>. Read the license for full
|
||||
details and please contact the <a href="http://moodle.org/user/view.php?id=1&course=1">copyright
|
||||
holder</a> directly if you have any questions.
|
||||
</p>
|
||||
<p>Moodle will run on any computer that can run <a href="http://www.php.net/" target="_top">
|
||||
PHP</a>, and can support many types of database (particularly <a href="http://www.mysql.com/" target="_top">MySQL</a>).</p>
|
||||
<p>The word Moodle was originally 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. Anyone who uses Moodle is a Moodler.</p>
|
||||
<p>Come <a href="http://moodle.org/community/" target="_top">moodle with us</a>!</p>
|
||||
</blockquote>
|
||||
<p><br />
|
||||
</p>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,18 +10,17 @@
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
(For the most up-to-date version of this license, see <a href="http://docs.moodle.org/en/License">Moodle Docs</a>).
|
||||
|
||||
<h1>Copyright License for Moodle</h1>
|
||||
<blockquote>
|
||||
<p>The <u>name</u> <strong>Moodle™</strong> is a registered trademark of The Moodle Trust.<br />
|
||||
If you are intending to use the name to promote commercial Moodle services,<br />
|
||||
then you must seek permission from the Trust via the <a href="http://moodle.com/helpdesk/">moodle.com helpdesk</a>,<br />
|
||||
in accordance with normal trademark restrictions. There are no restrictions<br />
|
||||
on how you use the name in other contexts.<br />
|
||||
If you are intending to use the name to advertise commercial generic Moodle services (eg Moodle Hosting, Moodle Support, Moodle Certification etc), then you must seek direct permission in writing from Martin Dougiamas via the <a href="http://moodle.com/helpdesk">moodle.com helpdesk</a>, in accordance with normal trademark restrictions. There are no restrictions on how you use the name in other contexts (for example, if you use Moodle just to provide courses then you can use the name freely to refer to it.) If you aren't sure of a particular case, please ask us via the moodle.com helpdesk: we'll be happy to either provide you with official permission in writing or help you fix your wording.
|
||||
</p>
|
||||
|
||||
<p>The <u>software</u> Moodle is Copyright © 1999 onwards,
|
||||
<a href="http://dougiamas.com/">Martin Dougiamas</a>.</p>
|
||||
<a href="http://dougiamas.com/">Martin Dougiamas</a> with portions contributed by many others.</p>
|
||||
|
||||
<p>This program is free software; you can redistribute it and/or modify<br />
|
||||
it under the terms of the GNU General Public License as published by<br />
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Frequently Asked Questions (FAQ)</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Other documentation</h1>
|
||||
<p class="normaltext">Here are some links to other sources of Moodle documentation:</p>
|
||||
<p class="normaltext"><a href="../help.php?file=index.html">Index of all Moodle
|
||||
help pages</a> - a list of all the context-sensitive help files within Moodle</p>
|
||||
<p class="normaltext"><a href="http://moodle.org/docs/">User-contributed documentation</a>
|
||||
- this page lists documentation contributed by Moodle users</p>
|
||||
<p align="center" class="normaltext"> </p>
|
||||
<hr />
|
||||
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,53 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
|
||||
<title>Moodle Docs: Philosophy</title>
|
||||
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h1>Philosophy</h1>
|
||||
|
||||
<blockquote>
|
||||
<p>The design and development of Moodle is guided by a particular philosophy of learning, a way of thinking that you may see referred to in shorthand as a "<em>social constructionist pedagogy</em>". (Some of you scientists may already be thinking "soft education mumbo jumbo" and reaching for your mouse, but please read on - this is useful for every subject area!)</p>
|
||||
<p>This page tries to explain in simple terms what that phrase means by unpacking <strong>four main concepts</strong> behind it. Note that each of these is summarising one view of an immense amount of diverse research so these definitions may seem thin if you have read about these before.</p>
|
||||
<p>If these concepts are completely new to you then it is likely that these ideas will be hard to understand at first - all I can recommend is that you read it carefully, while thinking about your own experiences of trying to learn something.<br />
|
||||
</p>
|
||||
<h3>1. Constructivism</h3>
|
||||
<blockquote>
|
||||
<p>This point of view maintains that people actively <strong>construct</strong> new knowledge as they interact with their environment. </p>
|
||||
<p>Everything you read, see, hear, feel, and touch is tested against your prior knowledge and if it is viable within your mental world, may form new knowledge you carry with you. Knowledge is strengthened if you can use it successfully in your wider environment. You are not just a memory bank passively absorbing information, nor can knowledge be "transmitted" to you just by reading something or listening to someone.</p>
|
||||
<p>This is not to say you can't learn anything from reading a web page or watching a lecture, obviously you can, it's just pointing out that there is more interpretation going on than a transfer of information from one brain to another.<br />
|
||||
</p>
|
||||
</blockquote>
|
||||
<h3>2. Constructionism</h3>
|
||||
<blockquote>
|
||||
<p>Constructionism asserts that learning is particularly effective when constructing something for others to experience. This can be anything from a spoken sentence or an internet posting, to more complex artifacts like a painting, a house or a software package.</p>
|
||||
<p>For example, you might read this page several times and still forget it by tomorrow - but if you were to try and explain these ideas to someone else in your own words, or produce a slideshow that explained these concepts, then I can guarantee you'd have a better understanding that is more integrated into your own ideas. This is why people take notes during lectures, even if they never read the notes again.<br />
|
||||
</p>
|
||||
</blockquote>
|
||||
<h3>3. Social Constructivism</h3>
|
||||
<blockquote>
|
||||
<p>This extends the above ideas into a social group constructing things for one another, collaboratively creating a small culture of shared artifacts with shared meanings. When one is immersed within a culture like this, one is learning all the time about how to be a part of that culture, on many levels.</p>
|
||||
<p>A very simple example is an object like a cup. The object can be used for many things, but its shape does suggest some "knowledge" about carrying liquids. A more complex example is an online course - not only do the "shapes" of the software tools indicate certain things about the way online courses should work, but the activities and texts produced within the group as a whole will help shape how each person behaves within that group.<br />
|
||||
</p>
|
||||
</blockquote>
|
||||
<h3>4. Connected and Separate</h3>
|
||||
<blockquote>
|
||||
<p>This idea looks deeper into the motivations of individuals within a discussion. <strong>Separate</strong> behaviour is when someone tries to remain 'objective' and 'factual', and tends to defend their own ideas using logic to find holes in their opponent's ideas. <strong>Connected</strong> behaviour is a more empathic approach that accepts subjectivity, trying to listen and ask questions in an effort to understand the other point of view. <strong>Constructed</strong> behaviour is when a person is sensitive to both of these approaches and is able to choose either of them as appropriate to the current situation.</p>
|
||||
<p>In general, a healthy amount of connected behaviour within a learning community is a very powerful stimulant for learning, not only bringing people closer together but promoting deeper reflection and re-examination of their existing beliefs.</p>
|
||||
</blockquote>
|
||||
<hr />
|
||||
<p>Once you are thinking about all these issues, it helps you to focus on the experiences that would be best for learning from the learner's point of view, rather than just publishing and assessing the information you think they need to know. It can also help you realise how each participant in a course can be a teacher as well as a learner. Your job as a 'teacher' can change from being 'the source of knowledge' to being an influencer and role model of class culture, connecting with students in a personal way that addresses their own learning needs, and moderating discussions and activities in a way that collectively leads students towards the learning goals of the class.</p>
|
||||
<p>Obviously Moodle doesn't force this style of behaviour, but this is what it is best at supporting. In future, as the technical infrastructure of Moodle stabilises, further improvements in pedagogical support will be a major direction for Moodle development.</p>
|
||||
</blockquote>
|
||||
<hr />
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,537 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
|
||||
<title>Moodle Docs: Current Release notes</title>
|
||||
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
|
||||
<style type="text/css">
|
||||
<!--
|
||||
dt {font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif; font-weight: bold;}
|
||||
dd {margin-bottom:1em;}
|
||||
dl {margin-left: 40px;}
|
||||
.style1 {font-weight: bold}
|
||||
-->
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
|
||||
<h1>Latest Release notes</h1>
|
||||
|
||||
<h2>Moodle 1.5.3 (11th November, 2005) </h2>
|
||||
|
||||
<p>(Because this release contains important security fixes, we highly advise
|
||||
that sites using any previous version of Moodle upgrade to this version
|
||||
as soon as possible.)</p>
|
||||
|
||||
<h3>A few new things</h3>
|
||||
<ul type="circle">
|
||||
<li> We now have SCORM 1.3 (SCORM 2004) support!</li>
|
||||
<li> A new Single-Sign-On API is available</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3>Various fixes</h3>
|
||||
|
||||
<h4>General</h4>
|
||||
<ul type="circle">
|
||||
<li> Contains warnings when Moodle is used on an PHP configuration known to be insecure</li>
|
||||
<li> Contains fixes for some recently reported security problems (see <a href="http://security.moodle.org/">security.moodle.org)</a>)</li>
|
||||
<li> Backups now runs a lot faster medium/large installs. Many issues fixed in this area </li>
|
||||
<li> Listing of directory sizes can be made <em>much</em> faster on Linux/Unix servers, thanks to a performance fix you can enable from Admin->Variables: "path_to_du"</li>
|
||||
<li> We now log more meaningful IP addresses when the server or the clients are working behind a proxy</li>
|
||||
<li> Fixed some issues with PHP accelerators</li>
|
||||
<li> Upgrade scripts have been refined and work much better for PostgreSQL installations</li>
|
||||
<li> General PostgreSQL port code cleanup</li>
|
||||
<li> Upgrading to 1.5.3 will fix any legacy Journal to Online Assignment upgrade issues</li>
|
||||
<li> RSS libraries now support <em>RSS 2.0 categories</em>, see <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3654" target="_blank">bug 3654</a></li>
|
||||
<li> Better accesibilty in file uploads, see <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3662" target="_blank">bug 3662</a></li>
|
||||
<li> Better support for site-wide HTTPS, see <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3848" target="_blank">bug 3848</a></li>
|
||||
<li> We now send away bots (like Googlebot) from that try mangled URLs, see <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3958" target="_blank">bug 3958</a></li>
|
||||
<li> Better <a href="http://moodle.org/mod/forum/discuss.php?d=29564" target="_blank">DST support for non-logged-in users</a></li>
|
||||
<li> Better DST support for repeat events in Calendar</li>
|
||||
<li> Small fixes to the lesson, choice and grade modules</li>
|
||||
<li> Minor CSS improvements to formal_white and orangewhite themes</li>
|
||||
<li> Better pagination in course listing and loglive pages</li>
|
||||
<li> Fixed an IE-only bug related to HTMLArea content where user-edited tables could float and hide part of the UI.</li>
|
||||
</ul>
|
||||
|
||||
<h4>Authentication</h4>
|
||||
<ul type="circle">
|
||||
<li> Fixes to change password/forgotten password with external auth</li>
|
||||
<li> Data fetched from external DB or LDAP is now truncated correctly</li>
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=4305" target="_blank">bug 4305</a> -- better login block behaviour when using secureforms</li>
|
||||
<li> Better support for utf-8 user data from external auth</li>
|
||||
<li> LDAP: General fixes covering sync_users script and logging of errors</li>
|
||||
<li> LDAP: Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3141" target="_blank">bug 3141</a> - Can't update external data
|
||||
with LDAP authentication</li>
|
||||
|
||||
<li> LDAP: Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3992" target="_blank">bug 3992</a> - LDAP password including a
|
||||
quote does not work - credits go to Kita</li>
|
||||
<li> LDAP: Better support for ActiveDirectory.</li>
|
||||
<li> LDAP: Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3594" target="_blank">bug #3594</a></li>
|
||||
<li> LDAP: Better handling of multi-source field mapping</li>
|
||||
<li> LDAP: Fix for using DN as idnumber - thanks fo Jeff Graham - <a href="http://moodle.org/mod/forum/discuss.php?d=28840" target="_blank">http://moodle.org/mod/forum/discuss.php?d=28840</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h4>Enrolment & Metacourses</h4>
|
||||
<ul type="circle">
|
||||
<li> Metacourses: Prevent normal users to gain access to meta courses via manual enrolment</li>
|
||||
<li> Metacourses: better support for MySQL v3.23.x</li>
|
||||
<li> DB: Enrolment lookups now work reliably with Moodle on MySQL and Postgres</li>
|
||||
<li> DB: Non-MySQL databases work again as external enrolment databases</li>
|
||||
<li> LDAP: Fixed a wrong call to add_teacher in LDAP plugin.</li>
|
||||
<li> LDAP: Servers being down or unavailable no longer prevent logins</li>
|
||||
<li> LDAP: Course auto-creation works again</li>
|
||||
<li> LDAP: Fixed several bugs reported by Jeff Graham and Barron Koralesky -- including bugs 3912 and 3974</li>
|
||||
<li> LDAP: We can now bind non-anonymously to LDAP</li>
|
||||
<li> Authorize.net: several fixes</li>
|
||||
</ul>
|
||||
|
||||
<h4>Resources</h4>
|
||||
<ul type="circle">
|
||||
<li> Bugfix: Avoid linking to empty or unlinkable activity names</li>
|
||||
</ul>
|
||||
|
||||
<h4>Forums</h4>
|
||||
<ul type="circle">
|
||||
<li> Big and small optimizations to tracking of read/unread messages, specially for PostgreSQL</li>
|
||||
<li> Fixed some PostgreSQL bugs</li>
|
||||
<li> Some more actions are now supported by backup/restore when processing log records, see <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3852">bug 3582</a></li>
|
||||
<li> Now message forum RSS feeds are including category data -- useful under some RSS agregators able to group messages, see <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3654" target="_blank">bug 3654</a></li>
|
||||
<li> Fixed paging on forum search</li>
|
||||
</ul>
|
||||
|
||||
<h4>Blocks</h4>
|
||||
<ul type="circle">
|
||||
<li> Several performance improvements </li>
|
||||
<li> Fixes to the upgrade process, including PostgreSQL syntax and lower memory usage</li>
|
||||
<li> Brought in several bugfixes from 1.6dev</li>
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3478" target="_blank">bug 3478</a>: Cannot add RSS feed as course creator</li>
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3793" target="_blank">bug 3793</a>:
|
||||
Prevent warning message when configuring a glossary_random block in
|
||||
a course which has no glossaries</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<h4>Quiz</h4>
|
||||
<ul type="circle">
|
||||
<li> Some CSS style fixes</li>
|
||||
<li> Better compatibility with themes that contain forms in the headers</li>
|
||||
<li> Highlighting of correct answers can now be turned off</li>
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3986" target="_blank">bug 3986</a>: Too many random questions.
|
||||
(mindforge)</li>
|
||||
<li> Fixed
|
||||
<a href="http://moodle.org/mod/forum/discuss.php?d=28466#139179">missing action icons</a></li>
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3899" target="_blank">bug 3899</a> and removed some 'missing
|
||||
course object' messages</li>
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3950" target="_blank">bug 3950</a>: Ee-attempt button inconsistency for multi-attempt quizzes</li>
|
||||
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3953" target="_blank">bug 3953</a>: Quiz/report.php pagesize can be set to 0, credits to Jean-Michel</li>
|
||||
|
||||
<li> Fixed potential data data corruption <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3915" target="_blank">bug 3915</a></li>
|
||||
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3884" target="_blank">bug 3884</a>: Quiz correct highlights missing for 2 of 3 options.</li>
|
||||
|
||||
|
||||
<li> Fix for the <a href="http://moodle.org/mod/forum/discuss.php?d=26526">Student review highlight doesn't seem to work</a> bug</li>
|
||||
|
||||
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3804" target="_blank">bug 3804</a>: Differences in question types between 1.5 and 1.6</li>
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3822" target="_blank">bug 3822</a>: don't count previews as attempts</li>
|
||||
<li> Fixed <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3807" target="_blank">bug 3807</a>: Question numbering issue</li>
|
||||
<li> Fixes for the <a href="http://moodle.org/mod/forum/discuss.php?d=27553" target="_blank">item analysis
|
||||
plug-in</a>, assembled by Jean-Michel</li>
|
||||
<li> Now we reset the timeout counter to <a href="http://moodle.org/mod/forum/discuss.php?d=24790#129431" target="_blank">avoid timeouts</a></li>
|
||||
<li> Several <a href="http://moodle.org/mod/forum/discuss.php?d=27766" target="_blank">improvements</a> contributed by Jean-Michel Vedrine. You can now change the number of attempts per page displayed on screen, and download results to Excel/text file, including detailed grades</li>
|
||||
<li> Fixed export bug with non-English languages</li>
|
||||
</ul>
|
||||
|
||||
<h4>SCORM</h4>
|
||||
<ul type="circle">
|
||||
<li> We now support SCORM 1.3 (SCORM 2004)!</li>
|
||||
<li> Fixed a bug with next and prev SCO search</li>
|
||||
<li> Fixed bugs related to masteryscore</li>
|
||||
<li> Fixed a problem in AICC course tracking</li>
|
||||
</ul>
|
||||
|
||||
<h4>Wiki</h4>
|
||||
<ul type="circle">
|
||||
<li> Now paging of older versions is showed
|
||||
and working properly, see <a href="http://moodle.org/bugs/bug.php?op=show&bugid=3750" target="_blank">bug 3750</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
<h4>Filters</h4>
|
||||
<ul type="circle">
|
||||
<li> Mediaplugin filter now <a href="http://moodle.org/mod/forum/discuss.php?d=27630" target="_blank"> finds multi-line links in HTML code</a></li>
|
||||
<li> Censor filter: Added original word as title to the
|
||||
blacked-out version. The filter can obscure actual
|
||||
important words by mistake (eg Dickens) and there needs to be some
|
||||
way to recover the meaning</li>
|
||||
</ul>
|
||||
|
||||
<!-- Roll of honour for the 1.5.3 release
|
||||
(computed very roughly)
|
||||
|
||||
<li>Committers and number of commits:</li> <ul>
|
||||
|
||||
<li>adamtpaw: 7</li>
|
||||
<li>bobopinna: 7</li>
|
||||
<li>danmarsden: 1</li>
|
||||
<li>defacer: 14</li>
|
||||
<li>dhawes: 2</li>
|
||||
<li>dlnsk: 1</li>
|
||||
<li>ethem: 2</li>
|
||||
<li>gbateson: 6</li>
|
||||
<li>gustav_delius: 13</li>
|
||||
<li>ikawhero: 5</li>
|
||||
<li>julmis: 8</li>
|
||||
<li>martignoni: 20</li>
|
||||
<li>martinlanghoff: 35</li>
|
||||
<li>michaelpenne: 12</li>
|
||||
<li>mindforge: 26</li>
|
||||
<li>mjollnir_: 39</li>
|
||||
<li>moodler: 67</li>
|
||||
<li>mudrd8mz: 6</li>
|
||||
<li>paca70: 5</li>
|
||||
<li>patrickslee: 24</li>
|
||||
<li>skodak: 36</li>
|
||||
<li>stronk7: 32</li>
|
||||
<li>thepurpleblob: 18</li>
|
||||
<li>urs_hunkler: 7</li>
|
||||
</ul>
|
||||
|
||||
-->
|
||||
|
||||
<h2>Moodle 1.5.2 (16th July, 2005) </h2>
|
||||
|
||||
<h3>Various fixes</h3>
|
||||
<ul type="circle">
|
||||
<li>Journal -> Assignment upgrade now works properly :-/</li>
|
||||
<li>Assignment submodules now upgrade as expected</li>
|
||||
<li>Various other bugs with new Assignments fixed</li>
|
||||
<li>Journal module is now disabled by default on new installations</li>
|
||||
<li>Login page is now 100% HTTPS if required</li>
|
||||
<li>Various small standard theme tweaks</li>
|
||||
<li>Fix for recent matching questions display bug in Quiz</li>
|
||||
<li>Language editor no longer creates empty files when not necessary (caused country list bug)</li>
|
||||
<li>Fixed some manifest parsing problems in SCORM module</li>
|
||||
<li>Multilang filter now deals with pack names that contain numbers</li>
|
||||
<li>Files are now force-downloaded (fixes IE problems and some security issues)</li>
|
||||
<li>Relinking debugging output is escaped</li>
|
||||
<lI>Large MP3 player now displays ID3 tags properly again</li>
|
||||
<li>Some chat daemon improvements</li>
|
||||
</ul>
|
||||
|
||||
<h3>Some new things</h3>
|
||||
<ul type="circle">
|
||||
<li>Orangewhite theme optimised for use on PDA</li>
|
||||
<li>Forum user posts page can be called without userid</li>
|
||||
<li>Altavista BabelFish now allowed in as guest when Google is</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<hr />
|
||||
<h2>Moodle 1.5.1 (8th July, 2005) </h2>
|
||||
|
||||
<h3>Various fixes</h3>
|
||||
<ul type="circle">
|
||||
<li>Several potential security problems solved</li>
|
||||
<li>Allowobjectembed setting now works correctly</li>
|
||||
<li>Speed problem on IE, caused by tab hover fixed.</li>
|
||||
<li>Cut and paste in editor on Firefox has a more helpful warning message</li>
|
||||
<li>Fixed a session problem when logged on as admin during upgrade from very old Moodle version</li>
|
||||
<li>Fixed editing problem in Main menu of site</li>
|
||||
<li>Minor CSS display problems in a few areas were fixed</li>
|
||||
<li>Fixed the adding of a single discussion forum</li>
|
||||
<li>Fixed Lesson problems with calculating grades, and dates </li>
|
||||
<li>Fixed Lesson problems with entering a cluster after a page</li>
|
||||
<li>Censor filter was fixed to make it work better with old themes</li>
|
||||
</ul>
|
||||
|
||||
<h3>Some new things</h3>
|
||||
<ul type="circle">
|
||||
<li>New theme: Wood</li>
|
||||
<li>Metal theme updated for 1.5</li>
|
||||
<li>Many language updates for most languages, including a new language: Khmer</li>
|
||||
<li>Block classes can now run custom code when an instance is created/deleted (this is useful for
|
||||
blocks that need to set up non-trivial data structures)</li>
|
||||
<li>Wizard for Calculated Questions in Quiz was rewritten</li>
|
||||
<li>Backup/Restore module selection is now improved and much easier</li>
|
||||
<li>Backup/Restore module has much improved relinking support, it's now faster and easier to implement in new modules</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
<h2>Moodle 1.5 (5th June, 2005) </h2>
|
||||
|
||||
<h3>Headline features</h3>
|
||||
<ul type="circle">
|
||||
<li> Web pages are compliant with XHTML Transitional 1.0</li>
|
||||
|
||||
<li> Improved <b>Accessibility</b>, aiming for compliance with WAI (W3C), SENDA (UK) and Section 508 (US) criteria.</li>
|
||||
<li> Very strong <b>new Themes system</b>, allowing cascading themes, user themes, course themes, with very fine control of every page in Moodle via CSS.</li>
|
||||
|
||||
<li> Integrated <b>Messaging</b> feature for direct communication between all users in the site, featuring realtime popup windows, notification, email copies, blocking, history, WYSIWYG editor, etc</li>
|
||||
<li> Forum read/unread tracking with highlights allows you to see new postings at a glance and to control how these are displayed (per forum, per user or per site).</li>
|
||||
<li> New <b>Blocks</b> system, allowing multiple copies of blocks and better block configuration</li>
|
||||
|
||||
<li> Full support for <b>Daylight Savings Time</b> in every locality around the globe, so everyone always see the correct local time for all events.</li>
|
||||
|
||||
<li> New <b>extended gradebook</b> allowing custom weighting of different activities, setting extra grades (or taking out others) and improved display and sorting options </li>
|
||||
|
||||
<li> Users can be required to agree to a <b>Site Policy</b> </li>
|
||||
</ul>
|
||||
|
||||
<h3>Other Major System-wide Improvements</h3>
|
||||
<h4>Admin </h4>
|
||||
<ul type="circle">
|
||||
<li> New "maintenance mode" allows the admin to temporarily disable a site (during upgrades, for example).</li>
|
||||
|
||||
<li> Moodle can automatically download a new list of timezones from moodle.org or elsewhere and install it to the database (Olson files are supported too)</li>
|
||||
<li> New version of Moodle MySQL Admin module (available separately)</li>
|
||||
|
||||
<li> New calendar options page provides user interface to configure the behavior of the calendar </li>
|
||||
</ul>
|
||||
|
||||
<h4>Authentication</h4>
|
||||
|
||||
<ul type="circle">
|
||||
<li> New Shibboleth Support</li>
|
||||
<li> New CAS Support</li>
|
||||
<li> New PAM Support</li>
|
||||
<li> Improved LDAP integration, so that LDAP can now control course creation, group assignments. Increased performance and scalability performing user synchronisation.</li>
|
||||
|
||||
<li> Certain user fields can be locked by the admin when using external authentication</li>
|
||||
<li> Improved session handling now detects "crossover" sessions that we have found in some buggy PHP installations and prevents them</li>
|
||||
<li> Sessions can now be stored in the database (good for clustered installations!)</li>
|
||||
|
||||
<li> Users can be forced to change their password </li>
|
||||
</ul>
|
||||
|
||||
<h4>Files</h4>
|
||||
<ul type="circle">
|
||||
<li> Standardised file browsing in all areas</li>
|
||||
<li> Improved uploading, with support for automated Virus scanning of new documents using ClamAV.</li>
|
||||
|
||||
<li> Slasharguments now work also on IIS (upgrade to PHP 4.3.11 needed for ISAPI) </li>
|
||||
</ul>
|
||||
|
||||
<h4>Filters</h4>
|
||||
<ul type="circle">
|
||||
<li> Standardised filter library makes it trivial to write new filters that require searching and highlighting of text.</li>
|
||||
|
||||
<li> Huge efficiency improvements for complex filters like the Glossary filter</li>
|
||||
<li> New Tidy filter uses the W3C Tidy program to (optionally) clean all user-entered texts throughout the site and convert it to valid XHTML code</li>
|
||||
<li> Improved censorship filter, now "blacks out" words using styles and uses a word list from the language packs.</li>
|
||||
|
||||
<li> Improved Flash MP3 player, now shows progress bar while downloading and playing</li>
|
||||
<li> Improved Multi-language filter is faster, more forgiving of syntax errors, and uses new editor-friendly syntax: <span lang="en"></span></li>
|
||||
<li> Auto-linking filters (glossary, activities) can work to link all the occurrences (old behaviour), once for each text block or only once for the whole page ($CFG->filtermatchonepertext, $CFG->filtermatchoneperpage).</li>
|
||||
|
||||
<li> More text can now be filtered in Moodle, including activity names, headings and other such small texts. This makes it possible to design completely multi-lingual sites in Moodle that fully appears in the user's chosen language. </li>
|
||||
</ul>
|
||||
|
||||
<h4>Themes</h4>
|
||||
<ul type="circle">
|
||||
<li> Modules can provide standard styles </li>
|
||||
<li> Themes can override required styles of other themes</li>
|
||||
|
||||
<li> Users and courses can choose their own themes if the admin allows it</li>
|
||||
<li> Implementation of tabs interface on many pages </li>
|
||||
<li> Modules, Blocks and Languages can define their own standard styles </li>
|
||||
</ul>
|
||||
|
||||
<h4> HTML Editor</h4>
|
||||
<ul type="circle">
|
||||
<li> The toolbuttons offered in the editor toolbar are now configurable by the admin</li>
|
||||
<li> Search and Replace text within the editor text area (with optional use of regular expressions) </li>
|
||||
</ul>
|
||||
|
||||
<h4> Course management</h4>
|
||||
|
||||
<ul type="circle">
|
||||
<li> Transparent Blackboard 5.5 course importing (partial 6.0 support)</li>
|
||||
<li> The new meta-courses allow to get users automatically enroled in a general course (the metacourse) when enroled in any of the metacourse-linked courses</li>
|
||||
<li> New tool to copy content from a course to other. </li>
|
||||
</ul>
|
||||
|
||||
<h4> New blocks </h4>
|
||||
<ul type="circle">
|
||||
<li> HTML block: allowing to place arbitrary content (text, images links) in any course mainpage </li>
|
||||
<li> Remote RSS feed: allows to display external news channels inside a Moodle course</li>
|
||||
|
||||
<li> Glossary Selection: to choose and display content from a Moodle glossary in course mainpage </li>
|
||||
</ul>
|
||||
|
||||
<h4> Calendar</h4>
|
||||
<ul type="circle">
|
||||
<li> Major speed improvements for sites with a large number of courses using groups</li>
|
||||
|
||||
<li> Repeating events can now be modified or deleted all at the same time or separately as before</li>
|
||||
<li> New "remember filter settings" preference that allows calendar filters to remember their status between logins </li>
|
||||
</ul>
|
||||
|
||||
<h3> Activity Module Improvements</h3>
|
||||
<h4>Assignment</h4>
|
||||
<ul type="circle">
|
||||
<li> Completely refactored into a new class-based design, allowing new plugin-assignment types</li>
|
||||
<li> New Online Text assignment type that doesn't require files and allows inline comments when grading - this new type effectively replaces the old Journal module</li>
|
||||
<li> Vastly improved grading interface for handling large classes</li>
|
||||
|
||||
<li> New configuration options to disable late submission and to e-mail alerts to teachers when students submit new work </li>
|
||||
</ul>
|
||||
|
||||
<h4>Chat</h4>
|
||||
<ul type="circle">
|
||||
<li> Streamlined interface looks smoother, works faster, even without using the optional server daemon</li>
|
||||
|
||||
<li> Blocks can now be added to chat pages (e.g. for additional information) </li>
|
||||
</ul>
|
||||
|
||||
<h4>Choice</h4>
|
||||
<ul type="circle">
|
||||
<li> Rewritten to allow any number of choices</li>
|
||||
|
||||
<li> The number of users per choice can be limited, which allows it to be used as tool for "signing up" to an array of options.</li>
|
||||
<li> You can now download the results of the choice to XLS or a TXT file </li>
|
||||
</ul>
|
||||
|
||||
<h4>Forum</h4>
|
||||
<ul type="circle">
|
||||
|
||||
<li> Powerful new Google-like forum searching tools</li>
|
||||
<li> Forum read/unread tracking - unread messages are highlighted on the course page, forum page, discussion listing and the discussion view</li>
|
||||
<li> The tracking system may be disabled by teachers/users </li>
|
||||
<li> User profiles show all posts by a user, as well as all discussions</li>
|
||||
<li> When admins edit user messages, a notice is attached </li>
|
||||
|
||||
<li> Discussion listing shows the last user who posted to each discussion and when it was, with a direct link to that post</li>
|
||||
<li> In group-enabled forums the discussion listing shows the group the thread applies to, with a link to the group description page. </li>
|
||||
</ul>
|
||||
|
||||
<h4>Glossary</h4>
|
||||
<ul type="circle">
|
||||
<li> New setting to enable/disable the print view of each glossary.</li>
|
||||
|
||||
<li> New search system looks for words everywhere (instead of doing exact phrase match).</li>
|
||||
<li> More information is sent to logs to be able to track activity better. </li>
|
||||
</ul>
|
||||
|
||||
<h4>Journal</h4>
|
||||
<ul type="circle">
|
||||
<li> The Journal module has not changed since 1.4, and is now deprecated. The upgrade procedure
|
||||
will convert all your Journal activities into Online Assignments, and hide all the old Journal
|
||||
activities. If you don't want this to happen, then define this in your config.php: $CFG->noconvertjournals = true;</li>
|
||||
</ul>
|
||||
|
||||
<h4>Lesson</h4>
|
||||
|
||||
<ul type="circle">
|
||||
<li> Now supports timed Lessons</li>
|
||||
<li> Can create practice Lessons (grades are not stored)</li>
|
||||
<li> Option for students to view points earned while taking the Lesson</li>
|
||||
<li> Allow students to review their answers before submitting the Lesson</li>
|
||||
|
||||
<li> New Slide Show Mode (only branch tables are displayed as slides)</li>
|
||||
<li> New Left Menu (for enabled branch tables only)</li>
|
||||
<li> Lessons can now be Password Protected</li>
|
||||
<li> A Tree View can be used for the Lesson creation screen</li>
|
||||
|
||||
<li> Students can post their high scores</li>
|
||||
<li> New option to save a Lesson's settings as defaults for new lessons in the same course</li>
|
||||
<li> Can delete a student's attempts</li>
|
||||
<li> New page Jumps:
|
||||
<ul type="circle">
|
||||
|
||||
<li> Previous Page</li>
|
||||
<li> Unseen question within a branch</li>
|
||||
<li> Random question within a branch</li>
|
||||
<li> Unseen question within a cluster </li>
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
<li> Added functionality to view Lesson statistics</li>
|
||||
<li> New question type: Essay. Teachers can view each essay and write comments, assign a grade, and then email it all to the student</li>
|
||||
<li> New question creation interface </li>
|
||||
|
||||
</ul>
|
||||
|
||||
<h4>Quiz</h4>
|
||||
|
||||
<ul type="circle">
|
||||
<li> Can handle adaptive questions, i.e., questions that allow the student to interact with them repeatedly within the same quiz attempt and that can change in response to student answers.</li>
|
||||
<li> Student can be allowed to try a question again immediately within the same quiz attempt until they get the answer right.</li>
|
||||
<li> There is a penalty mechanism that deducts a specified fraction of the mark for each wrong attempt at a question.</li>
|
||||
|
||||
<li> Allows questions rendered and scored externally (e.g., by mathematical assessment engines) to be integrated seamlessly into Moodle quizzes via the RQP web services protocol.</li>
|
||||
<li> Is prepared for the handling of IMS QTI questions once web services for these become available.</li>
|
||||
<li> New tabbed teacher interface for previewing, editing, and reviewing quizzes.</li>
|
||||
<li> New "improved security" mode shows quiz in a separate full-screen window, with many browser features disabled</li>
|
||||
|
||||
<li> Quizzes can be presented to students in several pages. The number of questions per page is selectable by the teacher.</li>
|
||||
<li> Blocks can now be added to quiz pages (to show results table, or additional information etc)</li>
|
||||
<li> Better and cleaner interface for question selection and management in the database. Selected questions can be added to quiz, moved to other categories or deleted en mass.</li>
|
||||
|
||||
<li> Random questions are now added to the quiz question list with a dedicated button, leaving a cleaner interface at questions database without phantom placeholders</li>
|
||||
|
||||
<li> Final grade can be a fractional number, with teacher-defined decimal figures </li>
|
||||
<li> Improved results page with user-selectable display of columns, cleaner sorting and new mark display options </li>
|
||||
<li> Questions can be edited with one click from the improved quiz preview and question preview screens.</li>
|
||||
<li> Questions can be copied with one click, to allow question variations to be created with ease.</li>
|
||||
<li> Revamped question categories structures and editing interface. </li>
|
||||
|
||||
<li> Categories now can contain nested subcategories and can be re-ordered. </li>
|
||||
<li> It is possible to select whether questions from categories, and or their subcategories are displayed on the question edit page. </li>
|
||||
<li> It is now possible to select whether to add random questions from a parent category alone, or from a parent category and its sub-categories. </li>
|
||||
<li> Quiz creators are prevented from changing the question set of quizes that have had student responses. </li>
|
||||
<li> Recognition, and rejection, of overlapping/redundant questions has been improved. </li>
|
||||
|
||||
<li> The display of questions in longer quiz categories on the quiz editing page is now paginated. </li>
|
||||
<li> New export types - IMS QTI (2.0) and xhtml. Improvements & fixes to others.</li>
|
||||
<li> New import type - Hot Potato. Improvements & fixes to others. </li>
|
||||
|
||||
</ul>
|
||||
|
||||
<h4>Scorm </h4>
|
||||
<ul type="circle">
|
||||
<li> The module is now fully conformant with the SCORM 1.2 standard.</li>
|
||||
<li> User result data storage and reporting was improved. </li>
|
||||
<li> AICC packages can now be imported. </li>
|
||||
</ul>
|
||||
|
||||
<h4>Survey</h4>
|
||||
<ul type="circle">
|
||||
<li> Graph formatting has been improved (labels are more readable)</li>
|
||||
</ul>
|
||||
|
||||
<h4>Wiki </h4>
|
||||
<ul type="circle">
|
||||
<li> Changes to wiki pages are now monitored and displayed in Recent Activity block</li>
|
||||
<li> Several under the hood improvements to backup/restore and other routines that enhance the reliability of wikis </li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<br />
|
||||
<br />
|
||||
<div align="center" class="style1"><strong><font size="+1">If you experience any bugs in this release, please report them <a href="http://moodle.org/bugs" target="_blank">moodle.org/bugs</a> so we can fix them in the next release.</font></strong></div>
|
||||
<br />
|
||||
<center>
|
||||
<p>
|
||||
<a href="./?file=releaseold.html">Old release information</a>
|
||||
</p>
|
||||
</center>
|
||||
<br />
|
||||
<p align="center"><font size="1"><a href="../doc/" target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,235 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Teachers Manual</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Teacher Manual</h1>
|
||||
<p>This page is a very quick guide to creating online courses with Moodle. It
|
||||
outlines the main functions that are available, as well as some of the main
|
||||
decisions you'll need to make.</p>
|
||||
<p>Sections in this document:</p>
|
||||
<ol>
|
||||
<li><a href="#started">Getting started</a></li>
|
||||
<li><a href="#settings">Course settings</a></li>
|
||||
<li><a href="#upload">Uploading files</a></li>
|
||||
<li><a href="#activities">Setting up activities</a></li>
|
||||
<li><a href="#course">Running the course</a></li>
|
||||
<li><a href="#further">Further information</a></li>
|
||||
</ol>
|
||||
<h3 class="sectionheading"><a name="started"></a>Getting started</h3>
|
||||
<blockquote>
|
||||
<p>This document assumes your site administrator has set up Moodle and given
|
||||
you new, blank course to start with. It also assumes you have logged in to
|
||||
your course using your teacher account.</p>
|
||||
<p>Here are three general tips that will help you get started.</p>
|
||||
<ol>
|
||||
<li><strong>Don't be afraid to experiment:</strong>
|
||||
<blockquote>feel free to poke around and change things. It's hard to break anything
|
||||
in a Moodle course, and even if you do it's usually easy to fix it.
|
||||
</blockquote>
|
||||
<li><strong>Notice and use these little icons</strong>:
|
||||
<blockquote>
|
||||
<p> <img src="../pix/i/edit.gif" /> - the <strong>edit icon</strong>
|
||||
lets you edit whatever it is next to.</p>
|
||||
<p><img src="../pix/help.gif" width="22" height="17" /> - the <strong>help
|
||||
icon</strong> will provide you with a <a target="helpwindow" href="../help.php?file=index.html">popup help window</a></p>
|
||||
<p> <img src="../pix/i/hide.gif" width="16" height="16" /> - the <strong>open-eye
|
||||
icon</strong> will let you hide something from students</p>
|
||||
<p> <img src="../pix/i/show.gif" width="16" height="16" /> - the <strong>closed-eye
|
||||
icon</strong> will make a hidden item available</p>
|
||||
</blockquote>
|
||||
</li>
|
||||
<li><strong>Use the navigation bar at the top of each page</strong>
|
||||
<blockquote>this
|
||||
should help remind you where you are and prevent getting lost.
|
||||
</blockquote>
|
||||
</li>
|
||||
</ol>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="settings"></a>Course settings</h3>
|
||||
<blockquote>
|
||||
<p>The first thing you should do is look under the "Administration"
|
||||
on your course home page and click on "<strong>Settings...</strong>"
|
||||
(Note that this link, and in fact the whole Administration section is only
|
||||
available to you (and the site administrator). Students will not even see
|
||||
these links).</p>
|
||||
<p>On the Settings page you can change a number of settings about your course,
|
||||
ranging from its name to what day it starts. I won't talk here about all these,
|
||||
as they all have a help icon next to them which explains them all in detail.
|
||||
However, I will talk about the most important of these - the <strong>course
|
||||
format</strong>.</p>
|
||||
<p>The course format that you choose will decide the basic layout of your course,
|
||||
like a template. Moodle version 1.0 has three formats - in future there will
|
||||
probably be many more (please send new ideas to <a href="mailto:[email protected]">[email protected]</a>!)</p>
|
||||
<p>Here are some screenshots of three sample courses in each of these three
|
||||
formats (ignore the different colours, which are set for a whole site by the
|
||||
site administrator):</p>
|
||||
<p align="center"><strong>Weekly format:</strong></p>
|
||||
<p align="center"><img src="pix/weekly.jpg" width="570" height="527" /></p>
|
||||
<p align="center"> </p>
|
||||
<p align="center"><strong>Topics format:</strong></p>
|
||||
<p align="center"><img src="pix/topics.jpg" width="570" height="463" /></p>
|
||||
<p align="center"> </p>
|
||||
<p align="center"><strong>Social format:</strong></p>
|
||||
<p align="center"><img src="pix/social.jpg" width="570" height="429" /></p>
|
||||
<p> </p>
|
||||
<p>Note that the weekly and topics formats are very similar in structure. The
|
||||
main difference is that each box in the weekly format covers exactly one week,
|
||||
whereas in the topic format each box can cover whatever you like. The social
|
||||
format doesn't use much content at all and is based around just one forum
|
||||
- this is displayed on the main page.</p>
|
||||
<p>See the help buttons on the Course Settings page for more details.</p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="upload"></a>Uploading files</h3>
|
||||
<blockquote>
|
||||
<p>You may have existing content that you want to add to your course, such as
|
||||
web pages, audio files, video files, word documents, or flash animations.
|
||||
Any type of file that exists can be uploaded into your course and stored on
|
||||
the server. While your files are on the server you can move, rename, edit
|
||||
or delete them.</p>
|
||||
<p>All of this is achieved through the <strong>Files</strong> link in your Administration
|
||||
menu. The Files section looks like this:</p>
|
||||
<p align="center"><img src="pix/files.jpg" width="400" height="347" /></p>
|
||||
<p> </p>
|
||||
<p>This interface is only available to teachers - it is not accessible by students.
|
||||
Individual files are made available to students later on (as "Resources"
|
||||
- see the next section).</p>
|
||||
<p>As you can see in the screenshot, files are listed alongside subdirectories.
|
||||
You can create any number of subdirectories to organise your files and move
|
||||
your files from one to the other.</p>
|
||||
<p>Uploading files via the web is currently restricted to one file at a time.
|
||||
If you want to upload a lot of files at once (for example a whole web site),
|
||||
it can be a lot easier to use a <strong>zip program</strong> to compress them
|
||||
into a single file, upload the zip file and then unzip them again on the server
|
||||
(you will see an "unzip" link next to zip archives).</p>
|
||||
<p>To preview any file you have uploaded just click on its name. Your web browser
|
||||
will take care of either displaying it or downloading it to your computer.</p>
|
||||
<p>HTML and text files can be edited in-place online. Other files will need
|
||||
to be edited on your local computer and uploaded again. if you upload a file
|
||||
with the same name as an existing file it will automatically be overwritten.</p>
|
||||
<p>A final note: if your content resides out on the web then you don't need
|
||||
to upload the files at all - you can link directly to them from inside the
|
||||
course (see the Resources module and the next section).</p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="activities"></a>Setting up activities</h3>
|
||||
<blockquote>
|
||||
<p>Building a course involves adding course activity modules to the main page
|
||||
in the order that students will be using them. You can shuffle the order any
|
||||
time you like.</p>
|
||||
<p>To turn on editing, click "Turn on editing" under Administration.
|
||||
This toggle switch shows or hides the extra controls that allow you to manipulate
|
||||
your main course page. Note in the first screenshot above (of the Weekly format
|
||||
course) that the editing controls are turned on.</p>
|
||||
<p>To add a new activity, simply go to the week or topic or section of the screen
|
||||
where you want to add it, and select the type of activity from the popup menu.
|
||||
Here is a summary of all the standard activities in Moodle 1.0:</p>
|
||||
<dl>
|
||||
<dt><strong>Assignment</strong></dt>
|
||||
<dd>An assignment is where you set a task with a due date and a maximum grade.
|
||||
Students will be able to upload one file to satisify the requirements. The
|
||||
date they upload their file is recorded. Afterwards, you will have a single
|
||||
page on which you can view each file (and how late or early it is), and then
|
||||
record a grade and a comment. Half an hour after you grade any particular
|
||||
student, Moodle will automatically email that student a notification.
|
||||
<br />
|
||||
<br /></dd>
|
||||
<dt><strong>Choice</strong></dt>
|
||||
<dd>A choice activity is very simple - you ask a question and specify a choice
|
||||
of responses. Students can make their choice, and you have a report screen
|
||||
where you can see the results. I use it to gather research consent from
|
||||
my students, but you could use it for quick polls or class votes.
|
||||
<br />
|
||||
<br /></dd>
|
||||
<dt><strong>Forum</strong></dt>
|
||||
<dd>This module is by far the most important - it is here that discussion
|
||||
takes place. When you add a new forum, you will be presented with a choice of
|
||||
different types - a simple single-topic discussion, a free-for-all general
|
||||
forum, or a one-discussion-thread-per-user.
|
||||
<br />
|
||||
<br /></dd>
|
||||
<dt><strong>Resource</strong></dt>
|
||||
<dd>Resources are the content of your course. Each resource can be any file
|
||||
you have uploaded or can point to using a URL. You can also maintain simple
|
||||
text-based pages by typing them directly into a form.
|
||||
<br />
|
||||
<br /></dd>
|
||||
<dt><strong>Quiz</strong></dt>
|
||||
<dd>This module allows you to design and set quiz tests, consisting of multiple
|
||||
choice, true-false, and short answer questions. These questions are kept
|
||||
in a categorised database, and can be re-used within courses and even between
|
||||
courses. Quizzes can allow multiple attempts. Each attempt is automatically
|
||||
marked, and the teacher can choose whether to give feedback or to show correct
|
||||
answers. This module includes grading facilities.
|
||||
<br />
|
||||
<br /></dd>
|
||||
<dt><strong>Survey</strong></dt>
|
||||
<dd>The survey module provides a number of predefined survey instruments that
|
||||
are useful in evaluating and understanding your class. Currently they include
|
||||
the COLLES and the ATTLS instruments. They can be given to students early
|
||||
in the course as a diagnostic tool and at the end of the course as an evaluation
|
||||
tool (I use one every week in my courses).</dd>
|
||||
</dl>
|
||||
<br />
|
||||
<p>After adding your activities you can move them up and down in your course
|
||||
layout by clicking on the little arrow icons (<img src="../pix/t/up.gif" width="9" height="10" />
|
||||
<img src="../pix/t/down.gif" width="9" height="10" />) next to each one. You
|
||||
can also delete them using the cross icon <img src="../pix/t/delete.gif" width="10" height="10" />,
|
||||
and re-edit them using the edit icon <img src="../pix/t/edit.gif" width="10" height="11" />.</p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="course"></a>Running the course</h3>
|
||||
<blockquote>
|
||||
<p>There are some big plans to extend this document into a more comprehensive
|
||||
tutorial. Until then here are a few ideas:</p>
|
||||
<ol>
|
||||
<li>Subscribe yourself to all the forums so you keep in touch with your class
|
||||
activity. </li>
|
||||
<li>Encourage all the students fill out their user profile (including photos)
|
||||
and read them all - this will help provide some context to their later writings
|
||||
and help you to respond in ways that are tailored to their own needs.</li>
|
||||
<li>Keep notes to yourself in the private "<strong>Teacher's Forum</strong>"
|
||||
(under Administration). This is especially useful when team teaching.</li>
|
||||
<li>Use the "<strong>Logs</strong>" link (under Administration)
|
||||
to get access to complete, raw logs. In there you'll see a link to a popup
|
||||
window that updates every sixty seconds and shows the last hour of activity.
|
||||
This is useful to keep open on your desktop all day so you can feel in touch
|
||||
with what's going on in the course.</li>
|
||||
<li>Use the "<strong>Activity Reports</strong>" (next to each name
|
||||
in the list of all people, or from any user profile page). These provide
|
||||
a great way to see what any particular person has been up to in the course.</li>
|
||||
<li>Respond quickly to students. Don't leave it for later - do it right away.
|
||||
Not only is it easy to become overwhelmed with the volume that can be generated,
|
||||
but it's a crucial part of building and maintaining a community feel in
|
||||
your course.</li>
|
||||
</ol>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading"><a name="further"></a>Further information</h3>
|
||||
<blockquote>
|
||||
<p>If you have any particular problems with your site, you should contact your
|
||||
local site administrator.</p>
|
||||
<p>If you have some great ideas for improvements to Moodle, or even some good
|
||||
stories, come over to <a href="http://moodle.org/" target="_top">moodle.org</a>
|
||||
and join us in the course called "<a href="http://moodle.org/course/view.php?id=5" target="_top" >Using
|
||||
Moodle</a>". We'd love to hear from you, and you can help Moodle improve.</p>
|
||||
<p>If you want to contribute to coding new modules, or writing documentation,
|
||||
or papers, contact me: <a href="http://moodle.org/user/view.php?id=1&course=1" target="_top">Martin
|
||||
Dougiamas</a> or browse the "bug tracker" site for Moodle, at <a href="http://moodle.org/bugs/" target="_top">moodle.org/bugs</a></p>
|
||||
<p>Finally, remember to use the help icons - here is an <a target="helpwindow" href="../help.php?file=index.html">index of all the help files in Moodle</a>.</p>
|
||||
<p align="center">Thanks for using Moodle - and good luck with your teaching!</p>
|
||||
<hr />
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id: teacher.html,v 1.4 2002/08/18 10:00:01
|
||||
martin Exp $</font></p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,249 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle translation guide</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<h1>Moodle Translation Guide</h1>
|
||||
|
||||
<p>Translating Moodle is not that difficult, but a few things are good to know before you start.</p>
|
||||
|
||||
<p> </p>
|
||||
|
||||
<h2>Structure of a Moodle language pack</h2>
|
||||
|
||||
<p style="margin-left: 40px;">All Moodle language packs are located in
|
||||
the lang directory, with each language in a unique directory named the
|
||||
same as the language short name (en, fr, nl, es ...). </p>
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">All the main files are in this
|
||||
folder, with .php extensions (eg moodle.php, resource.php etc).
|
||||
These files contains short phrases, often called "<span style="font-style: italic;">strings</span>".
|
||||
</p>
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">There might also be some folders containing .html web pages:
|
||||
</p>
|
||||
|
||||
|
||||
<ul style="margin-left: 40px;">
|
||||
|
||||
|
||||
<li><strong>help</strong>: containing the context-sensitive help files that pop-up when you click the help icons throughout Moodle
|
||||
</li><li><strong>docs</strong>: containing the basic documentation pages (such as this one!)<br />
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
|
||||
<h2>Creating a completely new language pack</h2>
|
||||
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">If your language is not yet supported by
|
||||
Moodle, or if you just want to make some customisations to your own
|
||||
site's interface, you may want to start a new translation. </p>
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">All you need to do is create a new folder
|
||||
in the lang directory using the 2-letter code for your language. You
|
||||
can find these standard codes in lib/languages.php. If you are making a
|
||||
local variation of another language use the code of that language with
|
||||
an underscore and a meaningful two letter extension (e.g. <span style="font-style: italic;">pt </span>for Portuguese and <span style="font-style: italic;">pt_br</span> for Brasilian variation of the Portuguese language pack). If you are making a Unicode version add <span style="font-weight: bold;">_utf8</span> at the end (eg <span style="font-style: italic;">sr_utf8</span>).<br />
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">Next, create in your new language folder the file "moodle.php", containing the folowing lines:<br /><br />
|
||||
<code>
|
||||
<?PHP <br />
|
||||
$string['thischarset'] = 'iso-8859-1';<br />
|
||||
$string['thisdirection'] = 'ltr';<br />
|
||||
$string['thislanguage'] = 'new language pack';<br />
|
||||
?>
|
||||
</code>
|
||||
<br /><br />
|
||||
or copy the moodle.php from another
|
||||
language into your new directory. The one from the "en" folder is
|
||||
usually best but it doesn't really matter as you are going to rewrite
|
||||
it anyway. Creating moodle.php yourself has the advantage of starting with a completely clean and empty language pack.<br />
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">You are now ready to start inserting new strings by editing your language... see below for details on this.</p>
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">For a new language pack, the very first
|
||||
thing you need to edit is the string named "thischarset" in moodle.php.
|
||||
It must contain a valid web character set for your language. After you
|
||||
change that string, save the moodle.php file, then <span style="font-weight: bold;">reload the page</span>. You can then continue with the rest of the strings. </p>
|
||||
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
|
||||
<h2>Editing an existing language pack</h2>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 style="margin-left: 40px;">Making small customisations<br />
|
||||
</h3>
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 80px;">If you just want to change a few things in the interface to suit your own site better, <span style="font-weight: bold;">don't start editing one of the standard language packs</span>. If you do then your changes will be overwritten next time you upgrade to a new Moodle.<br />
|
||||
</p>
|
||||
<p style="margin-left: 80px;">Instead, use the instructions above for
|
||||
making a brand new language pack, and set the parent language (in
|
||||
moodle.php) to be the language that is most similar to yours. For
|
||||
example, a good name for a local english version would be "<span style="font-style: italic;">en_local</span>", and the parent language would be "<span style="font-style: italic;">en</span>" or "<span style="font-style: italic;">en_us</span>".</p>
|
||||
<p style="margin-left: 80px;">Note that for everyone on your site to
|
||||
see this new pack you have to select it as the site language and
|
||||
restrict the available languages on <span style="font-weight: bold;">Admin >> Configuration >> Variables</span>.<br />
|
||||
<br />
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 style="margin-left: 40px;">Translating the Moodle interface language files (the "string" files)<br />
|
||||
</h3>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ol style="margin-left: 80px;">
|
||||
<li>Log on to your Moodle server as an administrator. </li>
|
||||
<li>Go to <span style="font-weight: bold;">Administration >> Configuration >> Language</span>, which is the language administration page. </li>
|
||||
<li>On this page you can choose your language from the menu, then choose "Compare and Edit Language".</li>
|
||||
<li>You should see forms you can edit for each file. If you do not,
|
||||
then you may have to make sure that the files are writeable - you may
|
||||
have to change file permissions.</li>
|
||||
<li>The forms consist of three columns, the first is the name of
|
||||
each string, the second is that string in English, and the last is
|
||||
translation in the current language. </li>
|
||||
<li>Edit missing strings in each files (highlighted in colour),
|
||||
remembering to hit the "Save changes" button at the end of each form.</li>
|
||||
<li>It's OK to leave strings empty - Moodle will simply use the
|
||||
parent language for that string instead. You can define the parent
|
||||
language in moodle.php, otherwise English is always used by default. </li>
|
||||
<li>A quick way to see all the missing strings is by using the button to "Check for missing strings". Leave the untranslated strings completely empty or this handy tool won't work.<br />
|
||||
<br />
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
<h3 style="margin-left: 40px;">Translating the help and documentation files</h3>
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 80px;">There's no built-in editor in Moodle yet to translate
|
||||
the help files, but it's really not that difficult. It is important to
|
||||
use the <span style="font-weight: bold;">en</span> language pack as a reference language. Copy a help file from
|
||||
the en language pack and paste it on the same location in your own
|
||||
language pack. Then use a plain text editor to translate the file,
|
||||
making sure not to modify any code in the file (there usually is no
|
||||
code, just HTML-tags). (DON'T USE A WORDPROCESSOR to write the
|
||||
help-files because these programs add too much rubbish to the files).
|
||||
<br /><b>Don't leave untranslated help files in your language pack.</b></p>
|
||||
|
||||
<p style="margin-left: 80px;">Take care to write the helpfiles XHTML-compliant. This means in short:</p>
|
||||
<ul style="margin-left: 80px;">
|
||||
<li>All tags should be closed: <span style="color:rgb(255, 0, 0);" ><p></span>lalala<span style="color:rgb(255, 0, 0);" ></p></span></li>
|
||||
<li>All elements should be nested: <span style="color:rgb(255, 0, 0);" ><p></span> lalala <span style="color:rgb(0, 0, 255);" ><em></span>lalala<span style="color:rgb(0, 0, 255);" ></em></span> <span style="color:rgb(255, 0, 0);" ></p></span></li>
|
||||
<li>All elements and attributes must be lower case</li>
|
||||
<li>All atributes should be written in full and with quotes : <span style="color:rgb(255, 0, 0);" ><p align="right"></span> lalala </p></li>
|
||||
<li>Empty elements must end with />: <span style="color:rgb(255, 0, 0);" ><br /> <hr /></span>. You should add an extra space before the "/" symbol.</li>
|
||||
<li>An <img should have an alt="" (it can be empty) en must be closed like other empty elements with a space and /> like <span style="color:rgb(255, 0, 0);" ><img alt="" src="picture.gif" /></span></li>
|
||||
<li><span style="color:rgb(255, 0, 0);" ><?=</span> and <span style="color:rgb(255, 0, 0);" ><?</span> should be <span style="color:rgb(255, 0, 0);" ><?php</span></li>
|
||||
<li>There should not be ANY font tags at all. <span style="color:rgb(255, 0, 0);" > <p><em> <h1> <h2></span> etc should be enough for the language files ...</li>
|
||||
<li>The language name in the languagepack ($string['thislanguage'] in moodle.php) should generally use Unicode Numeric Character References (NCR) if possible, because this allows the name to work within ANY encoding context (see the Chinese pack for example).</li>
|
||||
</ul>
|
||||
<p style="margin-left: 80px;">None of the files in the help folder need a doc type, html, body, head opening and closing tags - these files are included with help.php. The script will take care of welforming the pages. This means also there is not much room for HTML creativity! Please stick to the English example.</p>
|
||||
<p style="margin-left: 80px;">The files in the docs folder must be completely XHTML compliant, including doc type, header etc.</p>
|
||||
|
||||
|
||||
<p style="margin-left: 80px;">Clicking on "Check for missing strings"
|
||||
in the language administration screen will also show you what files you
|
||||
are missing. If you have missing files then Moodle will use the parent
|
||||
language instead, so don't leave copies of <strong>untranslated</strong> help files in your language pack or this handy tool won't work.</p>
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
<h2>Submitting your language pack to the Moodle project </h2>
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">Sharing your translation with Moodle will
|
||||
ensure that you help other people who speak your language.
|
||||
Your interface language will be available in future versions of Moodle.<br />
|
||||
</p>
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">Simply archive your whole new language directory as a <span style="font-weight: bold;">zip</span> file and email it to <a href="mailto:tra%6es%6ca%74%69o%6e%40%6d%6f%6f%64%6c%65.org">translation@moodle.org</a>.<br />
|
||||
</p>
|
||||
<p style="margin-left: 40px;">We will get back to you with further details.<br />
|
||||
</p>
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">Checklist you can use before committing::</p>
|
||||
<ul type="circle" style="margin-left: 80px;">
|
||||
<li>No empty files?</li>
|
||||
<li>No untranslated files or strings?</li>
|
||||
<li>Help files not edited with a wordprocessor?</li>
|
||||
<li>README file contains language, name and emailadress of the translator?</li>
|
||||
<li>Foldername is the right language code (check moodle\lib\languages.php)?</li>
|
||||
<li>Does the language pack run errorfree on a testsite?</li>
|
||||
<li>When "thislanguage" contains other then latin letters, is it written in NCR notation?</li>
|
||||
<li>Are the strings and files XHTML compliant?</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Maintenance of a standard language pack<br />
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">If you are committed to maintaining a language in Moodle, it's best to use <a href="?file=cvs.html">Moodle CVS</a> so that you have an up-to-date version of Moodle, and can easily "check in" your changes directly into the Moodle project. Contact <a href="mailto:tra%6es%6ca%74%69o%6e%40%6d%6f%6f%64%6c%65.org">translation@moodle.org</a> if you need help setting this up.<br />
|
||||
</p>
|
||||
|
||||
<p style="margin-left: 40px;">You must also subscribe to the <a target="_top" href="http://moodle.org/mod/forum/view.php?id=43">Languages Forum</a> for news and discussion about issues that affect translations.<br />
|
||||
</p>
|
||||
|
||||
<p style="margin-left: 40px;">Finally, to keep in touch with changes in the project on a day-to-day basis it is a very good idea to subscribe to the <a href="http://sourceforge.net/mail/?group_id=30935" target="_top">CVS mailing list</a>. This helps to keep your
|
||||
translation as close to the English text as possible.<br />
|
||||
</p>
|
||||
<p style="margin-left: 40px;"><br />
|
||||
</p>
|
||||
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
|
||||
</body></html>
|
||||
@@ -1,117 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>Moodle Docs: Upgrading</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Upgrading Moodle</h1>
|
||||
|
||||
<blockquote>
|
||||
<p>Moodle is designed to upgrade cleanly from any earlier version to any later
|
||||
version. </p>
|
||||
<p>When upgrading a Moodle installation you should follow these steps:</p>
|
||||
<h3 class="sectionheading">1. Backup important data</h3>
|
||||
<blockquote>
|
||||
<p>Although it is not strictly necessary, it is always a good idea to make a
|
||||
backup of any production system before a major upgrade, just in case you need
|
||||
to revert back to the older version for some reason. In fact, it's a good
|
||||
idea to automate your server to backup your Moodle installation daily, so
|
||||
that you can skip this step.</p>
|
||||
<p>There are three areas that need backing up:</p>
|
||||
<blockquote>
|
||||
<p><strong>1. The Moodle software directory itself</strong></p>
|
||||
<blockquote>
|
||||
<p>Make a separate copy of these files before the upgrade, so that you can
|
||||
retrieve your config.php and any modules you have added like themes, languages
|
||||
etc<strong><br />
|
||||
</strong></p>
|
||||
</blockquote>
|
||||
<p><strong>2. Your data directory.</strong></p>
|
||||
<blockquote>
|
||||
<p>This is where uploaded content resides (such as course resources and
|
||||
student assignments) so it is very important to have a backup of these
|
||||
files anyway. Sometimes upgrades may move or rename directories within
|
||||
your data directory.<strong><br />
|
||||
</strong></p>
|
||||
</blockquote>
|
||||
<p><strong>3. Your database</strong></p>
|
||||
<blockquote>
|
||||
<p>Most Moodle upgrades will alter the database tables, adding or changing
|
||||
fields. Each database has different ways to backup. One way of backing
|
||||
up a MySQL database is to 'dump' it to a single SQL file. The following
|
||||
example shows Unix commands to dump the database called "moodle":</p>
|
||||
<blockquote>
|
||||
<p><font face="Courier New, Courier, mono">mysqldump moodle > moodle-backup-2002-10-26.sql</font></p>
|
||||
</blockquote>
|
||||
<p>You can also use the "Export" feature in Moodle's optional
|
||||
"Database" web interface to do the same thing on all platforms.</p>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading">2. Install the new Moodle software</h3>
|
||||
<blockquote>
|
||||
<p><strong>Using a downloaded archive</strong></p>
|
||||
<blockquote>
|
||||
<p>Do not overwrite an old installation unless you know what you are doing
|
||||
... sometimes old files can cause problems in new installations. The best
|
||||
way it to rename the current Moodle directory to something else, then unpack
|
||||
the new Moodle archive into the old location.</p>
|
||||
<blockquote>
|
||||
<p><font face="Courier New, Courier, mono">mv moodle moodle.backup<br />
|
||||
tar xvzf moodle-1.1.tgz</font></p>
|
||||
</blockquote>
|
||||
<p>Next, copy across your config.php and any other plugins such as custom
|
||||
themes:</p>
|
||||
<blockquote>
|
||||
<p><font face="Courier New, Courier, mono">cp moodle.backup/config.php moodle<br />
|
||||
cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme</font></p>
|
||||
</blockquote>
|
||||
</blockquote>
|
||||
<p><strong>Using CVS</strong></p>
|
||||
<blockquote>
|
||||
<p>If you are using CVS, just go into the Moodle root directory and update
|
||||
to the new files:</p>
|
||||
<blockquote>
|
||||
<p><font face="Courier New, Courier, mono">cvs update -dP</font></p>
|
||||
</blockquote>
|
||||
<p>Make sure you use the "d" parameter to create new directories
|
||||
if necessary, and the "P" parameter to prune empty directories.</p>
|
||||
<p>If you have been editing Moodle files, watch the messages very closely
|
||||
for possible conflicts. All your customised themes and non-standard plugins
|
||||
will be untouched.</p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
</blockquote>
|
||||
<h3 class="sectionheading">3. Finishing the upgrade</h3>
|
||||
<blockquote>
|
||||
<p>The last step is to trigger the upgrade processes within Moodle.</p>
|
||||
<p>To do this just visit <a target="_top" href="../admin/index.php">the admin page of your
|
||||
installation</a>.</p>
|
||||
<blockquote>
|
||||
<p><font face="Courier New, Courier, mono">http://example.com/moodle/admin</font></p>
|
||||
</blockquote>
|
||||
<p>It doesn't matter if you are logged in as admin or not.</p>
|
||||
<p> Moodle will automatically detect the new version and perform all the database
|
||||
or filesystem upgrades that are necessary. If there is anything it can't do
|
||||
itself (very rare) then you will see messages telling you what you need to
|
||||
do. </p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<p> Assuming all goes well (no error messages) then you can start using your new
|
||||
version of Moodle and enjoy the new features!</p>
|
||||
<p>If you have trouble with the upgrade, visit <a target="_top" href="http://moodle.org/">moodle.org</a>
|
||||
and post on the <a target="_top" href="http://moodle.org/mod/forum/view.php?id=28">Installation
|
||||
Support Forum</a> in the Using Moodle course.</p>
|
||||
</blockquote>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p align="center"><font size="1"><a href="." target="_top">Moodle Documentation</a></font></p>
|
||||
<p align="center"><font size="1">Version: $Id$</font></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user