MoodleDocs - User contributions [en]

Ratings

2020-08-06T08:45:58Z

Mattbury: /* Changed URL because of change in my website settings. */

{{Grades}}
It is possible to rate glossary entries, forum posts and database records within Moodle. These ratings are then aggregated to produce a grade for that activity for the student being rated. For example a student's forum posts may be rated by their fellow students with those ratings being averaged and that grade then contributing to the students overall course grade. You can choose whether ratings can be submitted by students and/or by teachers.

==Enabling ratings==
Here is the process to enable ratings within an activity:
#Go to the activity settings and select the aggregation method you want applied. Average is typically the most useful.
#Choose a scale. The scale you select determines the list of options raters can choose from. Choosing a number, 10 for example, means that raters can choose any number from 0 to 10. Custom non-numeric scales can also be defined. To create a site wide custom scale go to ''Administration > Site Administration > Grades > Scales''. To create a course specific custom scale go to the gradebook and select "Scales - View".
#Optionally choose to restrict the submission of ratings to within a date range.
#Save your activity settings.

Once ratings have been enabled within an activity that activity will automatically appear in the gradebook.

==Capabilities and roles==
Capabilities and roles determine whether a given user can submit ratings, view aggregated ratings or even view the individual ratings that have been submitted. By default students can view the aggregation of all rating on their own items and only teachers can rate items.

The relevant capabilities are:

*moodle/rating:view - allows the user to view aggregated ratings made on their own items
*moodle/rating:viewany - allows the user to view aggregated ratings made on other people's items (but not their own)
*moodle/rating:viewall - allows the user to see individual ratings
*moodle/rating:rate - allows the user to rate other people's items

===Module capabilities===
Activity modules may define their own set of capabilities. When these exist the user needs BOTH the core capability and the module capability.

====Database====
* mod/data:rate
* mod/data:viewrating
* mod/data:viewanyrating
* mod/data:viewallratings

====Forum====
*mod/forum:rate
*mod/forum:viewrating
*mod/forum:viewanyrating
*mod/forum:viewallratings

====Glossary====
*mod/glossary:rate
*mod/glossary:viewrating
*mod/glossary:viewanyrating
*mod/glossary:viewallratings

==Aggregate type==

You can set an aggregate type, in other words, decide how all the ratings given are combined to form the final grade (for each entry and for the whole activity). Some scales do not lend themselves to certain types of aggregates. There are five options:

* Average of ratings (default) - This is the mean of all the ratings given. It is especially useful with peer grading when there are a lot of ratings being made.
* Count of ratings - The counts the number of rated entries which becomes the final grade. This is useful when the number of posts is important. Note that the total can not exceed the maximum grade allowed for the forum. A count may be used if the teacher simply wants to acknowledge that a reply was given in the case students being required to make a certain number of posts in a discussion. Note: Count of ratings does not work for the "Separate or Connected Ways of Knowing" scale or custom scales due to the limitation imposed by the max grade.
* Maximum rating - The highest rating is returned as the final grade. This method is useful for emphasising the best work from participants, allowing them to post one high-quality post as well as a number of more casual responses to others.
* Minimum rating - The smallest rating is returned as the final grade. This method promotes a culture of high quality for all entries.
* Sum of ratings - All the ratings for a particular user are added together. Note that the total is not allowed to exceed the maximum grade for the forum. Note: Sum of ratings does not work for the "Separate or Connected Ways of Knowing" scale or custom scales due to the limitation imposed by the max grade.

==See also==

