MoodleDocs - User contributions [en]

Creole format

2010-09-09T09:11:18Z

Pigui: New page: {{Wiki}}{{Moodle 2.0}} TODO: Write Creole format help Category:Wiki Category:Moodle 2.0

{{Wiki}}{{Moodle 2.0}}

TODO: Write Creole format help

[[Category:Wiki]]
[[Category:Moodle 2.0]]

Step by Step Installation on a Mac OS X 10.5 Server

2010-05-04T10:12:11Z

Pigui: /* How to set up SSL/https in MAMP for a development/test environment */

==Overview==
This guide shows all steps for the installation of Moodle on a [http://www.apple.com/server/macosx Mac OS X 10.5 Server]. This server is a commercial product.

This installation guide can't be useful for an installation on MAMP or XAMPP. If you are looking for an easy way to install Moodle on your local machine please use [[Complete Install Packages for Mac OS X | Complete install packages for Mac OS X 10.4/10.5]] that can be downloaded from http://download.moodle.org/macosx/ ... but if you are planning to set up a Moodle internet server on a Mac then you should think about some more security as the ever local package could give.

Please feel free to add your ideas and wishes to the discussion page for this article. You may also write a complete chapter if you tried the facts yourself on your own Mac Server. I am most interested in the "user administration via LDAP" and I hope to get enough ideas how to get all Mac users into the Moodle user list automaticly.

==System requirements==

+ Apple Computer
+ Mac mini, Mac Pro or Xserve
+ Processor: Intel Core 2 Duo
+ RAM: 2 GB or better
+ Hard Disk: 500 MB free
+ System Software: Mac OS X 10.5 Server

==Install PHP 5.3.0 and the GD Library on the Mac OS X 10.5 Server==

<div style="background-color: yellow; padding: 5px;"><b>Note:</b> <br />If you want to install Moodle 1.8.x on the server you need to get the Entropy PHP-5.2.9-7.pkg for the following steps. Moodle 1.8.9 does not run with PHP 5.3.0 in this moment. All the other things should work in the same way for all Moodle versions.</div>

The Mac OS X Server 10.5.6 Leopard comes with PHP 5.2.6 ... this is correct for Moodle 1.9.x. But you have to add the missing GD Library support to get Moodle running on your server. For Moodle 2.0 the server needs PHP 5.2.8 (or better) and some more PHP extensions ... in this case you must get a better PHP version. These instructions are helpful in both cases.

To see which PHP version and extensions are installed on your server you should edit the file ''/Library/WebServer/Documents/info.php''. You must activate the function call phpinfo() by deleting the both slashes // at the start of the function line. After saving the file you can get all PHP informations in your browser. Please look at http://your-server-address/info.php ... you will not find any GD library support ... bad thing for Moodle!!

<?php
// You can use Server Admin to enable the Apache PHP module; it's disabled by default.
// You can uncomment the phpinfo() directive below to provide a default PHP info page
// but note that this displays information about your host's configuration.
phpinfo();
?>

The easiest way to get the GD library support and to get a better PHP version would be the installation of the complete PHP 5.3.0 package from http://www.entropy.ch/software/macosx/php/. Marc Liyanage precompiled this package to use it on Mac clients and Mac servers. Please get the package and install it by following the instructions on the download page. The installer does everything for you ... it copies PHP into the correct folder ''/usr/local/php5'' and changes its owner to ''root'' automatically.

Now the Apache web server must get knowledge that you want to use the new PHP library instead of the old. Open the application Server Admin to switch to the new library. Go to the web server settings and find the entry php5_module. The normal place for PHP the Mac server is ''libexec/apache2/libphp5.so''. Please change to ''/usr/local/php5/libphp5.so'' and save the settings.

[[Image:Server-admin.png]]

The second thing to configure is the file php.ini. You will find this file inside the new package folder. Open the file ''/usr/local/php5/lib/php.ini'' and edit some settings for Moodle. Most of the settings are okay but not all of them. To communicate to the MySQL database with PHP you have to set the default socket name for local MySQL connects. The default socket name for local MySQLi connects is needed for Moodle 2.0.

If you want to upload any file to your Moodle you should add a little bit more upload size in php.ini. If your server can't use more than 1 GB RAM you should set the memory_limit to a value less than 128M ... but it should have more than 48M for Moodle 1.9 and Moodle 2.0.

; Default socket name for local MySQL connects.
; If empty, uses the built-in MySQL defaults.
mysql.default_socket = /var/mysql/mysql.sock

; Default socket name for local MySQL connects.
; If empty, uses the built-in MySQL defaults.
mysqli.default_socket = /var/mysql/mysql.sock

; Maximum amount of memory a script may consume (128MB)
memory_limit = 128M

; Maximum allowed size for uploaded files.
upload_max_filesize = 128M

; Maximum size of POST data that PHP will accept.
post_max_size = 128M

That's all ... save the file php.ini and restart the web server. Now you should look at http://your-server-address/info.php again. I hope that everything will be okay. You will find the version number PHP 5.3.0 and the running GD library support. Congratulations ... the first step for Moodle on the Mac server is done!

[[Image:phpinfo.png]]

[[Image:phpinfo2.png]]

==Configure the MySQL database for your Moodle installation==

In standard case the database MySQL is installed on the Mac OS X 10.5 Server but it is not running yet. Please make sure that you start the MySQL database server.

===Use the graphical way===
Sorry ... there are some more installations and a lot of clicks to configure MySQL in a graphical way.

First of all start the ''Server Admin''. You will find this program by the way ''Applications > Server > Server Admin''. Activate MySQL on the local server. You must set the password for the user ''root'' before you can start MySQL.

For the next you must download the MySQL database administration tool '''phpMyAdmin''' from http://www.phpmyadmin.net . Move the folder to the web server documents as ''/Library/WebServer/Documents/phpMyAdmin''.

Add the security phrase to the file ''config.inc.php'' in between the single quotes on the line $cfg['blowfish_secret'] = ''; /* YOU MUST FILL IN THIS FOR COOKIE AUTH! */

Now you will be able to start http://your-server-address/phpMyAdmin/ in your browser and to log into the database as the user ''root''. Add a database ''moodle19''. Add a database user ''moodle'' to the server ''localhost''. Don't forget to set a secure password. The database user ''moodle'' should be allowed to administrate the database ''moodle19'' only. It is a bad way to set ''root'' to administrate the database ''moodle19''. If you want to install also Moodle 2.0 dev please add a second database ''moodle20'' and use the same database user for it.

phpMyAdmin is a nice thing to look into the database while Moodle is running for some time. It's much easier to see in the graphical interface than in the command line tools. The image shows the database after Moodle 1.9 and Moodle 2.0 were already installed on this server.

[[Image:phpmyadmin.png]]

===Use the Terminal===
If you want a quick installation then don't fear to use the Terminal. It's easier to tell you all the commands for the right way with the Terminal than showing you all the pictures to do the same with graphical tools. There are only a few commands to do everything I told you before.

Start the Terminal. You will find this program by the way ''Applications > Tools > Terminal''. You will see that we must do the same steps as before but you can read them in a text form.

First of all you need to set the root password. If you didn't this before then use the first command line. If you want to change an existing password then use the second one.

Server:~ $ mysqladmin -u root password 'secret'
Server:~ $ mysqladmin -u root -p password 'topsecret'

The next steps are creating a new database ''moodle19'' with correct character set and setting up a database user ''moodle'' to administrate the new database ... and if you want then do the same for ''moodle20''.

Server:~ $ mysqladmin -u root -p create moodle19
Server:~ $ mysql -u root -p

mysql> ALTER DATABASE moodle19 CHARSET 'utf8';
mysql> GRANT ALL PRIVILEGES ON moodle19.* TO moodle@localhost
-> IDENTIFIED BY 'moodle!';
mysql> quit

Server:~ $

That's really all with the Terminal. You are just ready!

==Copy the Moodle files to the web server==

The documents for the web server are saved in the folder ''/Library/WebServer/Documents/''. You will place your Moodle folder here after you got it from http://download.moodle.org. Download the standard package MOODLE_19_WEEKLY because this is the best choice for new servers. Set the owner ''_www'' for the moodle folder ... this is the user for the web server. The folder permissions should be 755 before the installation and 555 after it's done ... please remember to set this later!

You also need the moodledata folder outside of the Documents folder ... so please make one. Go to the folder ''/Library/WebServer/'' and add the folder ''moodledata''. Because I want to install Moodle 1.9.x and Moodle 2.0 dev together on the same Mac server I add two folders ''moodle19'' and ''moodle20'' inside the moodledata folder. Please set the owner ''_www'' for both folders ''moodle19'' and ''moodle20'' and the folder permissions to 755.

cd /Library/WebServer/
mkdir moodledata
mkdir moodledata/moodle19
mkdir moodledata/moodle20
sudo chown -R _www moodledata
sudo chmod -R 755 moodledata

==Run the Moodle installation==
The installation on the Mac server is the same like the installation on every other server.
Open a web browser to http://your-server-address/moodle/install.php to begin the installation process.
On the screen picture and in the shown config.php you see the web address ''your-server-address'' ... it's only a placeholder for a real address or url ... please set yours. Also a user 'moodle' with a password 'moodle' would be very unsafe settings for your installation.

[[Image:moodle-install1.png]]

[[Image:moodle-install2.png]]

The installer generates the config.php automatically and saves it in the folder ''/Library/WebServer/Documents/moodle19''. Please edit the config.php with a text editor and add the line ''date_default_timezone_set('UTC');''. You may change ''UTC'' to your own timezone ... this is needed for PHP 5.3.0.

<?php /// Moodle Configuration File

unset($CFG);

$CFG->dbtype = 'mysql';
$CFG->dbhost = 'localhost';
$CFG->dbname = 'moodle19';
$CFG->dbuser = 'moodle';
$CFG->dbpass = 'moodle';
$CFG->dbpersist = false;
$CFG->prefix = 'mdl_';

$CFG->wwwroot = 'http://your-server-address/moodle19';
$CFG->dirroot = '/Library/WebServer/Documents/moodle19';
$CFG->dataroot = '/Library/WebServer/moodledata/moodle19';
$CFG->admin = 'admin';

$CFG->directorypermissions = 00777; // try 02777 on a server in Safe Mode

date_default_timezone_set('Europe/Berlin'); // timezone for PHP 5.3.0
require_once("$CFG->dirroot/lib/setup.php");
// MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
// RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
?>

When the installation is ready you should change the folder permission for ''/Library/WebServer/Documents/moodle19'' to 555 so the web server is not able to write into this folder again.

==Download the language packages==

==Moodle is running ...==
[[Image:moodle-on-macosx-server.png]]

==How to setup the cron job with launchd==

It's really important to start the cron job every 5 minutes. The cron job assists most of Moodle's modules to perform tasks on a scheduled basis. For example, the discussion forums can only mail out copies of new posts to all subscribers if the cron job tells Moodle to do this.

In Mac OS X 10.5 you will find the system daemon ''launchd'' for this service. This daemon offers a standardized interface to any user and all programs started automatically by the system. Please look at http://developer.apple.com/macosx/launchd.html for more information about the configurations and all parameters.

In our case the service should get the web page http://your-server-address/moodle19/admin/cron.php every 5 minutes. The configuration will be done by the file named ''moodle4mac.cron.plist'' which must be placed in the system folder ''/Library/LaunchDaemons/'' ... surely you can use any other file name but it should say something about the function of the service. The extension must be ''.plist''. After any reboot of your Mac server the cron service will start automaticly because the file is placed in the correct system folder.

===Use the graphical way===
You can use Lingon to add a new daemon plist or to edit one. It produces the same text as you can write in your text editor. http://sourceforge.net/projects/lingon/files/

[[Image:macosx-lingon.png]]

===Use a text editor===
Please use a text editor to write the needed file. You can open the Terminal and use the system editors vi or pico. But you can also write the text file with any GUI text editor ... I mostly use TextWrangler ... but do NOT take an editor for formatted texts like Microsoft Word or OpenOffice Writer. You must get pure text!

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>KeepAlive</key><false/>
<key>Label</key><string>moodle4mac.cron</string>
<key>ProgramArguments</key>
<array>
<string>curl</string>
<string>-s</string>
<string>http://your-server-address/moodle19/admin/cron.php</string>
</array>
<key>RunAtLoad</key><true />
<key>StartInterval</key><integer>300</integer>
<key>StandardErrorPath</key><string>/dev/null</string>
<key>StandardOutPath</key><string>/dev/null</string>
</dict>
</plist>

The label string must be the same as the file name is but without the extension ''.plist''. Save the text file ''/Library/LaunchDaemons/moodle4mac.cron.plist''. The owner of the file must be set to the system user ''root''. That's all, really!

===How to start and stop the cron service===
You can start the new cron service in the Terminal.

sudo launchctl load /Library/LaunchDaemons/moodle4mac.cron.plist

The following command would stop the service. If you want to activate changes in the cron service you need to ''unload'' and then to ''load'' the daemon again.

sudo launchctl unload /Library/LaunchDaemons/moodle4mac.cron.plist

===Only one service for two servers?===
For my server I needed to have a cron service for to instances ''moodle19'' and ''moodle20'' ... no problem ... with the typo ''moodle[19-20]'' the server will get a cron service for both instances.

<nowiki>curl -s http://your-server-address/moodle[19-20]/admin/cron.php</nowiki>

To see if the cron service works correctly you should look at the ''access.log'' of your web server. The cron.php should be accessed every 5 minutes ... on my server for both Moodle instances ''moodle19'' and ''moodle20'' ... oh yes, it works!!

192.168.0.220 - - [30/Jul/2009:22:10:56 +0200] "GET /moodle19/admin/cron.php HTTP/1.1" 200 1136
192.168.0.220 - - [30/Jul/2009:22:10:57 +0200] "GET /moodle20/admin/cron.php HTTP/1.1" 200 1403
192.168.0.220 - - [30/Jul/2009:22:11:18 +0200] "OPTIONS * HTTP/1.0" 200 -
192.168.0.220 - - [30/Jul/2009:22:15:56 +0200] "GET /moodle19/admin/cron.php HTTP/1.1" 200 735
192.168.0.220 - - [30/Jul/2009:22:15:57 +0200] "GET /moodle20/admin/cron.php HTTP/1.1" 200 964
192.168.0.220 - - [30/Jul/2009:22:20:56 +0200] "GET /moodle19/admin/cron.php HTTP/1.1" 200 1136
192.168.0.220 - - [30/Jul/2009:22:20:57 +0200] "GET /moodle20/admin/cron.php HTTP/1.1" 200 1365

==How to set up SSL/https in MAMP for a development/test environment==
Following are the steps that I copied from [http://www.webopius.com/content/355/getting-mamp-working-with-ssl-on-os-x webopius web site] (excepted the last steps).
#stop MAMP
#backup your /Applications/MAMP/conf folder
#open a terminal
#enter: ''openssl genrsa -des3 -out server.key 1024''. Enter a password twice.
#enter: ''openssl req -new -key server.key -out server.csr''. Enter the previous password. You need to answer some questions. ''Common name'' expects your local name (for me it was jerome.moodle.local)
#enter: ''openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt''
#enter: ''cp server.key server.tmp''
#enter: ''openssl rsa -in server.tmp -out server.key''. Enter the previous password.
#enter: ''mkdir /Applications/MAMP/conf/ssl''
#enter: cp server.crt /Applications/MAMP/conf/ssl
#enter: cp server.key /Applications/MAMP/conf/ssl
# Edit Applications/MAMP/conf/apache/ssl.conf:
##comment <IfDefine SSL> tag to closing tag (but not the content)
##SSLCertificateFile /Applications/MAMP/conf/ssl/server.crt
##SSLCertificateKeyFile /Applications/MAMP/conf/ssl/server.key
# Edit /Applications/MAMP/conf/apache/httpd.conf:
##Listen 80
##comment <IfDefine SSL> tag to closing tag (but not the content)
# Edit /Application/MAMP/conf/apache/ssl.conf, change the document root (DocumentRoot) for the one you have into /Application/MAMP/conf/apache/httpd.conf
#in a terminal enter: ''cd /Applications/MAMP/bin/apache2/bin''
#enter: ''sudo ./apachectl startssl''
#start MAMP

From now MAMP should start/stop with the SSL support activated. Note that these steps have only be tested with Apache port set to 80 into MAMP preferences.

==How to update with CVS==

==User administration via LDAP==

The following settings will work on 10.5 Server running LDAP - edit them to customize to your own environment. Please note that moodle requires some fields - it is best to have these fields completed in Workgroup Manager on 10.5 Server - otherwise they'll be prompted to enter info into their moodle profile on first login, but the way we've got it set up, moodle can't modify LDAP for security and data integrity. The necessary fields are user name, first name, surname, Email address, City/Town, country, description, ID number.

LDAP SERVER SETTINGS
Host URL = ourserver.example.com
Version = 3
LDAP encoding = utf-8

BIND SETTINGS
Hide passwords = Yes
Distinguished Name = (blank)
Password = (blank)

USER LOOKUP SETTINGS
User type = posixAccount (rfc2307)
Contexts = cn=users,dc=ourserver,dc=example,dc=com
Search subcontexts = Yes
Dereference aliases = No
User attribute = (blank)
Member attribute = (blank)
Member attribute uses dn = (blank)
Object class = (blank)

FORCE CHANGE PASSWORD
Force change password = No
Use standard Change Password Page = No
Password format = Plain text
Password change URL = (blank)

LDAP PASSWORD EXPIRATION SETTINGS
Expiration = no
Expiration warning = 10
Expiration attribute = ""
Grace logins = No
Grace login attribute = (blank)

ENABLE USER CREATION
Create users externally = No
Context for new users = (blank)

COURSE CREATOR
Creators = (blank)

CRON SYNCHRONIZATION SCRIPT
Removed ext user = Keep internal

NTLM SSO
Enable = No
Subnet = (blank)
First name = givenName (On every login, Never, Locked)
Surname = sn (On every login, Never, Locked)
Email address = mail (On every login, Never, Locked)
Phone 1 = (blank)
Phone 2 = (blank)
Department = (blank)
Address = (blank)
City/Town = l (On every login, Never, Locked)
Country = c (On every login, Never, Locked)
Description = description (On every login, Never, Locked)
ID number = uidNumber (On every login, Never, Locked)
Language = (blank)

==See also==
* [[Complete Install Packages for Mac OS X | Complete install packages for Mac OS X 10.4/10.5]]
* [[Step-by-step Guide for Installing Moodle on Mac OS X 10.4 Client|Step by step installation on a Mac OS X 10.4 Client]]
* [[Cron | Installation of cron for Moodle]]
* [[CVS for Administrators]]

* [http://moodle.org/mod/forum/discuss.php?d=24632 Using Moodle: Dynamic DNS Home Server]

[[Category:Administrator]]
[[Category:Installation]]
[[Category:Mac OS X]]

Development talk:Core Function List

2009-04-15T07:47:35Z

Pigui: New page: Ohhhh great!! Finally we have get_course_by_id ($id) function :)

Ohhhh great!! Finally we have get_course_by_id ($id) function :)

Development talk:Moodle API Function List

2009-02-05T14:26:13Z

Pigui:

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==
== Category ==
get_category()
create_category()
delete_category()
update_category()
update_parent_category()

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}
get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}
create_section()
get_sections()
delete_section()
get_metacourse()

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
create_grouping()
delete_grouping()
update_grouping()
get_grouping()
add_group_to_grouping()
get_groups_from_grouping()
delete_group_from_grouping()

