mods/mahara/README

   1 ====================================\r
   2 Mahara ePortfolio Integration Module\r
   3 \r
   4      by: Boon-Hau Teh\r
   5 ====================================\r
   6 \r
   7 \r
   8 Overview\r
   9 ----------------\r
  10 This is a simple Mahara integration module for ATutor.\r
  11 \r
  12    "Mahara is an open source e-portfolio, weblog, resume builder\r
  13     and social networking system, connecting users and creating\r
  14     online learner communities. Mahara is designed to provide users\r
  15     with the tools to demonstrate their life-long learning, skills\r
  16     and development over time to selected audiences."\r
  17 \r
  18 \r
  19 Requirements\r
  20 ----------------\r
  21 * ATutor version 1.6 or above\r
  22 * Mahara 1.0.2\r
  23 \r
  24 \r
  25 Installing\r
  26 ----------------\r
  27 1. Install ATutor and Mahara on the same server (see their\r
  28    respective installation documents).\r
  29 \r
  30 2. Copy all Mahara module files to /mods/mahara in Atutor.\r
  31 \r
  32 3. As an administrator in ATutor, install and enable the module.\r
  33 \r
  34 4. A link to 'ePortfolio' should now appear in the navigation menu.\r
  35    Still logged in as an administrator, enter full the path to the\r
  36    Mahara installation.\r
  37 \r
  38        example on Windows system:\r
  39             C:\webroot\mahara\\r
  40 \r
  41        example on Linux system:\r
  42             /usr/local/apache/htdocs/mahara/\r
  43 \r
  44 \r
  45 Using ePortfolio\r
  46 ----------------\r
  47 Once logged into ATutor, a regular user can access his/her\r
  48 ePortfolio through the main menu or Home page.  The ePortfolio\r
  49 will appear on the page in ATutor as an embedded iframe.  The user\r
  50 has the option of clicking on a button, which closes the iframe and\r
  51 opens the ePortfolio in a new window/tab of the browser.\r
  52 \r
  53 If a user's account on ATutor is deleted, the user's ePortfolio\r
  54 account on Mahara still remains active.  If the user wishes to\r
  55 continue accessing Mahara, the user should be able to retrieve\r
  56 the password by entering his/her E-mail (the same E-mail that was\r
  57 registered in ATutor) through the "Password Reminder" feature of\r
  58 Mahara.  Note that the "Password Reminder" feature is provided\r
  59 by Mahara 1.0.2 and is external to this module.\r
  60 \r
  61 \r
  62 \r
  63 Developer's Note\r
  64 ----------------\r
  65 This module does not make use of the single-sign-on feature via\r
  66 XMLRPC provided by Mahara. Instead, it integrates Mahara into\r
  67 ATutor by directly calling necessary functions found in Mahara.\r
  68 Therefore, this module may not work in other versions of Mahara if\r
  69 there are any noticeable changes made to these required functions.\r
  70 \r
  71 This module is intended for Mahara to run as an integrated part of\r
  72 ATutor, and not as a standalone program.  Single-sign-on through\r
  73 ATutor is implemented by storing login information for Mahara in the\r
  74 ATutor database.  When a user accesses the ePortfolio for the first\r
  75 time, the user is automatically registered into Mahara with a new\r
  76 account.  User details get copied over from ATutor and a password\r
  77 for Mahara is automatically generated.  The username and password\r
  78 get stored with ATutor and used whenever accessing Mahara\r
  79 (through Mahara's login script).  In the event that the username\r
  80 and password is lost from the database, the module can still find\r
  81 the user (by username) on the Mahara database, generate a new\r
  82 password, and re-save the login information in ATutor.\r