*[[Scales]]
*Blog post by Matt Bury: [https://matbury.com/wordpress/?p=2834 Implementing star ratings in Moodle]

[[de:Wertungen]]
[[es:Valoraciones]]

Moodle migration

2018-04-09T14:19:35Z

Mattbury: /* Copy moodledata from the old server to the new server */

{{Installing Moodle}}
There may be times when you need to move your Moodle site from one server to another. For example, moving a Moodle site from shared hosting service's server to a dedicated server.

==Recommended method==

This involves moving a whole site from one server to another. If you are changing the domain/IP address to the new server you need to do these steps:

===Turn on maintenance mode===

Place your current Moodle site into [[Maintenance mode]] via ''Site Administration > Server > Maintenance Mode'' to prevent any further additions to the Moodle database. Don't let administrators login during the migration as they are not affected by the maintenance mode setting.

===Backup the Moodle database on the old sever===

The right way to back up your database depends on which database system you are using. The instructions below are one way to back up a MySQL database. Another option would be to use a tool like phpMyAdmin to manually make a backup. The documentation for your database will give more options. There are many ways to do such backups. Here is an outline of a little script you can run from command line on Unix to backup the database:

<pre>
cd /my/backup/directory
mv moodle-database.sql.gz moodle-database-old.sql.gz
mysqldump -h example.com -u myusername -p'mypassword' -C -Q -e --create-options mydatabasename > moodle-database.sql
</pre>
If you only write "-p" without your password, you will be prompted for it.

=== Restore the database backup to the new server ===

Copy the database back up files to the new server and restore into the new database server.

Once you have created the new database on the new server:

<pre>mysql -p new_database < moodle-database.sql</pre>

For other databases, follow their instructions for restoring a backup.

===Copy moodledata from the old server to the new server===

Copy the contents of your data directory (check for the value in <code>$CFG->dataroot</code>) to the new server. This can be a lot of data, so consider using a good data copying tool like rsync. If using an FTP client, the transfer of the <code>filedir</code> folder must be in '''BINARY''' mode or the files will get corrupted in the process.

NB: It is not necessary to copy the contents of the /moodledata/cache, /moodledata/localcache, /moodledata/sessions, /moodledata/temp, or /moodledata/trashdir directories. Omitting these files will reduce transfer time substantially.

Check the file permissions of the copied files. The web server needs read and write access.

===Copy the Moodle code from the old server to the new server===

You will need to copy the Moodle code itself to the new server (this is the Moodle folder found in your webroot folder e.g. /var/www or public_html).

Check the file permissions of the copied files. The web server needs read access.

===Update config.php with the URL of the new server===

If the migration will move Moodle to a new URL, then update $CFG->wwwroot in config.php to point to the new location.

Also check the other properties there. Is the path $CFG->moodledata still correct? Do the database connection settings need to be changed?

===Test the copied site===

You should now be able to log into the new site as admin, and verify that most things are working.

===Update links containing wwwroot in the database===

The one thing we have not fixed is any internal links stored in the database. To fix these use the [[Search and replace tool]] buy going to {wwwroot}/admin/tool/replace/index.php.

Enter the url for your old server (<nowiki>http://oldserver.com/</nowiki>) and new server (<nowiki>http://newserver.com/</nowiki>) and it will fix any links stored in the database.

===Take the site out of maintenance mode===

Test the migration some more, then when you are satisfied, remember to take the site out of maintenance mode.

==Quick and hacky method==

If you have shell access on both servers, here is a quick command-line based method.

*Set up a new empty database on the '''new''' server.
*Place your existing Moodle site into maintenance mode.
*Login to shell on the '''old''' existing server.
*Use rsync to copy '''moodledata''' and '''public_html''' or '''moodle''' folders (or whatever directory your Moodle install is in) to the new server - execute (replacing caps with your details; SOURCE = the directory you want to copy) for each directory:
::<code>rsync -av -e ssh SOURCE/ USERNAME@NEW_SERVER.COM:/PATH/TO/DESTINATION/</code>
*Dump existing database and move and import into database on new server by executing:
::<code>mysqldump --allow-keywords --opt -uMySQL_USERNAME -pPASSWORD DATABASE | ssh USER@DOMAIN "mysql -uMySQL_USERNAME -pPASSWORD DATABASE"</code>
*Replace any links in the database that contin the full site URL:
::<code>#sed -e 's/oldserver.com/newserver.com/g' oldmysqldump.sql > newmysqldump.sql</code>
*On the '''new server''', update '''config.php''' with relevant details where applicable (e.g. database name and user details, the wwwroot and the dataroot).
*Check ownership and permissions are correct on both moodle code and moodledata directories.
*Make sure everything is working.

Takes about 15 minutes for a small site. However, transferring several Gigabytes of data for a larger site can take hours depending on your network connection and hard drive read/write speed.

When you are happy all has gone well, set up redirects/make DNS changes if required, take new site out of maintenance mode and "switch off" old site.

*If you are switching the ip address from the old server to the new one, you will need to turn off the old server before firing up the new one to avoid ip addressing conflicts and confusion!

==Other considerations==

===Upgrade Moodle at the same time?===

While doing the work of migrating Moodle, you might want to [[Upgrading | upgrade Moodle]] to the latest version at the same time. On the other hand, if you do that, and something breaks, you won't be sure which change caused the problem, so the more cautious approach is to change one thing at a time, and test in between to verify that all is well.

===DNS & masquerading changes===

You may have had to change the DNS entries for the new Moodle site. If you have done so, it will take some time for the changes to replicate, so be patient. If your server is located behind a firewall, you may also have to change your firewall rules to allow access to the new server. See the [[Masquerading | masquerading docs]].

===Internal and external access===

If you have a set up where your Moodle site can be accessed via a network and via the internet, ensure you check that the new site can be accessed internally and externally.

===ReCAPTURE===
If you migrate to a new domain and have setup [[Email-based_self-registration]], you need to create new API-Keys at google. You will find the explanation and links to google in [[Email-based_self-registration]].

==See also==

* [[Site backup]]
* [[Site restore]]
* [[Backup and restore FAQ]]

==Any questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=28 Installing and upgrading help forum] on moodle.org

[[es:Migración de Moodle]]
[[fr:Migration de Moodle]]
[[ja:Moodle移行]]
[[de:Moodle-Migration]]

Activity completion settings

2016-11-10T16:14:18Z

Mattbury: /* Require passing grade */

{{Activity completion}}
==Activity settings==

Depending on the type of activity, there are different completion requirements. For example, a [[Page|Page]] might have the requirement to ''require view''; a [[Quiz|Quiz]] might have the requirement to ''require grade'' while a [[Forum|Forum]] might have the requirement to ''require posts/discussions/replies''.

<gallery widths="300px">
File:Activity_completion_settings_common.png|Common settings for most graded activities
File:Forumactivitycompletion.png|Forum activity settings
File:24assignmentsubmit.png|Assignment settings
</gallery>

===Completion tracking===
There are three options:

*''Do not indicate activity completion'' - this will not show checks (ticks) next to the activity
*''Students can manually mark the activity as completed'' - students press the check (tick) to change it. (Note: they can do this even without doing the activity!)
*''Show activity as complete when conditions are met'' - the selected completion criteria must be met before the check (tick) will change style

===Require view===

When this option is turned on, students have to view the activity in order to complete it.

* In most cases, clicking the link is enough to 'view' the activity.
* You should usually not turn on the 'view' condition if you have other requirements - this makes extra work for the server and it's unlikely that a student could meet any other conditions without viewing the activity.

===Require grade===

When this option is turned on, students have to get a grade on the activity in order to complete it. For example, a quiz would be marked completed as soon as the user submits it (so long as it doesn't contain any "essay" questions).

It does not matter how well the student did. Getting any grade will mark the activity completed.

====Setting a grade to pass for a quiz====

It is possible to distinguish between 'pass' and 'fail' grades so that a quiz becomes 'completed, passed' or 'completed, not passed' instead of just 'completed'. These results show a different icon and alternative text in ''Course administration >Reports >Activity completion:
''
[[File:quizpassfail.png|thumb|400px|center]]

To set this up, you need to specify the pass value for the quiz activity's individual grade:

# Go to the Quiz settings and in the Grade section, locate the 'Grade to pass' field.
# Enter a grade value (e.g. 5.0)
# Click the 'Save changes' button

'Completed, passed' shows a green tick and 'Completed, not passed' shows a red cross.

Once you have done this, anybody submitting the quiz will receive either the pass or fail completion icon. If the quiz can be taken multiple times, the completion icon will automatically update whenever the grade does.

There is one limitation: this only works if grades are immediately visible to students. The grade must be neither permanently hidden, nor hidden until a certain date. If a grade is hidden then only the standard 'completed' state will be displayed - even once the hidden date has passed.

====Require passing grade====

If a 'Grade to pass' is set for the quiz then it will be marked complete once the student obtains this grade. Please note that ''Require grade'' must also be checked or it will never register as completed.

====All available attempts completed====

If a certain number of attempts are allowed, the quiz may be marked complete once the student has done them all (even if, for example, they did not achieve the passing grade.)

===Quiz completion settings===

The following settings are specific to the quiz (in addition to the standard ones).
[[File:quizpassinggrade.png|thumb|500px|center]]

===Lesson completion settings===
The following settings are specific to the Lesson activity (in additon to the standard ones)

[[File:newlessonconditions.png]]

====Require end reached====
In order for the lesson to be marked complete, the student must go to the very last page of the lesson.

====Require time spent====
In order for the lesson to be marked complete, the student must stay within the lesson pages for the time specified by the teacher here. The time can range from seconds to weeks. If they finish the lesson sooner, they will see an alert saying they did not reach the minimum time acceptable and may have to repeat the lesson.

[[File:lessonstudentviewrequiretimespent.png|thumb|400px|center|Student message if the condition is not met.]]

===Assignment completion settings===

====Require grade ====

=====Student must receive a grade to complete this activity=====

If enabled, the activity is considered complete when a student receives a grade. This works the same way as the Quiz require grade setting does.

=====Student must submit to this activity to complete it=====
This setting means that an assignment may be considered as completed once the student has submitted it but before the teacher has had time to grade it.

===Forum completion settings===

====Require posts====
This setting is seen in forums. For the forum to be classed as "complete" the student must either start a discussion or reply to a discussion. The number of posts they must make can be specified in the box.

====Require discussions====
This setting is seen in forums. For the forum to be classed as "complete", the student must start a discussion topic. The number of posts they must make can be specified in the box.

====Require replies====
This setting is seen in forums. For the forum to be classed as "complete" the student must reply to a discussion. The number of posts they must make can be specified in the box.

===Expect completed on===

The date is not shown to students and is only displayed in the [[Activity completion report]].

==Locked completion options==

If at least one person has completed an activity, completion options are 'locked'. This is because changing these options may result in unexpected behaviour. For example, if somebody has ticked an activity as manually completed, and you then set it to automatic completion, the activity will become unticked - very confusing for the student who had already ticked it!

:''Tip:'' It is best not to unlock options unless you are sure it won't cause problems - for example, if you know that students don't have access to the course yet, so it will only be staff who have marked the activity completed when testing.

==What happens when you unlock==

Once you unlock options and then click 'Save changes', all completion information for the activity will be deleted and, if possible, regenerated according to the new settings.

* If the new completion option is manual, everyone will be set to 'not completed' regardless of any previous setting.
* If it is automatic then, depending on the options chosen, the system may or may not be able to construct a correct current value for everyone.
** The 'viewed' requirement will not work - even if a student has viewed the activity before, it will not be marked completed until they view it again.
** Most other options will be recalculated successfully.

If you change completion options while a student is logged in, they may not see the changes for some minutes.

==Required site settings==
To use activity completion, the feature needs to be enabled for the site by an administrator as follows:
*In ''Administration > Site administration > [[Advanced_features| Advanced features]]'' check the "Enable completion tracking" box.
*The admin may also set the default completion tracking setting when adding new activities, choosing from 'Do not indicate completion' or ' Use activity default'
{|
|[[File:26defaultactivtycompletion.png|thumb|Selecting the default completion tracking setting]]
|}

* Click the 'Save changes' button

==Required course settings==

''Administration > Course administration > Edit settings'' and look for the ''Completion tracking'' section.

You must enable this setting.

[[Category: Completion]]

[[de:Einstellungen zum Aktivitätsabschluss]]
[[es:Configuraciones de finalización de actividad]]

Chat settings

2016-02-25T15:05:49Z

Mattbury: /* Chat server daemon */

{{Chat}}

==Adding a Chat to your course==

*With the editing turned on,in the section you wish to add your chat, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu )and choose ''Chat'' All settings may expanded by clicking the "Expand all" link top right.

===General===
{|
|[[File:chatgeneral26.png|General settings expanded by default]]
|}

===Name of this chat room===
*Whatever you type here will form the link learners click on to enter the chat so it is helpful to give it a name that suggests its purpose - for example "Student council discussion" or "Field trip planning meeting".

===Description===
Type the description of the chat here. Include precise instructions for students regarding the subject of the chat. Click the icon on the left to expand the toolbar, and drag the bottom right of the text box out to expand it.

===Display description on course page===
If this box is ticked, the description will appear on the course page just below the name of the Chat.

==Chat sessions==
(These settings are collapsed by default.)

{|
|[[File:chatsessions25.png|thumb|450px|Chat sessions settings expanded.]]
|}
===Next chat time===

*The day and hour of the next chat session. This will appear in the calendar so students know the schedule but it doesn't stop them accessing the chatroom at any other time.
*If you don't want them in the chatroom at other times, then hide it (with the eye icon) or use [[Conditional activities]] to restrict access.
*If you don't wish to schedule chat times then ignore this and choose from the next settings.

'''Note:'''For courses involving users across different time zones, it is useful to know that the time you set here will be adjusted to match the time zone of the user viewing it.

===Repeat/publish sessions===

*There are four options for scheduling future chat sessions:

# '''Don't publish any chat times'''- there are no set times and students are welcome to chat at any time.
# '''No repeats - publish the specified time only'''- only the Next chat time will be published. This could be used to schedule special events or meetings or simply to help learners identify a common time in which they can expect to find other learners in the chat room.
# '''At the same time every day'''- Daily chats are useful for scheduling daily office hours or work sessions with learners.
# '''At the same time every week'''--This setting will schedule a chat for the same day and time every week, which could be useful for instance for meeting and reviewing key ideas and questions related to the week’s content/assessment.

===Save past chat sessions===

*Choose from the dropdown how many days to save - or save everything by selecting ''Never delete messages''
*If you have any concerns about discussions that might take place in your chat room, you may want to keep transcripts to check the suitablility of what is discussed. If your learners are using the chatroom to collaborate on a group project you won't want to delete the messages until the project is complete.

===Everyone can view past sessions===

*Decide here whether or not allow everyone to view past chat sessions. (Teachers can always view past sessions)

==Common module settings==
(These settings are collapsed by default.)

See [[Common module settings]]

==Restrict access/Activity completion==
(These settings are collapsed by default)

These settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.

==Locally assigned roles==

*In ''Administration > Chat administration > Locally assigned roles'' selected users can be given additional roles in the activity, such as the capability to delete chat logs.

*Role permissions for the activity can be changed in ''Administration > Chat administration > Permissions''.

==Site administration settings==

The chat module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Chat''. They depend on the chat method which has been selected:

[[File:Chatmethod.png]]

===Ajax===
*This is the default method. It works everywhere but if many people are chatting it can put a large load on the server. Its particular settings are:
**'''Refresh user list''' - choose the number of seconds after which the user list is refreshed
**'''Disconnect timeout''' - choose the number of seconds after which we detect a user has disconnected.

===Normal method===
*The particular settings for this method are:
**'''Refresh room''' - choose the number of seconds after which the room is refreshed
**'''Update method''' - choose how to update the chatroom - "Keep alive" or "Stream" strategy. Stream works better but your sever might not support it.

===Chat server daemon===
*A daemon is a program that runs all the time in the background. In this case it's a PHP script, listening to a particular port on your server, accepting and giving out chat information.If you intend to use the chat activity a lot, then you should consider using a chat server daemon to reduce server load.Its particular settings are:
**Server name
**Server IP address
**Server port
**Max users

Then you need to start the chat daemon script from the command line:

cd moodle/mod/chat
php chatd.php --start &

How to stop the chat daemon script:

Moodle staff, please give details!

One option is to restart the server via the command line:

sudo reboot

==Chat capabilities==

*[[Capabilities/mod/chat:chat|Access a chat room]]
*[[Capabilities/mod/chat:deletelog|Delete chat logs]]
*[[Capabilities/mod/chat:exportparticipatedsession|Export chat session which you took part in]]
*[[Capabilities/mod/chat:exportsession|Export any chat session]]
*[[Capabilities/mod/chat:readlog|Read chat logs]]
*[[Capabilities/mod/chat:addinstance|Add a new chat]]

==See also==
* [http://youtu.be/TFRCZ21tvNk The Chat actvitiy in Moodle 2.x] MoodleBites video on YouTube

[[de:Chat konfigurieren]]
[[fr:Ajouter/modifier un chat]]
[[es:Configuraciones de chat]]

Chat settings

2016-02-25T15:03:25Z

Mattbury: /* Chat server daemon */

{{Chat}}

==Adding a Chat to your course==

*With the editing turned on,in the section you wish to add your chat, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu )and choose ''Chat'' All settings may expanded by clicking the "Expand all" link top right.

===General===
{|
|[[File:chatgeneral26.png|General settings expanded by default]]
|}

===Name of this chat room===
*Whatever you type here will form the link learners click on to enter the chat so it is helpful to give it a name that suggests its purpose - for example "Student council discussion" or "Field trip planning meeting".

===Description===
Type the description of the chat here. Include precise instructions for students regarding the subject of the chat. Click the icon on the left to expand the toolbar, and drag the bottom right of the text box out to expand it.

===Display description on course page===
If this box is ticked, the description will appear on the course page just below the name of the Chat.

==Chat sessions==
(These settings are collapsed by default.)

{|
|[[File:chatsessions25.png|thumb|450px|Chat sessions settings expanded.]]
|}
===Next chat time===

*The day and hour of the next chat session. This will appear in the calendar so students know the schedule but it doesn't stop them accessing the chatroom at any other time.
*If you don't want them in the chatroom at other times, then hide it (with the eye icon) or use [[Conditional activities]] to restrict access.
*If you don't wish to schedule chat times then ignore this and choose from the next settings.

'''Note:'''For courses involving users across different time zones, it is useful to know that the time you set here will be adjusted to match the time zone of the user viewing it.

===Repeat/publish sessions===

*There are four options for scheduling future chat sessions:

# '''Don't publish any chat times'''- there are no set times and students are welcome to chat at any time.
# '''No repeats - publish the specified time only'''- only the Next chat time will be published. This could be used to schedule special events or meetings or simply to help learners identify a common time in which they can expect to find other learners in the chat room.
# '''At the same time every day'''- Daily chats are useful for scheduling daily office hours or work sessions with learners.
# '''At the same time every week'''--This setting will schedule a chat for the same day and time every week, which could be useful for instance for meeting and reviewing key ideas and questions related to the week’s content/assessment.

===Save past chat sessions===

*Choose from the dropdown how many days to save - or save everything by selecting ''Never delete messages''
*If you have any concerns about discussions that might take place in your chat room, you may want to keep transcripts to check the suitablility of what is discussed. If your learners are using the chatroom to collaborate on a group project you won't want to delete the messages until the project is complete.

===Everyone can view past sessions===

*Decide here whether or not allow everyone to view past chat sessions. (Teachers can always view past sessions)

==Common module settings==
(These settings are collapsed by default.)

See [[Common module settings]]

==Restrict access/Activity completion==
(These settings are collapsed by default)

These settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.

==Locally assigned roles==

*In ''Administration > Chat administration > Locally assigned roles'' selected users can be given additional roles in the activity, such as the capability to delete chat logs.

*Role permissions for the activity can be changed in ''Administration > Chat administration > Permissions''.

==Site administration settings==

The chat module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > Chat''. They depend on the chat method which has been selected:

[[File:Chatmethod.png]]

===Ajax===
*This is the default method. It works everywhere but if many people are chatting it can put a large load on the server. Its particular settings are:
**'''Refresh user list''' - choose the number of seconds after which the user list is refreshed
**'''Disconnect timeout''' - choose the number of seconds after which we detect a user has disconnected.

===Normal method===
*The particular settings for this method are:
**'''Refresh room''' - choose the number of seconds after which the room is refreshed
**'''Update method''' - choose how to update the chatroom - "Keep alive" or "Stream" strategy. Stream works better but your sever might not support it.

===Chat server daemon===
*A daemon is a program that runs all the time in the background. In this case it's a PHP script, listening to a particular port on your server, accepting and giving out chat information.If you intend to use the chat activity a lot, then you should consider using a chat server daemon to reduce server load.Its particular settings are:
**Server name
**Server IP address
**Server port
**Max users

Then you need to start the chat daemon script from the command line:

cd moodle/mod/chat
php chatd.php --start &

How to stop the chat daemon script:

Moodle staff, please give details!

==Chat capabilities==

*[[Capabilities/mod/chat:chat|Access a chat room]]
*[[Capabilities/mod/chat:deletelog|Delete chat logs]]
*[[Capabilities/mod/chat:exportparticipatedsession|Export chat session which you took part in]]
*[[Capabilities/mod/chat:exportsession|Export any chat session]]
*[[Capabilities/mod/chat:readlog|Read chat logs]]
*[[Capabilities/mod/chat:addinstance|Add a new chat]]

==See also==
* [http://youtu.be/TFRCZ21tvNk The Chat actvitiy in Moodle 2.x] MoodleBites video on YouTube

[[de:Chat konfigurieren]]
[[fr:Ajouter/modifier un chat]]
[[es:Configuraciones de chat]]

Location

2016-01-07T22:34:56Z

Mattbury: /* GeoIP City data file */

{{Managing a Moodle site}}
==Location settings==
An administrator can change the following location settings in ''Administration > Site administration > Location > Location settings''.

===Time zone settings===

The time zone is used to help convert the raw timestamps in the database to human readable dates and times, for the user who is requesting the page.

====Default time zone====
Use this to set the default time zone for your site. This should be the time zone that most users use, or if that is difficult, where you When available, choose the Area/Location that is proper for you rather than use the UTC settings. These [http://en.wikipedia.org/wiki/Tz_database names are standardized by the IANA].

Note: As of Moodle 2.9, the older setting and button to allow you to update time zone codes from Moodle.org has been replaced with standard PHP date and time code. If your PHP version is over 6 months old, time zone data should be updated using the [http://pecl.php.net/package/timezonedb PECL timezonedb package].

====Force timezone====
If a particular time zone is forced, users will see the name of the time zone on their edit profile page and will be not be able to change it. If you wish to allow individual users to choose their own time zone, leave this at the default "Users can choose their own time zone."

====Default country====
Select the country to appear by default on a new user account page form.

==== Default city====
Enter a default city for new user profiles. This may be left blank.

===IP address lookup===
====GeoIP City data file====
Location of GeoIP City binary data file. This is a non-invasive way to determine geographical and other information about Internet visitors in real-time. This file is not part of Moodle distribution and must be obtained separately from MaxMind. There is a GeoIPLite version for free at [http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz]. Extract the GeoLietCity.dat file and upload it to /moodledata/geoip/GeoLiteCity.dat.

You can check to see if the GeoIP data file is available to Moodle by going to: Administration > Site administration > Location > Location settings, under IP Address Lookup.

====Google Maps API key====
Google Maps for IP address lookup visualization key. The Google Maps API lets you embed Google Maps with JavaScript. This is free.

'''NOTE:''' There is no longer support for Google maps API V2 as it has been deprecated since 2010. V3 is now used. See here for details: https://developers.google.com/maps/documentation/javascript/tutorial#api_key

After updating the information in this section, IPs that are displayed as a link, such as in reports, when clicked will open new window with a Google Map indicating the location of the IP, if found and if not a private address.

====All country codes====
This is the list of countries that may be selected in various places, for example in a user's profile. If blank (the default) the list in countries.php in the standard English language pack is used. Otherwise, you can specify a comma-separated list of codes, for example 'GB,FR,ES' in [http://en.wikipedia.org/wiki/ISO_3166-1 ISO-3166-1 format].

[[es:Localización]]
[[eu:Kokagunea]]
[[de:Lokales]]

Location

2016-01-07T22:34:26Z

Mattbury: /* GeoIP City data file */

{{Managing a Moodle site}}
==Location settings==
An administrator can change the following location settings in ''Administration > Site administration > Location > Location settings''.

===Time zone settings===

The time zone is used to help convert the raw timestamps in the database to human readable dates and times, for the user who is requesting the page.

====Default time zone====
Use this to set the default time zone for your site. This should be the time zone that most users use, or if that is difficult, where you When available, choose the Area/Location that is proper for you rather than use the UTC settings. These [http://en.wikipedia.org/wiki/Tz_database names are standardized by the IANA].

Note: As of Moodle 2.9, the older setting and button to allow you to update time zone codes from Moodle.org has been replaced with standard PHP date and time code. If your PHP version is over 6 months old, time zone data should be updated using the [http://pecl.php.net/package/timezonedb PECL timezonedb package].

====Force timezone====
If a particular time zone is forced, users will see the name of the time zone on their edit profile page and will be not be able to change it. If you wish to allow individual users to choose their own time zone, leave this at the default "Users can choose their own time zone."

====Default country====
Select the country to appear by default on a new user account page form.

==== Default city====
Enter a default city for new user profiles. This may be left blank.

===IP address lookup===
====GeoIP City data file====
Location of GeoIP City binary data file. This is a non-invasive way to determine geographical and other information about Internet visitors in real-time. This file is not part of Moodle distribution and must be obtained separately from MaxMind. There is a GeoIPLite version for free at [http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz]. Extract the GeoLietCity.dat file and upload it to /moodledata/geoip/GeoLiteCity.dat.

You can check to see if the GeoIP data file is available to Moodle by going to: Administration > Site administration > Location > Location settings, under IP Address Lookup.

====Google Maps API key====
Google Maps for IP address lookup visualization key. The Google Maps API lets you embed Google Maps with JavaScript. This is free.

'''NOTE:''' There is no longer support for Google maps API V2 as it has been deprecated since 2010. V3 is now used. See here for details: https://developers.google.com/maps/documentation/javascript/tutorial#api_key

After updating the information in this section, IPs that are displayed as a link, such as in reports, when clicked will open new window with a Google Map indicating the location of the IP, if found and if not a private address.

====All country codes====
This is the list of countries that may be selected in various places, for example in a user's profile. If blank (the default) the list in countries.php in the standard English language pack is used. Otherwise, you can specify a comma-separated list of codes, for example 'GB,FR,ES' in [http://en.wikipedia.org/wiki/ISO_3166-1 ISO-3166-1 format].

[[es:Localización]]
[[eu:Kokagunea]]
[[de:Lokales]]

Installing plugins

2014-03-11T16:39:03Z

Mattbury: /* =A file permissions error has occurred */

{{Installing Moodle}}
An add-on is an optional plugin for adding additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

==What is meant by the words 'plugin' and 'add-on'?==

Moodle = core code + plugins

Plugins may be either standard plugins (included in the Moodle download package) or add-ons.

== Considerations for production sites (skip if you're just moodling) ==

'''VERY IMPORTANT''' Warning: Please be aware that some add-ons have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. This is however improving over time with the evolving new plugins directory system.

* If you have a large site for production purposes consider if you '''really''' need the add-on? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the add-on supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the add-on does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches'' ([https://moodle.org/plugins/browse.php?list=category&id=38 Moodle Plugins Directory Other category]) ! If an add-on modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.

==Installing an add-on==

To install an add-on, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the add-on code can be deployed into Moodle.

In Moodle 2.5 onwards, an add-on code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new add-on is to be installed in order to use either of these methods.

Alternatively, an add-on code may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Administration > Site administration > Plugins > Install add-ons''.
# Click the button 'Install add-ons from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'.

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select your current Moodle version, then choose an add-on with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install add-ons''.
# Upload the ZIP file, select the appropriate plugin type, tick the acknowledgement checkbox, then click the button 'Install add-on from the ZIP file'.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'.

{|
| [[File:install add-ons.png|thumb|Install add-ons]]
| [[File:add-on package validation.png|thumb|Add-on package validation]]
|}

For both of the above methods, after clicking the button 'Install add-on', you will then be automatically redirected to ''Settings > Site administration > Notifications'' and the installation process (i.e. creating required database tables etc) will happen.

===Installing manually at the server===

If you can't deploy the add-on code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the add-on type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory], select Moodle 2.6 as version, then choose an add-on with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow add-on instructions).
# In your Moodle site (as admin) go to ''Settings > Site administration > Notifications'' (you should, for most plugin types, get a message saying the add-on is installed).

Note: The add-on may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this add-on have a coding problem. If you delete the ''plugin_name/lang/other_language_different_to_English/'' folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===A file permissions error has occurred===

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are mostl likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the add-on in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name then it won't work.

===Obtaining help===

Ask in the appropriate forum in [http://moodle.org/course/view.php?id=5 Using Moodle]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the add-on you downloaded (some have very similar names).

==Uninstalling an add-on==

To uninstall an add-on
# Go to ''Administration> Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the add-on you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

==Plugins overview==

[[File:plugins overview.png|thumb|left|Plugins overview highlighting available update with install button]]The Plugins overview page in ''Administration > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number, availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available to standard plugins or add-ons installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing add-ons from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

// Use the following flag to completely disable the On-click add-on installation
// feature and hide it from the server administration UI.
//
// $CFG->disableonclickaddoninstall = true;

==See also==

* [[Notifications]] for further details of update notifications
* [[Add-on Review Criteria]]
* [[Add-on FAQ]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=44 General add-ons forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]
* [http://www.somerandomthoughts.com/blog/2013/05/07/managing-add-ons-in-moodle-2-5/ Managing add-ons in Moodle 2.5] blog post by Gavin Henrick

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalando plugins]]

Installing plugins

2014-03-11T16:38:39Z

Mattbury: /* Troubleshooting */

{{Installing Moodle}}
An add-on is an optional plugin for adding additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.

==What is meant by the words 'plugin' and 'add-on'?==

Moodle = core code + plugins

Plugins may be either standard plugins (included in the Moodle download package) or add-ons.

== Considerations for production sites (skip if you're just moodling) ==

'''VERY IMPORTANT''' Warning: Please be aware that some add-ons have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. This is however improving over time with the evolving new plugins directory system.

* If you have a large site for production purposes consider if you '''really''' need the add-on? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
* Is the add-on supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
* If the add-on does not work in a future version of Moodle, what will you do about it?
* Beware of ''patches'' ([https://moodle.org/plugins/browse.php?list=category&id=38 Moodle Plugins Directory Other category]) ! If an add-on modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.

==Installing an add-on==

To install an add-on, its source code must be put (deployed) into the appropriate location inside the Moodle installation directory and the main administration page ''Administration > Site administration > Notifications'' must be visited. There are three ways how the add-on code can be deployed into Moodle.

In Moodle 2.5 onwards, an add-on code may be deployed from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. The web server process has to have write access to the plugin type folder where the new add-on is to be installed in order to use either of these methods.

Alternatively, an add-on code may be deployed manually at the server.

===Installing directly from the Moodle plugins directory===

# Login as an admin and go to ''Administration > Site administration > Plugins > Install add-ons''.
# Click the button 'Install add-ons from Moodle plugins directory'.
# Search for a plugin with an Install button, click the Install button then click Continue.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'.

===Installing via uploaded ZIP file===

# Go to the [https://moodle.org/plugins Moodle plugins directory], select your current Moodle version, then choose an add-on with a Download button and download the ZIP file.
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install add-ons''.
# Upload the ZIP file, select the appropriate plugin type, tick the acknowledgement checkbox, then click the button 'Install add-on from the ZIP file'.
# Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'.

{|
| [[File:install add-ons.png|thumb|Install add-ons]]
| [[File:add-on package validation.png|thumb|Add-on package validation]]
|}

For both of the above methods, after clicking the button 'Install add-on', you will then be automatically redirected to ''Settings > Site administration > Notifications'' and the installation process (i.e. creating required database tables etc) will happen.

===Installing manually at the server===

If you can't deploy the add-on code via the administration web interface, you have to copy it to the server file system manually (e.g. if the web server process does not have write access to the Moodle installation tree to do this for you).

First, establish the correct place in the Moodle code tree for the add-on type. Common locations are:

* /path/to/moodle/theme/ - themes
* /path/to/moodle/mod/ - activity modules and resources
* /path/to/moodle/blocks/ - sidebar blocks
* /path/to/moodle/question/type/ - question types
* /path/to/moodle/course/format/ - course formats
* /path/to/moodle/admin/report/ - admin reports

See [[:dev:Plugins]] for the full list of all plugin types and their locations within the Moodle tree.

# Go to the [https://moodle.org/plugins Moodle plugins directory], select Moodle 2.6 as version, then choose an add-on with a Download button and download the ZIP file.
# Upload or copy it to your Moodle server.
# Unzip it in the right place for the plugin type (or follow add-on instructions).
# In your Moodle site (as admin) go to ''Settings > Site administration > Notifications'' (you should, for most plugin types, get a message saying the add-on is installed).

Note: The add-on may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface. If you get a "Database error" when you try to edit your language files, there is a strong chance that the language files included within the downloaded ZIP file of this add-on have a coding problem. If you delete the ''plugin_name/lang/other_language_different_to_English/'' folder with the new language strings and the database error disappears, this is indeed the case. Please notify the plugin maintainer, so that it can be fixed in future releases.

==Troubleshooting==

===Errors===

If you obtain an error, please [[Debugging|turn debugging on]] to obtain additional information about the cause of the error.

;tool_installaddon/err_curl_exec - cURL error 60 : This suggests problems with the validation of the SSL certificate of the remote (moodle.org) site. This is also a known problem in Moodle Windows 7 servers running the Moodle package for Windows. See [[SSL certificate for moodle.org]] for more info and possible solutions.

===A file permissions error has occurred==

A common error after installing plugins is that when you create an instance of the module and then save and display it, it reports the error, "A file permissions error has occurred. Please check the permissions on the script and the directory it is in and try again." If you get this, the file permissions of the package are mostl likely set to 711 preventing them from running correctly. With your preferred FTP client or via your web hosts control panel, set the file permissions of all the files and directories in the installed module, e.g. /moodle/mod/[myplugin]/ to 755 and then see if you can successfully view the module instance.

===When installing manually===

* Check the file permissions. The web server needs to be able to read the plugin files. If the the rest of Moodle works then try to make the plugin permissions and ownership match.
* Did you '''definitely''' unzip or install the add-on in the correct place?
* Because Moodle scans plugin folders for new plugins you cannot have any other files or folders there. Make sure you deleted the zip file and don't try to rename (for example) an old version of the plugin to some other name - it will break.
* Make sure the directory name for the plugin is correct. All the names '''have''' to match. If you change the name then it won't work.

===Obtaining help===

Ask in the appropriate forum in [http://moodle.org/course/view.php?id=5 Using Moodle]. Make sure you describe your system (including versions of MySQL, PHP etc.), what you tried and what happened. Copy and paste error messages exactly. Provide the link to the version of the add-on you downloaded (some have very similar names).

==Uninstalling an add-on==

To uninstall an add-on
# Go to ''Administration> Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the add-on you wish to remove
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration

==Plugins overview==

[[File:plugins overview.png|thumb|left|Plugins overview highlighting available update with install button]]The Plugins overview page in ''Administration > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number, availability (enabled or disabled) and settings link (if applicable).

A 'Check for available updates' button enables admins to quickly check for any updates available to standard plugins or add-ons installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.

===Plugin updating from within Moodle===

In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details.

==Preventing installing add-ons from within Moodle==

If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.

// Use the following flag to completely disable the On-click add-on installation
// feature and hide it from the server administration UI.
//
// $CFG->disableonclickaddoninstall = true;

==See also==

* [[Notifications]] for further details of update notifications
* [[Add-on Review Criteria]]
* [[Add-on FAQ]]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=44 General add-ons forum]
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]]
* [http://www.somerandomthoughts.com/blog/2013/05/07/managing-add-ons-in-moodle-2-5/ Managing add-ons in Moodle 2.5] blog post by Gavin Henrick

For developers:

*[[:dev:Category:Plugins|Plugins developer documentation]]
*[[:dev:Plugin validation]]
*[[:dev:On-click add-on installation]]

[[Category:Contributed code]]

[[de:Plugins installieren]]
[[es:Instalando plugins]]

User:Matt Bury

2013-06-27T13:42:34Z

Mattbury: /*About Matt Bury*/

Hi,

I'm Matt Bury. I've developed two plugins for Moodle...

The SWF Activity Module: https://code.google.com/p/swf-activity-module/

and the Media Player module: https://code.google.com/p/moodle-mplayer/

My About Me page is at http://blog.matbury.com/about-matt-bury/

Using Forum

2013-06-27T13:23:04Z

Mattbury: /* Best Practice and shared discussions */

{{Forum}}
The teacher can set the format of what the student sees under the introduction by selecting the forum type in [[Forum settings]].

==Views==

===A single simple discussion===

Students will see the text you have placed in the [[Adding/editing_a_forum#Forum_introduction|Forum introduction setting]] as the first post of the discussion. Below you will find the replies that have been posted. In the example below, the student sees that their reply was rated.

{|
| [[File:Forum homepage view Simple student mu.png|thumb|Student view of "A single simple discussion" forum type]]

|}

===Each person posts one discussion===
The view will be basically the same as in the previous case, the only difference being the 'Add a new discussion' option. Viewing a forum page, the student will see the text you have written at the 'Forum introduction' space while creating the forum, and, if there are any, the discussions that have been started.

{|
| [[File:Forum homepage view Single student mu.png|thumb|Student view of "Each person posts one discussion" forum type]]

|}

===Standard forum for general use===

In this forum type, students will see the introduction text in a separate space above the discussion field, in which you will see the information such as the title of the discussion (which means the forum's title), its author, the number of replies and the date of the last post.

{|
| [[File:Forum homepage view student mu.png|thumb|Student view of "Standard forum" type]]

|}

===Question and Answer forum===

The Q & A forum is best used when you have a particular question that you wish to have answered. In a Q and A forum, teachers post the question and students respond with possible answers. By default a Q and A forum requires students to post once before viewing other students' postings. [[Using Forum#Question and Answer forum 2 |More details here]]

{|
| [[File:QA1.png|thumb|Inital view of Q&A forum]]
| [[File:QA2.png|thumb|Students cannot see posts until they post]]
| [[FIle:QA3.png|thumb|Other posts visible when editing time is over]]
|}

===Standard forum displayed in blog-like format===

{|
| [[File:Bloglikeforum.png|thumb|Blog like forum]]

|}

In the upper right corner of the home forum screen (above the introduction), the student may see the options the teacher has set for [[Adding/editing_a_forum#Force_everyone_to_be_subscribed.3F|subscriptions to the forum]], and the 'Jump to' field, with which you can 'jump' to any part of the course. This is also place where the teacher will find the "Update this forum" button.

==Display options==
[[Image:forumviewoptions.jpg|thumb|Reply display options]]A discussion thread may be displayed in four ways. Use the pull down menu at the top of each forum discussion to select a display type.

* Display replies flat, with oldest first
* Display replies flat, with newest first - The discussion will be displayed in one line and the chronological order from the newest to the oldest. This is the same as the above, just a different sort order.
* Display replies in threaded form - Only the post starting the discussion will be displayed in its full form; replies will be reduced to the headlines (including information about its author and date of release) and organized chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.
* Display replies in nested form - All posts are displayed in their full forms; replies will be reduced to the headlines (including information about its author and date of release) and organized chronologically; moreover, replies will be shifted towards the right so that only replies to the same post were in the same line.

{|
| [[Image:Forum Flat form mu.png|thumb|Flat Forum discussion, example from middle]]
| [[Image:Forum threaded form mu.png|thumb|Posts in threaded form]]
| [[Image:Forum nested form mu.png|thumb|"Nested reply example"]]
|}

==Forum posting==

The default content of '''Subject''' is usually 'Re: <the name of the 'parent' post>'. You can change it though.

When writing text in Moodle there are several formats you can choose to produce your text, depending on your expertise and the type of browser you are using. Please refer to [[Formatting text]] for further information.

=== Sharing images through forums ===

*When an image is "attached" as a file to a forum message, it is immediately displayed full size after the message (i.e. no need to click on an attachment). This an excellent way of sharing images without having to go through the process of uploading them as files and linking them from within web pages.

*Images may be dragged and dropped into the box as well as uploading via the "add" link and the [[File picker]].

[[File:forumdragdrop.png]]

===Sharing sound and video through forums===
*If multimedia filters are enabled, a sound file (mp3) or accepted video file can be attached and it will be embedded into the forum post in an appropriate player.
*As with images in the previous section, multimedia files may be dragged and dropped from the desktop instead of uploaded via the [[File picker]].

===Post length===

Extra-long posts cause problems when doing a forum search and can be difficult to read on screen. Rather than creating a very long post, consider copying and pasting the text into a text file and add it as an attachment to your forum post.

===Post editing time limit===

There is a time limit for editing posts, usually 30 minutes. It is set by an administrator in ''Administration > Security > [[Site policies]]''.

The Using Moodle forum discussion [http://moodle.org/mod/forum/discuss.php?d=5367 The philosophy underlying "no editing after 30 minutes"] includes reasons why it is a good idea to have a time limit for editing posts.

===Mail now===

A mail now checkbox is available for anyone with the [[Capabilities/moodle/course:manageactivities|capability to manage course activities]], normally teachers and admins.

Checking the "Mail now" box results in an email being sent immediately (i.e. when the [[Cron|cron]] next runs) to everyone subscribed to the forum, rather than after the post editing time limit.

==Exporting forum posts==
Users with the ''mod/forum:exportdiscussion'' or ''mod/forum:exportownpost'' or ''mod/forum:exportpost'' permission can export forum posts to any portfolio the administrator has enabled:

[[File:Exportforum.png]]

==Moving a discussion==

Teachers and other users with the [[Capabilities/mod/forum:movediscussions|capability to move discussions]] can move a discussion to any other forum in the course for which they have appropriate rights.
# Click on the arrow in the 'Move this discussion to...' dropdown menu in the top right corner of the page and select a destination forum.
# Click the Move button.

NOTE: Moving a forum post will display incorrect results in the [[Participation_report|course participation report]] for the affected forums. For example, take a student who posted in forum A and had their post moved to forum B. In the course participation report the student will still be listed has having made a post in forum A, but will not be listed as having made a post yet in forum B.

==Guidelines for Teaching and Learning Forums==

When you decide to use a discussion forum as an activity in an e-learning environment, it is important to be aware that your time will be needed in some sense in order to make the activity successful. If your goal is to encourage discussion, the forum will only work if:

a) '''participants feel there is a need/reason to participate and they will gain something from the experience.''' Incentives for learning, gathering support, etc. should be explored and encouraged early on in order to clearly convey the purpose of the forum to others. Anyone considering offering grades or marks for participation is advised to think very carefully about the difference between quantity and quality of discussions in forums.

b) a sense of community and purpose can be fostered amongst participants. This sense of community can be fostered through tutor/teacher initiative and scaffolding, or primarily through the students/participants themselves depending on the intentions of the activity.

==Selecting forum type==

Moodle has four kinds of forums each with a slightly different [[Viewing a forum|layout]] and purpose.

Which of the forums will best suit your needs for a particular activity? In order to answer this question, it is useful to think how you might lead such a discussion in a face-to-face environment. Would you throw the question out to the class and sit back to observe them in their answers? Or would you break them up into smaller groups first and ask them to have discussions with a partner before bringing them back to the main group? Or perhaps you would like to keep them focused on a particular aspect of a question and ensure that they do not wander away from the topic at hand? All of the above approaches are both valid and useful, depending on your learning outcomes, and you can replicate all of them in Moodle forums.

===A standard forum for general use===
The standard forum ([[Viewing_a_forum#Standard_forum_for_general_use|view here]]) probably most useful for large discussions that you intend to monitor/guide or for social forums that are student led. This does not mean that you need to make a new posting for each reply in each topic, although, in order to ensure that the discussion does not get 'out of control', you may need to be prepared to spend a significant amount of time finding the common threads amongst the various discussions and weaving them together. Providing overall remarks for particular topics can also be a key aspect of your responsibilities in the discussion. Alternatively, you could ask students to summarize discussion topics at agreed points, once a week or when a thread comes to an agreed conclusion. Such a learner-centred approach may be particularly useful once the online community has been established and, perhaps, when you have modeled the summarizing process.

===A single simple discussion===
The simple forum ([[Viewing_a_forum#A_single_simple_discussion|view here]]) is most useful for short/time-limited discussion on a single subject or topic. This kind of forum is very productive if you are interested in keeping students focused on a particular issue.

===Each person posts one discussion===
This forum ([[Viewing_a_forum#Each_person_posts_one_discussion|view here]]) is most useful when you want to achieve a happy medium between a large discussion and a short and focused discussion. A single discussion topic per person allows students a little more freedom than a single discussion forum, but not as much as a standard forum where each student can create as many topics as he or she wishes. Successful forums of this selection can be active, yet focused, as students are not limited in the number of times they can respond to others within threads.

===Question and Answer forum===
The Q & A forum ([[Viewing_a_forum#Question_and_Answer_forum|view here]]) is best used when you have a particular question that you wish to have answered. In a Q and A forum, tutors post the question and students respond with possible answers. By default a Q and A forum requires students to post once before viewing other students' postings. After the initial posting and once the editing time (usually 30 minutes) has elapsed, students can view and respond to others' postings. This feature allows equal initial posting opportunity among all students, thus encouraging original and independent thinking.

''Note:'' Students do not see the "add a new question" button in the Q & A forum. If you wish students to be able to add new questions, they need to be given the capability [[Capabilities/mod/forum:addquestion|mod/forum:addquestion]]

===Standard forum displayed in blog-like format===
This forum behaves in the same way as the default standard forum for general use, allowing users to start their own discussions. However, it displays differently in that the first post of each discussion is displayed (as in a blog) so that users can read it and then choose to respond by clicking the "Discuss this topic" button bottom right of the post.

====Tips for Question and Answer====
When the Question and Answer mode is selected, Moodle hides the replies to the initial thread post by the teacher but not the entire forum itself.

:''Tip:'' Post each question as a thread in the forum and then have students post replies to the question. In this fashion, Moodle will protect the replies from being viewable (subject to the caveat above) by other students but allow the initial post/thread visible for reply by all students.

:''Tip:'' Do not post the question in the forum summary because every student answer will become a thread and visible to all students. In this scenario, it may appear as if the Question and Answer forum is not working correctly, since the new initial posts in the thread are intentionally designed not to be hidden, just their replies.

:''Tip:'' If you have set up groups for your forum the facilitator needs to post a question to each of the groups and not to 'all participants' as questions asked of all participants (students) are able to be read by ALL students. Questions posed to group members are only visible to those group members and replies are only visible once a group member has posted a message.

==Forum subscription==

When a person is '''subscribed''' to a forum it means that they will be notified (according to their [[Messaging settings]] preferences) of every subsequent post in that forum. Posters have 30 minutes by default to edit their post before it is sent though this time limit can be changed by an administrator.

People can usually choose whether or not they want to be subscribed to each forum. However, if a teacher forces subscription on a particular forum then this choice is taken away and everyone in the class will get notified.This is especially useful in the News forum and in forums towards the beginning of the course (before everyone has worked out that they can subscribe to these emails themselves).

Note that even if you force subscriptions every user can elect not to be notified in [[Messaging settings]], or elect to have all email sent once a day in a digest contain either all posts or simply the subject headings.

Choosing ''Everyone can choose to be subscribed'' enables you to check (and modify) the number of subscribers (''Settings > Forum administration > Show/edit current subscribers'') and to subscribe to (or unsubscribe from) the forum ('Subscribe to this forum' / 'Unsubscribe from this forum').

An overview of your forum subscriptions is available on the forums index page e.g. http://moodle.org/mod/forum/index.php?id=5

==Concepts for use in forums==
===Participation and Scaffolding ===

Whilst one of the great advantages of e-learning is the flexibility it affords participants, this does not mean that days or weeks should pass without response and discussion in a forum (unless it is appropriate for it to do so). This is perhaps most especially true at the beginning of a course or programme when students and tutors are new to each other and in need of welcome messages/encouragement. Whilst e-learning, and discussions in particular, can support learning that is not always tutor/teacher-centred, your role will be important, especially as an online community begins to develop. It is during these initial stages of introductory material that a group of students can become a community of participants who begin to grow in their understandings of course material and individual contributions to the knowledge construction process.

As the discussions progress and learners become accustomed to the mechanics and the tone of the forums then there are key ways in which your input can be reduced, thereby helping to foster a community that is less dependent on the tutor/teacher. Even then, however, you will probably want to be a presence in the discussions although you may choose to be one of many contributors rather than the font of all wisdom.

===Commitment and Participation===

Ask yourself if

# you wish to have involvement in the forum or if you want the students to lead and own the space
# you want the forum to add value to the face to face environment or have a life of its own in its own right outside the lecture theatre/classroom or seminar room
# you are prepared to make appropriate contributions to the discussion in order to:
## encourage discussion if students are quiet
## help shape ideas if students begin to wander off-task
## your role will be defined as discussions/a course progresses
## you will explicitly but gradually relinquish control of the discussions
## you will encourage and support learners to share control of discussions(for example you might ask a learner/group of learners to summarise contributions to a discussion thread/topic or you might ask learners to initiate discussion topics)

===Student Centered Forums===

With the growing popularity of social networking software like Facebook, Bebo, MySpace and the like, students are leaving schools and coming to Higher and Further Education with a new technological sophistication and with new expectations for communication. And as school, colleges and universities recognise that reflective and life long learning are significant goals in education, student centered learning and the creation of student centered spaces online are also gaining credence in educational settings. We know that effective learning requires access to social and academic networks for both study material and emotional support; as such, online communities can offer a holistic knowledge construction and support mechanism and recognize that affective activity is effective.

Social forums, often called ‘Virtual Cafes’ or ‘Common Rooms’ can be set up for courses or for programmes, depending on the student need. Such spaces provide a common area for students to come together and discuss unlimited topics, including social activities and educational ideas. They are supportive spaces for students, most successful with large first and second year courses where students would not otherwise have the opportunity to communicate with others outside their own tutorial group. It is arguable that students will experience a greater sense of community within and a sense of belonging to an educational institution or individual department having had the experience and convenience of the social forum on their course; this could arguably have implications for retention.

These spaces are typically highly active, especially in first term. Depending on your institution, they are usually self monitored by students, who understand that the same ‘rules’ and ‘netiquette’ that apply to them within any computing space, also apply in Moodle.

===The News Forum===

Moodle courses automatically generate a [[News forum]] which defaults to automatically subscribe all participants in a course. The name of the News Forum can be changed to something more appropriate, such as ‘Important Announcements’ or the like. This is a useful feature and many use this forum in a Moodle course to announce exam dates, times or changes to exams, lectures or seminars, as well as important information about course work throughout a term or special announcements relating to events.

===Teacher/Tutor forums===
A teacher/tutor-only forum may be added to a course by creating a hidden forum. Teachers are able to view hidden course activities whereas students cannot.

==Some forum suggestions to consider==

#If your course is at a distance, if your face to face time is limited, or if you just wish to foster a sense of community in your Moodle course which supplements your face to face course, it is good practice to begin with a welcome or introductory message or thread in one of your forums. This welcome or introduction from you invites participants, for example, to post some specific details to introduce themselves to you and their peers. This can be your icebreaker or you can have an icebreaker separately.
#If you have two questions for participants to answer, starting the two strands or topics within the forum itself will both help learners to see where to put their responses, and remind them to answer all parts of your question.
#Remember that you are communicating in an environment that does not have the benefit of verbal tone, eye contact, body language and the like. Careful consideration of your communication is, therefore, necessary.
#Postings to a forum are always written but they can take different forms and you may wish to consider what form best suits the activity. For instance, you might choose to articulate a form of contribution in order to be explicit. Thus you might say, 'This is a think-aloud forum in which, together, we will try to tease out ideas and possibilities' or 'This is a formal forum in which you are invited to share your ideas on (topic)' and, where you select the latter, you might have already suggested learners plan those ideas offline or in another kind of activity within Moodle.
#Create a forum where only the teacher can start discussions, but the students can only reply. Each thread you start contains an essay question (or several similar ones). The students make a bullet point plan for the essay and post it as a reply. This works well as a revision strategy as the students can see how others have approached the same task. Once everyone has posted their plan, you can start a discussion as to which plans seem better and why. Creating a scale to use for rating the posts can be useful so that the students can see how helpful other people think their effort were. (Note: At this time, there is no option to hide the "Add new discussion topic" button, so you need to tell your students not to start discussion threads, but to only reply to threads started by the teacher. If you only need one thread, then you can use the "a single simple discussion" format and the "Add new discussion topic" button is not available to the students.)

===Grading forums===

The teacher can use the [[Forum ratings|ratings]] [[Scales|scales]] to [[Grades|grade]] student activities in a forum. There are several methods for calculating the grade for a forum that can be found in the [[Adding/editing_a_forum#Grade|Forum settings under grades]]. There are 5 ways to [[Adding/editing_a_forum#Aggregate_type|aggregate ratings]] automatically to calculate a forum grade for the [[Gradebook]]. These include: Average, Max, Min, Count and Sum.

==Forum ratings allow users to evaluate posts in a forum==

Forum ratings use [[Scales]] to standardize the reporting of performance. A forum rating can be included as part of a student's [[Grades|grade]]. For example, a teacher might use a custom rating scale in a forum and allow students to rate forum posts.

Forum ratings must be allowed and the potential rater must have [[Roles|role]] permission. Teachers by default have this ability. The teacher role is also able to give permission to a [[Student|student role]] in a specific forum to be able to assign a rating to a post. Forum settings and [[Forum_permissions#Enabling_students_to_rate_posts| Enabling student ratings]] has more information.

===How to use===
[[Image:Forum rating example1 mu.png|thumb|Teacher view of a previously rated student post]]When rating is allowed, the qualified user will see "Rate this post" and a pull down menu after an entry (not their own). The menu displays a [[Scales|scale]] that the forum creator selected in the [[Adding/editing_a_forum#Grade|Forum grade settings]]. The user can rate more than one post at a time. When finished they should click the "submit my ratings" button at the bottom of the page.

===AJAX forum rating===

Forum rating can be made more user-friendly with the use of AJAX. Users can rate forum posts almost instantly without needing to scroll to the bottom of the page and click the "Send in my latest ratings" button.

AJAX forum rating requires AJAX to be enabled by an administrator in ''Settings > Site administration > Appearance > [[AJAX and Javascript settings|AJAX and Javascript]]'' and by users in their [[Edit profile|user profile]].

===Separate and connected knowing===
You can rate forum posts with the [[Separate_and_Connected_Knowing| Separate and Connected Knowing]] scale here.

===Good Practice and shared discussions===
*There are lots of discussions about Forum good use and Forum assessment in the Teaching Strategies Forum http://moodle.org/mod/forum/view.php?id=41.

*A useful discussion about Forum assessment can be found here http://moodle.org/mod/forum/discuss.php?d=66008.

== See also ==

* Using Moodle [http://moodle.org/mod/forum/view.php?f=116 Forum module]
*[http://www.moodleblog.onet/?page_id=148 Peer Assessment using a Moodle Forum] blog post with screencast

Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=5367 The philosophy underlying "no editing after 30 minutes"]
* [http://moodle.org/mod/forum/discuss.php?d=66008 Best Practices for grading discussions]
* [http://moodle.org/mod/forum/discuss.php?d=88000 Two Courses, One Forum?]
* [http://moodle.org/mod/forum/discuss.php?d=93304 Using a forum for 1 to 1 teaching]
* [http://moodle.org/mod/forum/discuss.php?d=95470 Technicalities of managing a Forum]
* [http://moodle.org/mod/forum/discuss.php?d=67360 Role names showing next to posting photos]

[[de: Forum nutzen]]
[[fr:Afficher un forum]]
[[ja:フォーラムの閲覧]]

SWF Activity Module

2013-05-27T22:27:10Z

Mattbury: /* Production */

=Truly interactive e-learning with Rich Internet Applications=

The [http://code.google.com/p/swf-activity-module/ SWF Activity Module] is a Moodle plugin extension for deploying Flash learning applications, also known as Flash templates. Teachers and course content developers can use the [http://code.google.com/p/swf-activity-module/ SWF Activity Module] to deploy any Flash applications, including but not limited to those that use external data and media in order to function correctly. It also allows Flash applications to communicate with Moodle for purposes such as passing learners' grades into Moodle's grade book.

It does not include any Flash learning applications. However, a word search application is provided separately for testing and demonstration purposes. You're also free to use the word search in courses if you wish.

Sufficient documentation, source code and examples are provided on this project site so that Flash developers can easily write or adapt applications to work fully with the [http://code.google.com/p/swf-activity-module/ SWF Activity Module]. See the project wiki pages for further details.

==For Moodle 1.9==

Please note: This module is now ready for production use.

For a summary of the latest developments of the SWF Activity Module, please see the [http://code.google.com/p/swf-activity-module/wiki/ChangeLog ChangeLog] page.

==For Moodle 2.x==

The SWF Activity Module for Moodle 2.x is currently under development (as of January 2013). A beta testing version will be available sometime in 2013. Please note that owing to differences in the way in which Moodle 2.x's file management system works, the 2.x version will be a different module and will not be upgradeable from 1.9.

The SWF Avtivity Module for Moodle 2.x will, however, support easy video playback using compatible Flash based media players.

==Why develop the SWF Activity Module?==

I started the [http://code.google.com/p/swf-activity-module/ SWF Activity Module] project to resolve two issues in Moodle:

* Moodle does not provide an effective, W3C standards compliant way to embed Flash applications in its web pages.
* Moodle does not provide any direct means of communication between Flash applications and its functions and data (generally referred to as an API - Application Programming Interface)

These two issues effectively make it very difficult for developers and almost impossible for non-developers, such as teachers, course content developers and instructional designers, to deploy dynamic, Flash based e-learning applications in Moodle.

The [http://code.google.com/p/swf-activity-module/ SWF Activity Module] provides an easy, reliable way for developers and non-developers (i.e. teachers, trainers, course content developers and instructional designers) to deploy Flash e-learning interactions in Moodle.

No Flash e-learning applications are included with the [http://code.google.com/p/swf-activity-module/ SWF Activity Module], except for a word search activity, available as a separate download, to help you get started.

==General Features==

* Uses a "wizard interface" to deploy Flash learning applications: No developer skills necessary
* Supports all versions of Flash and is forwardly compatible
* Section 508 (accessibility) compliant
* Supports web services including dynamic API keys: No need to hard-code API keys into your software!
* Pushes grades from Flash learning applications into Moodle grade book
* Supports customisable FlashVars so that many existing 3rd party Flash applications can also be deployed
* Uses SWF Object - W3C standards compliant Flash embedding method, the best Flash embed method available: stable, fully functioning and reliable, as recommended by Adobe and leading Flash developers
* Detects users' Flash Player version to inform users if they need to upgrade
* Supports all Flash Player parameters
* Works in all browsers and browser versions that support Flash Player 6 and later
* Even works in browsers with Javascript disabled

==Supports Flash Remoting==

* Uses AMFPHP as a communication gateway with Moodle
* Compatible with ActionScript 3.0 (Flash Player 9 and later)
* Includes Access.php service to authenticate users and determine their capabilities seamlessly and securely (i.e. no need to re-login in Flash applications)
* Includes service library to give Flash clients access to Moodle functions for things like Users, Groups, Grades, etc.
* Object Oriented code: Requires PHP5 or later

==Supports XML==

* Can deploy dynamic Flash learning applications that load in external lesson data via XML
* URLs to XML files are dynamic: No need to hard-code them
* One Flash learning application can present an unlimited number of learning interactions (lessons)
* Supports any type of XML that the deployed learning application is compatible with: XML, RSS, ATOM, SMIL, etc.
* Supported by W3C standards for dynamic content
* Ideal for non-developers: A wide range of 3rd party XML authoring tools available

==Does Not Support Authorware==

Please note: Most authorware packages such as Adobe Captivate, Techsmith Camtasia, Raptivity, etc. publish learning interactions specifically for static web pages and in SCORM packages. They do not function correctly in dynamic web pages such as Moodle activity modules. (The Moodle SCORM activity module is a special exception to this).

However, it is sometimes possible to deploy screen recordings if they are single output .swf files. Due to the limit on the number of animation frames a single .swf file can contain, this is only possible for relatively short recordings.

==Documentation==

[http://code.google.com/p/swf-activity-module/w/list SWF Activity Module documentation]

==Demo==
Visit my [http://matbury.com/moodle/course/view.php?id=9 Moodle demo course] (Login as a guest) which allows users to login without creating an account.

[[Category:Contributed code]]

Multimedia plugins FAQ

2013-05-27T22:20:15Z

Mattbury: /* See also */

{{Filters}}
==What is the best way of Embedding media in Moodle?==

#Interesting discussion on Moodle Mahem list: https://groups.google.com/forum/?pli=1#!topic/moodlemayhem/txt_5pNwATk
#Playing Flash FLV & SWF in MOODLE 2.0: http://moodle.org/mod/forum/discuss.php?d=163374

==How can I have embedded media resized appropriately?==
You can add specific dimensions to the end of the attribute HREF inside the anchor <A> tag.
<pre>
<a href="link-to-some-flash-file.swf?d=480x640">Flash File</a>
</pre>
where 480x460 are the dimensions in pixels that you wish to use.

==See also==

* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=194684 Moodle Media player not appearing] forum discussion
* [[SWF Activity Module]]

[[Category:FAQ]]

Video

2012-12-09T22:23:49Z

Mattbury: /* Where to host the videos */

{{Working with media}}
*Video is a very powerful tool to use in a Moodle course, allowing students, for example to catch up on lectures they missed, learn from a "how to" screencast, or improve their language skills by watching native speakers interact.
*For a discussion on the best type of video file for Moodle, see [http://moodle.org/mod/forum/discuss.php?d=143478| here]
''
*For a discussion of the best programs for creating screencasts, see [http://moodle.org/mod/forum/discuss.php?d=147891| here]

==Where to host the videos==

*Whenever possible, it is preferable to upload your videos to Moodle, storing them on your own server as you retain ultimate control. However, when server space or upload limits are restricted, it is convenient to upload videos to an online site like youtube [http://www.youtube.com] or Vimeo[http://vimeo.com]. They can easily be embedded inside Moodle from such sites and privacy can still be maintained if you choose their private video sharing option.

===Cross domain video hosting===

Flash video players require permission to play videos hosted on a different URL, e.g. yourmoodle.org needs permission to play video files hosted at yourvideo.org. The permission files are stored on the root domain of where the video files are hosted, e.g. yourvideos.org/crossdomain.xml. If yourvideos.org does not have a cross domain policy file that permits yourmoodle.org to play videos, Flash Player will not permit it. Further details are available here [http://code.google.com/p/moodle-mplayer/wiki/CrossDomainSecurity].

Many public video hosting services, such as YouTube.com, already have catch-all cross domain policy files in place and so videos can be played from them via your Moodle without any cross domain security issues arising.

==Ways of displaying video==

===Linking to a video online elsewhere===
*If your video is hosted elsewhere online (such as youtube) you can simply link to the relevant page by choosing ''Add a resource>[[URL|URL]]'' and pasting in the relevant link.
*For more information, see [[URL|URL]]
*Note that, in an establishment where certain video sharing sites might be banned, your students might not be able to access your video through Moodle.

===Uploading a video for students to download===
*Choose this option if you wish to upload your video to Moodle and give users the option to download it to their own computers.
*Choose ''Add a resource>[[File|File]]''
*For more information, see [[File|File]]
*Note that the way the video will display depends on the software the user has on their own computer. This could mean that some students might be unable to view your video. (See this discussion [http://moodle.org/mod/forum/discuss.php?d=143478| here])

===Embedding a video in its own player===
*Moodle has an inbuilt video player called Flowplayer. If multimedia filters are enabled by the administrator, videos embedded into the text editor will play inline in Flowplayer.
*Anywhere that Moodle's TinyMCE text editor is available, it is possible to embed a video, for example in a [[Label|label]] or a [[Page|page]], a course topic summary, a [[Description_question_type| quiz description]] or a [[Lesson|lesson]].
*One ecxeption seems to be MP4 files. They don't seem to play in Flowplayer unless hacked. See discussion here: http://moodle.org/mod/forum/discuss.php?d=208849

====Using the Moodle media icon====
*With your editing turned on, click into the HTML editor where you wish to embed your video.
*Click the Moodle media icon as in the following screenshot:
[[File:Addmedia.png]]
*Click ''Find or upload a sound,video or applet''
*The file picker will appear:
[[File:Filepickermedia.png]]
*Either click ''Upload a file'' to upload from your computer or choose the appropriate repository from which you wish to bring in your video. (What you see will depend on what the Moodle admin has enabled)
*Note: '''To search for and embed a video from youtube, [[Youtube_videos|see here]]'''
*Change the ''save as/author/license'' settings if desired and click ''upload this file'' or ''select this file''
*Your video will appear in a preview player. Click ''Insert'' at the bottom
*'''''Don't panic''!''' You will now only get a blue text link of your video:
[[File:Moodletvgirlpreview.png]]
*When you click ''save changes'' to return to the main course page, your video will display:
[[File:Moodletvgirl2.png]]

====Using a hyperlink====
(Note - this method has no advantage over using the media icon, but was popular in older versions of Moodle)
*With your editing turned on, click into the HTML editor where you wish to embed your video.
*Type some blank spaces and select them.
*Click the hyperlink icon as in the following screenshot.(The icon will only be clickable if you have selected text or spaces)
[[File:Hyperlinkicon.png]]
*Click the icon to the right of the link URL box:
[[File:Linkurl.png]]
*This takes you to the file picker. Follow the instructions for uploading/selecting your video as for using the Moodle media icon.
*When your video is chosen, it will appear in the link URL box as below. Click ''Insert:''
[[File:Insertvideo.png]]
*'''''Don't panic!''''' You will now only get a blue line in the HTML editor:
[[File:Videopreview2.png]]
*When you click ''save changes'' to return to the main course page, your video will display.

====Using embed code to display external videos====
*Go to your chosen video sharing site and find the embed code of the video you wish to display. Copy this code.
*With your editing turned on, click into the HTML editor where you wish to embed your video.
*Click the HTML code icon as in the following screenshot:
[[File:Htmlcodeicon.png]]
*Paste your embed code into the box:
[[File:Embedcode.png]]
*Scroll down and click "update".
*Your video will be previewed in the HTML editor. Click ''save changes'' for it to display on the page
[[File:Youtubevideo.png]]

==See also==
*[[Video_FAQ|Video FAQ]]
*[[Multimedia plugins filter]]
*[http://www.mguhlin.org/2012/01/embedding-videos-in-moodle-22.html Embedding Videos in #Moodle 2.2] blog post from Miguel Guhlin

[[de:Video]]

Amazon S3 repository

2012-09-02T20:44:24Z

Mattbury: /* How to set up Moodle with Amazon S3 */

{{Repositories}}
The Amazon S3 repository enables users to link to or copy files from Amazon S3 into Moodle.

==How to set up Moodle with Amazon S3==

===Set up Amazon S3===

You need to set up an account with Amazon Web Services and activate a Simple Storage Service (S3) instance. You will also need to set up private and public access keys so that your Moodle can be authenticated to access the files.

===Enable Amazon S3 in Moodle===

Go to ''Settings > Site administration > Plugins > Repositories > Manage Repositories''

Enable the Amazon S3 repository:

*Either: Enabled and visible (What does this mean?)

*Or: Enabled and hidden (What does this mean?)

Once enabled, you can go to:

Located in ''Settings > Site administration > Plugins > Repositories > Amazon S3'' or ''Settings > Site administration > Plugins > Repositories > Manage Repositories > Amazon S3 > Settings''

*Repository plugin name

*Access key - Generated by your Amazon S3 account

*Secret key - Generated by your Amazon S3 account

==Repository capabilities==

There is just one capability, [[Capabilities/repository/s3:view|View amazon s3 repository]], which is allowed for the default authenticated user role.

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=165934 Streaming video files from Amazon S3]

*[http://aws.amazon.com/s3/ About Amazon Simple Storage Service (Amazon S3)]

{{stub}}

[[de:Amazon S3 Repository]]

Talk:Amazon S3 repository

2012-09-02T19:46:04Z

Mattbury: Created page with "Fresh install of Moodle 2.3 does not correspond to this documentation. No Amazon S3 repository options are visible. Have made ammendments."

Fresh install of Moodle 2.3 does not correspond to this documentation. No Amazon S3 repository options are visible. Have made ammendments.

Amazon S3 repository

2011-11-25T19:09:21Z

Mattbury: /* How to set up Moodle with Amazon S3 */

{{Repositories}}
The Amazon S3 repository enables users to link to or copy files from Amazon S3 into Moodle.

==How to set up Moodle with Amazon S3==

Located in Settings > Site administration > Plugins > Repositories > Amazon S3

*Repository plugin name

*Access key - Generated by your Amazon S3 account

*Secret key - Generated by your Amazon S3 account

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=165934 Streaming video files from Amazon S3]

*[http://aws.amazon.com/s3/ About Amazon Simple Storage Service (Amazon S3)]

{{stub}}

[[de:Amazon S3 Repository]]

Amazon S3 repository

2011-11-25T19:02:36Z

Mattbury: /* See also */

{{Repositories}}
The Amazon S3 repository enables users to link to or copy files from Amazon S3 into Moodle.

==How to set up Moodle with Amazon S3==

Located in Settings > Site administration > Plugins > Repositories > Amazon S3

==See also==

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=165934 Streaming video files from Amazon S3]

*[http://aws.amazon.com/s3/ About Amazon Simple Storage Service (Amazon S3)]

{{stub}}

[[de:Amazon S3 Repository]]

Development:NEWMODULE Documentation

2011-03-03T12:14:18Z

Mattbury: /* lib.php */

{{Template:Work in progress}}
{{New_Module}}
This first draft of Moodle Docs page about the creation of a new module is divided into the some sections. See block NEWMODULE at right side.

=Getting started=

== Base module folder content ==
To download the newmodule package, please refer to:
:* 1.8: http://download.moodle.org/plugins18/mod/NEWMODULE.zip
:* 1.9: http://download.moodle.org/plugins19/mod/NEWMODULE.zip
:* HEAD: http://download.moodle.org/plugins/mod/NEWMODULE.zip

Although you can download the newmodule package for moodle 1.8, such as 1.9 and HEAD, this tutorial is intended for the newmodule development in '''Moodle 1.9 only'''.

Let's start by getting an idea about what you find in the newmodule folder taken from http://download.moodle.org/plugins19/mod/NEWMODULE.zip
# db/install.xml
# db/upgrade.php
# icon.gif
# index.php
# lang/en_utf8/help/newmodule/index.html
# lang/en_utf8/help/newmodule/mods.html
# lang/en_utf8/newmodule.php
# lib.php
# mod_form.php
# README.txt
# version.php
# view.php

The path where you find each file is the correct one. So don't change the path of files and folders in this newmodule package.

Inside the db folder, at the beginning, you can only find install.xml and upgrade.php but sooner you will start to always add the new file "access.php".

=== db/install.xml ===
''db/install.xml'' is the file to write the xml describing the tables needed by the module.
Tables are at least two, first named with the same name of the module, second named "log_display".
They follow a strict syntax that you can learn by editing one of the several example you can find inside moodle modules.
Ultimately the only thing to take care is the <<previous>> <<next>> connection between tables and fields.
This is the mandatory file where you MUST write the structure of the tables your module is going to use.
The table "log_display" is the tables where you are requested to list all the "actions" that you will add to the logs of your module.

=== db/upgrade.php ===
''db/upgrade.php'' is the file that you will write each time you need to change the structure of the tables of your module.

To learn how to write this file, please refer to the examples you may find in the file itself.

=== icon.gif ===
It is a 16px per 16px icon identifying each instance of your module in the frame of a course.

=== index.php ===
''index.php'' is a page to list all instances of the functionality the module provides in a course.

=== lang ===
''lang'' is the folder reserved to language packs.

A module language pack is a folder named "xx_utf8" containing, in turn, a folder named "help" and a language file named with the same name of the module. xx is the two char long name of the language, i.e. en, de, es, it, fr and so forth. Each language file is dedicated to a specific language. The lang folder may contain as much language packs as provided by different translators.

The lang/xx_utf8/help/ folder contains all the help files you want to provide to your module. In order to link a help file from inside the code of your module pages use $mform->[[Development:lib/formslib.php_Form_Definition#setHelpButton|setHelpButton]] in [[#mod_form.php|mod_form.php]] and in other places use <code php> helpbutton('<<name of your help file saved in lang/xx_utf8/help/>>', get_string('your_string','newmodule'), 'newmodule');</code>

=== lib.php ===
''[[lib.php]]'' is the pre-filled file with "core" functions needed by each module.

Almost all newmodule functions go here. Each of them must have a name that starts with newmodule_
This file should have two well differenced parts:
* All the core Moodle functions, neeeded to allow the module to work integrated in Moodle.
* All the newmodule specific functions, needed to implement all the module logic.

Please, note that, if the module become complex and this lib grows a lot, it's HIGHLY recommended to move all these module specific functions to a new php file, called "locallib.php" (see forum, quiz...). This will help to save some memory when Moodle is performing actions across all modules.

There are convention to name functions into lib.php and locallib.php. See:
* [[Development:Coding_style#Functions_and_Methods]]
* [[Development:Modules]]

There are some details just above the each function in lib.php.

Mandatory function are, at least:

Module instance editing form handlers, that called from [http://xref.moodle.org/course/mod.php.source.html /course/mod.php] or [http://xref.moodle.org/course/modedit.php.source.html /course/modedit.php]:
*'''function newmodule_add_instance($newmodule)'''
This function is after an editing teacher ''create an instance'' of newmodule.

Moodle development team: Examples?

*'''function newmodule_update_instance($newmodule)'''
This function is executed after an editing teacher ''update an instance'' of newmodule.

Moodle development team: Examples?

*'''function newmodule_delete_instance($id)'''
This function is executed after an editing teacher ''delete an instance'' of newmodule.

Moodle development team: Examples?

*'''function newmodule_user_outline()'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_user_complete($course, $user, $mod, $newmodule)'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_print_recent_activity($course, $isteacher, $timestart)'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_cron()'''
Take care with this function. Differently by all the other functions, this function is not called by passing it the $newmodule record. This means that this function, called by moodle core cron has to look for each newmodule instance id before operating.

Don't worry, even if you have more than a single instance of your module among moodle courses, this function will be executed just one time.

*'''function newmodule_get_participants($newmoduleid)'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_scale_used($newmoduleid, $scaleid)'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_scale_used_anywhere($scaleid)'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_install()'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_uninstall()'''
Moodle development team: What does this function do? Examples? Please complete!

Some more functions should be added:

*'''function newmodule_reset_course_form_definition(&$mform)'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_reset_course_form_defaults($course)'''
Moodle development team: What does this function do? Examples? Please complete!

*'''function newmodule_reset_userdata($data)'''
Moodle development team: What does this function do? Examples? Please complete!

These three functions are responsible for the newmodule reset process during the more general course reset process. Please, refer to [[mod/data/lib.php]] or to [[mod/feedback/lib.php]], for instance, to understand them better.

Two more functions should be added to lib.php are:
*'''function newmodule_get_view_actions()'''
Moodle development team: Examples? Please complete!

*'''function newmodule_get_post_actions()'''
Moodle development team: Examples? Please complete!

They distinguish between "read" and "post" log actions. These functions are used by moodle core during log gather.
The actions you list inside these two functions, must match the ones you listed in the table "log_display" in install.xml

==== Connection between '''lib.php''' and '''locallib.php''' ====
One important issue is about the connection between '''lib.php''' and '''locallib.php'''. Who has to call the other, how and why?
It has to be locallib.php to call lib.php through:
<code php>
require_once("$CFG->dirroot/mod/newmodule/lib.php");
</code>
as first line.

In this way, if moodle core calls function inside mod/newmodule/lib.php no module specific function will be loaded in memory.
If it is your newmodule to call a function, it has to require_once('locallib.php'); that, in turn, will require_once('lib.php') so that your module will "see" all its available functions.

=== mod_form.php ===
''mod_form.php'' is the file describing the form you get at the module instance creation or at the instance editing time.

There are only one class definition, that extends class ''moodleform_mod'' from [http://xref.moodle.org/course/moodleform_mod.php.source.html /course/moodleform_mod.php].

The syntax for add new form elements is very simple and by reading the file it is simple to change it on your need. It uses the syntax you can learn in [[Development:lib/formslib.php_Form_Definition]].

This file used only from [http://xref.moodle.org/course/modedit.php.source.html /course/modedit.php].

At date, there is a missing detail by the end of the file. You can read:
<code php>
//------------------------------------------------------------------------------
// add standard elements, common to all modules
$this->standard_coursemodule_elements();
//------------------------------------------------------------------------------
</code>
This part with one call of function inherited from moodleform_mod that is responsible for the common modules section at the end of your newmodule editing instance page. The section related to groups, outcomes, grades, visibility etc. This code can be customized by settings object passed to it:
<code php>
//------------------------------------------------------------------------------
// add standard elements, common to all modules
$features = new object();
$features->groups = false;
$features->groupings = false;
$features->groupmembersonly = true;
$this->standard_coursemodule_elements($features);
//------------------------------------------------------------------------------
</code>

One more tip about this file.
* Once you submit the form described by this file, your module executes the function: ''newmodule_add_instance'' or ''newmodule_update_instance'' both pre-written in [[#lib.php|lib.php]].
* It seems that check boxes in the editing instance form don't work. To test this, please verify the passed parameter $newmodule inside your function ''newmodule_update_instance'' through a simple: <code php>print_object($newmodule);</code>
* You will find that even by selecting or unselecting the check box in the newmodule instance editing form, the corresponding value in the array doesn't change. This is not an error, but at least a lack of code. You will find that all works fine by adding at the beginning of both functions a simple code like this:
<code php>
$checkboxes = array('myfirstcheckboxfield', 'mysecondcheckboxfield', and so fort with all your checkbox field);
foreach ($checkboxes as $checkbox) {
if (empty($newmodule->{$checkbox})) {
$newmodule->{$checkbox} = 0;
}
}
</code>

=== README.txt ===
This is the file where you are welcome to write what your newmodule does.

=== version.php ===
''version.php'' is a really very simple file as simple as important.

To understand why it is important, you need to know that there are a bunch of actions that moodle performs for your newmodule ONLY (with only one exception) at the newmodule installation. They are, at least, db tables editing and load of capability. If during the development of your module (that you already installed on your development environment or that you already shared with remote users) you need to change the structure of your newmodule tables or you need to change the capability used by your newmodule, you need to force moodle to edit tables and reload capability.

This is done by:
* adding the proper code in newmodule/db/upgrade.php (to do this, use XMLDB as stated in this same page below)
* increasing the newmodule version in version.php
* visiting the notification page of your installation of Moodle

=== view.php ===
This is the first executed code of your module. By selecting the link of the instance of your module, the code of newmodule/view.php is executed.

== Some very important missing files ==
There are five files that are not present in the newmodule package that 90% of times you will go to add to your newmodule.

; locallib.php
: The first one is ''locallib.php'' already described before.

; access.php
: The second one is ''access.php'' that has to be saved inside newmodule/db/ folder.
: In this file you will add all the capability used by your newmodule and loaded at the installation time or upgrade time. To learn the syntax of the capability, please refer to the same file in other modules or to: https://docs.moodle.org/en/Development:NEWMODULE_Adding_capabilities

; settings.php
: The third missing file must be added to newmodule/ folder. It is ''settings.php'' and describes the form that can be accessed from: Site Administration block -> Modules -> Activities -> <<your newmodule name>>
:This form stores general settings for your newmodule into the site wide $CFG object. Because of this, it is strongly recommended to give to your newmodule general settings with names starting with "newmodule_". This file is useful when there is a setting that doesn't depend from the instance. I.e., if your newmodule simulates a telephone, you will probably save your telephone number in this newmodule setting site wide form instead of typing it each time you add a new instance of your newmodule into a course. In this case, to refer to you telephone number inside your newmodule you will use: $CFG->newmodule_telephonenumber

; backuplib.php
: Directly in the newmodule folder, you need to add ''backuplib.php'' that is responsible for the backup of each instance of your module and of its log.
:To learn how to code it, start by stealing it from some other module and read it.

; restorelib.php
: Again in the newmodule folder, you need to add ''restorelib.php'' that is responsible for the restore of each instance your module and of its log.
:To learn how to code it, start by stealing it from some other module and read it.

==Let's start==
To start using a downloaded package, please perform the 7 actions described in [[Development:NEWMODULE_Tutorial]] in ''How to Begin the Creation of a New Module'' paragraph.

Then, draw the structure of your tables on a sheet, edit the file db/install.xml according to your project, save, put your renamed newmodule folder in moodle/mod/ and visit the moodle notification page.

To add code to db/upgrade.php never do it manually. I always make use of Site Administration block -> Miscellaneous -> [[XMLDB editor]] and I ask it to write the code for me. It never fails.

Please remember: within your module, never use "embedded messages" like:
<pre>echo 'Welcome to this newmodule';</pre>
but make use of get_string or print_string. In this way your module will be multilang with a really small effort.
Use, for instance:
<code php>print_string('welcomemessage','newmodule');</code>
saving in newmodule/lang/en_utf8/newmodule.php
<code php>$string['welcomemessage'] = 'Welcome to this newmodule';</code>

==Some code snippets that I find useful==

=== Check the capability of a user ===

<code php>
if (newmodule_hascapabilitytodothis()) {
//user is allowed
} else {
// user is not allowed
}
</code>

typing in locallib.php

<code php>
function newmodule_hascapabilitytodothis($cm) {
$context = get_context_instance(CONTEXT_MODULE, $cm->id);

return (has_capability('mod/newmodule:candothis', $context));
}
</code>

typing in db/access.php
<code php>
$mod_newmodule_capabilities = array(
'mod/newmodule:candothis' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'legacy' => array(
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'admin' => CAP_ALLOW
)
)
)
</code>

=== Edit the tables in use by your newmodule ===

* edit [[#db/install.xml|db/install.xml]] manually by editing fields and or tables in the xml structure.
* go to Site Administration block -> Miscellaneous -> XMLDB editor and load the tables of your module
* ask to the XMLDB editor the snippets of code you need to add to [[#db/upgrade.php|db/upgrade.php]]
* copy and paste in [[#db/upgrade.php|db/upgrade.php]]
* in the line: <code php>if ($result && $oldversion < xxxxxxxxxxxx)</code> (replace xxxxxxxxxxxx with the version number you are going to give to your newmodule)
* change (increase) the version number
* visit the Moodle notification page

=== Add a single line to logs from your newmodule ===

<code php>
add_to_log($course->id, 'newmodule', '<<action already listed in log_display>>', "view.php?id=$cm->id", "$newmodule->id");
</code>

=== Ensure that remote user will not be able to contact your pages by typing their URL directly in the address bar ===

as first line of each of your php script
<code php>
if (!defined('MOODLE_INTERNAL')) {
die('Direct access to this script is forbidden.'); // It must be included from a Moodle page
}
</code>

==Some suggestion I find useful==
'''To include php scripts''', try:
<pre>require_once('myscript.php');</pre>

'''To include php library''', try:
<pre>require_once('locallib.php');</pre>

'''To periodically execute function newmodule_cron()''', try:
<pre>$module->cron = xxxx;</pre>
providing some code in: <pre>function newmodule_cron()</pre>
Your function newmodule_cron() will be executed about each xxxx seconds

'''Do not include config when it is not needed'''
<pre>require_once('config.php')</pre>
is not needed in library scripts

'''Do not use global $cm or $newmodule in your function'''
but use proper function parameters.

So, never use:
<pre>function newmodule_lookatthesky() {
global $cm, $newmodule;

// your stuff
}</pre>
but use:
<pre>function newmodule_lookatthesky($cm, $newmodule) {

// your stuff
}</pre>

==See also==

* [http://dev.moodle.org/course/view.php?id=2 Moodle Developers' Course]
* [[Development:Modules]]
* [[Development:Places to search for lang strings|Where to put language strings for your plugin]]
* [[Development:Installing and upgrading plugin database tables|Defining the database tables for your plugin]]

{{CategoryDeveloper}}

[[Category:Developer|Modules]]
[[Category:Tutorial]]

Development:AMF3

2011-02-13T22:22:21Z

Mattbury:

<div class="sideblock right" style="width: 12em;">
<div class="header">AMFPHP/Moodle2.0/Flex/AS3</div>
<div class="content">
* New Moodle Webservices for use with Flex/AS/ (dec 2009) [http://tracker.moodle.org/browse/MDL-12886 WS TRACKER 2.0]
* OLD ActionScript 3.0 (Flash CS3 and Flex) page
* Original ActionScript 2.0 tutorial [[Development:AMFPHP]]
</div>
</div>

==AMF in Moodle 1.9==

A framework for Flash learning interaction integration with Moodle 1.9 already exists. If you want to get started with AMFPHP in Moodle 1.9 right away, see the [http://code.google.com/p/swf-activity-module/ SWF Activity Module on Google Code].

==TEMP NOTE: Updates Dec 2009==
Further to recent questions from parties....

AMF for use in Moodle is currently being completed within web service infrastructure for Moodle 2.0. Developers please see [http://tracker.moodle.org/browse/MDL-12886 WS TRACKER 2.0]

The information contained below is for reference only, Parties interested in development status of Moodle/AMF see above link. Developers interested in /Flex/Flash builder/AS moodle trail activities feel free to contact marcusjpotter'at'gmail.com - who is co-ordinating Moodle trail activities with Moodle HQ.

- Marcus Potter: Will remove notice once docs updated

==History: What is AMFPHP?==

===Action Message Format PHP===
[http://sourceforge.net/projects/amfphp/ AMFPHP] is a widely used open source remoting server that allows Flash and Flex client-side applications to call PHP methods directly, as if they were native Flash/Flex ActionScript methods. It is fast and lightweight and presents an efficient, simple and easy to implement method of communicating with PHP and databases.

===Preserved Data Types===

[http://sourceforge.net/projects/amfphp/ AMFPHP] preserves the following data types between ActionScript and PHP:

* Array
* Bitmap
* ByteArray
* int
* Number
* Object
* Recordset (mysql_result)
* String
* XML (ActionScript 3.0 also supports [http://en.wikipedia.org/wiki/E4X E4X] notation)

Note: Please add to this list if you have successfully tested data types using AMFPHP 1.9.beta+ and ActionScript 3.0.

[http://sourceforge.net/projects/amfphp/ AMFPHP] automatically converts data types between ActionScript and PHP to their native equivalents. For example, it can convert a PHP array into and ActionScript array or a PHP resource, such as a mysql_result into an Actionscript Recordset.

===AMF0 and AMF3===
Previous versions of Flash, using ActionScript 2.0 (versions 6, 7 and 8), use AMF0. ActionScript 3.0, Flash CS3+ and Flex, use AMF3 by default but can also use AMF0. What's the difference? AMF3 is compressed and therefore lighter and faster. For more details look [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/flash/net/ObjectEncoding.html here]. AMFPHP version (1.9) supports AMF3

==What is AMF Moodle?==

[http://code.google.com/p/amfmoodle/ AMF Moodle] is a new project (9th October 2008) which aims to integrate Flash and Flex with Moodle's API. The aim is to build a library of services that Flash and Flex developers can use to create secure client-side applications that can interact with Moodle. The first step will be to create a Moodle modules that facilitates deploying custom made, generic Flash and Flex e-learning interactions in Moodle courses and recording user interaction results in the Moodle gradebook.

===AMF Moodle Outline===

There is a summary of some of the specifications for the new AMF Moodle on the [[Talk:AMF_Moodle]] comments page that are under discussion. Once we have a more definite specification, it will be transferred to here. Please feel free to comment, make requests, ask questions etc. on the comments page. It'll really help us alot.

===AMF Moodle Participants===

The project's participants at the moment are:
[http://matbury.com/ Matt Bury],
[http://jamiep.org/ Jamie Pratt]
and [http://twitter.com/marcusjpotter Marcus Potter].

Find the AMF Moodle discussion thread [http://moodle.org/mod/forum/discuss.php?d=105716 here].

For further discussion, please use the [[Talk:AMF_Moodle]] page comments tab for this wiki page.

==What Are the Differences between Using AMFPHP and SCORM?==

Several Moodle developers and contributors have asked the question, "If you want to deploy Flash in Moodle, why not use SCORM?" [http://moodle.org/mod/forum/discuss.php?d=107918#p475832 There is a discussion in the General Developers Forum on the advantages and disadvantages of SCORM.]

==Installing AMFPHP in Moodle==

===Download===
* Download the latest version of [http://sourceforge.net/projects/amfphp/ AMFPHP], currently version 1.9.beta (SourceForge repository).
* Unzip the file and find the directory amfphp.
* Upload the amfphp directory to ***MOODLEROOT***/lib/

===Edit gateway.php===
* Find the file ***MOODLEROOT***/lib/amfphp/gateway.php and open it in your favourite text/PHP editor
* At the beginning of the code, add the line: include_once "../../config.php";
* Find and edit the line: $gateway->setClassPath($servicesPath); and change it to: $gateway->setClassPath($CFG->dirroot."/lib/amfphp/services/");
* Upload the edited ***MOODLEROOT***/lib/amfphp/gateway.php file.
* That's it!

===Setting PHP 5 as Default===
Please note: AMFPHP requires PHP 5 to work seamlessly, although some report success with version 4. Many servers run both PHP 4 and 5, but have them set to run PHP 4 by default. If you experience problems, you may have to change the default PHP version in the ***MOODLEROOT***/lib/amfphp/ directory with an .htaccess file. The following is an example only. Please check that it is correct for your server configuration. If you have a hosted server, they'll probably have an example in their help files. For example:

* Find the AMFPHP .htaccess file at ***MOODLEROOT***/lib/amfphp/.htaccess
* Open it with a text editor. You'll see:
<pre>#If you're working with a server which doesn't seem to display errors and you don't
#have access to httpd.conf and you have a good reason to develop remotely instead of
#locally, you may have luck with uploading this configuration file to the server

php_flag display_errors on
php_flag display_startup_errors on
php_value error_reporting 2047</pre>

* Add another line of code to change the default PHP version setting for the amfphp directory:
<pre>#If you're working with a server which doesn't seem to display errors and you don't
#have access to httpd.conf and you have a good reason to develop remotely instead of
#locally, you may have luck with uploading this configuration file to the server

php_flag display_errors on
php_flag display_startup_errors on
php_value error_reporting 2047

SetEnv DEFAULT_PHP_VERSION 5</pre>

==Testing AMFPHP in Moodle==

Here is an example of a simple AMF Moodle service that checks the login status of your browser.

* Create a new document in your preferred text/PHP editor
* Copy and paste the code and save it as UserName.php
* Upload it to ***MOODLEROOT***/lib/amfphp/services/

Now is a good time to find out if your server is running the correct PHP version. If your server is running PHP 4 by default, you'll get error messages caused by the "public" namespace.

* Navigate to the PHP page you just uploaded in your browser: ***MOODLEROOT***/lib/amfphp/services/UserName.php
* If there are no error messages then you can continue to the "Testing AMFPHP in Flash" section

<pre>
<?php
class UserName
{
public function __construct()
{

}
/**
*checks whether you're logged in to Moodle
*@returns user login status
*/
public function loggedInAs() {
global $USER;
if (isguestuser()){
return get_string('loggedinasguest', 'moodle');
}else if (isloggedin()){
return get_string('loggedinas', 'moodle', fullname($USER));
} else {
return get_string('loggedinnot');
}
}
}
?>
</pre>

==Testing AMFPHP in Flash==

Please note: Flash CS3 and Flex come with the necessary classes for using AMFPHP already installed. It is not necessary to install any new classes!

* Open the Flash CS3 IDE
* Create a new ActionScript 3.0 class document
* Copy and past the code below and save it as UserName.as
* Create a new ActionScript 3.0 FLA document
* In Properties > Document class: type UserName.as
* Save the FLA file as UserName.fla in the same directory as UserName.as
* Publish the UserName.swf, AC_RunActiveContent.js and UserName.html files
* Upload the published files to your server
* In your browser, navigate to the location of the UserName.html page
* Try logging in and out of Moodle to see the change in your login status

===ActionScript 3.0 Document Class===
<pre>
package {

import flash.display.Sprite;
import flash.text.*;
import flash.events.MouseEvent;
import flash.events.NetStatusEvent;
import flash.net.NetConnection;
import flash.net.Responder;

public class UserName extends Sprite {

private var _format:TextFormat;
private var _display:TextField;
private var _call:Sprite;
private var _gateway:NetConnection;
private var _responder:Responder;

public function UserName() {
initFormat();
initDisplay();
initCall();
initGateway();
}

// create text format object
private function initFormat():void {
_format = new TextFormat();
_format.font = "Trebuchet MS";
_format.size = 15;
_format.bold = true;
}

// create text field to display results
private function initDisplay():void {
_display = new TextField();
_display.autoSize = TextFieldAutoSize.LEFT;
_display.multiline = true;
_display.x = 10;
_display.y = 10;
_display.defaultTextFormat = _format;
_display.text = "Click on \"Call UserName.php\" to test.";
addChild(_display);
}

// create text button to call UserName.php
private function initCall():void {
_call = new Sprite();
_call.mouseChildren = false;
_call.buttonMode = true;
_call.addEventListener(MouseEvent.MOUSE_DOWN, callDownHandler);
var btn:TextField = new TextField();
btn.autoSize = TextFieldAutoSize.LEFT;
btn.border = true;
btn.background = true;
btn.backgroundColor = 0xdddddd;
btn.defaultTextFormat = _format;
btn.text = " Call UserName.php ";
btn.x = (stage.stageWidth - btn.width) - 10;
btn.y = stage.stageHeight - 30;
_call.addChild(btn);
addChild(_call);
}

// depress call button and call UserName.loggedInAs method
private function callDownHandler(event:MouseEvent):void {
_call.removeEventListener(MouseEvent.MOUSE_DOWN, callDownHandler);
stage.addEventListener(MouseEvent.MOUSE_UP, callUpHandler);
_call.x += 2;
_call.y += 2;
_gateway.call("UserName.loggedInAs",_responder);
_display.appendText("\n Calling UserName.loggedInAs ... ");
}

// reset call button
private function callUpHandler(event:MouseEvent):void {
_call.addEventListener(MouseEvent.MOUSE_DOWN, callDownHandler);
stage.removeEventListener(MouseEvent.MOUSE_UP, callUpHandler);
_call.x -= 2;
_call.y -= 2;
}

// connect to AMFPHP gateway
private function initGateway():void {
_gateway = new NetConnection();
// Edit the following line to reflect your server configuration
_gateway.connect("http://***MOODLEROOT***/lib/amfphp/gateway.php");
_gateway.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
_responder = new Responder(onResult,onFault);
}

// show returned results
private function onResult(res:Object):void {
_display.appendText("\n " + String(res));
}

// show details if call is unsuccessful
private function onFault(res:Object):void {
for(var i:String in res) {
_display.appendText("\n " + String(res[i]));
}
}

// show all net status events (can be status or error events)
function netStatusHandler(event:NetStatusEvent):void {
for(var i:String in event.info) {
_display.appendText("\n" + String(event.info[i]));
}
}
}
}
</pre>

==AMF Moodle Service Library==

===AMFPHP Service Browser===
AMFPHP 1.9.beta comes with a Flex service browser ready installed. It allows you to see your library of services in the ***MOODLEROOT***/lib/amfphp/services/ directory and call them. It also displays error messages very well. It's an ideal tool for checking out your services before your write Flash and Flex applications that call them.

===VERY IMPORTANT!===
DO NOT leave the service browser installed on a production server (i.e. public). It will leave your service library and therefore your Moodle API and databases exposed to the public!

===List Of AMF Moodle Services===
* User.php - returns user login status, returns an array of config settings you can set, returns a value of a config setting, sets a value of a config setting
* UserName.php - returns user login status

==User.php Updated==

If you've already seen the tutorials in [[Development:AMFPHP]], here's an updated version of User.php that works with AMFPHP 1.9.beta. As with UserName.php, upload it tothe services directory at ***MOODLEROOT***/lib/amfphp/services/. You can test it by navigating to ***MOODLEROOT***/lib/amfphp/browser/index.html and selecting User from the menu of services.

===User.php Script===
<pre>
<?php
class User
{
public function __construct()
{

}
/**
* Returns string indicating whether a user is logged in.
* @access remote
*/
public function loggedInAs() {
global $USER;
if (isguestuser()){
return get_string('loggedinasguest', 'moodle');
}else if (isloggedin()){
return get_string('loggedinas', 'moodle', fullname($USER));
} else {
return get_string('loggedinnot');
}
}
/**
* Returns an array of config settings you can set.
* @access remote
*/
public function configSettings() {
return array_keys(get_user_preferences());

}
/**
* Returns a value of a config setting.
* @param string name
* @access remote
*/
public function getConfigSetting($name) {
$name = clean_param($name, PARAM_ALPHAEXT);
return get_user_preferences($name);
}
/**
* sets a value of a config setting.
* @param string name
* @param string value
* @access remote
*/
public function setConfigSetting($name, $value) {
$name = clean_param($name, PARAM_ALPHAEXT);
$value = clean_param($value, PARAM_NOTAGS);
return set_user_preference($name, $value);
}
}
?>

</pre>

==MDL.php==

The following is a simple AMFPHP service that retrieves current user session data from Moodle. Save this file in the services directory of AMFPHP, i.e. moodle/lib/amfphp/services/MDL.php.

This class is PHP5 Object Oriented code and acts as a handy repository for accessing user session data. I haven't forgotten the closing ?> PHP tag. It just isn't recommended for OOP PHP5 classes. (It probably should use getter and setter methods of Moodle's API... but I can't find the relevant documentation!)

===MDL.php script===
<pre><?php
class MDL
{
public $logged_in = false;
public $course_id; // course id of current login
public $course_name; // course name
public $user_id; // current user's id
public $data_path; // URL to moodledata directory via moodle/file.php

public function __construct()
{
global $CFG;
require_once('../../../config.php');
if (isguestuser()){
$this->logged_in = true;
}else if (isloggedin()){
$this->logged_in = true;
global $USER;
global $SESSION;
// set variables
$this->course_id = $SESSION->cal_course_referer;
$this->course_name = 'Not yet set!'; // TODO - find out how to get this
$this->user_id = $USER->id;
$this->data_path = $CFG->wwwroot . '/file.php/' . $this->course_id . '/';
} else {
$this->logged_in = false;
}
}
/**
*cleans up objects and variables for garbage collector
*@returns nothing
*/
public function __destruct()
{
unset($this->logged_in);
unset($this->course_id);
unset($this->course_name);
unset($this->user_id);
unset($this->data_path);
}
}
</pre>

You can create an instance of this class like this:
<pre><?php
class YourClassName
{
private $mdl;

public function __construct()
{
// create moodle authentication and user variables object
require('MDL.php');
$this->mdl = new MDL();
}</pre>

You can then access the user session data like this:
<pre>
$this->mdl->course_id;
$this->mdl->course_name;
$this->mdl->user_id;
$this->mdl->data_path;
</pre>

==Useful Links==

===AMFPHP===

* AMFPHP home page [http://amfphp.org/ amfphp.org]
* AMFPHP code repository [http://sourceforge.net/projects/amfphp/ SourceForge.net]

===AMF Moodle===
* [http://code.google.com/p/amfmoodle/ AMF Moodle code.google.com]
* [http://moodle.org/mod/forum/discuss.php?d=105716 Moodle Forums - AMF Moodle discussion thread]

===Sir Lee Brimelow's video tutorials===
* [http://gotoandlearn.com/play?id=78 Introduction to AMFPHP 1]
Learn how to install AMFPHP and create a simple service that sends email.

* [http://gotoandlearn.com/play?id=79 Introduction to AMFPHP 2]
In this tutorial he shows you how to directly return database records to Flash using AMFPHP.

===Alessandro Crugnola's tutorials===
* [http://www.sephiroth.it/tutorials/flashPHP/flex_remoteobject/ Flex RemoteObject and AMFPHP 1.9]
* [http://www.sephiroth.it/tutorials/flashPHP/amfphp_bytearray/ Send and Receive ByteArray to AMFPHP]
* [http://www.sephiroth.it/tutorials/flashPHP/flex2_amfphp/ Flex2/Actionscript3.0 and AMFPHP]

===Adobe ActionScript 3.0 Language Reference===
The two most important classes related to AMFPHP are:
* [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/flash/net/NetConnection.html NetConnection class]
* [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/flash/net/Responder.html Responder class]
Other useful resources
* [http://www.cgdou.net/flash/as3reference/flash/utils/IExternalizable.html Interface IExternalizable]

===MISC AMFPHP/Flex/AS3/AIR Tutorials===
AS3/AMF
* [http://flashorbit.com/?page_id=53 How to set up a simple connection from Actionscript 3 to call your services in AMFPHP]
* [http://www.flash-db.com/Tutorials/helloAS3/ Flash Remoting with AS3]
* [http://www.actionscriptfreelancer.com/category/php/ Writing private attributes to a database using AMF in AS3 (IExternalizable)]
* [http://www.kylebrekke.com/wordpress/2008/amfphp-as3-class-communication-between-flash-and-amfphp-made-easy/ Communication between Flash and AMFPHP made easy]
* [http://www.prodevtips.com/2008/07/28/amfphp-in-flash-cs3-with-as3-jquerypost-style/ AMFPHP in Flash CS3 with AS3 - jQuery.post style]
* [http://www.actionscriptfreelancer.com/writing-private-attributes-to-a-database-using-amf-in-as3-iexternalizable/ Writing private attributes to a database using AMF in AS3]
* [http://blog.flexcommunity.net/?p=40 Turning Flash CS3 assets into Flex components using Flex Component Kit]
Sample Flex,AS3(&AIR) Sourcecode & Applications
* [http://polygeek.com/510_flex-tutorial_amf-php-based-poll-in-flex AMF-PHP based poll in Flex]
* [http://soenkerohde.com/2008/06/amfphp-on-air-tutorial-with-mamp/ MFPHP on AIR Tutorial with MAMP]

Misc Example AMFPHP Framework Examples
* [http://modern-carpentry.com/talk/?p=32 Combining Drupal, AMFPHP, SWFAddress and Flash]
* [http://blog.flexcommunity.net/?p=43 Displaying Paypal IPN payment data in Adobe Flex via AMFPHP]

===AS3 APIS===
* [http://blog.martinlegris.com/?p=83 Youtube Data API AS3]
* [http://code.google.com/apis/maps/documentation/flash/ Google Maps API AS3]

===AMFPHP Is Fast===
There's always someone who'll play with a new toy and push it until it breaks. AMFPHP can go pretty fast! [http://www.5etdemi.com/blog/archives/2007/01/amfphp-19-beta-2-ridiculously-faster/ Check out this blog article].

==See Also==

Moodle 2.0 Webservices - PLease refer to [http://tracker.moodle.org/browse/MDL-12886 WS TRACKER 2.0] for updates on forthcoming AMF service for use with Moodle 2.0

[[Development:SWF]] - SWF Activity Module deploys Flash and Flex Framework (.swf) applications as learning interactions. Unlike the Flash Activity Module, it supports all versions of Flash and Flex Framework, XML, 3rd Party APIs and will eventually support Flash Remoting (AMF).

SWF Activity Module

2010-08-20T16:59:00Z

Mattbury: /* Truly interactive e-learning with Rich Internet Applications */

=Truly interactive e-learning with Rich Internet Applications=

The [http://code.google.com/p/swf-activity-module/ SWF Activity Module] is a Moodle plugin extension for deploying Flash learning applications, also known as Flash templates. Teachers and course content developers can use the [http://code.google.com/p/swf-activity-module/ SWF Activity Module] to deploy any Flash applications, including but not limited to those that use external data and media in order to function correctly. It also allows Flash applications to communicate with Moodle for purposes such as passing learners' grades into Moodle's grade book.

It does not include any Flash learning applications. However, a word search application is provided separately for testing and demonstration purposes. You're also free to use the word search in courses if you wish.

Sufficient documentation, source code and examples are provided on this project site so that Flash developers can easily write or adapt applications to work fully with the [http://code.google.com/p/swf-activity-module/ SWF Activity Module]. See the project wiki pages for further details.

==Production==

Please note: This module is now ready for production.

For a summary of the latest developments of the SWF Activity Module, please see the [http://code.google.com/p/swf-activity-module/wiki/ChangeLog ChangeLog] page.

==Why develop the SWF Activity Module?==

I started the [http://code.google.com/p/swf-activity-module/ SWF Activity Module] project to resolve two issues in Moodle:

* Moodle does not provide an effective, W3C standards compliant way to embed Flash applications in its web pages.
* Moodle does not provide any direct means of communication between Flash applications and its functions and data (generally referred to as an API - Application Programming Interface)

These two issues effectively make it very difficult for developers and almost impossible for non-developers, such as teachers, course content developers and instructional designers, to deploy dynamic, Flash based e-learning applications in Moodle.

The [http://code.google.com/p/swf-activity-module/ SWF Activity Module] provides an easy, reliable way for developers and non-developers (i.e. teachers, trainers, course content developers and instructional designers) to deploy Flash e-learning interactions in Moodle.

No Flash e-learning applications are included with the [http://code.google.com/p/swf-activity-module/ SWF Activity Module], except for a word search activity, available as a separate download, to help you get started.

==General Features==

* Uses a "wizard interface" to deploy Flash learning applications: No developer skills necessary
* Supports all versions of Flash and is forwardly compatible
* Section 508 (accessibility) compliant
* Supports web services including dynamic API keys: No need to hard-code API keys into your software!
* Pushes grades from Flash learning applications into Moodle grade book
* Supports customisable FlashVars so that many existing 3rd party Flash applications can also be deployed
* Uses SWF Object - W3C standards compliant Flash embedding method, the best Flash embed method available: stable, fully functioning and reliable, as recommended by Adobe and leading Flash developers
* Detects users' Flash Player version to inform users if they need to upgrade
* Supports all Flash Player parameters
* Works in all browsers and browser versions that support Flash Player 6 and later
* Even works in browsers with Javascript disabled

==Supports Flash Remoting==

* Uses AMFPHP as a communication gateway with Moodle
* Compatible with ActionScript 3.0 (Flash Player 9 and later)
* Includes Access.php service to authenticate users and determine their capabilities seamlessly and securely (i.e. no need to re-login in Flash applications)
* Includes service library to give Flash clients access to Moodle functions for things like Users, Groups, Grades, etc.
* Object Oriented code: Requires PHP5 or later

==Supports XML==

* Can deploy dynamic Flash learning applications that load in external lesson data via XML
* URLs to XML files are dynamic: No need to hard-code them
* One Flash learning application can present an unlimited number of learning interactions (lessons)
* Supports any type of XML that the deployed learning application is compatible with: XML, RSS, ATOM, SMIL, etc.
* Supported by W3C standards for dynamic content
* Ideal for non-developers: A wide range of 3rd party XML authoring tools available

==Does Not Support Authorware==

Please note: Most authorware packages such as Adobe Captivate, Techsmith Camtasia, Raptivity, etc. publish learning interactions specifically for static web pages and in SCORM packages. They do not function correctly in dynamic web pages such as Moodle activity modules. (The Moodle SCORM activity module is a special exception to this).

However, it is sometimes possible to deploy screen recordings if they are single output .swf files. Due to the limit on the number of animation frames a single .swf file can contain, this is only possible for relatively short recordings.

==Documentation==

[http://code.google.com/p/swf-activity-module/w/list SWF Activity Module documentation]

==Demo==
Visit my [http://matbury.com/moodle/course/view.php?id=9 Moodle demo course] (Login as a guest) which allows users to login without creating an account.

SWF Activity Module

2010-08-20T16:56:23Z

Mattbury: /* General Features */

=Truly interactive e-learning with Rich Internet Applications=

The SWF Activity Module is a Moodle plugin extension for deploying Flash learning applications, also known as Flash templates. Teachers and course content developers can use the SWF Activity Module to deploy any Flash applications, including but not limited to those that use external data and media in order to function correctly. It also allows Flash applications to communicate with Moodle for purposes such as passing learners' grades into Moodle's grade book.

It does not include any Flash learning applications. However, a word search application is provided separately for testing and demonstration purposes. You're also free to use the word search in courses if you wish.

Sufficient documentation, source code and examples are provided on this project site so that Flash developers can easily write or adapt applications to work fully with the SWF Activity Module. See the project wiki pages for further details.

==Production==

Please note: This module is now ready for production.

For a summary of the latest developments of the SWF Activity Module, please see the [http://code.google.com/p/swf-activity-module/wiki/ChangeLog ChangeLog] page.

==Why develop the SWF Activity Module?==

I started the SWF Activity Module project to resolve two issues in Moodle:

* Moodle does not provide an effective, W3C standards compliant way to embed Flash applications in its web pages.
* Moodle does not provide any direct means of communication between Flash applications and its functions and data (generally referred to as an API - Application Programming Interface)

These two issues effectively make it very difficult for developers and almost impossible for non-developers, such as teachers, course content developers and instructional designers, to deploy dynamic, Flash based e-learning applications in Moodle.

The SWF Activity Module provides an easy, reliable way for developers and non-developers (i.e. teachers, trainers, course content developers and instructional designers) to deploy Flash e-learning interactions in Moodle.

No Flash e-learning applications are included with the SWF Activity Module, except for a word search activity, available as a separate download, to help you get started.

==General Features==

* Uses a "wizard interface" to deploy Flash learning applications: No developer skills necessary
* Supports all versions of Flash and is forwardly compatible
* Section 508 (accessibility) compliant
* Supports web services including dynamic API keys: No need to hard-code API keys into your software!
* Pushes grades from Flash learning applications into Moodle grade book
* Supports customisable FlashVars so that many existing 3rd party Flash applications can also be deployed
* Uses SWF Object - W3C standards compliant Flash embedding method, the best Flash embed method available: stable, fully functioning and reliable, as recommended by Adobe and leading Flash developers
* Detects users' Flash Player version to inform users if they need to upgrade
* Supports all Flash Player parameters
* Works in all browsers and browser versions that support Flash Player 6 and later
* Even works in browsers with Javascript disabled

==Supports Flash Remoting==

* Uses AMFPHP as a communication gateway with Moodle
* Compatible with ActionScript 3.0 (Flash Player 9 and later)
* Includes Access.php service to authenticate users and determine their capabilities seamlessly and securely (i.e. no need to re-login in Flash applications)
* Includes service library to give Flash clients access to Moodle functions for things like Users, Groups, Grades, etc.
* Object Oriented code: Requires PHP5 or later

==Supports XML==

* Can deploy dynamic Flash learning applications that load in external lesson data via XML
* URLs to XML files are dynamic: No need to hard-code them
* One Flash learning application can present an unlimited number of learning interactions (lessons)
* Supports any type of XML that the deployed learning application is compatible with: XML, RSS, ATOM, SMIL, etc.
* Supported by W3C standards for dynamic content
* Ideal for non-developers: A wide range of 3rd party XML authoring tools available

==Does Not Support Authorware==

Please note: Most authorware packages such as Adobe Captivate, Techsmith Camtasia, Raptivity, etc. publish learning interactions specifically for static web pages and in SCORM packages. They do not function correctly in dynamic web pages such as Moodle activity modules. (The Moodle SCORM activity module is a special exception to this).

However, it is sometimes possible to deploy screen recordings if they are single output .swf files. Due to the limit on the number of animation frames a single .swf file can contain, this is only possible for relatively short recordings.

==Documentation==

[http://code.google.com/p/swf-activity-module/w/list SWF Activity Module documentation]

==Demo==
Visit my [http://matbury.com/moodle/course/view.php?id=9 Moodle demo course] (Login as a guest) which allows users to login without creating an account.

SWF Activity Module

2010-08-20T16:53:40Z

Mattbury: New page: =Truly interactive e-learning with Rich Internet Applications= The SWF Activity Module is a Moodle plugin extension for deploying Flash learning applications, also known as Flash template...

=Truly interactive e-learning with Rich Internet Applications=

The SWF Activity Module is a Moodle plugin extension for deploying Flash learning applications, also known as Flash templates. Teachers and course content developers can use the SWF Activity Module to deploy any Flash applications, including but not limited to those that use external data and media in order to function correctly. It also allows Flash applications to communicate with Moodle for purposes such as passing learners' grades into Moodle's grade book.

It does not include any Flash learning applications. However, a word search application is provided separately for testing and demonstration purposes. You're also free to use the word search in courses if you wish.

Sufficient documentation, source code and examples are provided on this project site so that Flash developers can easily write or adapt applications to work fully with the SWF Activity Module. See the project wiki pages for further details.

==Production==

Please note: This module is now ready for production.

For a summary of the latest developments of the SWF Activity Module, please see the [http://code.google.com/p/swf-activity-module/wiki/ChangeLog ChangeLog] page.

==Why develop the SWF Activity Module?==

I started the SWF Activity Module project to resolve two issues in Moodle:

* Moodle does not provide an effective, W3C standards compliant way to embed Flash applications in its web pages.
* Moodle does not provide any direct means of communication between Flash applications and its functions and data (generally referred to as an API - Application Programming Interface)

These two issues effectively make it very difficult for developers and almost impossible for non-developers, such as teachers, course content developers and instructional designers, to deploy dynamic, Flash based e-learning applications in Moodle.

The SWF Activity Module provides an easy, reliable way for developers and non-developers (i.e. teachers, trainers, course content developers and instructional designers) to deploy Flash e-learning interactions in Moodle.

No Flash e-learning applications are included with the SWF Activity Module, except for a word search activity, available as a separate download, to help you get started.

==General Features==

* Uses a "wizard interface" to deploy Flash learning applications: No developer skills necessary
* Supports all versions of Flash and is forwardly compatible
* Section 508 (accessibility) compliant
* Supports web services including dynamic API keys: No need to hard-code API keys into your software!
* Pushes grades from Flash learning applications into Moodle grade book
* Supports customisable FlashVars so that many existing 3rd party Flash applications can also be deployed
* Uses SWF Object - W3C standards compliant Flash embedding method, the best Flash embed method available: stable, fully functioning and reliable, as recommended by Adobe and leading Flash developers
* Detects users' Flash Player version to inform users if they need to upgrade
* Supports all Flash Player parameters
* Works in all browsers and browser versions that support Flash Player 6 and later
* Even works in browsers with Javascript disabled
* Supports Flash Remoting
* Uses AMFPHP as a communication gateway with Moodle
* Compatible with ActionScript 3.0 (Flash Player 9 and later)
* Includes Access.php service to authenticate users and determine their capabilities seamlessly and securely (i.e. no need to re-login in Flash applications)
* Includes service library to give Flash clients access to Moodle functions for things like Users, Groups, Grades, etc.
* Object Oriented code: Requires PHP5 or later

==Supports XML==

* Can deploy dynamic Flash learning applications that load in external lesson data via XML
* URLs to XML files are dynamic: No need to hard-code them
* One Flash learning application can present an unlimited number of learning interactions (lessons)
* Supports any type of XML that the deployed learning application is compatible with: XML, RSS, ATOM, SMIL, etc.
* Supported by W3C standards for dynamic content
* Ideal for non-developers: A wide range of 3rd party XML authoring tools available

==Does Not Support Authorware==

Please note: Most authorware packages such as Adobe Captivate, Techsmith Camtasia, Raptivity, etc. publish learning interactions specifically for static web pages and in SCORM packages. They do not function correctly in dynamic web pages such as Moodle activity modules. (The Moodle SCORM activity module is a special exception to this).

However, it is sometimes possible to deploy screen recordings if they are single output .swf files. Due to the limit on the number of animation frames a single .swf file can contain, this is only possible for relatively short recordings.

==Documentation==

[http://code.google.com/p/swf-activity-module/w/list SWF Activity Module documentation]

==Demo==
Visit my [http://matbury.com/moodle/course/view.php?id=9 Moodle demo course] (Login as a guest) which allows users to login without creating an account.

Development:SWF

2010-08-20T16:42:20Z

Mattbury: /* SWF Activity Module */

==SWF Activity Module==

The module documentation on this page is out of date. Please see the [[SWF Activity Module]] project site for up to date downloads, documentation and help.

I've moved the project code and documentation to Google Code: [http://code.google.com/p/swf-activity-module/ code.google.com/p/swf-activity-module/]

The most recent downloads and documentation are available there.

==What is the SWF Activity Module?==

The SWF Activity Module provides a comprehensive and flexible method for deploying Flash and Flex Framework learning applications as activities in a Moodle course.

==How does is work?==

===SWFObject===

The SWF Activity Module uses [http://code.google.com/p/swfobject/ SWFObject] as the default embed method for Flash and Flex Framework learning applications. The module also incorporates standard XHTML 1.0 strict object and embed code that functions if SWFObject fails for any reason, e.g. If the user has Javascript blocked in his/her browser.

Once installed, select SWF from an "Add an activity" list on a Moodle course page. The standard "Adding a new SWF to topic... " moodleform will appear. Help files are included in the SWF Activity Module in English and provide further details about the parameters. In this form you can set the following parameters:

===Required Parameters===
<pre>
* As with all Moodle activities, name and intro.
* SWF file
* Height
* Width
* Version
</pre>

===Optional Parameters===
<pre>
* AMF Interaction (Not yet implemented)
* XML file URL
* FlashVars #1
* FlashVars #2
* FlashVars #3
</pre>

===Advanced Parameters===
<pre>
* API Key (SWF Activity Module custom parameter)
* Align
* Auto Play
* Loop Playback
* Menu
* Quality
* Scale Mode
* Stage Align
* Window Mode
* Background
* Use Device Font
* Seamless Tabbing
* Allow Full Screen
* Allow Script Access
* Allow Networking
</pre>
You can find more details about these parameters in the [http://code.google.com/p/swfobject/wiki/documentation SWFObject Documentation].

==What features does it support?==

The SWF Activity Module automatically provides a deployed SWF learning activity application with the following data:
<pre>
* gateway - URL to gateway script for access to AMFPHP service library
* course - the current Moodle course that the user is accessing
* instance - Instance ID of the module
* swfid - The ID of the SWF learning activity application
* interaction - The ID of the SWF learning interaction data to consume (AMFPHP)
* moodledata - The URL to access the current moodledata course directory (file.php)
</pre>
It also supports a number of features, specific to Flash and Flex applications. They are:

===Flash Remoting (AMF)===

Flash Remoting is a method for Flash or Flex applications to communicate directly with server-side applications written in .NET, Java, PHP, Cold Fusion and Ruby on Rails. There are a number of open-source libraries for handling communication via Flash Remoting:

See [[Development:AMF3]] for details on how to set up AMFPHP in Moodle and more information about Flash Remoting technologies.

===XML Data Loading===

XML is a native data type to ActionScript 3.0 therefore Flash and Flex Framework learning applications use E4X notation to manipulate XML data in a similar way to a multidimensional array. For more details, see [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/ Adobe Actionscript 3.0 Language and Components Reference]. XML is also currently the most commonly used format for providing elearning data for learning interactions. The most commonly used format is [http://en.wikipedia.org/wiki/IMS_Global IMS]'s standard [http://en.wikipedia.org/wiki/QTI QTI] (Question and Test Interoperability specification) but basically any valid XML file with the appropriate data tree structure can be loaded into and consumed by a SWF file.

===FlashVars===

FlashVars is a method for passing string data into a SWF file. It is passed in from the printed HTML page that the SWF file is embedded in. It's ideally suited to very simple data sets such a vocabulary lists or series of numerical values. For learning activities such as hangman, crosswords, word searches, etc., FlashVars is simple, efficient and easy to use.

==What's Next?==

===Moodle Grades===

One of the most requested features for Flash and Flex Framework learning applications deployed in Moodle is for them to have the ability to record learners' activities in Moodle's Gradebook.

===AMFPHP===

The most powerful and flexible way for Flash and Flex Framework learning applications to interact with Moodle APIs, databases and web services is via Flash Remoting AKA [http://blogs.adobe.com/mikepotter/2006/12/amfphp_adds_amf.html AMF3], a communication protocol which is similar to JSON but much faster. It allows Flash and Flex Framework learning applications to directly call PHP methods and pass a number of different data types back and forth seamlessly.

For more details about using AMFPHP in Moodle, see [[Development:AMF3]]

===Learning Interaction Data DB Structure===

A standardised DB table structure to store learning interaction data with a variety of methods to populate the tables with data, including Moodle forms, dynamic Flash or Flex Framework on-line forms.

Also, standalone Adobe AIR desktop GUI applications, which can store data locally using SQLite, to create and edit learning interactions and then upload them. Using Adobe AIR will also provide convenient backup of interaction data and a means to easily transfer and distribute learning interactions.

====swf_interactions fields====
<pre>
* id
* course
* name
* intro
* introformat
* amftable - Default is swf_interaction_data but this allows for further, more specialised tables to be used
* timecreated
* timemodified
</pre>

====swf_interaction_data fields====
<pre>
* id
* interaction - ID of interaction (id of swf_interactions)
* ordernum - Allow sequential ordering of rows
* amp3 - URL of answer MP3 file
* qmp3 - URL of quesition MP3 file
* smp3 - URL of additional MP3 file
* image - URL of image file
* video - URL of FLV file
* ptext - Paragraph text
* qtext - Question
* catext - Correct answers (for multiple choice, use pipe separator as delimiter)
* watext - Wrong answers (for multiple choice, use pipe separator as delimiter)
* timecreated
* timemodified
</pre>

==See Also==

* [[Development:AMF3]] Flash Remoting for Moodle.
* [http://code.google.com/p/moodle-mplayer/ Media Player] Activity Module for deploying video in Moodle as an activity. Leverages the full range of functions of Jeroen Wijering's JW FLV Player.
* [http://matbury.com/ Matt Bury's website and Moodle] with demos of SWF Activity Module and Media Player modules.

Media Player

2010-08-20T16:37:35Z

Mattbury:

Media Player

2010-08-20T16:27:23Z

Mattbury:

Media Player

2010-08-20T16:24:19Z

Mattbury: /* Plugins */

==Summary==

The JW FLV Player 5.1 is a powerful and extremely versatile application for viewing video on web pages. The Media Player module acts as a wizard to deploy and configure the JW FLV Player. It doesn't require any coding abilities and is possibly the quickest, easiest, most comprehensive and robust method of deploying and configuring video in Moodle.

[[Image:flv_player.jpg]]

===Download===

The project code and documentation are hosted on Google Code at: [http://code.google.com/p/moodle-mplayer/ http://code.google.com/p/moodle-mplayer/]

The most recent downloads and documentation are available there.

Jeroen Wijering's FLV Player is an ideal method to deploy Flash video in Moodle. It's extremely versatile and supports a number of features that are particularly useful for e-learning:

* [http://en.wikipedia.org/wiki/Section_508 Section 508] (accessibility) compliance.
* Support for [http://en.wikipedia.org/wiki/Timed_text TimedText XML] and RealText (SMIL) captioning.
* A selection of plugins and skins are available.
* Developers can create their own skins and plugins.

===License===

Although this Moodle module is open source, '''Jeroen Wijering's FLV player, included within, is not open source'''. It is commercial software which is available free for noncommercial use, but requires a (small) license payment for all other use. Please see [http://www.longtailvideo.com/ Jeroen Wijering's web site] for licensing details.

==Supported Video Formats==

Supports all video formats supported by Flash Player 9 and above. Currently (5th February 2009) file types:

* FLV
* MP4
* M4V
* M4A
* 3GP
* MOV

It also supports the new standard high-definition CODEC, H.264, and AAC audio (Advanced Audio Compression) which is similar to MP3 but gives better quality at very low bit-rates.

==Captioning==

The FLV Player module makes it much easier to deploy captions with the JW FLV Player. Simply do the following:

* Prepare the video and TimedText (RealText is also supported) files.
* Upload them to the moodledata course directory (you can also upload these from the FLV Player module form)
* Create an instance of the FLV Player module and select the video file and desired parameters.
* Select Show Advanced if not already shown.
* At the bottom of the Behaviour section, type accessibility-1 into the Plugins text input area.
* Select Choose or upload file in the Timed Text Captions input area and select or upload and select the desired TimedText captions file.
* Select Save changes (Moodle 1.8) or Save changes and preview (Moodle 1.9)

Here are example [http://matbury.com/assets/captions_example.zip FLV video and TimedText caption XML] to download and try (7.75 MB).

[http://ncam.wgbh.org/webaccess/magpie/magpie_help/introduction.html MAGpie2 captioning editor] can export Adobe Flash WC3 DFXP captioning files which are compatible with JW FLV Player accessibility-1 plugin. However, the editor cannot play FLV files therefore an intermediary video file type, such as AVI, is necessary for creating caption files, i.e. create and export the caption file before encoding the video to FLV.

==Streaming==

There are two main types of video connection, '''progressive download''', where the video FLV file is downloaded into the browser cache and the user can start to view the video content after a second or two, and '''streaming''', where specific portions of the video stream are served to the video player as and when requested. Progressive download is the easiest to implement and the most commonly used.

The JW FLV Player supports:

* Progressive download (default)
* [http://www.longtailvideo.com/support/tutorials/HTTP-Video-Streaming HTTP streaming] (pseudo-streaming)
* [http://www.lighttpd.net/ LIGHTTP] streaming
* [http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol RTMP] streaming ([http://www.osflash.org/red5 Red5] and [http://en.wikipedia.org/wiki/Flash_Media_Server Flash Media Server])

==Playing YouTube.com Videos==

Playing videos directly from YouTube.com's servers is possibly the easiest way to play videos with the FLV Player Activity Module. Just follow these steps:

* Find the video you want to show on YouTube.com
* On a Moodle course page, select 'FLV Player' from the 'Add an activity...' list
* On the YouTube.com video page, copy the URL in your browser's address bar, e.g. http://www.youtube.com/watch?v=5lp1-OrycKs
* Now paste the URL in the 'Video URL' text field of the FLV Player form
* Select 'Show Advanced' if not already set
* Select 'youtube' from the 'Type' list
* Select 'Save Changes' (Moodle 1.8) or 'Save and Preview' (Moodle 1.9) at the bottom of the FLV Player form
* The YouTube.com video should play and all the parameters, such as icons, links, etc. will still function.

==Skins==

Skins are a quick and easy way to change the appearance of JW FLV Player. The FLV Player Activity Module comes supplied with 27 skins which you can select from a list.

* [http://www.longtailvideo.com/addons/skins JW FLV Player skins].

==Plugins==

Plugins add extra functionality to JW FLV Player. They are hosted on LongTail video's website so no downloading or installing is necessary. The Media Player setup wizard includes specific configuration panels which make deploying plugins as easy as possible. See the [http://code.google.com/p/moodle-mplayer/w/list Media Player project site] wiki for documentation. Supported plugins are:

* '''Audiodescription''' External audio track synchronised with video
* '''Captions''' SMIL TimedText and SubRip captions which are more flexible and easier to read that embedded subtitles
* '''HD''' Users can switch between high-definition and normal video streams
* '''Infobox''' Convenient way to display credits and info about video
* '''Livestream''' No need to keep refreshing the web page while you're waiting for a live broadcast, polls the live server every few seconds
* '''Logobox''' Put your logo on your videos
* '''Metaviewer''' View video stream metadata (debugging and info tool)
* '''Searchbar''' Search for videos, YouTube.com by default, can be used with custom search scripts
* '''Snapshot''' Take a still frame "snapshot" of a video and save it in the course files directory

There are also subscription and paid for plugin services available. [http://www.longtailvideo.com/addons/plugins Find documentation and further details here.]

==Module Form==

The module form allows users to set most of the parameters supported by JW FLV Player 4.3. [http://developer.longtailvideo.com/trac/wiki/FlashVars You can find documentation on the following parameters here.]

===Source===
* '''flvfile''' 'Video URL'
* '''type''' 'Type'
* '''streamer''' 'Streamer'

===Appearance===
* '''width''' 'Width'
* '''height''' 'Height'
* '''skin''' 'Skin'
* '''image''' 'Image'
* '''icons''' 'Icons'
* '''logo''' 'Logo'
* '''controlbar''' 'Control Bar'
* '''playlist''' 'Play List (position)'
* '''playlistsize''' 'Play List Size (pixels)'
* '''backcolor''' 'Back Color'
* '''frontcolor''' 'Front Color'
* '''lightcolor''' 'Light Color'
* '''screencolor''' 'Screen Color'

===Behaviour===
* '''autostart''' 'Auto Start'
* '''fullscreen''' 'Full Screen'
* '''volume''' 'Volume'
* '''mute''' 'Mute'
* '''flvstart''' 'Start (position in seconds)'
* '''duration''' 'Duration (seconds)'
* '''flvrepeat''' 'Repeat'
* '''shuffle''' 'Shuffle'
* '''bufferlength''' 'Buffer Length (seconds)'
* '''quality''' 'Quality'
* '''displayclick''' 'Display Click'
* '''link''' 'Link'
* '''linktarget''' 'Link Target'
* '''item''' 'Item'
* '''resizing''' 'Resizing'
* '''stretching''' 'Stretching'
* '''plugins''' 'Plugins'
* '''captions''' 'Timed Text Captions'

===Metadata===
* '''author''' 'Author'
* '''flvdate''' 'Date'
* '''title''' 'Title'
* '''description''' 'FLV Description'
* '''tags''' 'Tags'

===Advanced===
* '''configxml''' 'Config XML File'
* '''version''' 'JW Player Version'
* '''client''' 'Client'
* '''tracecall''' 'Trace Call (debugging)'
* '''flvid''' 'ID (For Linux OS Users Only)'
* '''abouttext''' 'About Text'
* '''aboutlink''' 'About Link'

==Issues==

If you have any problems or issues with the FLV Player module, please list them, as clearly as you can, here.

* Does not have a backup.php or a restore.php file. This indicates that FLV activities will not be backed up or restored when these processes are run.

==Resolved Issues==

* Browsers cached video files, images, icons and XML files. Users still saw old (cached files) after they had been updated on the server. The FLV Player Activity Module now prevents caching.

==See Also==

* [http://ncam.wgbh.org/webaccess/magpie/ NCAM MAGpie2] (Media Access Generator) for authoring caption and subtitle files*
* [http://www.longtailvideo.com/ Jeroen Wijering's web site] Including plugins, skins, tutorials and licensing details.
* An article on the [http://www.digital-web.com/articles/captions_flash_video/ Closed Captioning] component in Flash CS3 and its benefits for accessibility.
* [http://matbury.com/ Matt Bury's website] FLV Activity Module project developer.
* [http://xmoov.com/xmoov-php/ Xmoov] HTTP (pseudo) streaming open source project.
* [http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol RTMP] streaming media servers
* [http://www.osflash.org/red5 Red5] open source media server
* [http://www.adobe.com/products/flashmediaserver/ Adobe Flash Media Server]
* [http://www.lighttpd.net/ Lighttp] open source project which includes a streaming server

(*) MAGpie2 can export TimedText caption files for JW FLV Player but its video player does not support the FLV file type. It is therefore necessary to use an intermediary video file type, such as AVI, in order to create the captions.

===Other Projects by Matt Bury===
* [[Development:SWF]] SWF Activity Module, in development, which will enable deployment of Flash and Flex Framework learning applications (RIAs) in Moodle and leverage AMFPHP (Flash Remoting).

Media Player

2010-08-20T16:18:25Z

Mattbury: New page: ==Summary== The JW FLV Player 5.1 is a powerful and extremely versatile application for viewing video on web pages. The Media Player module acts as a wizard to deploy and configure the JW...

==Summary==

The JW FLV Player 5.1 is a powerful and extremely versatile application for viewing video on web pages. The Media Player module acts as a wizard to deploy and configure the JW FLV Player. It doesn't require any coding abilities and is possibly the quickest, easiest, most comprehensive and robust method of deploying and configuring video in Moodle.

[[Image:flv_player.jpg]]

===Download===

The project code and documentation are hosted on Google Code at: [http://code.google.com/p/moodle-mplayer/ http://code.google.com/p/moodle-mplayer/]

The most recent downloads and documentation are available there.

Jeroen Wijering's FLV Player is an ideal method to deploy Flash video in Moodle. It's extremely versatile and supports a number of features that are particularly useful for e-learning:

* [http://en.wikipedia.org/wiki/Section_508 Section 508] (accessibility) compliance.
* Support for [http://en.wikipedia.org/wiki/Timed_text TimedText XML] and RealText (SMIL) captioning.
* A selection of plugins and skins are available.
* Developers can create their own skins and plugins.

===License===

Although this Moodle module is open source, '''Jeroen Wijering's FLV player, included within, is not open source'''. It is commercial software which is available free for noncommercial use, but requires a (small) license payment for all other use. Please see [http://www.longtailvideo.com/ Jeroen Wijering's web site] for licensing details.

==Supported Video Formats==

Supports all video formats supported by Flash Player 9 and above. Currently (5th February 2009) file types:

* FLV
* MP4
* M4V
* M4A
* 3GP
* MOV

It also supports the new standard high-definition CODEC, H.264, and AAC audio (Advanced Audio Compression) which is similar to MP3 but gives better quality at very low bit-rates.

==Captioning==

The FLV Player module makes it much easier to deploy captions with the JW FLV Player. Simply do the following:

* Prepare the video and TimedText (RealText is also supported) files.
* Upload them to the moodledata course directory (you can also upload these from the FLV Player module form)
* Create an instance of the FLV Player module and select the video file and desired parameters.
* Select Show Advanced if not already shown.
* At the bottom of the Behaviour section, type accessibility-1 into the Plugins text input area.
* Select Choose or upload file in the Timed Text Captions input area and select or upload and select the desired TimedText captions file.
* Select Save changes (Moodle 1.8) or Save changes and preview (Moodle 1.9)

Here are example [http://matbury.com/assets/captions_example.zip FLV video and TimedText caption XML] to download and try (7.75 MB).

[http://ncam.wgbh.org/webaccess/magpie/magpie_help/introduction.html MAGpie2 captioning editor] can export Adobe Flash WC3 DFXP captioning files which are compatible with JW FLV Player accessibility-1 plugin. However, the editor cannot play FLV files therefore an intermediary video file type, such as AVI, is necessary for creating caption files, i.e. create and export the caption file before encoding the video to FLV.

==Streaming==

There are two main types of video connection, '''progressive download''', where the video FLV file is downloaded into the browser cache and the user can start to view the video content after a second or two, and '''streaming''', where specific portions of the video stream are served to the video player as and when requested. Progressive download is the easiest to implement and the most commonly used.

The JW FLV Player supports:

* Progressive download (default)
* [http://www.longtailvideo.com/support/tutorials/HTTP-Video-Streaming HTTP streaming] (pseudo-streaming)
* [http://www.lighttpd.net/ LIGHTTP] streaming
* [http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol RTMP] streaming ([http://www.osflash.org/red5 Red5] and [http://en.wikipedia.org/wiki/Flash_Media_Server Flash Media Server])

==Playing YouTube.com Videos==

Playing videos directly from YouTube.com's servers is possibly the easiest way to play videos with the FLV Player Activity Module. Just follow these steps:

* Find the video you want to show on YouTube.com
* On a Moodle course page, select 'FLV Player' from the 'Add an activity...' list
* On the YouTube.com video page, copy the URL in your browser's address bar, e.g. http://www.youtube.com/watch?v=5lp1-OrycKs
* Now paste the URL in the 'Video URL' text field of the FLV Player form
* Select 'Show Advanced' if not already set
* Select 'youtube' from the 'Type' list
* Select 'Save Changes' (Moodle 1.8) or 'Save and Preview' (Moodle 1.9) at the bottom of the FLV Player form
* The YouTube.com video should play and all the parameters, such as icons, links, etc. will still function.

==Skins==

Skins are a quick and easy way to change the appearance of JW FLV Player. The FLV Player Activity Module comes supplied with 27 skins which you can select from a list.

* [http://www.longtailvideo.com/addons/skins JW FLV Player skins].

==Plugins==

Plugins add extra functionality to JW FLV Player. They are hosted on LongTail video's website so no downloading or installing is necessary. Simply type the name of one or more of the plugins you require in the Plugins text input area in the Behaviour section of the FLV Player Activity Module form. Available plugins are:

* accessibility-1
* viral-1
* rateit-1
* drelated-1
* embed-1
* tipjar-1
* googlytics-1
* revolt-1
* yourlytics-1
* yousearch-1
* searchtoob-1
* quickkeys-1
* metaviewer-1
* hd-1
* soundproxy-1
* clickproxy-1

There are also subscription and paid for plugin services available. [http://www.longtailvideo.com/addons/plugins Find documentation and further details here.]

==Module Form==

The module form allows users to set most of the parameters supported by JW FLV Player 4.3. [http://developer.longtailvideo.com/trac/wiki/FlashVars You can find documentation on the following parameters here.]

===Source===
* '''flvfile''' 'Video URL'
* '''type''' 'Type'
* '''streamer''' 'Streamer'

===Appearance===
* '''width''' 'Width'
* '''height''' 'Height'
* '''skin''' 'Skin'
* '''image''' 'Image'
* '''icons''' 'Icons'
* '''logo''' 'Logo'
* '''controlbar''' 'Control Bar'
* '''playlist''' 'Play List (position)'
* '''playlistsize''' 'Play List Size (pixels)'
* '''backcolor''' 'Back Color'
* '''frontcolor''' 'Front Color'
* '''lightcolor''' 'Light Color'
* '''screencolor''' 'Screen Color'

===Behaviour===
* '''autostart''' 'Auto Start'
* '''fullscreen''' 'Full Screen'
* '''volume''' 'Volume'
* '''mute''' 'Mute'
* '''flvstart''' 'Start (position in seconds)'
* '''duration''' 'Duration (seconds)'
* '''flvrepeat''' 'Repeat'
* '''shuffle''' 'Shuffle'
* '''bufferlength''' 'Buffer Length (seconds)'
* '''quality''' 'Quality'
* '''displayclick''' 'Display Click'
* '''link''' 'Link'
* '''linktarget''' 'Link Target'
* '''item''' 'Item'
* '''resizing''' 'Resizing'
* '''stretching''' 'Stretching'
* '''plugins''' 'Plugins'
* '''captions''' 'Timed Text Captions'

===Metadata===
* '''author''' 'Author'
* '''flvdate''' 'Date'
* '''title''' 'Title'
* '''description''' 'FLV Description'
* '''tags''' 'Tags'

===Advanced===
* '''configxml''' 'Config XML File'
* '''version''' 'JW Player Version'
* '''client''' 'Client'
* '''tracecall''' 'Trace Call (debugging)'
* '''flvid''' 'ID (For Linux OS Users Only)'
* '''abouttext''' 'About Text'
* '''aboutlink''' 'About Link'

==Issues==

If you have any problems or issues with the FLV Player module, please list them, as clearly as you can, here.

* Does not have a backup.php or a restore.php file. This indicates that FLV activities will not be backed up or restored when these processes are run.

==Resolved Issues==

* Browsers cached video files, images, icons and XML files. Users still saw old (cached files) after they had been updated on the server. The FLV Player Activity Module now prevents caching.

==See Also==

* [http://ncam.wgbh.org/webaccess/magpie/ NCAM MAGpie2] (Media Access Generator) for authoring caption and subtitle files*
* [http://www.longtailvideo.com/ Jeroen Wijering's web site] Including plugins, skins, tutorials and licensing details.
* An article on the [http://www.digital-web.com/articles/captions_flash_video/ Closed Captioning] component in Flash CS3 and its benefits for accessibility.
* [http://matbury.com/ Matt Bury's website] FLV Activity Module project developer.
* [http://xmoov.com/xmoov-php/ Xmoov] HTTP (pseudo) streaming open source project.
* [http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol RTMP] streaming media servers
* [http://www.osflash.org/red5 Red5] open source media server
* [http://www.adobe.com/products/flashmediaserver/ Adobe Flash Media Server]
* [http://www.lighttpd.net/ Lighttp] open source project which includes a streaming server

(*) MAGpie2 can export TimedText caption files for JW FLV Player but its video player does not support the FLV file type. It is therefore necessary to use an intermediary video file type, such as AVI, in order to create the captions.

===Other Projects by Matt Bury===
* [[Development:SWF]] SWF Activity Module, in development, which will enable deployment of Flash and Flex Framework learning applications (RIAs) in Moodle and leverage AMFPHP (Flash Remoting).

mod/swf/view

2010-05-11T10:42:46Z

Mattbury:

This article is a stub.

The SWF Activity Module provides an easy to use method of deploying Flash learning interactions in Moodle. It's designed for dynamic Flash learning applications, also known as Flash templates, that can load interaction (lesson or activity) data from an external source such as XML, a database or a web service.

For more information about the SWF Activity Module, please visit the project site on Google Code:

* [http://code.google.com/p/swf-activity-module/ Project home page]
* [http://code.google.com/p/swf-activity-module/w/list Documentation]
* [http://code.google.com/p/swf-activity-module/issues/list Issues tracker]
* [http://matbury.com/moodle/course/view.php?id=9 SWF Activity Module learning application demo course] (Login as a guest)

mod/swf/view

2010-05-11T10:42:15Z

Mattbury:

mod/swf/view

2010-05-11T10:41:07Z

Mattbury:

This article is a stub.

The SWF Activity Module provides an easy to use method of deploying Flash learning interactions in Moodle. It's designed for dynamic Flash learning applications, also known as Flash templates, that can load interaction (lesson or activity) data from an external source such as XML, a database or a web service.

For more information about the SWF Activity Module, please visit the project site on Google Code:

* [http://code.google.com/p/swf-activity-module/ project home page]

* [http://code.google.com/p/swf-activity-module/w/list documentation]

* [http://code.google.com/p/swf-activity-module/issues/list issues tracker]

* [http://matbury.com/moodle/course/view.php?id=9 SWF Activity Module learning application demo course]

Development:SWF

2010-03-13T02:01:47Z

Mattbury: /* See Also */

==SWF Activity Module==

The module documentation on this page is out of date. Please see the SWF Activity Module project site for up to date downloads, documentation and help.

I've moved the project code and documentation to Google Code: [http://code.google.com/p/swf-activity-module/ code.google.com/p/swf-activity-module/]

The most recent downloads and documentation are available there.

==What is the SWF Activity Module?==

The SWF Activity Module provides a comprehensive and flexible method for deploying Flash and Flex Framework learning applications as activities in a Moodle course.

==How does is work?==

===SWFObject===

The SWF Activity Module uses [http://code.google.com/p/swfobject/ SWFObject] as the default embed method for Flash and Flex Framework learning applications. The module also incorporates standard XHTML 1.0 strict object and embed code that functions if SWFObject fails for any reason, e.g. If the user has Javascript blocked in his/her browser.

Once installed, select SWF from an "Add an activity" list on a Moodle course page. The standard "Adding a new SWF to topic... " moodleform will appear. Help files are included in the SWF Activity Module in English and provide further details about the parameters. In this form you can set the following parameters:

===Required Parameters===
<pre>
* As with all Moodle activities, name and intro.
* SWF file
* Height
* Width
* Version
</pre>

===Optional Parameters===
<pre>
* AMF Interaction (Not yet implemented)
* XML file URL
* FlashVars #1
* FlashVars #2
* FlashVars #3
</pre>

===Advanced Parameters===
<pre>
* API Key (SWF Activity Module custom parameter)
* Align
* Auto Play
* Loop Playback
* Menu
* Quality
* Scale Mode
* Stage Align
* Window Mode
* Background
* Use Device Font
* Seamless Tabbing
* Allow Full Screen
* Allow Script Access
* Allow Networking
</pre>
You can find more details about these parameters in the [http://code.google.com/p/swfobject/wiki/documentation SWFObject Documentation].

==What features does it support?==

The SWF Activity Module automatically provides a deployed SWF learning activity application with the following data:
<pre>
* gateway - URL to gateway script for access to AMFPHP service library
* course - the current Moodle course that the user is accessing
* instance - Instance ID of the module
* swfid - The ID of the SWF learning activity application
* interaction - The ID of the SWF learning interaction data to consume (AMFPHP)
* moodledata - The URL to access the current moodledata course directory (file.php)
</pre>
It also supports a number of features, specific to Flash and Flex applications. They are:

===Flash Remoting (AMF)===

Flash Remoting is a method for Flash or Flex applications to communicate directly with server-side applications written in .NET, Java, PHP, Cold Fusion and Ruby on Rails. There are a number of open-source libraries for handling communication via Flash Remoting:

See [[Development:AMF3]] for details on how to set up AMFPHP in Moodle and more information about Flash Remoting technologies.

===XML Data Loading===

XML is a native data type to ActionScript 3.0 therefore Flash and Flex Framework learning applications use E4X notation to manipulate XML data in a similar way to a multidimensional array. For more details, see [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/ Adobe Actionscript 3.0 Language and Components Reference]. XML is also currently the most commonly used format for providing elearning data for learning interactions. The most commonly used format is [http://en.wikipedia.org/wiki/IMS_Global IMS]'s standard [http://en.wikipedia.org/wiki/QTI QTI] (Question and Test Interoperability specification) but basically any valid XML file with the appropriate data tree structure can be loaded into and consumed by a SWF file.

===FlashVars===

FlashVars is a method for passing string data into a SWF file. It is passed in from the printed HTML page that the SWF file is embedded in. It's ideally suited to very simple data sets such a vocabulary lists or series of numerical values. For learning activities such as hangman, crosswords, word searches, etc., FlashVars is simple, efficient and easy to use.

==What's Next?==

===Moodle Grades===

One of the most requested features for Flash and Flex Framework learning applications deployed in Moodle is for them to have the ability to record learners' activities in Moodle's Gradebook.

===AMFPHP===

The most powerful and flexible way for Flash and Flex Framework learning applications to interact with Moodle APIs, databases and web services is via Flash Remoting AKA [http://blogs.adobe.com/mikepotter/2006/12/amfphp_adds_amf.html AMF3], a communication protocol which is similar to JSON but much faster. It allows Flash and Flex Framework learning applications to directly call PHP methods and pass a number of different data types back and forth seamlessly.

For more details about using AMFPHP in Moodle, see [[Development:AMF3]]

===Learning Interaction Data DB Structure===

A standardised DB table structure to store learning interaction data with a variety of methods to populate the tables with data, including Moodle forms, dynamic Flash or Flex Framework on-line forms.

Also, standalone Adobe AIR desktop GUI applications, which can store data locally using SQLite, to create and edit learning interactions and then upload them. Using Adobe AIR will also provide convenient backup of interaction data and a means to easily transfer and distribute learning interactions.

====swf_interactions fields====
<pre>
* id
* course
* name
* intro
* introformat
* amftable - Default is swf_interaction_data but this allows for further, more specialised tables to be used
* timecreated
* timemodified
</pre>

====swf_interaction_data fields====
<pre>
* id
* interaction - ID of interaction (id of swf_interactions)
* ordernum - Allow sequential ordering of rows
* amp3 - URL of answer MP3 file
* qmp3 - URL of quesition MP3 file
* smp3 - URL of additional MP3 file
* image - URL of image file
* video - URL of FLV file
* ptext - Paragraph text
* qtext - Question
* catext - Correct answers (for multiple choice, use pipe separator as delimiter)
* watext - Wrong answers (for multiple choice, use pipe separator as delimiter)
* timecreated
* timemodified
</pre>

==See Also==

* [[Development:AMF3]] Flash Remoting for Moodle.
* [http://code.google.com/p/moodle-mplayer/ Media Player] Activity Module for deploying video in Moodle as an activity. Leverages the full range of functions of Jeroen Wijering's JW FLV Player.
* [http://matbury.com/ Matt Bury's website and Moodle] with demos of SWF Activity Module and Media Player modules.

Development:SWF

2010-03-13T02:00:00Z

Mattbury: /* SWF Activity Module */

==SWF Activity Module==

The module documentation on this page is out of date. Please see the SWF Activity Module project site for up to date downloads, documentation and help.

I've moved the project code and documentation to Google Code: [http://code.google.com/p/swf-activity-module/ code.google.com/p/swf-activity-module/]

The most recent downloads and documentation are available there.

==What is the SWF Activity Module?==

The SWF Activity Module provides a comprehensive and flexible method for deploying Flash and Flex Framework learning applications as activities in a Moodle course.

==How does is work?==

===SWFObject===

The SWF Activity Module uses [http://code.google.com/p/swfobject/ SWFObject] as the default embed method for Flash and Flex Framework learning applications. The module also incorporates standard XHTML 1.0 strict object and embed code that functions if SWFObject fails for any reason, e.g. If the user has Javascript blocked in his/her browser.

Once installed, select SWF from an "Add an activity" list on a Moodle course page. The standard "Adding a new SWF to topic... " moodleform will appear. Help files are included in the SWF Activity Module in English and provide further details about the parameters. In this form you can set the following parameters:

===Required Parameters===
<pre>
* As with all Moodle activities, name and intro.
* SWF file
* Height
* Width
* Version
</pre>

===Optional Parameters===
<pre>
* AMF Interaction (Not yet implemented)
* XML file URL
* FlashVars #1
* FlashVars #2
* FlashVars #3
</pre>

===Advanced Parameters===
<pre>
* API Key (SWF Activity Module custom parameter)
* Align
* Auto Play
* Loop Playback
* Menu
* Quality
* Scale Mode
* Stage Align
* Window Mode
* Background
* Use Device Font
* Seamless Tabbing
* Allow Full Screen
* Allow Script Access
* Allow Networking
</pre>
You can find more details about these parameters in the [http://code.google.com/p/swfobject/wiki/documentation SWFObject Documentation].

==What features does it support?==

The SWF Activity Module automatically provides a deployed SWF learning activity application with the following data:
<pre>
* gateway - URL to gateway script for access to AMFPHP service library
* course - the current Moodle course that the user is accessing
* instance - Instance ID of the module
* swfid - The ID of the SWF learning activity application
* interaction - The ID of the SWF learning interaction data to consume (AMFPHP)
* moodledata - The URL to access the current moodledata course directory (file.php)
</pre>
It also supports a number of features, specific to Flash and Flex applications. They are:

===Flash Remoting (AMF)===

Flash Remoting is a method for Flash or Flex applications to communicate directly with server-side applications written in .NET, Java, PHP, Cold Fusion and Ruby on Rails. There are a number of open-source libraries for handling communication via Flash Remoting:

See [[Development:AMF3]] for details on how to set up AMFPHP in Moodle and more information about Flash Remoting technologies.

===XML Data Loading===

XML is a native data type to ActionScript 3.0 therefore Flash and Flex Framework learning applications use E4X notation to manipulate XML data in a similar way to a multidimensional array. For more details, see [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/ Adobe Actionscript 3.0 Language and Components Reference]. XML is also currently the most commonly used format for providing elearning data for learning interactions. The most commonly used format is [http://en.wikipedia.org/wiki/IMS_Global IMS]'s standard [http://en.wikipedia.org/wiki/QTI QTI] (Question and Test Interoperability specification) but basically any valid XML file with the appropriate data tree structure can be loaded into and consumed by a SWF file.

===FlashVars===

FlashVars is a method for passing string data into a SWF file. It is passed in from the printed HTML page that the SWF file is embedded in. It's ideally suited to very simple data sets such a vocabulary lists or series of numerical values. For learning activities such as hangman, crosswords, word searches, etc., FlashVars is simple, efficient and easy to use.

==What's Next?==

===Moodle Grades===

One of the most requested features for Flash and Flex Framework learning applications deployed in Moodle is for them to have the ability to record learners' activities in Moodle's Gradebook.

===AMFPHP===

The most powerful and flexible way for Flash and Flex Framework learning applications to interact with Moodle APIs, databases and web services is via Flash Remoting AKA [http://blogs.adobe.com/mikepotter/2006/12/amfphp_adds_amf.html AMF3], a communication protocol which is similar to JSON but much faster. It allows Flash and Flex Framework learning applications to directly call PHP methods and pass a number of different data types back and forth seamlessly.

For more details about using AMFPHP in Moodle, see [[Development:AMF3]]

===Learning Interaction Data DB Structure===

A standardised DB table structure to store learning interaction data with a variety of methods to populate the tables with data, including Moodle forms, dynamic Flash or Flex Framework on-line forms.

Also, standalone Adobe AIR desktop GUI applications, which can store data locally using SQLite, to create and edit learning interactions and then upload them. Using Adobe AIR will also provide convenient backup of interaction data and a means to easily transfer and distribute learning interactions.

====swf_interactions fields====
<pre>
* id
* course
* name
* intro
* introformat
* amftable - Default is swf_interaction_data but this allows for further, more specialised tables to be used
* timecreated
* timemodified
</pre>

====swf_interaction_data fields====
<pre>
* id
* interaction - ID of interaction (id of swf_interactions)
* ordernum - Allow sequential ordering of rows
* amp3 - URL of answer MP3 file
* qmp3 - URL of quesition MP3 file
* smp3 - URL of additional MP3 file
* image - URL of image file
* video - URL of FLV file
* ptext - Paragraph text
* qtext - Question
* catext - Correct answers (for multiple choice, use pipe separator as delimiter)
* watext - Wrong answers (for multiple choice, use pipe separator as delimiter)
* timecreated
* timemodified
</pre>

==See Also==

* [[Development:AMF3]] Flash Remoting for Moodle.
* [[FLV Player]] Activity Module for deploying video in Moodle as an activity. Leverages the full range of functions of Jeroen Wijering's JW FLV Player.
* [http://matbury.com/ Matt Bury's website and Moodle]

Development:SWF

2010-03-13T01:58:38Z

Mattbury: /* SWF Activity Module */

==SWF Activity Module==

I've moved the project code and documentation to Google Code: [http://code.google.com/p/swf-activity-module/ code.google.com/p/swf-activity-module/]

The most recent downloads and documentation are available there.

==What is the SWF Activity Module?==

The SWF Activity Module provides a comprehensive and flexible method for deploying Flash and Flex Framework learning applications as activities in a Moodle course.

==How does is work?==

===SWFObject===

The SWF Activity Module uses [http://code.google.com/p/swfobject/ SWFObject] as the default embed method for Flash and Flex Framework learning applications. The module also incorporates standard XHTML 1.0 strict object and embed code that functions if SWFObject fails for any reason, e.g. If the user has Javascript blocked in his/her browser.

Once installed, select SWF from an "Add an activity" list on a Moodle course page. The standard "Adding a new SWF to topic... " moodleform will appear. Help files are included in the SWF Activity Module in English and provide further details about the parameters. In this form you can set the following parameters:

===Required Parameters===
<pre>
* As with all Moodle activities, name and intro.
* SWF file
* Height
* Width
* Version
</pre>

===Optional Parameters===
<pre>
* AMF Interaction (Not yet implemented)
* XML file URL
* FlashVars #1
* FlashVars #2
* FlashVars #3
</pre>

===Advanced Parameters===
<pre>
* API Key (SWF Activity Module custom parameter)
* Align
* Auto Play
* Loop Playback
* Menu
* Quality
* Scale Mode
* Stage Align
* Window Mode
* Background
* Use Device Font
* Seamless Tabbing
* Allow Full Screen
* Allow Script Access
* Allow Networking
</pre>
You can find more details about these parameters in the [http://code.google.com/p/swfobject/wiki/documentation SWFObject Documentation].

==What features does it support?==

The SWF Activity Module automatically provides a deployed SWF learning activity application with the following data:
<pre>
* gateway - URL to gateway script for access to AMFPHP service library
* course - the current Moodle course that the user is accessing
* instance - Instance ID of the module
* swfid - The ID of the SWF learning activity application
* interaction - The ID of the SWF learning interaction data to consume (AMFPHP)
* moodledata - The URL to access the current moodledata course directory (file.php)
</pre>
It also supports a number of features, specific to Flash and Flex applications. They are:

===Flash Remoting (AMF)===

Flash Remoting is a method for Flash or Flex applications to communicate directly with server-side applications written in .NET, Java, PHP, Cold Fusion and Ruby on Rails. There are a number of open-source libraries for handling communication via Flash Remoting:

See [[Development:AMF3]] for details on how to set up AMFPHP in Moodle and more information about Flash Remoting technologies.

===XML Data Loading===

XML is a native data type to ActionScript 3.0 therefore Flash and Flex Framework learning applications use E4X notation to manipulate XML data in a similar way to a multidimensional array. For more details, see [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/ Adobe Actionscript 3.0 Language and Components Reference]. XML is also currently the most commonly used format for providing elearning data for learning interactions. The most commonly used format is [http://en.wikipedia.org/wiki/IMS_Global IMS]'s standard [http://en.wikipedia.org/wiki/QTI QTI] (Question and Test Interoperability specification) but basically any valid XML file with the appropriate data tree structure can be loaded into and consumed by a SWF file.

===FlashVars===

FlashVars is a method for passing string data into a SWF file. It is passed in from the printed HTML page that the SWF file is embedded in. It's ideally suited to very simple data sets such a vocabulary lists or series of numerical values. For learning activities such as hangman, crosswords, word searches, etc., FlashVars is simple, efficient and easy to use.

==What's Next?==

===Moodle Grades===

One of the most requested features for Flash and Flex Framework learning applications deployed in Moodle is for them to have the ability to record learners' activities in Moodle's Gradebook.

===AMFPHP===

The most powerful and flexible way for Flash and Flex Framework learning applications to interact with Moodle APIs, databases and web services is via Flash Remoting AKA [http://blogs.adobe.com/mikepotter/2006/12/amfphp_adds_amf.html AMF3], a communication protocol which is similar to JSON but much faster. It allows Flash and Flex Framework learning applications to directly call PHP methods and pass a number of different data types back and forth seamlessly.

For more details about using AMFPHP in Moodle, see [[Development:AMF3]]

===Learning Interaction Data DB Structure===

A standardised DB table structure to store learning interaction data with a variety of methods to populate the tables with data, including Moodle forms, dynamic Flash or Flex Framework on-line forms.

Also, standalone Adobe AIR desktop GUI applications, which can store data locally using SQLite, to create and edit learning interactions and then upload them. Using Adobe AIR will also provide convenient backup of interaction data and a means to easily transfer and distribute learning interactions.

====swf_interactions fields====
<pre>
* id
* course
* name
* intro
* introformat
* amftable - Default is swf_interaction_data but this allows for further, more specialised tables to be used
* timecreated
* timemodified
</pre>

====swf_interaction_data fields====
<pre>
* id
* interaction - ID of interaction (id of swf_interactions)
* ordernum - Allow sequential ordering of rows
* amp3 - URL of answer MP3 file
* qmp3 - URL of quesition MP3 file
* smp3 - URL of additional MP3 file
* image - URL of image file
* video - URL of FLV file
* ptext - Paragraph text
* qtext - Question
* catext - Correct answers (for multiple choice, use pipe separator as delimiter)
* watext - Wrong answers (for multiple choice, use pipe separator as delimiter)
* timecreated
* timemodified
</pre>

==See Also==

* [[Development:AMF3]] Flash Remoting for Moodle.
* [[FLV Player]] Activity Module for deploying video in Moodle as an activity. Leverages the full range of functions of Jeroen Wijering's JW FLV Player.
* [http://matbury.com/ Matt Bury's website and Moodle]

SWF

2010-03-13T01:55:18Z

Mattbury:

==What is the SWF Activity Module?==

The SWF Activity Module is a plugin which allows users to deploy Flash learning applications, or any Flash content, in Moodle as an activity. It includes the following advantages:

* Very easy to use - Doesn't require writing any code.
* Integrated with Moodle's course file management system.
* Supports XML driven Flash templates.
* Works with almost any Flash learning applications.
* Flash Player version independent - Can deploy any Flash a
* Robust and reliable - Flash embedding is never interfered with by Moodle's filters.
* W3C Standards compliant - Uses Adobe's recommended Flash embed method (SWFObject).
* Integrated with Moodle's grade book - Automatically creates grade items when required.
* Fast, powerful, direct two-way communication between Flash and Moodle's APIs.
* Can support 3rd party web services, e.g. Google Maps, Youtube.com and Yahoo!
* Well documented - Find all the code, documentation and help all in one place.
* Free and open source of course! (GPL3 licence)

Please note: The SWF Activity Module cannot deploy Flash presentations like those produced by Adobe Captivate CS3 and earlier versions. It does, however, support Adobe Captivate CS4 if the published Flash presentation is a single SWF file. For Flash video presentations, see the [http://code.google.com/p/moodle-mplayer/ Media Player] module.

==SWF Activity Module project site==

The SWF Activity Module downloads, documentation and help are hosted at Google Code: [http://code.google.com/p/swf-activity-module/ SWF Activity Module].

You can also see demos of the SWF Activity Module in action at the developer's Moodle demo course: [http://matbury.com/moodle/course/view.php?id=9 matbury.com demo course] (Login as a guest)

==See also==

[http://code.google.com/p/moodle-mplayer/ Media Player] module for deploying video and other media in Moodle.
[http://code.google.com/p/moodle-mp3-player-for-tests/ MP3 Player for Tests] Flash MP3 player that can be embedded in Moodle quizzes and other Moodle pages which gives detailed control over how many times the audio can be played, if it waits until the entire MP3 file has loaded before starting, etc.

[[Development:AMF3]] AMFPHP Flash Remoting in Moodle (communicating with Moodle via Flash).

SWF

2010-03-13T01:54:19Z

Mattbury: /* What is the SWF Activity Module? */

==What is the SWF Activity Module?==

The SWF Activity Module is a plugin which allows users to deploy Flash learning applications, or any Flash content, in Moodle as an activity. It includes the following advantages:

* Very easy to use - Doesn't require writing any code.
* Integrated with Moodle's course file management system.
* Supports XML driven Flash templates.
* Works with almost any Flash learning applications.
* Flash Player version independent - Can deploy any Flash a
* Robust and reliable - Flash embedding is never interfered with by Moodle's filters.
* W3C Standards compliant - Uses Adobe's recommended Flash embed method (SWFObject).
* Integrated with Moodle's grade book - Automatically creates grade items when required.
* Fast, powerful, direct two-way communication between Flash and Moodle's APIs.
* Can support 3rd party web services, e.g. Google Maps, Youtube.com and Yahoo!
* Well documented - Find all the code, documentation and help all in one place.
* Free and open source of course! (GPL3 licence)

Please note: The SWF Activity Module cannot deploy Flash presentations like those produced by Adobe Captivate CS3 and earlier versions. It does, however, support Adobe Captivate CS4 if the published Flash presentation is a single SWF file. For Flash video presentations, see the [http://code.google.com/p/moodle-mplayer/ Media Player] module.

==SWF Activity Module project site==

The SWF Activity Module downloads, documentation and help are hosted at Google Code: [http://code.google.com/p/swf-activity-module/ SWF Activity Module].

You can also see demos of the SWF Activity Module in action at the developer's Moodle demo course: [http://matbury.com/moodle/course/view.php?id=9 matbury.com demo course] (Login as a guest)

==See also==

[http://code.google.com/p/moodle-mplayer/ Media Player] module for deploying video and other media in Moodle.
[http://code.google.com/p/moodle-mp3-player-for-tests/ MP3 Player for Tests] Flash MP3 player that can be embedded in Moodle quizzes and other Moodle pages which gives detailed control over how many times the audio can be played, if it waits until the entire MP3 file has loaded before starting, etc.

==See also==

[[FLV Player]] module for deploying audio and video in Moodle. Supports YouTube.com video and media streaming technologies.

[[Development:AMF3]] AMFPHP Flash Remoting in Moodle (communicating with Moodle via Flash).

SWF

2010-03-13T01:30:22Z

Mattbury:

mod/swf/view

2010-03-13T01:21:28Z

Mattbury:

This article is a stub. For more information about the SWF Activity Module, please click [http://code.google.com/p/swf-activity-module/ here].

Development talk:NEWMODULE Documentation

2009-12-03T14:29:47Z

Mattbury:

== Old stuff moved out of the way ==

Daniele, did you know about [[Development:Modules]], which is linked to from [[Developer_documentation#Make_a_new_plugin]]? You may be better off editing that, rather than starting a new page. However don't let me discourage you. That documentation is very limited, and badly needs to be expanded, so it is absolutely brilliant that you want to work on it.--[[User:Tim Hunt|Tim Hunt]] 12:03, 28 March 2008 (CDT)

::Good point Tim! Anyway... I think we can use this as temporary root for Daniele's work and then, simply, move things to their final place. Let's see how this evolves. -- [[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 12:33, 28 March 2008 (CDT)

----

[http://lyceum.open.ac.uk/temp/creating_moodle_modules.ppt My powerpoint about creating moodle modules] is a bit old (1.8) and maybe not that comprehensible but I use it when I'm trying to explain things to people. It includes a list of all the things you need to have in a module, except the ones I forgot (backuplib iirc is missing). [[User:sam marshall|sam marshall]] 12:52, 28 March 2008 (CDT)

::That's really great, Sam. For sure that presentation will help.Thanks! -- [[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 13:08, 28 March 2008 (CDT)

Dear Tim, Sam and Eloy, I wrote what was my learning path on these issues. I wrote whatever I found in your powerpoint guide (thanks again, Sam) and whatever I got mainly from Tim, Eloy and Petr. A lot of issues are still obscure to me like: grades, groups, groupings, backup and so forth. Please let me know your opinion to make all together a plan to carry on in the best way. Thanks. -- [[User:Daniele Cordella|Daniele Cordella]] 11:55, 10 September 2009 (UTC)

: Just moved the old discussion stuff here. --[[User:Frank Ralf|Frank Ralf]] 07:55, 29 September 2009 (UTC)

== Formatting tips ==

Hi Daniele, Thanks for starting this documentation.

You might consider using more sub-headings instead of bullet points as those will show up in the contents section and make for easier navigation.

And when you use <nowiki><code php></nowiki> you will get syntax highlighting for your code.

There were also suggestions to incorporate Unit 7 of http://dev.moodle.org/course/view.php?id=2 into Moodle Docs (http://dev.moodle.org/mod/forum/discuss.php?d=360). --[[User:Frank Ralf|Frank Ralf]] 08:05, 29 September 2009 (UTC)

== Grades ==

Thanks for the great work Daniele! This is such an improvement :)

I can't find any reference to pushing grades into Moodle's grade book in the NEWMODULE docs. I think this is a core function of the majority of activity modules and would like to see it documented or at least referenced here. Will this be included in the not too distant future?

Development:NEWMODULE FAQ

2009-09-22T15:34:08Z

Mattbury: /* Q: How can I provide the needed code to: */

{{Template:Work in progress}}
{{New_Module}}

== Q: Where do I have to start? ==
A: The content of your module is in moodle/mod/widget/view.php
If you look inside that file you will find the row: "Write your code here".

== Q: How can I check required variables like "Course Module ID" and "widget ID"? ==
A: Use
$id = optional_param('id', 0, PARAM_INT); // Course Module ID, or
$a = optional_param('a' , 0, PARAM_INT); // widget ID
An example of use of these two check can be easily found in your moodle/mod/widget/view.php (row 15 to 41)
If you miss this step, the file can be called directly by writing their address in the web browser and unauthorized user can get them.

== Q: Are some more variables needed to check for security reasons? ==
A: ???????????

== Q: What is provided "for free" by the Moodle environment, alias, which set of variables are provided as "ready to use" ==
A: You have availability of all the global Moodle variables (CFG->xxx), the object $USER (in which it is saved all the information the current user entered in his/her login form)
More over you have the availability of the $course array and of some information about your specific widget module.
It follow the description of the variables you are free to use:
CFG->
$USER
$course->id
$cm->id
There are a lot more variables that are beyong the scope of this moodle docs page that are, for this reason, going to be neglected.
Belong to this list of neglected variables, for instance, $THEME, $???
Some examples:
if (CFG->xxx == '') {

}

== Q: Why is this set of variables so important? ==
A: At any moment you may need to:
*reload the widget page
To call the instance of you module page, you need to call:
$CFG->wwwroot.'/mod/newmodule/view.php?id='.$cm->id
$cm stands for course module (Is this true??????????)
*return to the main course page
To return back to the course page, you need to call:
$CFG->wwwroot.'/course/view.php?id='.$course->id

== Q: My module lives in the view.php page only. How can I tell my code I want an output (of something) in a different page and not at the bottom of the view.php page? ==
A:

== Q: How to put a form into a module. ==
A:

== Q: How can I distinguish part of code for admins/teachers/ from the code for simple users, alias, how can I take advantages of the new feature offered up to Moodle 1.9 ==
*groups
*role
*capabilities
A:

== Q: How can I provide the needed code to ==
*backup my widget module
*restore my widget module
A:

== Q: How can I provide the needed code to: ==
*upgrade the XML tables my module is based on
A: Use the moodle->

== Q: How can I push students' grades from the module into the Moodle gradebook? ==

A: ???

mod/swf/view

2009-03-09T23:41:49Z

Mattbury: New page: This article is a stub. For more information about the SWF Activity Module, please click [http://code.google.com/p/moodle-swf/ here].

This article is a stub. For more information about the SWF Activity Module, please click [http://code.google.com/p/moodle-swf/ here].

Development:SWF

2009-02-23T13:43:07Z

Mattbury: /* SWF Activity Module */

==SWF Activity Module==

This page relates to the SWF Activity Module which is currently under development.

I've moved the project code and documentation to Google Code: [http://code.google.com/p/moodle-swf/ code.google.com/p/moodle-swf]

The most recent downloads and documentation are available there.

==What is the SWF Activity Module?==

The SWF Activity Module provides a comprehensive and flexible method for deploying Flash and Flex Framework learning applications as activities in a Moodle course.

==How does is work?==

===SWFObject===

The SWF Activity Module uses [http://code.google.com/p/swfobject/ SWFObject] as the default embed method for Flash and Flex Framework learning applications. The module also incorporates standard XHTML 1.0 strict object and embed code that functions if SWFObject fails for any reason, e.g. If the user has Javascript blocked in his/her browser.

Once installed, select SWF from an "Add an activity" list on a Moodle course page. The standard "Adding a new SWF to topic... " moodleform will appear. Help files are included in the SWF Activity Module in English and provide further details about the parameters. In this form you can set the following parameters:

===Required Parameters===
<pre>
* As with all Moodle activities, name and intro.
* SWF file
* Height
* Width
* Version
</pre>

===Optional Parameters===
<pre>
* AMF Interaction (Not yet implemented)
* XML file URL
* FlashVars #1
* FlashVars #2
* FlashVars #3
</pre>

===Advanced Parameters===
<pre>
* API Key (SWF Activity Module custom parameter)
* Align
* Auto Play
* Loop Playback
* Menu
* Quality
* Scale Mode
* Stage Align
* Window Mode
* Background
* Use Device Font
* Seamless Tabbing
* Allow Full Screen
* Allow Script Access
* Allow Networking
</pre>
You can find more details about these parameters in the [http://code.google.com/p/swfobject/wiki/documentation SWFObject Documentation].

==What features does it support?==

The SWF Activity Module automatically provides a deployed SWF learning activity application with the following data:
<pre>
* gateway - URL to gateway script for access to AMFPHP service library
* course - the current Moodle course that the user is accessing
* instance - Instance ID of the module
* swfid - The ID of the SWF learning activity application
* interaction - The ID of the SWF learning interaction data to consume (AMFPHP)
* moodledata - The URL to access the current moodledata course directory (file.php)
</pre>
It also supports a number of features, specific to Flash and Flex applications. They are:

===Flash Remoting (AMF)===

Flash Remoting is a method for Flash or Flex applications to communicate directly with server-side applications written in .NET, Java, PHP, Cold Fusion and Ruby on Rails. There are a number of open-source libraries for handling communication via Flash Remoting:

See [[Development:AMF3]] for details on how to set up AMFPHP in Moodle and more information about Flash Remoting technologies.

===XML Data Loading===

XML is a native data type to ActionScript 3.0 therefore Flash and Flex Framework learning applications use E4X notation to manipulate XML data in a similar way to a multidimensional array. For more details, see [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/ Adobe Actionscript 3.0 Language and Components Reference]. XML is also currently the most commonly used format for providing elearning data for learning interactions. The most commonly used format is [http://en.wikipedia.org/wiki/IMS_Global IMS]'s standard [http://en.wikipedia.org/wiki/QTI QTI] (Question and Test Interoperability specification) but basically any valid XML file with the appropriate data tree structure can be loaded into and consumed by a SWF file.

===FlashVars===

FlashVars is a method for passing string data into a SWF file. It is passed in from the printed HTML page that the SWF file is embedded in. It's ideally suited to very simple data sets such a vocabulary lists or series of numerical values. For learning activities such as hangman, crosswords, word searches, etc., FlashVars is simple, efficient and easy to use.

==What's Next?==

===Moodle Grades===

One of the most requested features for Flash and Flex Framework learning applications deployed in Moodle is for them to have the ability to record learners' activities in Moodle's Gradebook.

===AMFPHP===

The most powerful and flexible way for Flash and Flex Framework learning applications to interact with Moodle APIs, databases and web services is via Flash Remoting AKA [http://blogs.adobe.com/mikepotter/2006/12/amfphp_adds_amf.html AMF3], a communication protocol which is similar to JSON but much faster. It allows Flash and Flex Framework learning applications to directly call PHP methods and pass a number of different data types back and forth seamlessly.

For more details about using AMFPHP in Moodle, see [[Development:AMF3]]

===Learning Interaction Data DB Structure===

A standardised DB table structure to store learning interaction data with a variety of methods to populate the tables with data, including Moodle forms, dynamic Flash or Flex Framework on-line forms.

Also, standalone Adobe AIR desktop GUI applications, which can store data locally using SQLite, to create and edit learning interactions and then upload them. Using Adobe AIR will also provide convenient backup of interaction data and a means to easily transfer and distribute learning interactions.

====swf_interactions fields====
<pre>
* id
* course
* name
* intro
* introformat
* amftable - Default is swf_interaction_data but this allows for further, more specialised tables to be used
* timecreated
* timemodified
</pre>

====swf_interaction_data fields====
<pre>
* id
* interaction - ID of interaction (id of swf_interactions)
* ordernum - Allow sequential ordering of rows
* amp3 - URL of answer MP3 file
* qmp3 - URL of quesition MP3 file
* smp3 - URL of additional MP3 file
* image - URL of image file
* video - URL of FLV file
* ptext - Paragraph text
* qtext - Question
* catext - Correct answers (for multiple choice, use pipe separator as delimiter)
* watext - Wrong answers (for multiple choice, use pipe separator as delimiter)
* timecreated
* timemodified
</pre>

==See Also==

* [[Development:AMF3]] Flash Remoting for Moodle.
* [[FLV Player]] Activity Module for deploying video in Moodle as an activity. Leverages the full range of functions of Jeroen Wijering's JW FLV Player.
* [http://matbury.com/ Matt Bury's website and Moodle]

SWF

2009-02-16T22:21:19Z

Mattbury: /* See also */

This page is a stub. The SWF Activity Module is currently under development. You can download a working but incomplete beta version at: [[Development:SWF]].

==What is the SWF Activity Module?==

The SWF Activity Module is a means of deploying learning applications on the Flash platform.

==Why use the SWF Activity Module?==

==Installing the SWF Activity Module==

===Download===

===Unzip and upload===

===Admin install===

==Deploying the SWF Activity Module==

===Create an instance===

===Required parameters===

===Optional parameters===

===Advanced parameters===

==See also==

[[FLV Player]] module for deploying audio and video in Moodle. Supports YouTube.com video and media streaming technologies.

[[Development:AMF3]] AMFPHP Flash Remoting in Moodle (communicating with Moodle via Flash).

SWF

2009-02-16T22:18:10Z

Mattbury: /* Admin Install */

SWF

2009-02-16T22:17:43Z

Mattbury: New page: This page is a stub. The SWF Activity Module is currently under development. You can download a working but incomplete beta version at: Development:SWF. ==What is the SWF Activity Mod...

This page is a stub. The SWF Activity Module is currently under development. You can download a working but incomplete beta version at: [[Development:SWF]].

==What is the SWF Activity Module?==

The SWF Activity Module is a means of deploying learning applications on the Flash platform.

==Why use the SWF Activity Module?==

==Installing the SWF Activity Module==

===Download===

===Unzip and upload===

===Admin Install===

==Deploying the SWF Activity Module==

===Create an instance===

===Required parameters===

===Optional parameters===

===Advanced parameters===

==See also==

[[FLV Player]] module for deploying audio and video in Moodle. Supports YouTube.com video and media streaming technologies.

File:widget.gif

2009-02-07T23:38:47Z

Mattbury: widget

widget

Development:NEWMODULE Tutorial

2009-02-07T23:37:36Z

Mattbury: /* How to Begin the Creation of a New Module */

[[Development:NEWMODULE Documentation|NEWMODULE Documentation]] > Tutorial
----
{{Template:Work in progress}}
== How to Begin the Creation of a New Module ==

*choose a name for your module. Take care: no capital letter and no numbers in the name. In this example it will be choosen: "widget"
*find/replace all the occorrences of newmodule in each file with the name of your own module
*change the name of the folder containing you new created module to "widget"
*change the name of the file in widget/lang/en_utf8/newmodule.php to "widget.php"
*put your just born widget folder in moodle/mod
*visit "notification" page of moodle->Site Administration block
*follow the instruction on the screen

[[Image:widget.gif]]

== Some Basic Regulation for the Beginner PHP Developer ==

You will probably want to use this set of basic commands
*require
*require_once
*include
*include_once

Take in mind the difference between them.<br />
The difference between require and require_once is: ???<br />
The difference between include and include_once is: ???<br />
Use only xxx to call libraries and use only xxx to include snippets of code written to different files.<br />
Remember:<br />
*redirect move the execution of the code to the target file and you are allowed to call the target file passing it some parameters.<br />
for instance: redirect("./come_modello/edit.php?id=$cm->id");
*include requires the name of the called file "clean", without "?id=$cm->id", for instance, and the target file is executed as it were written in the place of the calling row.<br />
<br />
You need these two informations to correctly include library files into target files called through redirect or include.

[[Category:Developer]]
[[Category:Tutorial]]

File:flv player.jpg

2009-02-05T04:00:42Z

Mattbury: FLV Player Activity Module

FLV Player Activity Module

File:moodle form2.png

2009-02-02T12:10:40Z

Mattbury: Module form screenshot

Module form screenshot

Development:SWF

2009-02-02T01:10:15Z

Mattbury: /* See Also */

==SWF Activity Module==

This page relates to the SWF Activity Module which is currently under development.

The current Beta version is available here: [http://matbury.com/assets/SWF.zip SWF.zip] Last uploaded 28th January 2009

==What is the SWF Activity Module?==

The SWF Activity Module provides a comprehensive and flexible method for deploying Flash and Flex Framework learning applications as activities in a Moodle course.

==How does is work?==

===SWFObject===

The SWF Activity Module uses [http://code.google.com/p/swfobject/ SWFObject] as the default embed method for Flash and Flex Framework learning applications. The module also incorporates standard XHTML 1.0 strict object and embed code that functions if SWFObject fails for any reason, e.g. If the user has Javascript blocked in his/her browser.

Once installed, select SWF from an "Add an activity" list on a Moodle course page. The standard "Adding a new SWF to topic... " moodleform will appear. Help files are included in the SWF Activity Module in English and provide further details about the parameters. In this form you can set the following parameters:

===Required Parameters===
<pre>
* As with all Moodle activities, name and intro.
* SWF file
* Height
* Width
* Version
</pre>

===Optional Parameters===
<pre>
* AMF Interaction (Not yet implemented)
* XML file URL
* FlashVars #1
* FlashVars #2
* FlashVars #3
</pre>

===Advanced Parameters===
<pre>
* API Key (SWF Activity Module custom parameter)
* Align
* Auto Play
* Loop Playback
* Menu
* Quality
* Scale Mode
* Stage Align
* Window Mode
* Background
* Use Device Font
* Seamless Tabbing
* Allow Full Screen
* Allow Script Access
* Allow Networking
</pre>
You can find more details about these parameters in the [http://code.google.com/p/swfobject/wiki/documentation SWFObject Documentation].

==What features does it support?==

The SWF Activity Module automatically provides a deployed SWF learning activity application with the following data:
<pre>
* gateway - URL to gateway script for access to AMFPHP service library
* course - the current Moodle course that the user is accessing
* instance - Instance ID of the module
* swfid - The ID of the SWF learning activity application
* interaction - The ID of the SWF learning interaction data to consume (AMFPHP)
* moodledata - The URL to access the current moodledata course directory (file.php)
</pre>
It also supports a number of features, specific to Flash and Flex applications. They are:

===Flash Remoting (AMF)===

Flash Remoting is a method for Flash or Flex applications to communicate directly with server-side applications written in .NET, Java, PHP, Cold Fusion and Ruby on Rails. There are a number of open-source libraries for handling communication via Flash Remoting:

See [[Development:AMF3]] for details on how to set up AMFPHP in Moodle and more information about Flash Remoting technologies.

===XML Data Loading===

XML is a native data type to ActionScript 3.0 therefore Flash and Flex Framework learning applications use E4X notation to manipulate XML data in a similar way to a multidimensional array. For more details, see [http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/ Adobe Actionscript 3.0 Language and Components Reference]. XML is also currently the most commonly used format for providing elearning data for learning interactions. The most commonly used format is [http://en.wikipedia.org/wiki/IMS_Global IMS]'s standard [http://en.wikipedia.org/wiki/QTI QTI] (Question and Test Interoperability specification) but basically any valid XML file with the appropriate data tree structure can be loaded into and consumed by a SWF file.

===FlashVars===

FlashVars is a method for passing string data into a SWF file. It is passed in from the printed HTML page that the SWF file is embedded in. It's ideally suited to very simple data sets such a vocabulary lists or series of numerical values. For learning activities such as hangman, crosswords, word searches, etc., FlashVars is simple, efficient and easy to use.

==What's Next?==

===Moodle Grades===

One of the most requested features for Flash and Flex Framework learning applications deployed in Moodle is for them to have the ability to record learners' activities in Moodle's Gradebook.

===AMFPHP===

The most powerful and flexible way for Flash and Flex Framework learning applications to interact with Moodle APIs, databases and web services is via Flash Remoting AKA [http://blogs.adobe.com/mikepotter/2006/12/amfphp_adds_amf.html AMF3], a communication protocol which is similar to JSON but much faster. It allows Flash and Flex Framework learning applications to directly call PHP methods and pass a number of different data types back and forth seamlessly.

For more details about using AMFPHP in Moodle, see [[Development:AMF3]]

===Learning Interaction Data DB Structure===

A standardised DB table structure to store learning interaction data with a variety of methods to populate the tables with data, including Moodle forms, dynamic Flash or Flex Framework on-line forms.

Also, standalone Adobe AIR desktop GUI applications, which can store data locally using SQLite, to create and edit learning interactions and then upload them. Using Adobe AIR will also provide convenient backup of interaction data and a means to easily transfer and distribute learning interactions.

====swf_interactions fields====
<pre>
* id
* course
* name
* intro
* introformat
* amftable - Default is swf_interaction_data but this allows for further, more specialised tables to be used
* timecreated
* timemodified
</pre>

====swf_interaction_data fields====
<pre>
* id
* interaction - ID of interaction (id of swf_interactions)
* ordernum - Allow sequential ordering of rows
* amp3 - URL of answer MP3 file
* qmp3 - URL of quesition MP3 file
* smp3 - URL of additional MP3 file
* image - URL of image file
* video - URL of FLV file
* ptext - Paragraph text
* qtext - Question
* catext - Correct answers (for multiple choice, use pipe separator as delimiter)
* watext - Wrong answers (for multiple choice, use pipe separator as delimiter)
* timecreated
* timemodified
</pre>

==See Also==

* [[Development:AMF3]] Flash Remoting for Moodle.
* [[FLV Player]] Activity Module for deploying video in Moodle as an activity. Leverages the full range of functions of Jeroen Wijering's JW FLV Player.
* [http://matbury.com/ Matt Bury's website and Moodle]