== Mod ==
=== Assignment ===
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===
== Portfolio ==
== Repository ==
== Role ==
create_role()
get_roles()
update_role()
delete_role()
assign_role()
inherit_capability()
allow_capability()
prevent_capability()
prohibit_capability()
get_users_by_role()
has_capability()

== Search ==
== Tag ==
== User ==

Development talk:Moodle API Function List

2009-02-05T14:25:36Z

Pigui: /* Course */

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==
== Category ==
get_category()
create_category()
delete_category()
update_category()
update_parent_category()

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}

get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}

create_section()

get_sections()

delete_section()

get_metacourse()

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
create_grouping()
delete_grouping()
update_grouping()
get_grouping()
add_group_to_grouping()
get_groups_from_grouping()
delete_group_from_grouping()

== Mod ==
=== Assignment ===
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===
== Portfolio ==
== Repository ==
== Role ==
create_role()
get_roles()
update_role()
delete_role()
assign_role()
inherit_capability()
allow_capability()
prevent_capability()
prohibit_capability()
get_users_by_role()
has_capability()

== Search ==
== Tag ==
== User ==

Development talk:Moodle API Function List

2009-01-29T09:30:19Z

Pigui: /* Role */

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==
== Category ==
get_category()
create_category()
delete_category()
update_category()
update_parent_category()

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}

