https://docs.moodle.org/21/en/api.php?action=feedcontributions&feedformat=atom&user=ScyrmaMoodleDocs - User contributions [en]2026-04-18T17:28:50ZUser contributionsMediaWiki 1.43.5https://docs.moodle.org/21/en/index.php?title=Web_Hosts&diff=42587Web Hosts2008-08-25T07:15:30Z<p>Scyrma: </p>
<hr />
<div>{{Work_in_progress}}<br />
The intent here is to invite those who have experience with various web hosting firms to provide data on their experience so as to provide an easy comparison among web hosting firms.<br />
<br />
Feature Key appears below the matrix - please suggest additional features<br />
<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!Webhosts<br />
!A<br />
!B<br />
!C<br />
!D<br />
!E<br />
!F<br />
!G<br />
!H<br />
! I <br />
!J<br />
!K<br />
!L<br />
!M<br />
!N<br />
!O<br />
!P<br />
!Q<br />
!R<br />
!S<br />
!T<br />
!U<br />
!V<br />
!W<br />
!X<br />
!Y<br />
!Z<br />
!II<br />
!III<br />
!IV<br />
!VI<br />
|-<br />
|Siteground<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|-<br />
|BlueHost<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|-<br />
|Dreamhost<br />
|■<br />
|■<br />
|■<br />
|■<br />
|■<br />
|■<br />
|■ <br />
|■<br />
|1<br />
|■<br />
|x<br />
|x<br />
|?<br />
|■<br />
|■<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|-<br />
|Another<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|-<br />
|And Another<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|-<br />
|}<br />
<br />
A. Customizable php.ini or .htaccess<br />
<br />
B. Access to custom build of php<br />
<br />
C. PHP version 5.x provided<br />
<br />
D. MySQL version 5 provided<br />
<br />
E. Shell access<br />
<br />
F. SSH supported<br />
<br />
G. Bulk Mail use restriction<br />
<br />
H. SPAM restrictions in excess of security provided via Moodle<br />
<br />
I. Language (1- only English, 2- English and Spanish, etc)?<br />
<br />
J. Custom panel<br />
<br />
K. Fantastico<br />
<br />
L. Cpanel<br />
<br />
M. Limited TLDs available<br />
<br />
N. Domains available<br />
<br />
O. Under US$100/yr</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=TinyMCE&diff=40438TinyMCE2008-07-25T06:20:00Z<p>Scyrma: </p>
<hr />
<div>TinyMCE ([http://tinymce.moxiecode.com/ homepage]) is an opensource javascript text editor from Moxiecode released under the LGPL licence. It is being used by some as a replacement for the HTML editor which in versions 1.8 and 1.9 of Moodle.<br />
<br />
It will be the default editor in Moodle 2.0.<br />
<br />
= Plugins =<br />
<br />
Some plugins are Moodle-specific and need to be maintained separately. <br />
<br />
TinyMCE plugins code should be compressed using http://javascriptcompressor.com/. <br />
<br />
== moodlenolink ==<br />
<br />
Lets people mark some text that must not be filtered by Moodle (ie. to prevent auto-linking).<br />
<br />
[[Category:HTML editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:How_to_create_a_patch&diff=39002Development:How to create a patch2008-07-01T08:00:40Z<p>Scyrma: /* Creating a patch using CVS (command line) */</p>
<hr />
<div>If you have made some changes to the code that you would like to share with the community, particularly if you want to send them to one of the core developers for possible inclusion in Moodle Core, it is very helpful if you can provide them as a patch file. Sometimes also called a diff file.<br />
<br />
This page explains how you can make a patch file. Patch is a standard format, and there are many options for how to create one. Pick the one that is easiest for you.<br />
<br />
''Note, I have not been able to test most of these instructions. They are about right, but I am hoping that as people use them, they will fill in any gaps, correct any details, and so on.[[User:Tim Hunt|Tim Hunt]] 08:40, 25 June 2007 (CDT)''<br />
<br />
==Introduction: what does a patch file look like==<br />
<br />
This is a simple example:<br />
<br />
<pre><nowiki><br />
Index: lang/en_utf8/quiz.php<br />
===================================================================<br />
RCS file: /cvsroot/moodle/moodle/lang/en_utf8/quiz.php,v<br />
retrieving revision 1.57.2.10<br />
diff -u -r1.57.2.10 quiz.php<br />
--- lang/en_utf8/quiz.php 29 May 2007 17:47:25 -0000 1.57.2.10<br />
+++ lang/en_utf8/quiz.php 25 Jun 2007 12:58:34 -0000<br />
@@ -252,7 +255,6 @@<br />
$string['indivresp'] = 'Responses of Individuals to Each Item';<br />
$string['info'] = 'Info';<br />
$string['introduction'] = 'Introduction';<br />
-$string['invalidcategory'] = 'Category ID is invalid';<br />
$string['invalidnumericanswer'] = 'One of the answers you entered was not a valid number.';<br />
$string['invalidnumerictolerance'] = 'One of the tolerances you entered was not a valid number.';<br />
$string['invalidsource'] = 'The source is not accepted as valid.';<br />
@@ -375,8 +377,10 @@<br />
$string['questiontypesetupoptions'] = 'Setup options for question types:';<br />
$string['quiz:attempt'] = 'Attempt quizzes';<br />
$string['quiz:deleteattempts'] = 'Delete quiz attempts';<br />
+$string['quiz:emailconfirmsubmission'] = 'Receive own quiz submission notification';<br />
+$string['quiz:emailnotifysubmission'] = 'Receive student quiz submission notifications';<br />
$string['quiz:grade'] = 'Grade quizzes manually';<br />
-$string['quiz:ignoretimelimits'] = 'Ignores time limit on quizzes';<br />
+$string['quiz:ignoretimelimits'] = 'Ignores time limit on quizs';<br />
$string['quiz:manage'] = 'Manage quizzes';<br />
$string['quiz:preview'] = 'Preview quizzes';<br />
$string['quiz:view'] = 'View quiz information';<br />
</nowiki></pre><br />
<br />
At the top it says which file is being affected. Changes to several files can be included in one patch. Lines added are shown with a '+', lines removed are shown with a '-', lines changed are shown as the old line being removed and the new one added.<br />
<br />
Patch files are good because they only show the changed parts of the file. This has two advantages: it easy to understand the change; and if other parts of the same files change between the patch being made an being used, there is no problem, the patch will still apply.<br />
<br />
==Creating a patch using diff==<br />
<br />
diff is the a linux command line program, and is where patch files originated. It requires that you have two copies of the code, one with your changes, and one without. Suppose these two copies are in folders called 'standard_moodle' and 'my_moodle' which are subdirectories of the current folder. Then to create the patch, type:<br />
<br />
diff -ur standard_moodle my_moodle > patch.txt<br />
<br />
==Creating a patch using CVS (command line)==<br />
<br />
It is easier if you are using CVS to manage your development, because you don't need to keep the copy of 'standard_moodle'. CVS takes care of that for you. In you workspace (sandbox) type:<br />
<br />
cvs diff -uN > patch.txt<br />
<br />
If you have unversioned files to include in your patch, you will notice that the above command simply adds the file's name to the top of your patch, prefixed with a question mark. This is because your new file is not tagged for adding to the repository. Just do<br />
<br />
cvs add newfile<br />
<br />
Then <br />
<br />
cvs diff -uNa > patch.txt<br />
<br />
This should add the correct code to the patch, so that someone applying the patch to their working copy will have a new file created at the right place (hopefully!).<br />
<br />
If your patch, for some reason, contains a lot of white space changes in many files, you might want to add -Bbw to the diff call. Make sure these changes are really not significant (like adding or removing a space at the end of a line - editors like Eclipse sometimes do this automatically). This can make a patch a lot smaller, and thus easier to review. The complete call would then be <br />
<br />
cvs diff -uNawbB > patch.txt<br />
<br />
==Creating a patch using Tortoise CVS==<br />
<br />
[http://www.tortoisecvs.org/ Tortoise CVS] is a Windows GUI front end for CVS. To create a patch, right-click on a folder in CVS, and choose '''CVS -> Make patch ...''' from the context menu.<br />
<br />
==Creating a patch using Eclipse==<br />
<br />
See [[Development:Setting_up_Eclipse#Creating_a_patch]]. Eclipse makes creating patches really easy, once you have got it set up correctly.<br />
<br />
==Creating a patch using WinMerge==<br />
<br />
[http://winmerge.org/ WinMerge] is a nice windows GUI for comparing folders. In this sense it is like the original command-line 'diff' program. You need a copy of 'standard_moodle' and 'my_moodle'. Use '''File -> Open...''' to open the two versions for comparison. This will give you a nice view of what you have changed. Then do '''Tools -> Generate patch ...'''. In the dialogue box, make sure you select Style: Unified in the Format box.</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development_talk:Setting_up_Eclipse&diff=38326Development talk:Setting up Eclipse2008-06-26T01:28:32Z<p>Scyrma: New section: Eclipse and whitespace</p>
<hr />
<div>Really nice work, Tim, thanks! I've been through and I'm trying it out. [[User:Martin Dougiamas|Martin Dougiamas]] 09:05, 5 September 2006 (CDT)<br />
<br />
----<br />
<br />
The stuff about changing editors under General -> Editors -> File Associations doesn't work any more if an Eclipse plugin has 'locked' a file type or content type. Not sure how to fix this<br />
--[[User:Andy Baker|Andy Baker]] 06:40, 28 November 2006 (CST)<br />
<br />
Hopefully it will be the PHP plugin, and it will have locked *.php to the setting you want anyway. If not, can you tell us exactly what you are seeing.[[User:Tim Hunt|Tim Hunt]] 04:24, 29 November 2006 (CST)<br />
<br />
== Problems with Ubuntu 6.10... ==<br />
<br />
I'd really like to switch completely to Linux and Eclipse on my Moodle developments. However, I can't get the PHPEclipse plug-in to work with Eclipse 3.2 that came with Ubuntu 6.10. After the Eclipse restart required by the "add . to the include path" tweak, the "PHPEclipse stuff" is gone from the menus (forgot what it said), and when I try to open a PHP file in Eclipse I get:<br />
"Failed to execute runnable (java.lang.NoClassDefFoundError: net.sourceforge.phpeclipse.phpeditor.PHPUnitEditor)" and "Unhandled event loop exception"... Going to Google around a bit, but there seems to be a lot of other issues with the JVM also: Eclipse crashed when I tried to search the help, for example. --[[User:Samuli Karevaara|Samuli Karevaara]] 04:07, 20 December 2006 (CST)<br />
:Just reporting that now the error message has changed to "Problems occurred when invoking code from plug-in: "org.eclipse.jface"." or I was reading the wrong part of the error log before... --[[User:Samuli Karevaara|Samuli Karevaara]] 04:11, 20 December 2006 (CST)<br />
:One headache later I was able to get Eclipse to open the PHP files. Apparently it was about the Java Runtime Environment version after all. I had "sun-java5-bin : Sun Java(TM) Runtime Environment (JRE) 5.0" package installed but it didn't help. After completely removing everything "Java 1.4" ("j2re1.4" and friends) and upgrading "libgjc" packages I got it to work. I reeeeally not a friend of Java versioning and library packaging! --[[User:Samuli Karevaara|Samuli Karevaara]] 06:05, 20 December 2006 (CST)<br />
<br />
== Ubuntu Eclipse Improvements ==<br />
<br />
Just found this:<br />
http://wiki.liferay.com/index.php/Liferay_Development_Environment:_Ubuntu_Linux#Eclipse_IDE<br />
<br />
It may help a bit.<br />
<br />
There is a problem wiht the different java VM. If you set that the vm is the one of sun it must be like this everywere<br />
I did that:<br />
<br />
<br />
$ sudo aptitude install eclipse-sdk<br />
<br />
Remove any reference to gcj in <br />
/etc/eclipse/java_home.<br />
<br />
edit the file /usr/bin/eclipse and comment<br />
<br />
-Dgnu.gcj.precompiled.db.path=/var/lib/gcj-4.1/classmap.db et <br />
-Dgnu.gcj.runtime.VMClassLoader.library_control=never.<br />
<br />
For me now eclipse runs with no problem<br />
<br />
== Prefs file missing? ==<br />
<br />
Working through this bit:<br />
<br />
Open the file net.sourceforge.phpeclipse.ui.prefs that is in the directory (your<br />
workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings in a text editor.<br />
<br />
the file is not there. net.sourceforge.phpeclipse.prefs is present, but does not have the line described.<br />
<br />
Also,<br />
<br />
Under Team -> CVS -> SSH2 Connection Method,<br />
<br />
this path does not exist (working on Xandros with linux eclipse)<br />
<br />
[[User:Matt Gibson|Matt Gibson]] 16:48, 17 January 2008 (CST)<br />
<br />
== net.sourcegorge.phpeclipse.ui.prefs ==<br />
<br />
Note that in the documentation is:<br />
- Look for a line in the file that starts _php_include_paths= '''If it is not there, add it at the end'''. <br />
<br />
In my case, it was nothing there, so I add the line <br />
_php_include_paths=.<br />
and work.<br />
<br />
== Under Team -> CVS -> SSH2 Connection Method ==<br />
<br />
I found this to be '''General -> Network Connections -> SSH2 -> Key Management''' (the documentation is updated).<br />
<br />
After generating a DSA key, and following the rest of the instructions, I finally finish setting up Eclipse.<br />
<br />
== Eclipse and whitespace ==<br />
<br />
<br />
<br />
<br />
(Moving this out of main page, so as not to confuse people with discussion...) I suggested ... Under '''General -> Compare/Patch''', turn on '''Ignore white space''' if you plan to exchange patches with other developers or send patches on the tracker. This will make patches smaller and easier to compare. [[User:Mathieu Petit-Clair|Mathieu Petit-Clair]] 20:28, 25 June 2008 (CDT)<br />
<br />
Tim replied: but that is a very bad idea. Whitespace is important, you should not change it unnecessarily, and so whitespace changes should be included in patches.'' <br />
<br />
You've got good point there, whitespace is significant. But Eclipse seems to remove trailing space (eg. at the end of lines) by itself, and this makes patches I receive from Eclipse users impossible to apply after a few days of hacking in cvs head. :( Is there a way to tell Eclipse not to remove whitespace by itself? I really like to work with patches, but when they're twice as big as they should be and don't apply, it makes it a nightmare... [[User:Mathieu Petit-Clair|Mathieu Petit-Clair]] 20:28, 25 June 2008 (CDT)</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Setting_up_Eclipse&diff=38325Development:Setting up Eclipse2008-06-26T01:23:33Z<p>Scyrma: /* General settings */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it create a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step.<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://phpeclipse.sourceforge.net/update/releases/; then click '''OK'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Back in the wizard, turn on just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site'''.<br />
Then click '''Finish'''.<br />
<br />
It goes off sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want. The ones you want (you may have to search the tree structure) are, '''PHPeclipse''' (from your newly created PHPEclipse Update Site) and all the '''Web Standard Tools (WST)''' (usually under Callisto Discovery Site --> Web and J2EE Development).<br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation build digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box. With '''*.html''' selected in the top box, select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Internet -> Proxy Settings'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
These are all hidden under the '''PHPeclipse Web Development''' bit of the tree.<br />
<br />
Under '''PHPeclipse Web Development -> Browser Preview Defaults''', turn off both checkboxes.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE.- When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments''' and '''Remove trailing spaces on editor save'''. It would be nice to turn on more of these options, but most of the rest don't work very well.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse Web Development -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-hightlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should fine that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project.... That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all the really important features. I sure you can learn everything else on your own. An you could always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right click on an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right click on an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags ... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. right click on it and expand configure branches and versions<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
[[Category:Developer|Setting up Eclipse]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Setting_up_Eclipse&diff=38279Development:Setting up Eclipse2008-06-25T07:10:39Z<p>Scyrma: /* General settings */ ignore whitespace in patches</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it create a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step.<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://phpeclipse.sourceforge.net/update/releases/; then click '''OK'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Back in the wizard, turn on just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site'''.<br />
Then click '''Finish'''.<br />
<br />
It goes off sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want. The ones you want (you may have to search the tree structure) are, '''PHPeclipse''' (from your newly created PHPEclipse Update Site) and all the '''Web Standard Tools (WST)''' (usually under Callisto Discovery Site --> Web and J2EE Development).<br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation build digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Compare/Patch''', turn on '''Ignore white space''' if you plan to exchange patches with other developers or send patches on the tracker. This will make patches smaller and easier to compare.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box. With '''*.html''' selected in the top box, select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Internet -> Proxy Settings'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
These are all hidden under the '''PHPeclipse Web Development''' bit of the tree.<br />
<br />
Under '''PHPeclipse Web Development -> Browser Preview Defaults''', turn off both checkboxes.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE.- When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments''' and '''Remove trailing spaces on editor save'''. It would be nice to turn on more of these options, but most of the rest don't work very well.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse Web Development -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-hightlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should fine that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project.... That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all the really important features. I sure you can learn everything else on your own. An you could always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right click on an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right click on an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags ... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. right click on it and expand configure branches and versions<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
[[Category:Developer|Setting up Eclipse]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Moodle.org_homepage&diff=38153Development:Moodle.org homepage2008-06-24T01:42:09Z<p>Scyrma: out of sourceforge</p>
<hr />
<div>The intent of this page is to present suggestions concerning the words on the homepage of Moodle.org . <br />
<br />
Those interested in making suggestions, please edit one of the alternative sub sections and leave the "current" untouched. Page comments are a good place to explain rational for the suggestions.<br />
<br />
=Welcome to Moodle!=<br />
==Welcome to Moodle! current== <br />
Moodle is a course management system (CMS) - a free, [http://www.opensource.org/docs/definition.php Open Source] software package designed using sound [[Philosophy|pedagogical]] principles, to help educators create effective online learning communities. You can download and use it on any computer you have handy (including webhosts), yet it can scale from a single-teacher site to a 50,000-student University. This site itself is created using Moodle, so check out the [http://moodle.org/course/category.php?id=2 Moodle Demonstration Courses] or read the latest [http://moodle.org/mod/data/view.php?id=6140/ Moodle Buzz].<br />
<br />
<br />
==Welcome to Moodle! alternative A==<br />
[https://docs.moodle.org/en/About_Moodle Moodle] is a course management system (CMS) - a free, [http://www.opensource.org/docs/definition.php Open Source] software package designed using sound [[Philosophy|pedagogical]] principles to help educators create effective online learning communities. You can [http://download.moodle.org/ download] and use it on any computer you have handy (including webhosts), yet it can meet the needs of a single classrrom-teacher site to a 50,000-student University. This site itself is created using Moodle, so check out the [http://moodle.org/course/category.php?id=2 Moodle Demonstration Courses], read the latest [http://moodle.org/mod/data/view.php?id=6140/ Moodle Buzz], or some [links for a new user]http://moodle.org/mod/resource/view.php?id=1361 ?.<br />
<br />
=Moodle Community=<br />
<br />
==Moodle Community current== <br />
Moodle has a large and diverse user community with [http://moodle.org/userpics/ over 150,000 registered users] on this site alone, speaking over [http://download.moodle.org/lang16/ 75 languages] in over [http://moodle.org/sites/ 160 countries] (we have more [http://moodle.org/stats/ statistics here]). The best place to start is [http://moodle.org/course/view.php?id=5 Using Moodle], which is where the main international discussions are held in English, but we have a variety of groups discussing [http://moodle.org/course/category.php?id=1 other topics] and in [http://moodle.org/course/category.php?id=3other languages].<br />
<br />
==Moodle Community alternative A==<br />
Moodle has a large and diverse community with [http://moodle.org/userpics/ over 150,000 registered users] on this site alone, that live in over [http://moodle.org/sites/ 160 countries] and speak many different languages (we have more [http://moodle.org/stats/ statistics here]). Our main international discusions are held in English at [http://moodle.org/course/view.php?id=5 Using Moodle]. However, we have a variety of groups discussing [http://moodle.org/course/category.php?id=1 other topics], and in [http://moodle.org/course/category.php?id=3 other languages]. Our community also maintains [[Special:Statistics|{{NUMBEROFARTICLES}}]] pages of [https://docs.moodle.org/en/Main_Page Moodle documentation] in a wiki and has translated them into other [[link to list| MoodleDoc languages]].<br />
<br />
<br />
The dynamic NUMBEROFARTICLES link will need to changed on the homepage.<br />
<br />
=Moodle Development=<br />
==Moodle Development current== <br />
We have a long list of [[Credits|developers]] who contribute towards the development of Moodle. Start with our [[Developer_documentation|developer information]] as well as the [[Roadmap|roadmap]], the [[Development:Coding|coding guide]] and [[CVS|CVS guide]] to access our [[http://cvs.moodle.org/moodle/ source code]]. Most discussion can be found in [http://moodle.org/course/view.php?id=5 Using Moodle], but we also have a [http://tracker.moodle.org/secure/Dashboard.jspa Tracker] where you should report general bugs, feature requests, fixes and other issues. Sensitive security problems should be posted to the [http://security.moodle.org/ Moodle Security] site, so we can deal with them appropriately.<br />
<br />
==Moodle Development alternative A==<br />
none at moment<br />
<br />
=Moodle Downloads=<br />
<br />
==Moodle Downloads current== <br />
Moodle is available in a variety of [http://download.moodle.org/ download packages] with different levels of stability, as well as via CVS from [http://cvs.moodle.org/moodle cvs.moodle.org]. A number of additional [http://moodle.org/mod/data/view.php?id=6009 modules/plugins] and [http://download.moodle.org/lang16/ language packs] are also available.<br />
<br />
==Moodle Downloads alternative A==<br />
Moodle is available in over 10 [http://download.moodle.org/ download packages] of different versions and operating systems. [http://cvs.moodle.org/moodle cvs.moodle.org] offers Moodle via CVS (Concurrent Versions System). A number of additional [http://moodle.org/mod/data/view.php?id=6009 modules/plugins] and 60+ [http://download.moodle.org/lang16/ language packs] can also be added to a Moodle site.</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:XMLDB_defining_an_XML_structure&diff=38151Development:XMLDB defining an XML structure2008-06-24T01:36:45Z<p>Scyrma: moving out of sourceforge</p>
<hr />
<div>[[Development:XMLDB Documentation|XMLDB Documentation]] > [[Development:XMLDB roadmap|Roadmap]] > Defining one XML structure<br />
----<br />
<br />
== Justification ==<br />
<br />
Before Moodle 1.7, all the DB install and upgrade was developed twice (once to handle MySQL installations and another to handle PostgreSQL installations). This approach, although working, has caused some headaches in the past, mainly because it was really difficult to keep both lines of development 100% on sync. Some developers do they work against one RDBMS and it was complex to develop to the other one (two test environments, skills on both databases, slower development cycle...). And all this was happening with ''only'' two supported RDBMS!<br />
<br />
One of the main objectives of Moodle 1.7 is to extend the the number of supported RDBMS to other flavours (more exactly, to Oracle and MSSQL). And the old approach (one line of development for each DB) could become an absolute nightmare. <br />
<br />
Because of this we have planned to build one structure to define all the DB objects used by Moodle. This structure will provide the necessary level of abstraction to be shared by all the RDBMS systems, so the "multiple lines of development" explained in the previous paragraph will be out forever, giving us one robust and well defined way to handle DB objects independently of the underlying RDBMS being used.<br />
<br />
== Implementation ==<br />
<br />
Initially all our best wishes were to use the [http://phplens.com/lens/adodb/docs-datadict.htm#xmlschema AdoDB XML Schema]. As Moodle is using ADOdb libraries to communicate with databases it sounded like the natural approach to solve the problem. But, finally, two reasons prevented us to use it:<br />
<br />
# Although working, it seems to be one feature in progress, with important changes/evolutions arriving at the time of write this document.<br />
# Its lack of support for "prefixes" (one Moodle key feature, to allow multiple instances to run in the same server), would force us to create some awful tricks to generate the objects.<br />
<br />
So, finally, we decided to build our own XML files, with everything we need to define every object present in the DB.<br />
<br />
== The XMLDB editor ==<br />
[[XMLDB_editor | Main article]]<br />
<br />
Although the XML is pretty simple to read (and to write), one of the major drawbacks was its easy and error-prone adoption by the developers. Also some problems with versioning systems getting crazy with XML files (thanks ML!) pointed us to the requirement to use one high-density format (it means, physically '''long lines''') in our XML files. <br />
<br />
After some intense thoughts we decided to build one specialised editor for our XML format. This editor should be easy to use and provide support for all the objects present one Moodle DB. And it's done (and will support future enhancements easily, we hope).<br />
<br />
The XMLDB Editor makes the edition of tables/fields/keys/indexes practically a trivial task, allowing the developer to spend the time coding and improving things instead of fighting against XML files and the errors caused by manual editing (of course, the developer is free to use such extra-time as desired, beers, dance, books, music...) ;-)<br />
<br />
All the new '''install.xml''' files, present under each '''db''' directory in Moodle can be edited (and we recommend it) with just some clicks and keystrokes. Those '''install.xml''' will contain all the info needed to generate the specific objects needed for each RDBMS supported. Obviously, such files, are the neutral replacement for all the *.sql files used until now.<br />
<br />
=== Launching ===<br />
<br />
Just login to your server as an administrator and, under the Miscellaneous tab of the Administration Block, you'll see a new link pointing to the "XMLDB Editor".<br />
<br />
One '''important note''' is that, to be able to handle files properly, the web server needs write access to all those "db" directories where the "install.xml" files reside (and to the files themselves, of course). ;-)<br />
<br />
That's all!<br />
<br />
=== Use===<br />
<br />
We really think the XMLDB Editor is pretty easy to use, so here you won't see a complete guide to use it. We highly recommend you to play with it for a while, viewing how it works and how it modifies the '''install.xml''' files.<br />
<br />
It's organised in a top-botton structure, where you start '''loading''' (or '''creating''') a new XMLDB file. Then, you can '''edit''' such file and its '''general structure''' will be showed. This structure have two type of elements, '''tables''' and '''statements''' and the XMLDB Editor allows you to '''add''', '''edit''', '''delete''', and '''move''' them easily. Also, for initial creation of tables, one small but effective '''reverse-enginery''' tool has been developed (only under MySQL) allowing you to retrofit any table from the DB to the XMLDB Editor.<br />
<br />
'''Note: If you can't click on the create links....''' you must first create the /db folder (as shown in the list, but it may not really exist) and then make sure it is writeable by the webserver<br />
<br />
While editing tables you will see their '''fields''', '''keys''' and '''indexes''' and you'll be able to handle all them easily. Note that some fields can be no-editable. It uses to be because they are being used in some way (part of one key or index) and the idea is to warn you about that.<br />
<br />
Fields can be edited and you can specify their '''name''', '''type''', '''length''', '''decimals''', '''null-ability''', '''defaults''' and so one. Exactly the same for both '''keys''' and '''indexes'''.<br />
<br />
While editing statements, you must think about them like "collections of sentences". Once you select the '''type''' (only inserts are allowed for now) and '''table''' you are interested you'll be able to introduce the exact values easily, being able to '''duplicate''' them easily to gain some speed if you have a lot of sentences in your development. Sentences can be '''edited''' and '''deleted''' easily too.<br />
<br />
One interesting feature is that all the XMLDB Editor pages allow you to enter one '''comment''' about the item being modified (table, index, key, field, statement...). Use it at your entire needs, sure it helps other developers to understand a bit more the DB model.<br />
<br />
Please, don't forget to read and understand the next section, where we talk about '''some important guidelines''' to create and handle XMLDB files.<br />
<br />
== Conventions ==<br />
<br />
Apart of the [[Coding#Database_structures| Database Structures guidelines]], some more conventions should be followed:<br />
<br />
# About names:<br />
## All lowercase names (tables, indexes, keys and fields).<br />
## Table names and field names must use only a-z, 0-9 and _ chars.<br />
## Key and index names under the XMLDB Files must be formed by concatenating the name of the fields present in the key/index with the '"-" (minus) character.<br />
## Primary key always must be named "primary" (this is one exception to the previous convention).<br />
## It's highly recommended to avoid [[XMLDB_reserved_words|reserved words]] completely. We know we have some of them now but they should be completely out for next releases.<br />
# About NULLS<br />
## Avoid to create all the fields as NOT NULL with the ''silly'' default value <nowiki>''</nowiki> (empty string). The underlying code used to create tables will handle it properly but the XMLDB structure must be REAL. Read more in the [[XMLDB Problems#NOT NULL fields using a DEFAULT <nowiki>''</nowiki> clause|Problems Page]].<br />
# About FOREIGN KEYS<br />
## Under the tables of every XMLDB file, you must define the existing '''Foreign Keys''' (FK) properly. This will allow everybody to know a bit better the structure, allow to evolve to a better constrained system in the future and will provide the underlying code with the needed info to create the proper indexes. <br />
## Note that, if you define any field combination as FK you won't have to create any index on that fields, the code will do it automatically! <br />
## This convention is only applicable for relations INSIDE one file. Don't generate FK constraints against other files (courseid, userid), use indexes there.<br />
## Respect Convention 1.3<br />
# About UNIQUE KEYS<br />
## Declare any fields as UNIQUE KEY (UK) only if they are going to be used as target for one FK. Create unique indexes instead.<br />
## Respect Convention 1.3<br />
<br />
== One example: the assignment module ==<br />
<br />
Here we are going to examine the [http://cvs.moodle.org/moodle/mod/assignment/db/install.xml?view=markup current implementation of the XMLDB Schema for the assignment module] (a simple one). It has been completely generated with the XMLDB Editor but it's nice to know a bit more about the XML internals.<br />
<br />
As you can see the structure is pretty simple:<br />
<br />
* XMLDB<br />
** TABLES, one or more, each one with<br />
*** FIELDS<br />
*** KEYS<br />
*** INDEXES<br />
** STATEMENTS, none or more, each one with<br />
*** SENTENCES<br />
<br />
First of all you should note that all the elements contain the '''PREVIOUS''' and '''NEXT''' attributes. They allow us to keep everything ordered although it isn't meaningful at all from the RDBMS perspective. Also the '''COMMENT''' field is present everywhere to be used as desired.<br />
<br />
=== The TABLE element ===<br />
<br />
We can ignore the TABLE element, as it's simply one container for the internals (FIELDS, KEYS and INDEXES). Let's go to examine them a bit more:<br />
<br />
==== The FIELD element ====<br />
<br />
It maps with one field in the DB (obviously). For each field you can define its '''name''', '''type''' (from a list of [[XMLDB column types|neutral types]]), '''length''', '''decimals''' (for some types), '''notnull''' (true/false), '''unsigned''' (true/false), '''sequence''' (if it's autonumeric or serial, true/false), '''enum''' (true/false), '''enumvalues''' (the list of values if the field has been declared as enum, for example <tt>'frog','toad','newt'</tt>) and '''default''' (to assign a default value).<br />
<br />
So, in our example, we have two tables, assignment and assignment_submissions, each one with its own fields, defining all the information related above. Please note that naming conventions are followed.<br />
<br />
==== The KEY element ====<br />
<br />
Here is where all the PRIMARY KEYS (PK), UNIQUE KEYS (UK) and FOREIGN KEYS (FK) will be defined. For each key we define its '''name''', '''type''', '''fields''' (that belongs to it) and optionally (if the key is one FK) the target '''reftable''' and '''reffields'''.<br />
<br />
In our example, the assignment table has one (mandatory!) PK (called, "primary", rules are rules) built with the "id" field. <br />
<br />
The other table, the "assignment_submissions" one, also has its PK (called "primary" once more) and one FK, with the field "assignment" pointing to the field "id" of the table "assignment". Note that the FK follows the name conventions and its name is, simply, the name of the fields being part of it ("assignment"). Also, the FK has as target to one PK of the same module.<br />
<br />
Finally, note that there isn't any index created for all these keys. Moodle will generate them automatically when the table is created. All the keys will have their corresponding index. Point. ;-)<br />
<br />
==== The INDEX element ====<br />
<br />
Where all the indexes will be defined. For each index you can define its '''name''', '''unique''' (true/false) and the '''fields''' that conform it. Please note that naming conventions are followed.<br />
<br />
Also, some "obvious index", like the one based in the "assignment" field of the "assignment_submissions" table doesn't exist. Yes, you know why: Because such column has been defined as a FK and the index will be automatically created (see previous section).<br />
<br />
=== The STATEMENT element ===<br />
<br />
This is the other '''big container''' in the XMLDB Schema (at the same level as the '''TABLES''' one) and we can define its '''name''', '''type''' (only insert allowed for now) and '''table''' (against the sentences will be executed).<br />
<br />
Every statement is a collection of '''sentences''' <br />
<br />
==== The SENTENCE element ====<br />
<br />
Each sentence implies one simple action to be performed against the DB and it can be defined as the "missing part of the SQL statement". In our example, we have one statement, of type "insert" on table "log_display". With this Moodle knows the initial part of the sentence, i.e:<br />
<br />
INSERT INTO log_display <br />
<br />
and then the text will be added to create this:<br />
<br />
INSERT INTO log_display <br />
(module, action, mtable, field) <br />
VALUES <br />
('assignment', 'view', 'assignment', 'name')<br />
<br />
There is one important trick when handling sentences, although they aren't in the assignment example. Take a look to the [http://cvs.moodle.org/moodle/lib/db/install.xml?view=co Core Tables XML Schema] (it's a huge one!). If you go near the end, to the statements section, you will see some sentences like this:<br />
<br />
<SENTENCE TEXT="....VALUES ('user', 'view', 'user', 'CONCAT(firstname," ",lastname)')"/><br />
<br />
Such "CONCAT" function isn't standard at all (only MySQL supports it), but don't worry, we'll transform it to the correct concatenation operators for other RDBMS. Just be sure to use the syntax showed above.<br />
<br />
== DTD and XML schema ==<br />
<br />
Not sure if this will be usable for somebody but here you can find one [http://cvs.moodle.org/moodle/lib/xmldb/xmldb.dtd?view=co automatically generated DTD] for the XMLDB files. Also one [http://cvs.moodle.org/moodle/lib/xmldb/xmldb.xsd?view=co automatically generated XML Schema] is available. Any improvement/fix to them will be welcome!<br />
<br />
== See also ==<br />
<br />
* [[XMLB List of files to create|List of files to create]]: The list of files to be created from scratch. Used to follow the progress.<br />
* http://www.hitsw.com/xml_utilites/: One online XML-DTD-Schema converter.<br />
<br />
[[Category:XMLDB]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=IMS_Enterprise&diff=38146IMS Enterprise2008-06-24T01:22:16Z<p>Scyrma: /* See also */ out of sourceforge ... into our own repo.</p>
<hr />
<div>{{Moodle 1.6}}<br />
'''IMS Enterprise''' is an international standard XML file format which may be used to specify enrolments/unenrolments in courses, as well as course information and user information.<br />
<br />
Starting in Moodle 1.6, IMS Enterprise files may be used for enrolment. For more information please see [http://moodle.cvs.sourceforge.net/*checkout*/moodle/moodle/lang/en_utf8/help/enrol/imsenterprise/formatoverview.html the main IMS Enterprise help file].<br />
<br />
==See also==<br />
<br />
* [http://www.imsglobal.org/enterprise/ IMS Enterprise specification] - the official site<br />
* [http://cvs.moodle.org/contrib/plugins/enrol/imsenterprise/entv1p1_conformance_summary.html?view=co Conformance summary] - summarises the parts of the specification which Moodle makes use of<br />
* [https://studydirect.sussex.ac.uk/downloads/imsenterprise.php Minted IMS Enterprise enrolment plugin] - An extension of the ims enterprise enrolment plugin developed in the [http://www.sussex.ac.uk/minted minted project]<br />
<br />
[[Category:Administrator]]<br />
[[Category:Enrolment]]<br />
<br />
[[fr:Fichier IMS Enterprise]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Moodle_3.0&diff=37916Development:Moodle 3.02008-06-20T01:56:09Z<p>Scyrma: </p>
<hr />
<div>This page is a brainstorm about a complete rewrite/refactor for Moodle 3.0.<br />
<br />
Please add your ideas! They don't need to be consistent yet, just make sure your ideas are here to be boiled down later on.<br />
<br />
Think Big!<br />
<br />
<br />
===One type of plugin===<br />
<br />
All plugins/modules could be subclassed from one plugin class, making installation easier and simplifying the API a lot.<br />
<br />
===Look at new framework===<br />
<br />
Possibly base Moodle 3.0 on new existing frameworks? Ruby on Rails? Drupal?<br />
<br />
=== Moodlets===<br />
<br />
Individual-independent-activities backup/restore + metadata - Eloy<br />
<br />
=== Support for alternate interfaces ===<br />
<br />
Completely flash-based interface? Designed for offline clients?<br />
<br />
=== Integrated category/taxonomy system ===<br />
<br />
Putting together the "course categories", "tags" into a generic taxonomy system.</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=37019Development:HTML editor 2.02008-06-04T08:59:10Z<p>Scyrma: /* Plan of action */</p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
* Support - Developed by an active community that will support it for a long time.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Highlighting (not text background color, with "set-on" operation--Word style)<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (possibly modified) content (see [http://wiki.moxiecode.com/examples/tinymce/installation_example_07.php this TinyMCE example of this])<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
* Submit drafts in the background, using ajax.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Plan of action ==<br />
<br />
See: MDL-11113 and MDL-14739<br />
<br />
* Get latest TinyMCE in HEAD before 13 May 2008 so that work can be done there (done, MDL-14739)<br />
* Have the XHTML profile active by default in TinyMCE (done)<br />
* Attack each Moodle plugin in turn, keeping modifications to TinyMCE code base as modular and minimal as possible<br />
<br />
=== Plugins to write ===<br />
Some plugins will have to be written for each editor to make integration with Moodle possible. These should be as abstracted as possible, to make as much code as possible common between each. Since editors will be located under /lib/editor, let's store this common code under /lib/editormod.<br />
<br />
* File browser: the file browser (especially with the [[File API]]) will be Moodle specific<br />
* Emoticons (smileys): Moodle defines its own list of emoticons, we need to make sure the editors use these consistently<br />
* Language files: Moodle has a lot more languages than any editors, and some strings will be Moodle-specific. We need a way to make for each editor to use Moodle strings, reusing as many existing strings as possible, and using lang/xx/editor.php for the rest.<br />
* Equation editor: there is [[DragMath_equation_editor| ongoing work]] to get [http://www.dragmath.bham.ac.uk/ Dragmath] working in Moodle, making a common plugin could be a nice improvement<br />
* Multilang: all editors need to support multilang properly.<br />
<br />
It also may be possible to use Moodle's CSS files to define editors themes/skins, this needs investigation<br />
<br />
'''Editor-specific information:'''<br />
* TinyMCE makes it possible to have [http://tinymce.moxiecode.com/punbb/viewtopic.php?pid=9317#p9317 self-registering plugins], that don't need to be under it's /plugins folder (and so could be in a moodle-specific folder).<br />
* FCKeditor [http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide/Customization/Plug-ins needs to have its plugins in a specific place].<br />
<br />
=== Change in formats ===<br />
<br />
There is a bug (MDL-4868) about Markdown not being converted to HTML when using the HTML editor (after creating a post with Markdown). <br />
<br />
This really applies to all non-HTML formats.<br />
<br />
Proposal: whenever the HTML editor is used to edit existing non-HTML text, we convert the text to HTML for use in the editor. Saving the changes will save the text (and format) as HTML.<br />
<br />
Although we are losing some information, we feel it's an acceptable tradeoff against overall usability, particularly as the HTML editor works on a wider range of browsers and we make XHTML compliance a requirement.<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific customisations to the HTML editor]]<br />
<br />
Using Moodle General developer forum discussions:<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 What is the current position with the HTML editor?]<br />
* [http://moodle.org/mod/forum/discuss.php?d=96160 The most important decision on editor integration]<br />
<br />
[[Category:HTML editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=37018Development:HTML editor 2.02008-06-04T08:57:17Z<p>Scyrma: /* Plugins to write */</p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
* Support - Developed by an active community that will support it for a long time.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Highlighting (not text background color, with "set-on" operation--Word style)<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (possibly modified) content (see [http://wiki.moxiecode.com/examples/tinymce/installation_example_07.php this TinyMCE example of this])<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
* Submit drafts in the background, using ajax.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Plan of action ==<br />
<br />
See: MDL-xxxx<br />
<br />
* Get latest TinyMCE in HEAD before 13 May 2008 so that work can be done there<br />
* Have the XHTML profile active by default in TinyMCE<br />
* Attack each Moodle plugin in turn, keeping modifications to TinyMCE code base as modular and minimal as possible<br />
<br />
<br />
=== Plugins to write ===<br />
Some plugins will have to be written for each editor to make integration with Moodle possible. These should be as abstracted as possible, to make as much code as possible common between each. Since editors will be located under /lib/editor, let's store this common code under /lib/editormod.<br />
<br />
* File browser: the file browser (especially with the [[File API]]) will be Moodle specific<br />
* Emoticons (smileys): Moodle defines its own list of emoticons, we need to make sure the editors use these consistently<br />
* Language files: Moodle has a lot more languages than any editors, and some strings will be Moodle-specific. We need a way to make for each editor to use Moodle strings, reusing as many existing strings as possible, and using lang/xx/editor.php for the rest.<br />
* Equation editor: there is [[DragMath_equation_editor| ongoing work]] to get [http://www.dragmath.bham.ac.uk/ Dragmath] working in Moodle, making a common plugin could be a nice improvement<br />
* Multilang: all editors need to support multilang properly.<br />
<br />
It also may be possible to use Moodle's CSS files to define editors themes/skins, this needs investigation<br />
<br />
'''Editor-specific information:'''<br />
* TinyMCE makes it possible to have [http://tinymce.moxiecode.com/punbb/viewtopic.php?pid=9317#p9317 self-registering plugins], that don't need to be under it's /plugins folder (and so could be in a moodle-specific folder).<br />
* FCKeditor [http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide/Customization/Plug-ins needs to have its plugins in a specific place].<br />
<br />
=== Change in formats ===<br />
<br />
There is a bug (MDL-4868) about Markdown not being converted to HTML when using the HTML editor (after creating a post with Markdown). <br />
<br />
This really applies to all non-HTML formats.<br />
<br />
Proposal: whenever the HTML editor is used to edit existing non-HTML text, we convert the text to HTML for use in the editor. Saving the changes will save the text (and format) as HTML.<br />
<br />
Although we are losing some information, we feel it's an acceptable tradeoff against overall usability, particularly as the HTML editor works on a wider range of browsers and we make XHTML compliance a requirement.<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific customisations to the HTML editor]]<br />
<br />
Using Moodle General developer forum discussions:<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 What is the current position with the HTML editor?]<br />
* [http://moodle.org/mod/forum/discuss.php?d=96160 The most important decision on editor integration]<br />
<br />
[[Category:HTML editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=37017Development:HTML editor 2.02008-06-04T08:53:44Z<p>Scyrma: /* Plugins to write */</p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
* Support - Developed by an active community that will support it for a long time.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Highlighting (not text background color, with "set-on" operation--Word style)<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (possibly modified) content (see [http://wiki.moxiecode.com/examples/tinymce/installation_example_07.php this TinyMCE example of this])<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
* Submit drafts in the background, using ajax.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Plan of action ==<br />
<br />
See: MDL-xxxx<br />
<br />
* Get latest TinyMCE in HEAD before 13 May 2008 so that work can be done there<br />
* Have the XHTML profile active by default in TinyMCE<br />
* Attack each Moodle plugin in turn, keeping modifications to TinyMCE code base as modular and minimal as possible<br />
<br />
<br />
=== Plugins to write ===<br />
Some plugins will have to be written for each editor to make integration with Moodle possible. These should be as abstracted as possible, to make as much code as possible common between each. Since editors will be located under /lib/editor, let's store this common code under /lib/editormod.<br />
<br />
* File browser: the file browser (especially with the [[File API]]) will be Moodle specific<br />
* Emoticons (smileys): Moodle defines its own list of emoticons, we need to make sure the editors use these consistently<br />
* Language files: Moodle has a lot more languages than any editors, and some strings will be Moodle-specific. We need a way to make for each editor to use Moodle strings, reusing as many existing strings as possible, and using lang/xx/editor.php for the rest.<br />
* Equation editor: there is [[DragMath_equation_editor| ongoing work]] to get [http://www.dragmath.bham.ac.uk/ Dragmath] working in Moodle, making a common plugin could be a nice improvement<br />
* Multilang: all editors need to support multilang properly.<br />
<br />
It also may be possible to use Moodle's CSS files to define editors themes/skins, this needs investigation<br />
<br />
Editor-specific information:<br />
* TinyMCE makes it possible to have [http://tinymce.moxiecode.com/punbb/viewtopic.php?pid=9317#p9317 self-registering plugins], that don't need to be under it's /plugins folder (and so could be in a moodle-specific folder).<br />
* FCKeditor [http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide/Customization/Plug-ins needs to have its plugins in a specific place].<br />
<br />
=== Change in formats ===<br />
<br />
There is a bug (MDL-4868) about Markdown not being converted to HTML when using the HTML editor (after creating a post with Markdown). <br />
<br />
This really applies to all non-HTML formats.<br />
<br />
Proposal: whenever the HTML editor is used to edit existing non-HTML text, we convert the text to HTML for use in the editor. Saving the changes will save the text (and format) as HTML.<br />
<br />
Although we are losing some information, we feel it's an acceptable tradeoff against overall usability, particularly as the HTML editor works on a wider range of browsers and we make XHTML compliance a requirement.<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific customisations to the HTML editor]]<br />
<br />
Using Moodle General developer forum discussions:<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 What is the current position with the HTML editor?]<br />
* [http://moodle.org/mod/forum/discuss.php?d=96160 The most important decision on editor integration]<br />
<br />
[[Category:HTML editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=37016Development:HTML editor 2.02008-06-04T08:48:57Z<p>Scyrma: /* Plugins to write */</p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
* Support - Developed by an active community that will support it for a long time.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Highlighting (not text background color, with "set-on" operation--Word style)<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (possibly modified) content (see [http://wiki.moxiecode.com/examples/tinymce/installation_example_07.php this TinyMCE example of this])<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
* Submit drafts in the background, using ajax.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Plan of action ==<br />
<br />
See: MDL-xxxx<br />
<br />
* Get latest TinyMCE in HEAD before 13 May 2008 so that work can be done there<br />
* Have the XHTML profile active by default in TinyMCE<br />
* Attack each Moodle plugin in turn, keeping modifications to TinyMCE code base as modular and minimal as possible<br />
<br />
<br />
=== Plugins to write ===<br />
Some plugins will have to be written for each editor to make integration with Moodle possible. These should be as abstracted as possible, to make as much code as possible common between each. Since editors will be located under /lib/editor, let's store this common code under /lib/editormod.<br />
<br />
* File browser: the file browser (especially with the [[File API]]) will be Moodle specific<br />
* Emoticons (smileys): Moodle defines its own list of emoticons, we need to make sure the editors use these consistently<br />
* Language files: Moodle has a lot more languages than any editors, and some strings will be Moodle-specific. We need a way to make for each editor to use Moodle strings, reusing as many existing strings as possible, and using lang/xx/editor.php for the rest.<br />
* Equation editor: there is [[DragMath_equation_editor| ongoing work]] to get [http://www.dragmath.bham.ac.uk/ Dragmath] working in Moodle, making a common plugin could be a nice improvement<br />
* Multilang: all editors need to support multilang properly.<br />
<br />
It also may be possible to use Moodle's CSS files to define editors themes/skins, this needs investigation<br />
<br />
Editor-specific information:<br />
* tinymce makes it possible to have [http://tinymce.moxiecode.com/punbb/viewtopic.php?pid=9317#p9317 self-registering plugins], that don't need to be under it's /plugins folder (and so could be in a moodle-specific folder).<br />
<br />
=== Change in formats ===<br />
<br />
There is a bug (MDL-4868) about Markdown not being converted to HTML when using the HTML editor (after creating a post with Markdown). <br />
<br />
This really applies to all non-HTML formats.<br />
<br />
Proposal: whenever the HTML editor is used to edit existing non-HTML text, we convert the text to HTML for use in the editor. Saving the changes will save the text (and format) as HTML.<br />
<br />
Although we are losing some information, we feel it's an acceptable tradeoff against overall usability, particularly as the HTML editor works on a wider range of browsers and we make XHTML compliance a requirement.<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific customisations to the HTML editor]]<br />
<br />
Using Moodle General developer forum discussions:<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 What is the current position with the HTML editor?]<br />
* [http://moodle.org/mod/forum/discuss.php?d=96160 The most important decision on editor integration]<br />
<br />
[[Category:HTML editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=User:Mathieu_Petit-Clair&diff=35782User:Mathieu Petit-Clair2008-05-08T05:11:01Z<p>Scyrma: </p>
<hr />
<div>See http://moodle.org/user/view.php?id=423027&course=1 for details.</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=CVS_for_Administrators&diff=35716CVS for Administrators2008-05-07T06:52:43Z<p>Scyrma: adding -P to checkout, otherwise it won't install</p>
<hr />
<div>The [http://cvs.moodle.org/ CVS archive] contains all the source code for Moodle. You can use a CVS program to extract versions ranging from the most stable release to the most cutting-edge development version. CVS can be an extremely convenient way of maintaining a Moodle server.<br />
<br />
[[Image:Cvstree.png|CVS tree]]<br />
<br />
Developers may have selective write access to the Moodle CVS archive (see [[CVS for Developers]] for details about how to do this). However, most people only need read-only access, so they can just connect to one of the mirrors using '''anonymous CVS''' as described below. There can however currently be a delay of up to 1 hour between the time a developer commits changes to developer CVS and the time it becomes available on anonymous CVS. <br />
<br />
==CVS Servers==<br />
<br />
Please choose the closest CVS mirror server to you from this list:<br />
<br />
{| border="1" cellpadding="4" cellspacing="0"<br />
|'''Country'''<br />
|'''Server'''<br />
|'''Provided by'''<br />
|-<br />
|EU<br />
|'''eu.cvs.moodle.org'''<br />
|[http://www.open.ac.uk/ The Open University] In case of trouble, contact [mailto:r.t.c.norfor@open.ac.uk Rod Norfor] or [mailto:d.a.woolhead@open.ac.uk Derek Woolhead]<br />
|-<br />
|ES<br />
|'''es.cvs.moodle.org'''<br />
|[http://www.mondragon.edu/ Mondragon Unibertsitatea] In case of trouble, contact [mailto:iarenuno@eteo.mondragon.edu iarenuno@eteo.mondragon.edu] or [mailto:iarenaza@escomposlinux.org iarenaza@escomposlinux.org]<br />
|-<br />
|UK<br />
|'''uk.cvs.moodle.org'''<br />
|Cumbria and Lancashire Education Online ([http://www.cleo.net.uk/ CLEO]) in collaboration with Lancaster University Network Services ([http://www.lancs.ac.uk/ LUNS])<br />
|-<br />
|US<br />
|'''us.cvs.moodle.org'''<br />
|San Francisco State University, Academic Technology ([http://www.sfsu.edu/ SFSU]). In case of trouble, contact [mailto:ilearn@sfsu.edu iLearn support]<br />
|}<br />
<br />
<br />
Replace the SERVER.cvs.moodle.org in the instructions below with the server you chose above!<br />
<br />
For up-to-date alerts about planned or unplanned outages on any of these servers subscribe to the [http://lists.moodle.org/info/outages Moodle Outage mailing list].<br />
<br />
(If you would like to contribute to the project by running a mirror, please see [[How to set up a CVS mirror]]) <br />
<br />
===Switching to a new server===<br />
<br />
If you were ''already'' using CVS and want to switch to a different server, you'll probably need to make a small change so that the control files in your working copy will point to the new mirrors. <br />
<br />
====Switching to a new server on Unix====<br />
<br />
Use a shell command like this to change existing installations to point to the new mirror (UK mirror used in this example):<br />
<br />
'''find . -type f -name Root -print0 | xargs -0 perl -pi -e 's/\@moodle\.cvs\.sourceforge\.net/\@uk\.cvs\.moodle\.org/''''<br />
<br />
It can be run from /home, say, to fix multiple sites at once.<br />
<br />
====Switching to a new server with TortoiseCVS====<br />
<br />
If you were ''already'' using Tortoise CVS on Windows it's tricky, because Tortoise doesn't have any interface for changing the server. http://www.tortoisecvs.org/faq.html#changecvsroot explains it. But basically, <br />
<br />
1) Install WinCVS and launch it. <br />
2) Navigate to and select your Moodle folder. <br />
3) Choose 'Macros'->CVS->Change Root from the menu. <br />
4) Accept (or change) the default for the 'old' server. <br />
5) Type the new server name. OK! <br />
<br />
It takes a few seconds to go through all of the '''cvs''' folders and update the '''root''' files.<br />
<br />
By the way, if you don't want to install WinCVS, another way of doing this is to uninstall your TortoiseCVS client on Windows, then do a regedit to clean up all the tortoisecvs related entries (might not be necessary), then reinstall TortoiseCVS client again (a good reason to upgrade to the most recent version of TortoiseCVS!). I have tested this and it cleared up the original setting of the original anonymous CVS server setting.<br />
<br />
==Instructions==<br />
<br />
===From a Unix computer===<br />
<br />
To connect and login for the first time to the CVS server, you can use this command (remember to replace '''SERVER.cvs.moodle.org''' in the instructions below with the mirror server you chose above):<br />
<br />
cvs -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle login<br />
<br />
There is no password - when asked for one, just hit Enter.<br />
<br />
To checkout (download) the entire Moodle code for the first time, use this command to get the latest STABLE version:<br />
<br />
cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co -P -r MOODLE_19_STABLE moodle<br />
<br />
Or the latest development version:<br />
<br />
cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co -P moodle<br />
<br />
Or the modules in Contrib<br />
<br />
cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co contrib<br />
<br />
Later, to update your local copy of Moodle to the current version in CVS you just need to go into your local Moodle directory and type:<br />
<br />
cvs update -dP<br />
<br />
To update your local copy of Moodle to a new version (e.g. from 1.8+ to 1.9), go into your local Moodle directory and type:<br />
<br />
cvs update -dP -r MOODLE_19_STABLE<br />
<br />
To update your local copy and to save the log of the process, use the following command instead the previous one:<br />
<br />
cvs update -dP -r MOODLE_19_STABLE | tee upgrade.log<br />
<br />
Then look at the upgrade.log, notably look for lines starting with "C" (conflict):<br />
<br />
grep '^C' upgrade.log<br />
<br />
Conflicts may appear in case you have manually modified your source files. You have to resolve conflicts before using the site. See [[CVS for Developers]] for more details.<br />
<br />
===Changing the directory name===<br />
<br />
By default, the CVS checkout creates a diectory on your webserver called 'moodle'. If you want your Moodle installation in a different directory, you can change the name of the directory that it will checkout the files to, by typing the follwing. This would download the MOODLE_19_STABLE branch into a directory called "mydirectory" (-d mydirectory).<br />
<br />
cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co '''-d mydirectory''' -r MOODLE_19_STABLE moodle<br />
<br />
Or the latest development version to a directory called 'moodle-dev':<br />
<br />
cvs -z3 -d:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle co '''-d moodle-dev''' moodle<br />
<br />
You can also change the name of the directory after the files are downloaded, and before you go through the Moodle install process. If you change the name of the directory before install, it will not affect anything during the install or during a CVS update. If you change the name of the directory after an install, you will need to change the config.php to reflect the name change ([[Moodle_migration#Migrating_a_complete_Moodle_site|guidance here]]). It won't affect the CVS update though.<br />
<br />
===Change directory owner===<br />
<br />
Depending on your webserver setup, you may well need to change the owner of the directory to the webserver user. Follow this step if you get permissions error when you try to access the page. For apache:<br />
<br />
chown -R www-data:www-data moodle<br />
<br />
===From a Windows computer===<br />
<br />
To get started with a fresh copy of Moodle, follow the following steps (remember to replace '''SERVER.cvs.moodle.org''' in the instructions below with the mirror server you chose above):[[Image:CVS moodle settings for tortoise CVS.jpg|thumb|Tortoise CVS Screen capture]]<br />
[[Image:Ecran cvs.jpg|thumb|Tortoise CVS (real name) Screen capture]]<br />
# Get TortoiseCVS from [http://www.tortoisecvs.org/ tortoisecvs.org] and install it, then reboot.<br />
# Find or create a new folder somewhere where you want Moodle to be downloaded to.<br />
# Right-mouse-click that folder and choose "CVS Checkout" from the menu. You should see a dialog box. <br />
# Copy this text into the CVSROOT field: <code>:pserver:anonymous@SERVER.cvs.moodle.org:/cvsroot/moodle</code><br />
#* NOTE - replace "SERVER" with "eu", "es", "uk" or "us" depending on your location.<br />
# Under the "Module" field, type "moodle" to get moodle. (Other options here include"contrib" to get the contrib directory of hacks and addons, or "mysql" to get the optional MySQL Admin module).<br />
#* For the latest STABLE version, click on the "Revision" tab and then check the radio button labelled "Choose branch or tag". From the drop-down menu select MOODLE_18_STABLE.<br />
#* If you don't see the very latest version in the long drop-down list under Branch or tag name, click the Update List button next to it and wait for the list to be updated.<br />
#* For the latest UNSTABLE development version, the radio-button "Use HEAD branch" in the Revision tab should be checked.<br />
# Press the button: "OK" and everything should be downloaded. <br />
<br />
Later, to update your local copy of Moodle to the current version in CVS, just right-mouse-click the folder and choose "CVS Update".<br />
<br />
Note that the enclosing moodle folder is self-contained - you can move it anywhere you like or even rename it.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
'''NOTE.-''' Admins with a developer account on cvs.moodle.org can connect with their account name, see attached screen shot.<br />
<br />
===From a Mac OS X computer===<br />
You will find some information about CVS and Mac OS X in the documentation for the complete installation package Moodle4Mac. Please read [[Complete_Install_Packages_for_Mac_OS_X#How_To_Update_Your_Moodle4Mac | How To Update Your Moodle4Mac]]. It works fine with the new CVS servers.<br />
<br />
===Troubleshooting===<br />
<br />
If you see something like this, make sure that there is not some firewall blocking the port (it's 2401):<br />
<br />
$ cvs -d:pserver:anonymous@us.cvs.moodle.org:/cvsroot/moodle login<br />
Logging in to :pserver:anonymous@us.cvs.moodle.org:2401/cvsroot/moodle<br />
CVS password:<br />
cvs [login aborted]: connect to us.cvs.moodle.org(130.212.64.111):2401 failed: Connection timed out<br />
<br />
==See also==<br />
<br />
*[[Development:Setting up Eclipse]] for step by step instructions for setting up the [http://www.eclipse.org/ Eclipse IDE] for Moodle development, which including how to do the necessary CVS operations.<br />
<br />
Using Moodle forum discussions:<br />
*[http://moodle.org/mod/forum/discuss.php?d=26731&parent=125858 Using cvs]<br />
*[http://moodle.org/mod/forum/discuss.php?d=91891 CVS Updating of 3rd-Party Plug-ins in the Moodle folder itself]<br />
<br />
[[Category:Administrator]]<br />
<br />
[[fr:CVS pour administrateurs]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Overview&diff=35714Development:Overview2008-05-07T06:44:32Z<p>Scyrma: /* The key players */</p>
<hr />
<div>A lot of people ask how the development of Moodle operates. This page should give you a working overview that should help in understanding a lot of other developer documentation.<br />
<br />
==The key players==<br />
<br />
;Martin Dougiamas: Martin is the lead developer of Moodle. Generally he tries to facilitate democracy and meritocracy but occasionally has to make executive decisions on things.<br />
<br />
;Moodle HQ: The mostly-Australian team of developers who are directly funded by the Moodle project to work full-time on core developments. Developers include Martin Dougiamas (moodler), Eloy Lafuente (stronk7), Petr Skoda (skodak), Mathieu Petit-Clair (scyrma), Nicolas Connault, Donsheng Cai, Jérôme Mouneyrac, Helen Foster (wildgirl) and occasionally Jamie Pratt (jamiesensei). Pictures of everyone can be found here: http://moodle.com/hq/.<br />
<br />
;Catalyst: The team of developers working for Moodle clients via Catalyst Ltd in New Zealand, resulting in a lot of core development. Developers include Martin Langhoff, Penny Leach (mjollnir), Matt Clarkson, and Donal McMullan.<br />
<br />
;Open University: The team of developers working on Moodle implementations at Open University in the UK. Developers include Tim Hunt, Sam Marshall, Nick Freear, Thanh Le and Jenny Gray.<br />
<br />
There are many other people contributing to Moodle in many ways, these are just the main groups currently working on core development. See [http://moodle.org/cvs the full list of people with write access to Moodle]<br />
<br />
==Moodle versions==<br />
<br />
Moodle major releases occur roughly 6 months or more apart, on no fixed schedule. Each major release increments the version number by 0.1. Minor releases (no new features, just fixes) on each stable branch can occur at any time, whenever enough bug fixes have been made to justify them. The full details can be seen in the [[Release notes]].<br />
<br />
The current development version is always on the trunk of CVS (i.e. HEAD), while stable branches are split off for every major version (e.g. MOODLE_18_STABLE).<br />
<br />
<br />
==Release cycles==<br />
<br />
Generally a cycle works like this:<br />
;Rapid Development:Long period of several months adding code to the HEAD version of Moodle. At the same time, all fixes that don't involve database changes or radical core changes are backported to the last two or three stable branches.<br />
;Head Freeze:At some point Martin Dougiamas declares a freeze on new work for a while to stabilise the core. All database changes and all major core changes need to have explicit permission from Martin. All developers should be wrapping up work on new features and fixing bugs in new code. This period may be 1 or 2 weeks.<br />
;Beta period:Once the HEAD version becomes fairly stable, Martin declares a BETA version and this point is marked on HEAD as MOODLE_XX_BETA (e.g. MOODLE_19_BETA). Install packages are generated daily from the latest version for wider testing and feedback via the tracker. The freeze continues, testing and bug fixing continues. This testing period may be anywhere from 2 to 6 weeks.<br />
;Major release:When the core code passes all the testing we can throw at it, the MOODLE_XX_BETA flag is moved up to mark the current point as a branch point, and a new stable branch named MOODLE_XX_STABLE is created. Packages are created, and the release is announced.<br />
<br />
Then it all starts again!<br />
<br />
==Quality control==<br />
<br />
Issue tracking is an important part of a continuous quality control process. It involves reporting of problems (bugs), ideas for improvement and new features. Unlike most proprietary software programs, Moodle issue reporting and tracking information is open to everyone. Moodle's issue tracking system is called the [[Tracker]].<br />
<br />
All Moodle users are encouraged to be active participants when it comes to testing. Anyone with a Tracker user account can create, view, comment on, vote, and watch bugs.<br />
<br />
===Testers===<br />
<br />
Testers are responsible for verifying the accuracy of changes made by developers. Testers choose which bugs they want to test, according to their area of expertise, and use the QA Assignee field to identify themselves as the tester.<br />
<br />
If the bug passes testing, then the tester changes the status of the bug from 'resolved' to 'closed'. If the bug fails testing, or if the fix is incomplete, then the tester reopens the bug.<br />
<br />
A Moodle release will be deemed ready when all "blocker" bugs fixed for a particular version have been closed.<br />
<br />
<br />
===Weekly Code Review===<br />
<br />
Every Tuesday (all time zones), testers and core developers stop developing new code and focus on reviewing changes made to the stable releases in the past week (both at a code level and an interface level).<br />
<br />
This process is intended to improve the quality of the latest download packages and to catch any new bugs that might have been created while fixing old ones.<br />
<br />
The latest stable packages are tagged as MOODLE_19_WEEKLY (these tags are updated after the weekly review is over).<br />
<br />
See [[Development:Weekly Code Review]] for more details.<br />
<br />
==Coding Standards==<br />
<br />
The full [[Coding|Coding Guide]] gives all the details, but here are some of the major things your code needs to hit:<br />
<br />
===XMLDB===<br />
<br />
All our database schema are created using the XML ''install.php'' files, and upgraded using database-agnostic commands in ''upgrade.php'' files. Any version of any part of Moodle can be smoothly upgraded to any later version in this fashion (on a wide variety of supported databases).<br />
<br />
===XHTML===<br />
<br />
All output from Moodle must be compliant with XHTML Strict 1.0, and also compliant with all common accessibility guidelines (such as W3C WAG). <br />
<br />
===Forms===<br />
<br />
All forms should use the Moodleforms library if possible. This results in a standardised accessible output that designers can style consistently and well.<br />
<br />
===Parameters===<br />
<br />
All parameters should be checked using require_param() and optional_param() which will safely clean all incoming data for use and provide defaults to your code. Moodleforms will do this automatically for you.<br />
<br />
===Output===<br />
<br />
All textual output should be output using the format_text or format_string functions. This will ensure that text is cleaned and filtered appropriately.<br />
<br />
===Access===<br />
<br />
All permissions-checking should use the "Access library" to check against current capabilities. The most common function you'll use is has_capability() which checks the permissions of the current user in an efficient way to see if they are allowed to do this specific operation. Do not check for specific roles in your code (e.g. teacher/student) as that will make your code useless.<br />
<br />
===Other core libraries===<br />
<br />
The other major libraries you should get familiar with are:<br />
# ''moodlelib.php'' - a useful bin of all kinds of useful functions and constants<br />
# ''datalib.php'' - all the functions you need to interface with the database <br />
# ''weblib.php'' - all the functions you'll need to create and output XHTML <br />
<br />
<br />
===Plugins===<br />
<br />
Moodle has about 22 different types of plugins last time I counted. Plugins can generally be self-contained in a single directory containing scripts, images, stylesheets and language files all in one package that can be dropped into the Moodle script directory in the right place. After that the admin just needs to visit the admin page to install them.<br />
<br />
Most plugins work in one of two ways, they either provide a ''lib.php'' filled with common functions and some scripts with standard names, or they subclass a proto-plugin and override a few method functions to achieve their goals. <br />
<br />
The best way to learn is to pick an example from the core code that is similar to what you want to do and start playing with it. There are also some template plugins to help get you started.<br />
<br />
==Development processes==<br />
Not all Moodle development happens exactly like this, but it really should. :-)<br />
<br />
===Major Development===<br />
A major development is a significant piece of new code, adding new functionality to Moodle.<br />
<br />
====Make sure it's a good idea====<br />
Firstly, you should look at the roadmap and talk the idea over with some Moodle developers to see if someone else is working on it already and whether others think the general idea has merit. Use the forums if you wish, or whatever means you have. If you have a client, you may need to work with them to work out what they REALLY want (perhaps it isn't actually a new development for Moodle).<br />
<br />
====Create a specification in Moodle Docs====<br />
Start a new page in the Moodle Docs wiki, similar to [[Development:Grades]]. Your page should outline the database table design, the GUI, the hows and whys etc. Include as much detail as you need (even mock screenshots) but try to keep it clear and logically organised.<br />
<br />
====Seek and absorb community feedback====<br />
Post about the new page in the appropriate forums on [http://moodle.org/course/view.php?id=5 Using Moodle] to help draw attention to it and to stimulate some discussion around your development. The more feedback you have the better, especially if it includes a wide variety of users (developers, teachers, students etc).<br />
<br />
Edit your page in response to the feedback, or invite people to do so themselves. try to evolve the specification into something that all users are happy with. Sometimes it's worth working harder to find the "best" way to do something without adding Yet Another Option.<br />
<br />
====Set up tasks in the Moodle Tracker====<br />
Once the specification has settled down, it's time to start work. Create a new task for yourself in the Moodle Tracker, and add sub-tasks in roughly chronological order for all the different parts of the job. This not only helps you keep track of where you are, but allows the community to "watch you" develop and to help you where they can. If there are different people working on different parts, you can assign subtasks to different people. It's really very convenient to use once you get the hang of it.<br />
<br />
====Use CVS and link commits to Tracker====<br />
If possible, develop the code in an open code repository (and preferably Moodle CVS!). If you need CVS write access to the core code or the contrib repository, contact support@moodle.com with details. Gaining access to the main core code is quite difficult, but we are generally very free with access to the contrib area.<br />
<br />
Every time you make a commit, include a detailed message about the new code and always include a Moodle Tracker bug number (e.g. MDL-7777). This will ensure that the Moodle Tracker is able to detect your commit and attach it to the relevant bug report.<br />
<br />
====Comment on milestones in forums and tracker====<br />
If you hit a major milestone, or want testers to try something, feel free to post about it in the relevant forum on Using Moodle. The more people you can attract to look and try out your code the better it will be, trust me.<br />
<br />
====Respond to bug reports====<br />
Of course you need to listen to your users (well, most of them :-)). Encourage people to file bugs, and fix them. If you need help setting up a project category in the Tracker contact support@moodle.com. This will ensure that all your bugs are easy to find and to track.<br />
<br />
===Minor Development=== <br />
<br />
For smaller modules, fixes, improvements and other issues.<br />
<br />
====Create a new issue in the tracker====<br />
<br />
You should definitely create an issue in the tracker to describe your development and to act as a focus point for all discussion. You can reference the bug number from forum discussions and in commit messages etc. This way everyone can easily find out exactly what they are talking about.<br />
<br />
====Attach a patch====<br />
<br />
If you have some code, please attach it to the tracker issue, or if it's on your own site then link to it from the tracker issue. Don't attach code in the Moodle forums ... it will "rot" quickly there and just clogs up moodle.org with useless old code.<br />
<br />
====Promote the patch====<br />
<br />
By all means draw attention to your work in the Moodle forums (mentioning the bug number) or email developers directly to help make them aware of it. You can also add developers as "watchers" to the tracker issue if you want, this means they will get email for every change on the issue.<br />
<br />
==See also==<br />
<br />
* [[Development:Finding your way into the Moodle code]]<br />
* [[Development:Working with the Community]]<br />
<br />
[[Category:Developer|Overview]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=35652Development:HTML editor 2.02008-05-06T09:40:20Z<p>Scyrma: </p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
* Support - Developed by an active community that will support it for a long time.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Highlighting (not text background color, with "set-on" operation--Word style)<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (possibly modified) content (see [http://wiki.moxiecode.com/examples/tinymce/installation_example_07.php this TinyMCE example of this])<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
* Submit drafts in the background, using ajax.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Plan of action ==<br />
* Get code in HEAD before 13 May 2008 so that work can be done there<br />
* Have the XHTML profile active by default in TinyMCE<br />
<br />
=== Change in formats ===<br />
<br />
This is actually more a related issue... There is a [[http://tracker.moodle.org/browse/MDL-4868 | long-standing bug]] about Markdown not being converted to HTML when using the HTML editor (after creating a post with Markdown). As the HTML editor becomes available on more browsers (and being more stable), most people will probably want to use it instead of Markdown, so we should solve this bug, by properly converting the Markdown text to HTML, the first time it is displayed in the editor.<br />
<br />
=== Plugins to write ===<br />
Some plugins will have to be written for each editor to make integration with Moodle possible. These should be as abstracted as possible, to make as much code as possible common between each<br />
* Language files: Moodle has a lot more languages than any editors, and some strings will be Moodle-specific. We need a way to make the editors use Moodle strings<br />
* File browser: the file browser (especially with the [[Repository API]]) will be Moodle specific<br />
* Emoticons (smileys): Moodle defines it's own list of emoticons, we need to make a plugin to use them<br />
* Equation editor: there is [[DragMath_equation_editor| ongoing work]] to get [http://www.dragmath.bham.ac.uk/ Dragmath] working in Moodle, making a common plugin could be a nice improvement<br />
* It may be possible to use Moodle's CSS files to define editors themes/skins, this needs investigation<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific customisations to the HTML editor]]<br />
<br />
Using Moodle General developer forum discussions:<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 What is the current position with the HTML editor?]<br />
* [http://moodle.org/mod/forum/discuss.php?d=96160 The most important decision on editor integration]<br />
<br />
[[Category:HTML editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=35645Development:HTML editor 2.02008-05-06T09:08:45Z<p>Scyrma: </p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
* Support - Developed by an active community that will support it for a long time.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Highlighting (not text background color, with "set-on" operation--Word style)<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (possibly modified) content (see [http://wiki.moxiecode.com/examples/tinymce/installation_example_07.php this TinyMCE example of this])<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
* Submit drafts in the background, using ajax.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Plan of action ==<br />
* Get code in HEAD before 13 May 2008 so that work can be done there<br />
* Have the XHTML profile active by default in TinyMCE<br />
<br />
=== Problems & Solutions ===<br />
<br />
<br />
=== Plugins to write ===<br />
Some plugins will have to be written for each editor to make integration with Moodle possible. These should be as abstracted as possible, to make as much code as possible common between each<br />
* Language files: Moodle has a lot more languages than any editors, and some strings will be Moodle-specific. We need a way to make the editors use Moodle strings<br />
* File browser: the file browser (especially with the [[Repository API]]) will be Moodle specific<br />
* Emoticons (smileys): Moodle defines it's own list of emoticons, we need to make a plugin to use them<br />
* Equation editor: there is [[DragMath_equation_editor| ongoing work]] to get [http://www.dragmath.bham.ac.uk/ Dragmath] working in Moodle, making a common plugin could be a nice improvement<br />
* It may be possible to use Moodle's CSS files to define editors themes/skins, this needs investigation<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific customisations to the HTML editor]]<br />
<br />
Using Moodle General developer forum discussions:<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 What is the current position with the HTML editor?]<br />
* [http://moodle.org/mod/forum/discuss.php?d=96160 The most important decision on editor integration]<br />
<br />
[[Category:HTML editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=35603Development:HTML editor 2.02008-05-05T08:26:08Z<p>Scyrma: /* Wishes */</p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
* Support - Developed by an active community that will support it for a long time.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Highlighting (not text background color, with "set-on" operation--Word style)<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (modified) content<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
* Submit drafts in the background, using ajax.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific customisations to the HTML editor]]<br />
<br />
Using Moodle General developer forum discussions:<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 What is the current position with the HTML editor?]<br />
* [http://moodle.org/mod/forum/discuss.php?d=96160 The most important decision on editor integration]<br />
<br />
[[Category:HTML editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=35138Development:HTML editor 2.02008-04-24T03:42:31Z<p>Scyrma: /* Requirements */</p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
* Support - Developed by an active community that will support it for a long time.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Highlighting (not text background color, with "set-on" operation--Word style)<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (modified) content<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific_customisations_to_the_HTML_editor]]<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 Using Moodle - General developer forum: TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 Using Moodle - General developer forum: XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 Using Moodle - General developer forum: What is the current position with the HTML editor?]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=admin/environment/php_extension/ctype&diff=35137admin/environment/php extension/ctype2008-04-24T02:41:48Z<p>Scyrma: </p>
<hr />
<div>The ctype extension is enabled by default in PHP since version 4.3.0. If it's not enabled on your server, either you have a very old version of php, or it was probably disabled at build time. You will need to either remove --disable-ctype from the build command, or add --enable-ctype. Read http://www.php.net/manual/en/ctype.installation.php for details.<br />
<br />
For details about Ctype features and history, you can read http://en.wikipedia.org/wiki/Ctype.h<br />
<br />
[[Category:Environment|php extension]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=34870Development:HTML editor 2.02008-04-16T06:21:06Z<p>Scyrma: /* Requirements */</p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes, cleaning up current code as much as possible<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (modified) content<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific_customisations_to_the_HTML_editor]]<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 Using Moodle - General developer forum: TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 Using Moodle - General developer forum: XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 Using Moodle - General developer forum: What is the current position with the HTML editor?]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=34869Development:HTML editor 2.02008-04-16T06:19:03Z<p>Scyrma: </p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
== What we want ==<br />
Ticket MDL-11113 discusses most issues.<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Image uploading<br />
* Mathematical formulas/equation editing<br />
* Possible to turn it on and off on demand (on the page) without losing (modified) content<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
=== Wishes ===<br />
* Make it possible to change to a different editor (provided someone comes up with the necessary code to "plug it" in Moodle)<br />
* Possible to run many instances on the same page (see MDL-11101 in tracker)<br />
* Fix [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10070&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC all the bugs] related to the HTML editor<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific_customisations_to_the_HTML_editor]]<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 Using Moodle - General developer forum: TinyMCE3 Integration]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 Using Moodle - General developer forum: XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 Using Moodle - General developer forum: What is the current position with the HTML editor?]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=34868Development:HTML editor 2.02008-04-16T05:44:32Z<p>Scyrma: /* Links to forum discussions, tracker, docs, etc. */</p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
<br />
== What we want ==<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Image uploading<br />
* Mathematical formulas editing<br />
* Possible to turn it on and off on demand (on the page) without losing (modified) content<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
Ticket MDL-11113 discusses most issues.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
<br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [[Development:Moodle-specific_customisations_to_the_HTML_editor]]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 Using Moodle - General developer forum: What is the current position with the HTML editor?]<br />
* [http://moodle.org/mod/forum/discuss.php?d=93475 Using Moodle - General developer forum: XINHA has started to support Opera and Safari]<br />
* [http://moodle.org/mod/forum/discuss.php?d=88382 Using Moodle - General developer forum: TinyMCE3 Integration]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=34867Development:HTML editor 2.02008-04-16T04:34:29Z<p>Scyrma: </p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
<br />
== What we want ==<br />
=== Requirements ===<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
<br />
=== Features ===<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Image uploading<br />
* Mathematical formulas editing<br />
* Possible to turn it on and off on demand (on the page) without losing (modified) content<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
Ticket MDL-11113 discusses most issues.<br />
<br />
== Possibilities and evaluation ==<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
<br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 Using Moodle: What is the current position with the HTML editor?]<br />
* [[Development:Moodle-specific_customisations_to_the_HTML_editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:HTML_editor_2.0&diff=34866Development:HTML editor 2.02008-04-16T04:33:17Z<p>Scyrma: </p>
<hr />
<div>This page details the specification of the HTML editor in Moodle 2.0.<br />
<br />
== What we want ==<br />
<br />
* Integration - With Moodle (smileys, different formats, etc.) with a minimum of changes<br />
* Compatibility - With web browsers (mostly FF, IE, Safari, Opera)<br />
* Standard - Outputs valid XHTML code<br />
* Accessibility - Is it 100% keyboard accessible? Is it usable in JAWS? Etc.<br />
* Configurability - Possibility to make it show different options and buttons according to the user, the context, etc.<br />
<br />
Some features that should be evaluated:<br />
* Handling of Word documents<br />
* HTML code direct editing<br />
* Image uploading<br />
* Mathematical formulas editing<br />
* Possible to turn it on and off on demand (on the page) without losing (modified) content<br />
* Right-to-left text input<br />
* Smileys (has to be possible to use the Moodle list of smileys)<br />
* Special characters<br />
* Tables<br />
* Themeable (possible to make a theme that fits with Moodle's)<br />
<br />
Ticket MDL-11113 discusses most issues.<br />
<br />
== Possibilities and evaluation ==<br />
<br />
* [http://en.wikipedia.org/wiki/Comparison_of_WYSIWYG_HTML_editors Comparison of WYSIWYG HTML editors on Wikipedia]<br />
* [http://tinymce.moxiecode.com/ TinyMCE]: [http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility Compatibility], [http://wiki.moxiecode.com/index.php/TinyMCE:Index Documentation], [http://tinymce.moxiecode.com/example_full.php?example=true Demo]<br />
* [http://www.fckeditor.net/ FCKeditor]: [http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Browsers_Compatibility Compatibility] [http://docs.fckeditor.net/ Documentation], [http://www.fckeditor.net/demo Demo]<br />
* [http://xinha.webfactional.com/ Xinha]: [http://xinha.webfactional.com/wiki/Documentation Documentation], [http://xinha.webfactional.com/wiki/Examples Demo]<br />
* [http://developer.yahoo.com/yui/editor/ Yahoo RTE]: [http://developer.yahoo.com/yui/docs/module_editor.html Documentation], [http://developer.yahoo.com/yui/examples/editor/index.html Demo], <br />
<br />
As of 16 April 2008, the preference goes to TinyMCE.<br />
<br />
== Links to forum discussions, tracker, docs, etc. ==<br />
* [http://tracker.moodle.org/browse/MDL-11113 MDL-11113 - Get a fully working HTML editor in Moodle]<br />
* [http://moodle.org/mod/forum/discuss.php?d=76912 Using Moodle: What is the current position with the HTML editor?]<br />
* [[Development:Moodle-specific_customisations_to_the_HTML_editor]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Setting_up_Eclipse&diff=34795Development:Setting up Eclipse2008-04-14T04:09:51Z<p>Scyrma: /* Checking out the Moodle code */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it create a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step.<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://phpeclipse.sourceforge.net/update/releases/; then click '''OK'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Back in the wizard, turn on just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site'''.<br />
Then click '''Finish'''.<br />
<br />
It goes off sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want. The ones you want (you may have to search the tree structure) are, '''PHPeclipse''' (from your newly created PHPEclipse Update Site) and all the '''Web Standard Tools (WST)''' (usually under Callisto Discovery Site --> Web and J2EE Development).<br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation build digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box. With '''*.html''' selected in the top box, select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Internet -> Proxy Settings'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
These are all hidden under the '''PHPeclipse Web Development''' bit of the tree.<br />
<br />
Under '''PHPeclipse Web Development -> Browser Preview Defaults''', turn off both checkboxes.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE.- When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments''' and '''Remove trailing spaces on editor save'''. It would be nice to turn on more of these options, but most of the rest don't work very well.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse Web Development -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===CVS Settings===<br />
<br />
These are all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''Team -> CVS -> SSH2 Connection Method''', you can set up a public/private key pair. If you do this, you won't have to keep typing your Sourceforge password when doing CVS operations. See http://sourceforge.net/docs/F02/ for the instructions on what people used to do when the CVS was at Sourceforge. However, If you follow the Sourceforge instructions now you will spend a good deal of time trying to add a public key to your sourceforge profile to no purpose; the key generated is for cvs.moodle.org, NOT, sourceforge, and you add it via the Update My Developer Information tab on the moodle developers page at http://moodle.org/mod/cvsadmin/view.php?id=7134. Once you have uploaded your public key you can then try to fgure out how to make Eclipse use this keyset. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...''', then click '''Next >'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-hightlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should fine that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project.... That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all the really important features. I sure you can learn everything else on your own. An you could always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right click on an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right click on an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags ... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
[[Category:Developer|Setting up Eclipse]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Weekly_Code_Review&diff=34360Development:Weekly Code Review2008-04-01T03:42:23Z<p>Scyrma: /* Test the fix */</p>
<hr />
<div>Moodle has a weekly process of code review in the stable branches to help improve the quality of stable packages and to help detect any regressions that may have occurred in stable code.<br />
<br />
Here is the process for testers and developers:<br />
<br />
==Every Tuesday==<br />
<br />
===Find bugs to test===<br />
<br />
All developers and testers should be looking at:<br />
<br />
Moodle 1.9 stable: [http://tracker.moodle.org/secure/IssueNavigator.jspa?mode=hide&requestId=10565 1.9.x Needs QA review]<br />
<br />
(Make sure you can see the QA Assigned column)<br />
<br />
Grab any bug that:<br />
<br />
* is from the last week<br />
* you did not fix<br />
* does not have a QA assignee yet <br />
<br />
and claim it by editing the bug to add your name as QA Assignee.<br />
<br />
<br />
===Test the fix===<br />
<br />
* Read the comments <br />
* Look at the patch attached to the tracker<br />
* Try the feature out to make sure it works as advertised<br />
* Post new comments (or talk on Moodle HQ) if you need clarification<br />
<br />
===If you find a problem===<br />
<br />
* Post a comment on the bug with details (preferably including patch!)<br />
* Reopen the bug<br />
* If it looks like the original developer isn't seeing it, reassign to Eloy Lafuente for triage.<br />
* If the fix is obvious and you have CVS access, fix it yourself.<br />
<br />
===Mark the fix as reviewed===<br />
<br />
* When you are satisfied the bug is correctly fixed, simply change the status from Resolved to Closed<br />
<br />
==Every Wednesday==<br />
<br />
* The download site will automatically tag the whole current stable codebase (eg MOODLE_19_WEEKLY) and then build download packages</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Repository_API&diff=34334Development:Repository API2008-03-31T09:09:09Z<p>Scyrma: /* Repository plugins */</p>
<hr />
<div>This page describes the specification for a future feature, currently being worked on for Moodle 2.0. This spec is STILL UNDER CONSTRUCTION.<br />
<br />
See MDL-13766 to track the status of the implementation.<br />
<br />
The page is open for everyone so everyone can help correct mistakes and help evolution of this document. However, if you have questions, problems or major changes to suggest please add them to the [[Development_talk:Repository_API|page comments]], or start a discussion in the [http://moodle.org/mod/forum/view.php?id=1807 Repositories forum]. We'll endeavour to merge all such suggestions into the main spec before we start development.<br />
<br />
==Objectives==<br />
<br />
# Allow files to be added directly into Moodle (as we do now)<br />
# Allow all Moodle users to easily bring content into Moodle from external repositories<br />
# Allow content to be used in multiple Moodle contexts securely and simply via capabilities<br />
# Consistency and simplicity for ALL file handling<br />
<br />
==Overview==<br />
<br />
The Repository API is a core set of interfaces that all Moodle code will use to:<br />
# copy files from external servers<br />
# store files within Moodle<br />
# display files to Moodle users<br />
<br />
It's important to remember that a repository will generally be treated as READ-ONLY. Management of the files will normally be done through the native interface provided by the repository. Publishing of Moodle content TO a repository is handled by the [[Development:Portfolio API|Portfolio API]].<br />
<br />
==Use cases==<br />
<br />
===Teacher adding an external file as a new resource===<br />
<br />
# Teacher wants to add a new resource to a course <br />
# Teacher clicks the "Choose a resource" button<br />
# Teacher is able to choose from a list of configured repositories (this step will be skipped if there's only one).<br />
# Teacher is presented with a simple file picker to choose a file<br />
# Teacher chooses a file<br />
# File is COPIED into Moodle and included in the course.<br />
# File is marked as owned by that user<br />
# Access controls are automatically added for that file so that only those with privileges to see that course can see that file (the owner can change those permissions anytime)<br />
<br />
<br />
===Student submitting an assignment===<br />
# Student needs to submit an assignment and presses the "Choose files" button<br />
# Student sees a "file picker" where they can see files listed on any of several configured repositories<br />
# Student chooses MySpace from the list<br />
# Student is prompted to enter MySpace username/password (a checkbox could be there to "remember this for next time" but for security perhaps not)<br />
# Student sees their files in MySpace and chooses one or more<br />
# Files are copied from MySpace to Moodle <br />
# Assignment module gives the files permissions so that only the Student and assignment graders can see the file (other students would not have permission).<br />
<br />
<br />
===Student attaching an image to a forum===<br />
# Student needs to attach an image and presses the "Choose files" button in the posting screen<br />
# Student sees a "file picker" where they can see files listed on any of several configured repositories<br />
# Student chooses Mahara from the list<br />
# Student is prompted to enter MySpace username/password (a checkbox could be there to "remember this for next time" but for security perhaps not)<br />
# Student sees their files in Mahara and chooses one image<br />
# Image is copied to Moodle <br />
# Image file is attached to forum post by Forum module (by reference)<br />
# Forum module gives permissions so that anyone who can read that forum can see that file<br />
<br />
===Student attaching the same image in another forum===<br />
<br />
# Student needs to submit an assignment and presses the "Choose files" button<br />
# Student sees a "file picker" where they can see files listed on any of several configured repositories<br />
# Student chooses Mahara from the list<br />
# Student is prompted to enter MySpace username/password (a checkbox could be there to "remember this for next time" but for security perhaps not)<br />
# Student sees their files in Mahara and chooses one image<br />
# Moodle detects that the image already exists in Moodle so it it not copied again (or it's just updated)<br />
# Image file is attached to forum post by Forum module (by reference)<br />
# Forum module adds some permissions so that anyone who can read the current forum can also see that file<br />
<br />
===User managing their files===<br />
# User goes to the "Files" area (similar to current Moodle, but for all users)<br />
# User sees two tabs<br />
# First tab shows listing of current files belonging to self, with buttons to manage them, including buttons to modify the permissions (eg "Allow all people in Course X to see this"). You can also see what repository it came from, including the foreign path, and choose to "update from repository" and get a new copy of the file.<br />
# Second tab shows listing of files belonging to others that you are able to see.<br />
<br />
Please add more use cases in this same format<br />
<br />
<br />
==General Architecture==<br />
<br />
All file-handling areas in Moodle (eg adding a new resource, adding attachments to a forum post, uploading assignments) will be rewritten to talk to the standard API class methods in a standard way.<br />
<br />
Each repository plugin (a standard Moodle plugin stored under /repository/xxx) will subclass the standard API and override methods specific to that repository.<br />
<br />
As is usual in Moodle, there will be admin settings to disable/enable certain repository plugins as standard, as well as user settings so that users can add their own personal repositories to the standard list (eg [http://briefcase.yahoo.com Yahoo Briefcase] or [http://docs.google.com Google Docs]) and to select their default repository.<br />
<br />
Once a repository has been used the file will usually be copied into Moodle there and then. However there will also be options to:<br />
* only return the URL to the file if it's desired to keep it external (but this does present security and integrity risks), or<br />
* refresh the local file copy regularly and automatically<br />
<br />
All files in Moodle will be listed in a table (see below) allowing us to store various metadata about each file. The file contents will not be the database (though we could easily offer that option if we want to), they will be on disk with a name related to the id rather than the "human" name (this avoids a lot of OS Unicode problems).<br />
<br />
The current "course file manager" will be replaced by a personal file manager, which basically is a user's view of the internal Moodle repository, showing the files that are available to you in that context (which may include files from other people, repositories etc) and a nice browse/search interface.<br />
<br />
Finally, normal Moodle modules will have easy functions it can use to add/remove permissions to particular files, according to module rules. For example, the assignment plugin may, after allowing a student to select a file to be submitted, add permissions so that people who have grade permissions in that assignment can read it.<br />
<br />
All files will be served via a single control script in Moodle, located at $CFG->fileroot. This could be the same as $CFG->wwwroot by default, but will be recommended (for security and avoiding XSS) that Moodle admins set up a second DNS name pointing to this script eg the main site could be at http://moodle.domain.edu but files would be served via http://moodlefiles.domain.edu/file.php. (We'll have to set session cookies on both domains and keep them in sync somehow).<br />
<br />
The file.php will serve files using slasharguments almost as now. We just need to replace the courseid with a fileid: file.php/fileid/dir/dir/file.jpg (where dir/dir/file.jpg is the virtual path in Moodle).<br />
<br />
<br />
==Repository requirements==<br />
<br />
From the Moodle point of view, each repository is just a hierarchy of nodes.<br />
<br />
The repository MUST provide:<br />
# A URL to download each node (eg file).<br />
# A list of the nodes (eg files and directories) under a given node (eg directory). This allows Moodle to construct a standard browse interface (much like a standard OS file picker). However some repository plugins may choose to completely override the repository_browse() method and implement their own interface, that's OK, as long as they end up with a URL for the file.<br />
<br />
The repository can OPTIONALLY:<br />
# Require some authentication credentials <br />
# Provide more metadata about each node (mime type, size, dates, related files, dublin core stuff, etc)<br />
# Describe a search facility (so that Moodle can construct a search form)<br />
# Provide copyright and usage rules (or just information about the rules)<br />
<br />
==Repository plugins==<br />
<br />
Some plugins I'd like to see developed for the first version are:<br />
* local - very similar to the current course-based file manager, except user-based<br />
* moodle - an interface to another Moodle site, accessed over a secure mnet connection<br />
* jsr170 - an interface that can talk to anything that supports jsr170 (eg [http://www.alfresco.com/ Alfresco])<br />
* oki - an OKI emulator allowing us to access things with OKI interfaces,like [http://www.fedora.info/ Fedora]<br />
* briefcase - an interface to [http://briefcase.yahoo.com/ Yahoo Briefcase]<br />
* myspace - an interface to MySpace files (perhaps via [http://www.programmableweb.com/api/myspace this MySpace API])<br />
* googledocs - an interface to [http://docs.google.com Google Docs]<br />
* skydrive - an interface to Microsoft's [http://skydrive.live.com/ SkyDrive] files<br />
* facebook - an interface to Facebook files<br />
* merlot - an interface to the learning materials in [http://www.merlot.org/merlot/materials.htm Merlot.org]<br />
* flickr - an interface to [http://flickr.com flickr]<br />
* youtube - an interface to [http://youtube.com YouTube]<br />
* mahara - an interface to a Mahara installation<br />
<br />
==Local Files==<br />
<br />
In general, all external files will be copied locally and stored in Moodle. This section describes the storage of the files and how we define ACLs (access control lists) for them. All existing files in the Moodle dataroot course areas will be moved into this new system during the upgrade.<br />
<br />
The files will not be stored as they have been in the past. The new file system is "flat" with each file stored as an id. The name and path are stored in tables. To avoid running out of nodes we'll use a hash-like structure like the users directory does, ie:<br />
<br />
dataroot <br />
/files<br />
/0<br />
/10000<br />
/20000<br />
/30000<br />
/3076.jpg<br />
<br />
<br />
==Tables==<br />
<br />
=== repository ===<br />
<br />
This table contains one entry for every configured external repository instance.<br />
<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
|'''Field''' <br />
|'''Type''' <br />
|'''Default''' <br />
|'''Info''' <br />
<br />
|-<br />
|'''id''' <br />
|int(10) <br />
|<br />
|autoincrementing <br />
<br />
|-<br />
|repositoryname<br />
|varchar<br />
|<br />
|A custom name for this reopsitory (non-unique)<br />
<br />
|-<br />
|'''repositorytype''' <br />
|varchar<br />
| <br />
|The name of the plugin being used<br />
<br />
|-<br />
|'''userid''' <br />
|int(10)<br />
| <br />
|The person who created this repository instance<br />
<br />
|-<br />
|'''contextid''' <br />
|int(10)<br />
| <br />
|The context that this repository is available to ( = system context for site-wide ones)<br />
<br />
|-<br />
|username<br />
|varchar<br />
| <br />
|username to log in with, if required<br />
<br />
|-<br />
|password<br />
|varchar<br />
| <br />
|password to log in with, if required<br />
<br />
|-<br />
|option1<br />
|varchar<br />
| <br />
|Other information useful to the plugin<br />
<br />
|-<br />
|option2<br />
|varchar<br />
| <br />
|Other information useful to the plugin<br />
<br />
|-<br />
|option3<br />
|varchar<br />
| <br />
|Other information useful to the plugin<br />
<br />
|-<br />
|option4<br />
|varchar<br />
| <br />
|Other information useful to the plugin<br />
<br />
|-<br />
|option5<br />
|varchar<br />
| <br />
|Other information useful to the plugin<br />
<br />
|-<br />
|timecreated<br />
|int(10)<br />
|<br />
|The time this repository was created<br />
<br />
|-<br />
|timemodified<br />
|int(10)<br />
|<br />
|The last time the repository was modified<br />
|}<br />
<br />
<br />
=== file ===<br />
<br />
This table contains one entry for every file. Enough information is kept here so that the file can be fully identified and retrieved again if necessary.<br />
<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
|'''Field''' <br />
|'''Type''' <br />
|'''Default''' <br />
|'''Info''' <br />
<br />
|-<br />
|'''id''' <br />
|int(10) <br />
|<br />
|autoincrementing <br />
<br />
|-<br />
|'''userid''' <br />
|int(10) <br />
| <br />
|The owner of the file (person who created this entry)<br />
<br />
|-<br />
|filename<br />
|varchar<br />
|<br />
|The full Unicode name of this file<br />
<br />
|-<br />
|'''repositoryid'''<br />
|int(10)<br />
|<br />
|The repository instance this is associated with<br />
<br />
|-<br />
|updates<br />
|int(10)<br />
|<br />
|Specifies the update schedule (0 = none, 1 = on demand, other = some period in seconds)<br />
<br />
|-<br />
|cachetime<br />
|int(10)<br />
|<br />
|Specifies how long this file can be cached by browsers<br />
<br />
<br />
|-<br />
|moodlepath<br />
|text<br />
|<br />
|The virtual path to the file locally (so we can still have apparent subdirectories etc)<br />
<br />
<br />
|-<br />
|repositorypath<br />
|text<br />
|<br />
|The full path to the original file on the repository<br />
<br />
|-<br />
|timeimportfirst<br />
|int(10)<br />
|<br />
|The first time this file was imported into Moodle<br />
<br />
|-<br />
|timeimportlast<br />
|int(10)<br />
|<br />
|The most recent time that this file was imported into Moodle<br />
<br />
|-<br />
|timecreated<br />
|int(10)<br />
|<br />
|The time this file was created (if known), otherwise same as time imported<br />
<br />
|-<br />
|timemodified<br />
|int(10)<br />
|<br />
|The last time the file was modified<br />
<br />
|-<br />
|timeaccessed<br />
|int(10)<br />
|<br />
|The last time this file was accessed for any reason<br />
|}<br />
<br />
<br />
=== file_instances ===<br />
<br />
This table contains one entry for every "place" a file is published to. For example, one file might appear in an assignment but also in a forum attachment, so there would be two entries here.<br />
<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
|'''Field''' <br />
|'''Type''' <br />
|'''Default''' <br />
|'''Info''' <br />
<br />
|-<br />
|'''id''' <br />
|int(10) <br />
|<br />
|autoincrementing <br />
<br />
|-<br />
|'''fileid''' <br />
|int(10) <br />
| <br />
|The file we are defining access for<br />
<br />
|-<br />
|instancetype<br />
|varchar<br />
|<br />
|This defines the table in Moodle that this instance is associated with (eg 'forum_posts', 'assignment_submissions' etc<br />
<br />
|-<br />
|'''instanceid'''<br />
|int(10)<br />
|<br />
|The id in the foreign table (of name instancetype) that this instance is associated with<br />
|}<br />
<br />
=== file_access ===<br />
<br />
This table describes the ACL for each file, so that checks can easily be made on whether someone can see this file or not. Note there can be multiple entries per file. Users can ALWAYS see their own files, so there are no entries here for that.<br />
<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
|'''Field''' <br />
|'''Type''' <br />
|'''Default''' <br />
|'''Info''' <br />
<br />
|-<br />
|'''id''' <br />
|int(10) <br />
|<br />
|autoincrementing <br />
<br />
|-<br />
|'''fileid''' <br />
|int(10) <br />
| <br />
|The file we are defining access for<br />
<br />
|-<br />
|'''contextid'''<br />
|int(10)<br />
|<br />
|The context where this file is being published<br />
<br />
|-<br />
|'''capability'''<br />
|text <br />
|<br />
|The capability that is required to see this file<br />
|}<br />
<br />
<br />
==Class methods==<br />
<br />
===Repository class===<br />
<br />
This class implements the interface to a particular repository, for browsing, selecting and updating files.<br />
<br />
====get_file($path)====<br />
<br />
====get_listing($parent='/', $search='''''''')====<br />
<br />
====cron()====<br />
<br />
====etc====<br />
<br />
===File class===<br />
<br />
This class implements the display and management of files from local storage, with full access checking. Some of the functions are for single files, while some are optimised for bulk display and searching (eg in the personal files interface).<br />
<br />
====display_file()====<br />
<br />
sort of like file.php is now, except smarter<br />
<br />
====set_access($fileid, $accessstuff)====<br />
<br />
Grant some access to people to a file<br />
<br />
====has_access($fileid, $userid=NULL)====<br />
<br />
Returns true or false depending on access to a file<br />
<br />
==Areas in Moodle that need re-writing==</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:contrib&diff=33994Development:contrib2008-03-26T03:37:11Z<p>Scyrma: /* Browsing CONTRB */</p>
<hr />
<div>CONTRIB is an area in the Moodle CVS repository where developers can work on custom patches and plugins (modules, blocks, themes, etc.) and share them with other people. It is less tightly restricted that the code for Moodle Core in CVS which contains the official Moodle releases. The advantages of using CONTRIB are that it is a standard place where people know to look, so it facilitates sharing your code and allows developers to evaluate and make suggestions. In addition, download packages are automatically build for all plugins in CONTRIB allowing easy access to the latest versions of the contributed code.<br />
<br />
==Browsing CONTRIB==<br />
<br />
You can browse the CONTRIB area of CVS here: http://cvs.moodle.org/contrib/<br />
<br />
Most of the interesting code is in the plugins folder. It is organised like the main Moodle codebase, so, for example, if you are looking for an activity module called '''gallery''', look in [http://moodle.cvs.sourceforge.net/moodle/contrib/plugins/mod/gallery/ plugins/mod/gallery].<br />
<br />
A more user-friendly list of the available plugins is available in the [http://moodle.org/mod/data/view.php?id=6009 Modules and Plugins database] on Moodle.org and documentation for contributed code is maintained via the [https://docs.moodle.org/en/Category:Contributed_code Contributed Code Category].<br />
<br />
==Getting write access to CONTRIB==<br />
<br />
If you are a developer working on Moodle patches or plugins, please read [https://docs.moodle.org/en/Development:Guidelines_for_contributed_code Guidelines for Contributed Code] to learn how you can share your code and request write access to CONTRIB. <br />
<br />
For more information on how to use CVS once you have write access, read:<br />
* [[Development:CVS_for_developers|CVS for developers]]<br />
<br />
==Auto-packaging of CONTRIB plugins and patches==<br />
<br />
In the Modules and plugins database, you will see that a lot of the plugins have download URLs like http://download.moodle.org/plugins/question/type/TEMPLATE.zip. This is because, every night, downloadable copies of every plugin in CONTRIB are automatically built and made available. The download URL is based on the path in the CONTRIB repository. The code for TEMPLATE.zip is in the plugins/question/type/TEMPLATE folder.<br />
<br />
==Branches in CONTRIB==<br />
<br />
There are branches in CONTRIB CVS for each stable branch in the core Moodle module. The auto-packaging system understands them. This allows for different versions of the patch or plugin, if necessary, to work with different versions of Moodle.<br />
<br />
[[Category:Developer|CVS for developers]]<br />
[[Category:Developer tools]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Capabilities/moodle/blog:manageofficialtags&diff=33195Capabilities/moodle/blog:manageofficialtags2008-03-05T01:48:46Z<p>Scyrma: </p>
<hr />
<div>*This allows a user to create and delete official blog tags (system context only)<br />
*Note: this capability has been deprecated in Moodle 1.9.<br />
<br />
[[Category:Capabilities|Blog]]<br />
[[Category:Blog]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Capabilities/moodle/blog:managepersonaltags&diff=33194Capabilities/moodle/blog:managepersonaltags2008-03-05T01:48:22Z<p>Scyrma: </p>
<hr />
<div>*This allows a user to create and delete user defined/personal blog tags that others may use (system context only)<br />
*Note: Users are always allowed to add their own user personal tags<br />
*Note: this capability has been deprecated in Moodle 1.9.<br />
<br />
==See also==<br />
<br />
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=56088 User defined tags are shared?] forum discussion <br />
<br />
[[Category:Capabilities|Blog]]<br />
[[Category:Blog]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Blog_tags_block&diff=33193Blog tags block2008-03-05T01:47:00Z<p>Scyrma: </p>
<hr />
<div>A '''Blog Tags''' block displays a list of blogs where font size visually indicates each blog's use. The more frequently used blogs appear in a larger font size and least used in smaller fonts. This format is sometimes called a "tag cloud".<br />
<br />
==Adding a Blog Tags block to a course page==<br />
<br />
#Click the "Turn editing on" button.<br />
#Select Blog Tags from the Add blocks menu.<br />
#If appropriate, move the Blog Tags block up and/or left, using the arrow icons under the block title.<br />
<br />
==Block configuration==<br />
<br />
To configure a Blog Tags block, click on the edit icon in the block header.<br />
*Blog tags block title - You can change the title of the block.<br />
*Number of tags display - Here you specify how many tags you want to display in the block. <br />
*Display tags used within this many days - You can specify here how recent the tags that you want to appear are. For example, if it is 90 days then only tags that have been used in the last 90 days will be used.<br />
*Sort the tag display by - Here you can specify in what order you want the tags to appear. You can choose to sort the tag according to tag name. So the tags will be sorted in alphabetical order. Or you can choose to sort them according to last date used. So the most recent tag would appear first.<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=65907 Blogging tags don't show in Blog Tags block] forum discussion<br />
<br />
[[Category:Blog]]<br />
[[Category:Block]]<br />
[[Category:Tags]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Outcomes&diff=32853Outcomes2008-02-26T07:37:55Z<p>Scyrma: /* Import/export of outcomes */</p>
<hr />
<div>{{Grades}}Outcomes are specific descriptions of what a student is expected to be able to do or understand at the completion of an activity or course. An activity might have more than one outcome, and each may have a grade against it (usually on a scale). Other terms for Outcomes are ''Competencies'' and ''Goals''.<br />
<br />
<br />
==Enabling outcomes==<br />
<br />
To use outcomes, the feature must be enabled by an administrator by checking the enableoutcomes box in ''Administration > Grades > [[General grade settings|Grade settings]]''.<br />
<br />
==Using outcomes==<br />
<br />
# Choose or define some outcomes for your course (see below).<br />
# For each activity, choose which of these outcomes apply. <br />
# When grading that activity, grade each student using the Outcome scales. Note: You can also edit the grades in the [[Grader report]] (useful for modules that don't feature inbuilt grading).<br />
# Use the outcomes as part of the assessment for students, or look at the [[Outcomes report]] for some useful feedback on how students in the class in general are performing.<br />
<br />
==Outcomes used in course==<br />
<br />
Outcomes may be set at site and/or course level. To choose outcomes for use in your course:<br />
<br />
# Follow the outcomes link in the course administration block. (Alternatively, select outcomes from the gradebook view dropdown menu.)<br />
# Select standard outcomes from the right list, and use the left-facing arrow button to add them to the left list. Multiple outcomes may be selected by holding down the Apple or Ctrl key whilst clicking on the individual outcomes.<br />
<br />
==Adding course-level outcomes==<br />
<br />
[[Image:Adding an outcome.png|thumb|Adding an outcome]]To add a course-level outcome:<br />
<br />
# Follow the outcomes link in the course administration block. (Alternatively, select outcomes from the gradebook view dropdown menu.)<br />
# Click the "Edit outcomes" tab in the middle of the page.<br />
# Click the "Add a new outcome" button.<br />
# Complete the form then click the "Save changes" button. <br />
<br />
==Adding standard outcomes==<br />
<br />
To add standard outcomes, which are available site-wide:<br />
<br />
# Login as an administrator.<br />
# Access ''Site administration > Grades > Outcomes''.<br />
# Click the "Add a new outcome" button.<br />
# Complete the form then click the "Save changes" button. <br />
<br />
==Import/export of outcomes==<br />
<br />
Outcomes (and their associated scales) can be exported by clicking the "Export all outcomes" button. This will send a file (in .csv format) that can be read by Excel, OpenOffice.org or by any text editor.<br />
<br />
It's possible to import outcomes (and associated scales) by submitting a csv file. The format of the file should be copied from the file obtained by the export function. Note that while importing: <br />
*Existing outcomes and scale will be used if available (no overwriting is done by the script)<br />
*The script will stop if it detects that the file contains invalid data.<br />
<br />
==See also==<br />
<br />
*[[Development:Outcomes]]<br />
*[http://www.youtube.com/watch?v=PmkEGfvjj9U Video on how to use outcomes in Moodle]<br />
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=78074 Outcomes in 1.9] forum discussion<br />
<br />
[[fr:Objectifs]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Outcomes&diff=32034Outcomes2008-02-11T08:08:57Z<p>Scyrma: </p>
<hr />
<div>{{Grades}}Location: ''Administration > Grades > Outcomes''<br />
<br />
<br />
Outcomes are new in 1.9. You can develop a list of expected outcomes (competencies) and connect these to courses and activities. You can even grade against multiple outcomes at once (i.e. Rubrics).<br />
<br />
To use outcomes, the feature must be enabled via ''Administration > Grades > Outcomes''.<br />
<br />
Basically the steps are like this:<br />
# Choose or define some outcomes for the course ''Administration > Grades > Outcomes''<br />
# For each activity, choose which of these outcomes apply <br />
# When grading that activity, grade each student using the Outcome scales<br />
# You can also edit the grades in the grader report (useful for modules that don't feature inbuilt grading)<br />
# Use the outcomes as part of the assessment for students, or look at the Outcomes report for some useful feedback on how the class in general are performing.<br />
<br />
Outcomes (and their associated scales) can be exported, by selecting the checkbox under the "Export" column, and clicking the "Export selected outcomes button. This will send a file (in .csv format) that can be read by Excel, OpenOffice.org or by any text editor.<br />
<br />
It's possible to import outcomes (and associated scales) by submitting a csv file. The format of the file should be copied from the file obtained by the export function. Note that while importing : <br />
*existing outcomes and scale will be used if available (no overwriting is done by the script);<br />
*the script will stop if it detects that the file contains invalid data.<br />
<br />
<br />
==See also==<br />
<br />
*[[Development:Outcomes]]<br />
*[http://www.youtube.com/watch?v=PmkEGfvjj9U Video on how to use outcomes in Moodle]<br />
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=78074 Outcomes in 1.9] forum discussion<br />
<br />
[[fr:Objectifs]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Development:Modules&diff=30446Development:Modules2007-12-20T06:34:15Z<p>Scyrma: /* See also */</p>
<hr />
<div>'''Activity modules''' reside in the 'mod' directory. Each module is in a separate subdirectory and consists of the following mandatory elements (plus extra scripts unique to each module):<br />
<br />
* ''mod.html'' - a form to set up or update an instance of this module<br />
* ''version.php'' - defines some meta-info and provides upgrading code<br />
* ''icon.gif'' - a 16x16 icon for the module<br />
* ''db/'' - SQL dumps of all the required db tables and data (for each database type)<br />
* ''index.php'' - a page to list all instances in a course<br />
* ''view.php'' - a page to view a particular instance<br />
* ''lib.php'' - any/all functions defined by the module should be in here. If the modulename is called widget, then the required functions include:<br />
:* widget_install() - will be called during the installation of the module<br />
:* widget_add_instance() - code to add a new instance of widget<br />
:* widget_update_instance() - code to update an existing instance<br />
:* widget_delete_instance() - code to delete an instance<br />
:* widget_user_outline() - given an instance, return a summary of a user's contribution<br />
:* widget_user_complete() - given an instance, print details of a user's contribution<br />
:* Other functions available but not required are:<br />
:** widget_delete_course() - code to clean up anything that would be leftover after all instances are deleted<br />
:** widget_process_options() - code to pre-process the form data from module settings<br />
:** [[Development:Implementing Reset course functionality in a module|widget_reset_course_form() and widget_delete_userdata()]] - used to implement [[Reset course]] feature.<br />
:* To avoid possible conflict, any module functions should be named starting with widget_ and any constants you define should start with WIDGET_<br />
* ''config.html'' - (optional) a form to set up or update global settings of this module<br />
* ''lang/en_utf8/resource_widget.php'' - (optional) Lastly, each module will have some language files that contain strings for that module.<br />
<br />
IMPORTANT: When creating a new module, the new name of the module must not contain numbers or other special characters! <br />
<br />
You should also make sure that your activity module provides appropriate support for groups and metacourses. <br />
<br />
==See also==<br />
<br />
* Tracker issue [http://tracker.moodle.org/browse/CONTRIB-52 CONTRIB-52 Improvements to make NEWMODULE really useful] - including download link for new module template supporting roles, formslib etc. (unfinished) <br />
* http://download.moodle.org/plugins16/mod/NEWMODULE.zip - new module template for versions of Moodle prior to 1.7. Please follow the README instructions inside the zip.<br />
* Using Moodle [http://moodle.org/course/view.php?id=5 Activity modules] forum<br />
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=66165 A new resource type: where do I put the language strings?] forum discussion<br />
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=65986 New Module Template Code for Moodle 1.7] forum discussion<br />
<br />
[[Category:Developer|Modules]]<br />
[[Category:Modules]]<br />
<br />
[[es:Módulos de actividades (desarrollador)]]<br />
[[fr:Modules (développeur)]]<br />
[[ja:モジュール (開発者)]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Moodle_version_history&diff=30161Moodle version history2007-12-12T05:04:52Z<p>Scyrma: /* Moodle 1.9 */</p>
<hr />
<div>==Release History==<br />
<br />
See [[Release_Notes|Release Notes]] for more details.<br />
<br />
==Moodle 1.0==<br />
*Moodle 1.0 - 20 August 2002<br />
*Moodle 1.0.1 - 26 August 2002<br />
*Moodle 1.0.2 - 2 September 2002<br />
*Moodle 1.0.3 - 5 September 2002<br />
*Moodle 1.0.4 - 10 September 2002<br />
*Moodle 1.0.5 - 27 September 2002<br />
*Moodle 1.0.6 - 26 October 2002<br />
:: 1.0.6.1 - 6 Nov<br />
:: 1.0.6.2 - 11 Nov<br />
:: 1.0.6.3 - 14 Nov<br />
:: 1.0.6.4 - 25 Nov<br />
*Moodle 1.0.7 - 9 December 2002<br />
*Moodle 1.0.8 - 7 January 2003<br />
*Moodle 1.0.9 - 30 May 2003<br />
<br />
==Moodle 1.1==<br />
*Moodle 1.1 - 29 August 2003<br />
*Moodle 1.1.1 - 11 September 2003<br />
<br />
==Moodle 1.2==<br />
*Moodle 1.2 - 20 March 2004<br />
*Moodle 1.2.1 - 25 March 2004<br />
<br />
==Moodle 1.3==<br />
*Moodle 1.3 - 25 May 2004<br />
*Moodle 1.3.1 - 4 June 2004<br />
*Moodle 1.3.2 - 9 July 2004<br />
*Moodle 1.3.3 - 16 July 2004<br />
*Moodle 1.3.4 - 11 August 2004<br />
<br />
==Moodle 1.4==<br />
*Moodle 1.4 - 31 August 2004<br />
*Moodle 1.4.1 - 12 September 2004<br />
*Moodle 1.4.2 - 5 November 2004<br />
*Moodle 1.4.3 - 21 December 2004<br />
*Moodle 1.4.4 - 7 March 2005 <br />
*Moodle 1.4.5 - 7 May 2005<br />
<br />
==Moodle 1.5==<br />
*Moodle 1.5 - 5 June 2005<br />
*Moodle 1.5.1 - 8 July 2005<br />
*Moodle 1.5.2 - 16 July 2005<br />
*Moodle 1.5.3 - 11 November 2005<br />
*Moodle 1.5.4 - 21 May 2006<br />
<br />
==Moodle 1.6==<br />
*Moodle 1.6 - 20 June 2006<br />
*Moodle 1.6.1 - 20 July 2006<br />
*Moodle 1.6.2 - 12 September 2006<br />
*Moodle 1.6.3 - 10 October 2006<br />
*Moodle 1.6.4 - 17 January 2007<br />
*Moodle 1.6.5 - 30 March 2007<br />
<br />
==Moodle 1.7==<br />
*Moodle 1.7 - 7 November 2006<br />
*Moodle 1.7.1 - 17 January 2007<br />
*Moodle 1.7.2 - 30 March 2007<br />
*Moodle 1.7.3 - 11 October 2007<br />
<br />
==Moodle 1.8==<br />
*Moodle 1.8 - 30 March 2007<br />
*Moodle 1.8.1 - 14 June 2007<br />
*Moodle 1.8.2 - 8 July 2007<br />
*Moodle 1.8.3 - 11 October 2007<br />
<br />
==Moodle 1.9==<br />
*Moodle 1.9 beta 2 - 11 October 2007<br />
*Moodle 1.9 beta 3 - 6 December 2007<br />
<br />
[[Category:Administrator]]<br />
[[Category:Developer]]<br />
<br />
[[fr:Historique des versions]]<br />
[[es:Historia de las versiones]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=Participants&diff=29508Participants2007-11-29T04:20:17Z<p>Scyrma: </p>
<hr />
<div>{{Moodle 1.6}}<br />
Participants are the [[Teachers|teachers]] and [[Students|students]] who are part of a course. The list of participants can be seen by using the Participant icon link in the [[People block]].<br />
<br />
* Users inactive for more than a particular period of time may be listed.<br />
* Users may be selected then a message sent to them all or their enrolment period extended.<br />
<br />
==See also==<br />
*[[Users]] can be participants<br />
*[[Messaging|Messages]]<br />
*The ''Enrolment duration'' in the [[Settings|course settings]], which unenrols students after the specified time has elapsed.<br />
<br />
[[Category:Teacher]]<br />
[[fr:Participants]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=message&diff=29384message2007-11-27T01:46:05Z<p>Scyrma: </p>
<hr />
<div>#redirect [[Messaging]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=message&diff=29383message2007-11-27T01:45:28Z<p>Scyrma: </p>
<hr />
<div></div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=message/index&diff=29382message/index2007-11-27T01:44:45Z<p>Scyrma: </p>
<hr />
<div>#redirect [[Messaging]]</div>Scyrmahttps://docs.moodle.org/21/en/index.php?title=message&diff=29381message2007-11-27T01:43:52Z<p>Scyrma: </p>
<hr />
<div>#redirect [[Messaging]]</div>Scyrma