Installing Joomdle in Joomla: Difference between revisions

From Joomdle
Jump to navigationJump to search
No edit summary
No edit summary
Line 128: Line 128:
* Request motivation: No, Optional, Mandatory
* Request motivation: No, Optional, Mandatory
* Request experience No, Optional, Mandatory
* Request experience No, Optional, Mandatory
Please note that you can only configure to show ONE of the following:
* Show 'Go to course link': This will carry the user to moodle course, without enroling him. Useful for settings with course keys.
* Show Enrol Button. Typical case in which the user can enrol himself into the courses.
* Show Paypal button: This will show the Paypal button. Only to use if you are using Moodle's own paypal system.
* Show 'Request course' links: This lets the user request a course. Enrolment will be made when request is accepted.
Also, you can use one last option, without configuring any of the above to yes, if you are using an e-commerce extension to sell courses. In that case, a 'Buy course' button will appear for courses that are on sell on shop.
Note also that the 'Enrol button' may not appear, even if configured to do so, as it checks Moodle to see if self-enrolment is available at the moment.
If you don't see it, please re-check your moodle course enrol settings.


|-
|-

Revision as of 17:57, 3 February 2011

This document applies to Joomdle Release 2.0.0

Preparing Joomla! 1.5+ for Joomdle

Before you install Joomdle ensure that Joomla 1.5.x is installed and running correctly. In addition, you will need to:

  • Activate Joomla's web services through Site -> Global System Configuration, System Tab, System Configuration.

joomla_webservices.jpg

  • Install and configure any third party extensions that you wish to integrate with Joomdle such as CB, Jomsocial, Tienda, Virtuemart, XMAP. For Integration instructions with third party extensions please refer to 3rd Party Integration
  • Complete any Prerequisites required for Joomdle


.

Installing Joomdle for Joomla! 1.5+

The Joomdle for Joomla! extension consists of a Component, 7 Plugins and 6 Modules, refer to the end of this article to see the full list. To install Joomdle for Joomla!, use Joomla!'s Extension Manager and select the Joomdle package called "joomdle-joomla-package.zip". The component, plugins and modules will all be installed as one package simplifying the installation for you.

Note: It also enables all the plugins and creates the modules although they are not published.

For additional information regarding the components, plugins and modules, refer to this document <insert doclink here>


.

Configuring Joomdle for Joomla! 1.5+

Joomdle Component

Configuring Joomdle for Joomla! is done through the Configuration screen which can be found by choosing Configuration option in the Joomdle Component menu, or through the Joomdle dashboard. There are several sections that you can configure, however, only the first is mandatory.

joomla_component_config.jpg

Section Description
General config
  • Moodle URL
    • Enter the full URL and path of your Moodle installation - this is likely to be http: //www.mydomain.com/moodle assuming you have installed Moodle in a directory called moodle off the Joomla! root.
  • Moodle Version
    • Select your Moodle version.
  • Moodle 2.0 auth token (Moodle 2.0 only)
    • Enter the auth token you obtained when you configured Moodle web services.
  • Connection method
    • Available options are: file_get_contents and cURL. Select the one available on your server.
  • Use redirectless SSO
    • This option only works with cURL and both Moodle and Joomla on the same domain. It makes Joomdle do Single Sign On without redirecting the user back and forward. This is mostly useful for shops, so the purchase process is not broken on user logging.
  • Auto create Moodle users.
    • Set this to "Yes" if you want Joomdle to automatically create new users in Moodle when they register in Joomla!.
  • Auto delete Moodle users.
    • Set this to "Yes" if you want Joomdle to automatically delete users in Moodle when they are deleted in Joomla!.
  • Auto login users at registration
    • Set this to "Yes" if you want Joomdle to automatically log in users when they register in Joomla!.
Links behaviour
  • Open Moodle links in
    • The parameter tells Joomdle how to respond when you click on any of the Joomdle links. This is a Global Joomdle setting and can be over written by setting the same parameters in the individual Joomdle Menu Views.
      • Open in the same window
      • Open in new window
      • Open in wrapper