get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
create_grouping()
delete_grouping()
update_grouping()
get_grouping()
add_group_to_grouping()
get_groups_from_grouping()
delete_group_from_grouping()

== Mod ==
=== Assignment ===
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===
== Portfolio ==
== Repository ==
== Role ==
create_role()
get_roles()
update_role()
delete_role()
assign_role()
inherit_capability()
allow_capability()
prevent_capability()
prohibit_capability()
get_users_by_role()
has_capability()

== Search ==
== Tag ==
== User ==

Development talk:Moodle API Function List

2009-01-29T09:29:06Z

Pigui: /* Group */

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==
== Category ==
get_category()
create_category()
delete_category()
update_category()
update_parent_category()

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}

get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
create_grouping()
delete_grouping()
update_grouping()
get_grouping()
add_group_to_grouping()
get_groups_from_grouping()
delete_group_from_grouping()

== Mod ==
=== Assignment ===
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===
== Portfolio ==
== Repository ==
== Role ==
create_role()
get_roles()
update_role()
delete_role()
assign_role()
inherit_capability()
allow_capability()
prevent_capability()
prohibit_capability()
get_users_by_role()

== Search ==
== Tag ==
== User ==

Development talk:Moodle API Function List

2009-01-29T09:28:52Z

Pigui: /* Group */

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==
== Category ==
get_category()
create_category()
delete_category()
update_category()
update_parent_category()

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}

get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
create_grouping()
delete_grouping()
update_grouping()
get_grouping()
add_group_to_grouping()
get_groups_from_grouping()
delete_group_from_grouping()

== Mod ==
=== Assignment ===
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===
== Portfolio ==
== Repository ==
== Role ==
create_role()
get_roles()
update_role()
delete_role()
assign_role()
inherit_capability()
allow_capability()
prevent_capability()
prohibit_capability()
get_users_by_role()

== Search ==
== Tag ==
== User ==

Development talk:Moodle API Function List

2009-01-29T09:25:48Z

Pigui:

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==
== Category ==
get_category()
create_category()
delete_category()
update_category()
update_parent_category()

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}

get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
== Mod ==
=== Assignment ===
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===
== Portfolio ==
== Repository ==
== Role ==
create_role()
get_roles()
update_role()
delete_role()
assign_role()
inherit_capability()
allow_capability()
prevent_capability()
prohibit_capability()
get_users_by_role()

== Search ==
== Tag ==
== User ==

Development talk:Moodle API Function List

2009-01-29T09:20:08Z

Pigui:

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==
== Category ==
get_category()
create_category()
delete_category()
update_category()
update_parent_category()

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}

get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
== Mod ==
=== Assignment ===
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===
== Portfolio ==
== Repository ==
== Search ==
== Tag ==
== User ==