When you choose to open Moodle in a "Wrapper" you can choose the Wrapper dimensions. This is a Global Joomdle setting and can be over written by setting the same parameters in the individual Joomdle Menu Views.

  • Wrapper scroll bars
  • Wrapper width
  • Wrapper height
  • Autoheight in wrapper
  • Transparent wrapper
  • Default Itemid
    • This lets you specify a default itemid to be associated to all calls to the Moodle wrapper
  • Joomdle Itemid
    • This lets you specify a default itemid to be associated to all calls to the Joomdle component from Joomdle modules
  • Shop Itemid
    • This lets you specify a default itemid to be associated to all calls to the shop component from Joomdle


Data source
  • Additional Data source
    • Select other component to provide additional user information to Joomdle
      • Jomsocial
      • Virtuemart
      • Tienda
Shop Integration

Use these parameters if you wish to integrate Joomdle with VirtueMart or Tienda.

  • Category ID: The Product Category ID that you wish Moodle Courses to appear under.
  • Buy courses for children. Enable this option if you are using the Features for parents. If not, set it to No.
  • Subject of email: Enter the subject of the email sent when successfully purchasing a Moodle course.
  • Body of email: Enter the body of the email sent when successfully purchasing a Moodle course.

For more detailed information regarding the Joomdle and Virtuemart integration see the VirtueMart page. For more detailed information regarding the Joomdle and Tienda integration see the Tienda page.

Detail view These options control which info and links should be displayed by default on course details view.
  • Show category
  • Show course summary
  • Show language
  • Show start date
  • Show enrol dates
  • Show enrol period
  • Show number of topics
  • Show cost
  • Show Topics link
  • Show Grading system link
  • Show Teachers link
  • Show 'Go to course' button
  • Show Enrol Button
  • Show Paypal button
  • Show 'Request course' links

When using course requests, you can also configure Joomdle to ask for additional info:

  • Request motivation: No, Optional, Mandatory
  • Request experience No, Optional, Mandatory

Please note that you can only configure to show ONE of the following:

  • Show 'Go to course link': This will carry the user to moodle course, without enroling him. Useful for settings with course keys.
  • Show Enrol Button. Typical case in which the user can enrol himself into the courses.
  • Show Paypal button: This will show the Paypal button. Only to use if you are using Moodle's own paypal system.
  • Show 'Request course' links: This lets the user request a course. Enrolment will be made when request is accepted.

Also, you can use one last option, without configuring any of the above to yes, if you are using an e-commerce extension to sell courses. In that case, a 'Buy course' button will appear for courses that are on sell on shop.

Note also that the 'Enrol button' may not appear, even if configured to do so, as it checks Moodle to see if self-enrolment is available at the moment. If you don't see it, please re-check your moodle course enrol settings.

Topics view These options control which info and links should be displayed by default on course topics view.
  • Show numbers: show topics numbers
Course category view These options control which info and links should be displayed by default on course category view.
  • Show category info
Mycourses view
  • 'No courses' text : text to show to user in mycourses view if he has no courses

Joomdle Plugins

The Joomdle plugins do not require any configuration. They are all enabled by default at install time.

Joomdle Modules

During installation of Joomdle for Joomla!, six new Modules will be installed: mod_joomdle_courses, mod_joomdle_my_courses, mod_joomdle_calendar, mod_joomdle_my_grades, mod_joomdle_mentees, mod_joomdle_abc. These modules will automatically be installed and you are required to enable them before they appear on your website.

To know more about modules features and configuration options, check the Modules page.


.

System Health Check

Once you have installed and configure Joomdle, please visit the System Health Check tab to ensure all items have been configured correctly.

Refer to System health check for details with possible issues and associated resolutions.


.

Package Components

The Joomdle for Joomla! package consists of the following:

Component: com_joomdle

6 Plugins:

  • plg_joomdle
  • plg_joomdlehooks
  • plg_search_courses
  • plg_search_coursetopics
  • plg_search_coursecategories
  • plg_system_joomdlesession
  • plg_system_joomdletienda

6 Modules:

  • mod_joomdle_courses
  • mod_joomdle_my_courses
  • mod_joomdle_calendar
  • mod_joomdle_my_grades
  • mod_joomdle_mentees
  • mod_joomdle_abc

Also, other separate packages are included:

  • xmap-joomdle-plugin
  • plg_community_jsbar
  • plug_joomdlehookscommunitybuilder