Development talk:Moodle API Function List

2009-01-29T09:16:50Z

Pigui:

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}

get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
== Mod ==
=== Assignment ===
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===
== Portfolio ==
== Repository ==
== Search ==
== Tag ==
== User ==

Development talk:Moodle API Function List

2009-01-29T09:16:29Z

Pigui:

=Proposal for expansion of the API=
''by Ludo's team UPC''

== Admin ==
== Blocks ==
== Blog ==
== Calendar ==

== Course ==

get_course_activities($courseid=0, $groupid=null) // return the list of activity {id, name, type}

get_course_resources($courseid=0, $groupid=null) // return the list of {id,. resource, type}

=== Course Format ===
get_course_outline($courseid=0, $groupid=null) // to discuss, maybe xml stuff

get_course_outline would be a nice to have from the webservices consumer app. If an external app needs to render the moodle course, need's more than just activities and resources, it needs to know how to display it. this function whould be implemented by the course format.

TODO: define course outline xml dtd

== Grade ==
== Group ==
== Mod ==
=== Assignment ==
=== Chat ===
=== Choice ===
=== Data ===
=== Feedback ===
=== Forum ===
=== Glossary ===
=== Lesson ===
=== Quiz ===
=== Resource ===
=== Scorm ===
=== Survey ===
=== Wiki ===

== Portfolio ==
== Repository ==
== Search ==
== Tag ==
== User ==

Development:Wiki 2.0

2008-11-14T08:00:52Z

Pigui: /* Database design */

Let's restart the wiki movement, yay!

Here is the plan for 2.0 - we are not looking back, you can access information that was here previously in page history, sorry :-)

=Database design=

Changes compared to OU wiki
* used section titles instead of byte ranges
* section titles must bu unique on each page
* synonyms table
* text format in versions table (and maybe caching field for parsed text)
* Do we need one wiki per student mode?
* page lock option

[[Image:Wikidatabasedesign.png]]

=Formats, Editors & Filters=

Implemented in core.

===Filters===
We need filtering before and after conversion to HTML.

===Editors===
New mforms editor element should support all types of formats.

===Formats===
Responsible for conversions and diffs.

=Locking=

Should use section titles instead of byte ranges.

=Version & diffs=

Diffs not part of wiki code anymore, instead handled by format plugins.

=Comments=

We need general comments framework - to be used in blogs, glossary, database mod, assignments and wiki.

Questions:
* do we need attachments? yes
* threads? no
* edit timeouts like in forum? yes
* some more capabilitites

=Groups=

Group mode can be used for emulation of one wiki per student mode.

=Grading=

General grading support for assignments and wikis with group grading mode.

Grading is handled by gradebook plugins. Grading means the act of setting final grade. This is not a peer review.

Gradebook plugins may use ratings, display overview of all pages, all contributions, etc.

=Rating=

Optional peer review - ratings, could be something like proposal for final grade.

Two different types of ratings - open on wiki pages view, the other on versions history page. First for rating of page as the result of collaborative work, the other rating of individual contributions.

=File handling=

Supported in moodle core (file handling, editors, etc.).

=Backup/Restore=

Only basic restore support for 1.6-1.9. Full support only for 2.x

=Tags=

Core tags library.

=Blocks=

* Index map - ideally graph, text too?
* Add new or missing page
* List of orphaned pages
* My contributions
* Search?? better to have generic search
* standard tags (nothing special)
* navigation
* full list of pages

=Permissions=

view, edit, comment, change locking, manage (general)

=Templates=

we need to store the template in database, we need it in group mode

=Export/Import=
portfolio and repository API

File:Wikidatabasedesign.png

2008-11-14T07:59:59Z

Pigui:

Development talk:Wiki 2.0

2008-11-12T16:52:59Z

Pigui:

=Database design=
=Formats, Editors & Filters=
=Locking=
=Version & diffs=
=Comments=
=Groups=
=Grading=
=Rating=
=File handling=
=Backup/Restore=
=Tags=
=Blocks=
=Permisions=
=Templates=

Development talk:Wiki 2.0

2008-11-12T16:30:13Z

Pigui:

=Database design=
=Formats, Editors & Filters=
=Version & diffs=
=Comments=
=Groups=
=Grading=
=Rating=
=File handling=
=Backup/Restore=
=Tags=
=Blocks=
=Permisions=
=Templates=

Development:NWiki roadmap

2007-09-12T10:31:07Z

Pigui:

This page is to talk about the (likely) entrance of NWiki into 1.9 core.

= NWiki roadmap=
Rigth Now DFwikiteam is focussed in the following issues:
== XHTML Strict ==
*NWiki complies with XHTML transitional. April 2007
*NWiki complies with '''XHTML Strict''' mid May '07
** this affects main engine
** blocks not finished yet (some javascript to look up to)

==Logs and stats==
We need to ckeck out stats and logs with nwiki.

== Code Tunning : new wiki api==
There's a big issue in the code, the $WS variable that acts like a big set of global variables.
*We are getting $WS smaller day by day
*We are witting a new internal API to create an internal layer of services for developers.

'''Done!!!''' Two main layers for developers have been written and working inside of the Nwiki distributions since May 2007.
[http://morfeo.upc.es/crom/file.php/4/wikiAPIdoc/index.htmlThe PHPDoc documentation is available here].

=== PHPUnit testing===
* a set of PHPUnit tests have been developed to ensure the quality of the thing.
* test case descriptions have been written to help developers and maintainers
[http://morfeo.upc.es/crom/mod/wiki/view.php?id=22&page=Wiki+Unit+Tests+Documentation&gid=0&uid=0 NWiki PHPUnit documentation]

== shall we trim nwiki ?==
NWiki is Huge ! As many have said we implement a lot of features that maybe are not necessary for everybody.
We could have a reduced set of nwiki into the oficial distribution and a 3rd party and a extended version as 3rd part plug in.
Things that could be taken outside:
===Maybe we keep them===
* wiki course format
* discussion pages ?
* grading in wikis ?
* ranking and votes?

===Most likely===
* integration with tiddlywiki ? [[Tiddlywiki integration]]

=== New upcoming toys ===
In June 2007 will come new features that need to be sorted in or out of the basic distribution
* [[Wikibook]] [http://moodle.org/mod/forum/discuss.php?d=72909 wikibook in the forum]
* PDF Generation
* Timeline-like wiki history browser
* Import / export from openoffice writer and (eventually) msword

== Migration issues ==
So far the data migration works fine. No bugs reported without attending.
== rethink wiki permisions and roles ==
* a user can discuss the page while he cannot edit the page
* the teacher cat FIX a markup for a wiki in the wiki options form.

==Tracked issues==
There are several bugs and improvements listed in Moodle's [http://tracker.moodle.org/secure/IssueNavigator.jspa?assigneeSelect=specificuser&assignee=dfwikiteam tracker].
==More?==
Let's rememeber to complete the PDF export thing (HTML Editor wiki pages are not exported)
Expected mid june

==Even More features Implemented==

=== Wiki Templates ===

* Add templates so that some content can be made available to all groups when they start using a wiki
Implemented, in release June 2007
=== mailto ===
* a mailto link for dfwiki
has already ben developed must be included in next release [http://moodle.org/mod/forum/discuss.php?d=38991 mailto dfwiki forum thread]

==And finally==
Dynamical online import from mediawiki utilty... :-D

= Old DFwiki requests =
Use this page for requests of bugfixes and new features on the [http://morfeo.upc.es/crom/course/view.php?id=4 NWiki]
The [http://morfeo.upc.es/crom/course/view.php?id=4 DFwikiteam] will keep a sharp eye on the list.

== Miscellaneous ==
*We need to implement some [[Special pages]] like mediawiki's [[Recent changes]].
*Section edit.
*borrow some interface ideas from OUWiki

== block wikipage ==

Would be useful to have a block with the content of a wikipage.

If you select 'social' course format you have the option of inserting a social activities block... I don't get that option for the DFWiki, but I think I should so I can add other Moodle activities...

otherwise, when I go to admin/site I can choose to display a topic section where I can put activities and this may be an alternative solution.

Note: In theme [http://moodle.org/mod/forum/discuss.php?d=42325 Including wiki page in other Moodle resources] was announced filter, which can include wiki-page into any filterable place. In summ with existing html block it sounds like solution for this suggestion! --[[User:Ne Nashev|Ne Nashev]] 07:52, 26 March 2006 (WST)

== Including wiki page in other Moodle resources ==
I suggest add to standard filters (like Autoformat, Markdown) tag which allow include content (not a link) of wiki page (without editing). This will allow to use wiki as general place for storage texts and use them in resources, lessons and so on.

Note: In theme [http://moodle.org/mod/forum/discuss.php?d=42325 Including wiki page in other Moodle resources] was announced this filter

-----
The words "Change to one of the following editors" tells the new user to change to an editor other than the default editor. As this works now, the choice cannot be changed once selected.

In order to avoid this confusion, the teacher should be able to make the default editor the only choice.

In the meantime, the option "Change to one of the following editors" could be moved down below the buttons: save, preview, cancel.

That way new users will be more likely to use the default editor and not lock themselves into one of the other options.
[http://moodle.org/mod/forum/discuss.php?d=39191 forum tread]
-----

== Moodle wide metawiki==

We need a metawiki index to easily link between wikis.
The idea is to have admin tool to manage the wiki-names to be able to
refer easily from one wiki to another like this:

<nowiki> [wiki-name:wikipagename|label to link]</nowiki>

== Special wiki pages ==

=== Wiki reference. ===
To implement biblio references... a link like
<nowiki>[ref:refname]</nowiki> Will lead us to a editing page with a form (maybe a [[database module]] form) to enter the biblio reference ( title, author, isbn, link , pages ... and so on )...
Once we got that any page with a reference to a biblio ref will get printed at its bottom the complete reference and a link to it.

This feature proposal comes within the [[wikibook]] line of work

== weird course interaction stuff ==
If you select 'social' course format you have the option of inserting a social activities block... I don't get that option if I select DFWiki, but I think I should so I can add other Moodle activities... (using Moodle 1.6)

Otherwise, when I go to admin/site I can choose to display 1 topic section where I can put activities and this may be an alternative solution.

Also if I modify a course that had a different format, such as topics ,to be DFWiki the course crashes and you cannot get back to original course format because of the error it throws up.

*[[wiki]]
*[[Dfwiki]]
*[http://morfeo.upc.es/crom/course/view.php?id=4 DFWikilabs]
*[[Development:Wiki requirements]]

Development:NWiki roadmap

2007-09-12T10:23:33Z

Pigui: /* Logs and stats */

This page is to talk about the (likely) entrance of NWiki into 1.9 core.

= NWiki roadmap=
Rigth Now DFwikiteam is focussed in the following issues:
== XHTML Strict ==
*NWiki complies with XHTML transitional. April 2007
*NWiki complies with '''XHTML Strict''' mid May '07
** this affects main engine
** blocks not finished yet (some javascript to look up to)

==Logs and stats==
We need to ckeck out stats and logs with nwiki.

== Code Tunning : new wiki api==
There's a big issue in the code, the $WS variable that acts like a big set of global variables.
*We are getting $WS smaller day by day
*We are witting a new internal API to create an internal layer of services for developers.

'''Done!!!''' Two main layers for developers have been written and working inside of the Nwiki distributions since May 2007.
[http://morfeo.upc.es/crom/file.php/4/wikiAPIdoc/index.htmlThe PHPDoc documentation is available here].

=== PHPUnit testing===
* a set of PHPUnit tests have been developed to ensure the quality of the thing.
* test case descriptions have been written to help developers and maintainers
[http://morfeo.upc.es/crom/mod/wiki/view.php?id=22&page=Wiki+Unit+Tests+Documentation&gid=0&uid=0 NWiki PHPUnit documentation]

== shall we trim nwiki ?==
NWiki is Huge ! As many have said we implement a lot of features that maybe are not necessary for everybody.
We could have a reduced set of nwiki into the oficial distribution and a 3rd party and a extended version as 3rd part plug in.
Things that could be taken outside:
===Maybe we keep them===
* wiki course format
* discussion pages ?
* grading in wikis ?
* ranking and votes?

===Most likely===
* integration with tiddlywiki ? [[Tiddlywiki integration]]

=== New upcoming toys ===
In June 2007 will come new features that need to be sorted in or out of the basic distribution
* [[Wikibook]] [http://moodle.org/mod/forum/discuss.php?d=72909 wikibook in the forum]
* PDF Generation
* Timeline-like wiki history browser
* Import / export from openoffice writer and (eventually) msword

== Migration issues ==
So far the data migration works fine. No bugs reported without attending.
== rethink wiki permisions and roles ==
* a user can discuss the page while he cannot edit the page
* the teacher cat FIX a markup for a wiki in the wiki options form.

==More?==
Let's rememeber to complete the PDF export thing (HTML Editor wiki pages are not exported)
Expected mid june

==Even More features Implemented==

=== Wiki Templates ===

* Add templates so that some content can be made available to all groups when they start using a wiki
Implemented, in release June 2007
=== mailto ===
* a mailto link for dfwiki
has already ben developed must be included in next release [http://moodle.org/mod/forum/discuss.php?d=38991 mailto dfwiki forum thread]

==And finally==
Dynamical online import from mediawiki utilty... :-D

= Old DFwiki requests =
Use this page for requests of bugfixes and new features on the [http://morfeo.upc.es/crom/course/view.php?id=4 NWiki]
The [http://morfeo.upc.es/crom/course/view.php?id=4 DFwikiteam] will keep a sharp eye on the list.

== Miscellaneous ==
*We need to implement some [[Special pages]] like mediawiki's [[Recent changes]].
*Section edit.
*borrow some interface ideas from OUWiki

== block wikipage ==

Would be useful to have a block with the content of a wikipage.

If you select 'social' course format you have the option of inserting a social activities block... I don't get that option for the DFWiki, but I think I should so I can add other Moodle activities...

otherwise, when I go to admin/site I can choose to display a topic section where I can put activities and this may be an alternative solution.

Note: In theme [http://moodle.org/mod/forum/discuss.php?d=42325 Including wiki page in other Moodle resources] was announced filter, which can include wiki-page into any filterable place. In summ with existing html block it sounds like solution for this suggestion! --[[User:Ne Nashev|Ne Nashev]] 07:52, 26 March 2006 (WST)

== Including wiki page in other Moodle resources ==
I suggest add to standard filters (like Autoformat, Markdown) tag which allow include content (not a link) of wiki page (without editing). This will allow to use wiki as general place for storage texts and use them in resources, lessons and so on.

Note: In theme [http://moodle.org/mod/forum/discuss.php?d=42325 Including wiki page in other Moodle resources] was announced this filter

-----
The words "Change to one of the following editors" tells the new user to change to an editor other than the default editor. As this works now, the choice cannot be changed once selected.

In order to avoid this confusion, the teacher should be able to make the default editor the only choice.

In the meantime, the option "Change to one of the following editors" could be moved down below the buttons: save, preview, cancel.

That way new users will be more likely to use the default editor and not lock themselves into one of the other options.
[http://moodle.org/mod/forum/discuss.php?d=39191 forum tread]
-----

== Moodle wide metawiki==

We need a metawiki index to easily link between wikis.
The idea is to have admin tool to manage the wiki-names to be able to
refer easily from one wiki to another like this:

<nowiki> [wiki-name:wikipagename|label to link]</nowiki>

== Special wiki pages ==

=== Wiki reference. ===
To implement biblio references... a link like
<nowiki>[ref:refname]</nowiki> Will lead us to a editing page with a form (maybe a [[database module]] form) to enter the biblio reference ( title, author, isbn, link , pages ... and so on )...
Once we got that any page with a reference to a biblio ref will get printed at its bottom the complete reference and a link to it.

This feature proposal comes within the [[wikibook]] line of work

== weird course interaction stuff ==
If you select 'social' course format you have the option of inserting a social activities block... I don't get that option if I select DFWiki, but I think I should so I can add other Moodle activities... (using Moodle 1.6)

Otherwise, when I go to admin/site I can choose to display 1 topic section where I can put activities and this may be an alternative solution.

Also if I modify a course that had a different format, such as topics ,to be DFWiki the course crashes and you cannot get back to original course format because of the error it throws up.

*[[wiki]]
*[[Dfwiki]]
*[http://morfeo.upc.es/crom/course/view.php?id=4 DFWikilabs]
*[[Development:Wiki requirements]]

Development talk:Wiki requirements

2007-06-03T11:16:28Z

Pigui: /* New wiki issue list (Comments) */

What about wrapping the already existing bits of Moodle together to create a new wiki (oh, no...not another wiki) My thinking is that we already have the following tools:

* a "standard" markup (Markdown)
* several ways to store attachments/images/binary files in various modules
* filters for multimedia, Latex, Math and the like.

Could these instances be refactored and refined then called from the wiki parser? This would avoid re-inventing the wheel(s) and simplify maintanence of system. I guess I'm suggesting a "plugin" mechanism where each of these tools could be added to Moodle and then assembled to form the wiki rather than create a monolithic and eventually cumbersome script. If all wiki pages are simply text, the wiki script will just dole out portions of each page to the proper tool. I'm imagining these tools could be used everywhere in Moodle, rather than being specific to the wiki...kind of following the unix philosophy of assembling several simpler tools to perform complicated tasks. Looking at Martin D's post outlining the must-have features, he alludes to this approach when discussing Mediawiki. Posts in other discussions have as well.

Regarding feature ideas, I would recommend folks look at Uniwakka. This "academically oriented" wiki engine has some great possibilities including support for MathML (better than latex filter for sophisticated maths?), Latex, chemistry (a personal favorite), and bibliographies; it exports/imports OpenOffice documents directly and exports Latex versions of the pages. Veeerryy nice!

Thoughts?

~Steve
----
These are interesting thougts Steve, in fact it was my fisrt idea twio years ago when I longed to develop tools for the current wiki. But teh coding and features of the current wiki convinced me that we needed a new wiki from scratch. I vbeliebe that the aproach you propose can be implemented once we have the [[DFWiki]] up and official.

By the way we are already working on a wiki parser compilant with mediawiki, comming soon .

Ludo - DFWikiteam
----

The features I find myself often missing in the current Moodle Wiki are:

* editable sections/sub-pages
* in history: ability to compare two arbitrary versions

These are things I have grown used to in MediaWiki.

In the markup department I'd like to see:

* at minimum: a basic wiki-like markup as the default
* optionally: ability to define your own markup
* optionally 2: ability to define what if the default markup

I find that most cases people will use the default markup. I don't use the Markdown format although I hear great things about it from people who do use it. I wouldn't want to make the users at our site transfer to Markdown, when I didn't even mention it in the basic training sessions they participated in.

~Jussi

I have used a number of different wiki systems and some of them with students. I've tried [http://www.twiki.org/ TWiki] and found that students with no knowledge of html take to it quite readily (and do understand the wiki way of makinglinks). I use different versions of [http://www.tiddlywiki.com/ Tiddlywiki] but the markup drives me bonkers (eg because links use | you cannot encluse a URL inside a table). I have also helped faculty use the Moodle wiki (Moodle v 1.5.1) for class but what I don't like about it is the html editor approach. A student actually managed to crunch the wiki at one point with mangled html code pasted in from MS Word which was then edited! My favourite and what I consider to be the most flexible markup system is [http://www.centeredwork.com/xilize2/index.html Xilize] which at version 2 is powerful strong. There's a plugin for Jedit which I use to create web pages.

Personally, I hope that the Moodle wiki behaves more like a 'traditional' wiki with CamelCase links and a default markup system that's easy to comprehend and orthogonal (I don't much like the accent on quotes in Markdown).

For me the selling point of Moodle wiki for use in a course is the flexibility of access control -- one can configure it to be individual access or group access, etc etc. If it defaulted to a wiki like markup and were more stable (especially with Postgres back end) I and many faculty would be happy campers.

~Markpea 25 Jan 2006

[[Category:Developer|Wiki requirements]]

I think you should either put the same information that you find in this link or the link itself in the wiki part of the documentation. I needed to know about the markup used in Moodle's wiki, and it would be nice if it were laid out right here.

I didn't know if it were more appropriate to link to this previous documentation, or if it would be better to re-create it.

[http://moodle.org/help.php?module=wiki&file=howtowiki.html /moodle.org help, how to wiki]

Thank you,
atw

== New wiki issue list (Comments) ==

# '''There is no userid column in the wiki_pages table (author char-string instead). Must be supported in migration too.''' userid has been there since June06
# '''There is no intro and introformat in the wiki table.'''. I can't remember when Eloy Lafuente added these two columns... A long, long time ago...
# '''In the upgrade from wiki to dfwiki, as there aren't userids, my wiki-pages were assigned to "guest". Once more, userid seems to be critical.'''. Solved. We are using userids. In case of mismatching, we assign the page to the current user.
# '''Wikis having different wiki_entries (group or user ones) have no support in new wiki (only one simultaneous line of versions is available?) so we get a lot of duplicate version errors with data-lost of such pedagogical feature! Or am I losing anything? With only groupid and version in the UK of the table, old student wikis can fit in the new one. Once more, userid!''' Solved UNIQUE KEY `wiki_pages_uk` (`pagename`, `version`, `dfwiki`, `groupid`, `userid`, `ownerid`).
# '''Search doesn't work for diacritics. And/or match is performed with case matching (I think).''' Search has some bugs. We hae to improve it. Minor priority.
# '''Search seems to work against titles and contents always (no matter the checkbox was selected or no). Perhaps it's due to that usage of globals? Ah! After a second try I saw that such checkbox is to decide to show the details of the search in the body of the page. Perhaps the title should be changed to be a bit more clear? Something like "show results page" and some sort of nice help...''' I don't think so. I'll review it.
# '''The useful "What links here" block isn't available.''' Now it is.
# '''Wiki backup and restore don't support individual activities!''' Why not? Where is the problem?
# '''Wikis aren't included in the backup/restore at all!''' Backup/Restore are working correctly. We have not noticed any bug.
# '''Blocks system. Would be difficult to migrate to core block system?''' Migrated in May06.
# '''UTF-8 migration always get teacher_main_language() and it should get page author language! If we know the author responsible for the version, we must look for their original encoding instead of using the teacher one! Similar to forum_posts (if I'm not wrong). And we should know the user: userid again! ;-)''' I'm gonna take a look to this.
# '''In the wiki_pages table there is one "dfwiki" field. Should be "wikiid". Such name doesn't sound ok. (although it's possible that migation become painful, so we can change it in the future...).''' I know. Pain! It will be changed with the API integration.
# '''dfwiki is inside a lot of places in code. It should go out (although it's possible that migation become painful, so we can change it in the future...).''' Yes, variables, comments... We have to clean it out.
# '''globals, globals, globals usage should be out. Just request parameters filtered with xxxx_param() functions.''' There is only a big one. We are making it smaller every day.
# '''Attachment storage (as I've seen in the old-new migration script) seems to be a bit special with a lot of "dfwikiXXXX" dirs generated.''' I made a script to rename all these dirs.
# '''The old-new migration script seems to be twice, once under the wikimigrate dir (the used one) and under the mod directory (unused?).''' I gonna bet for duplicated code...

This summer three of us will apply a re-engineering process to adapt NWiki to Moodle standards, solve incoherences and improve architecture.

Development talk:Wiki requirements

2007-06-03T11:09:37Z

Pigui: New wiki issue list (Comments)