mods/_standard/social/README

   1 MODULE DETAILS:\r
   2 ---------------\r
   3 Description:\r
   4 Putting ATutor into the age of social networking. Allow users to share profiles\r
   5 and activities, link OpenSocial gadgets and applications into their social \r
   6 learning environment, and network with others locally, on other ATutor \r
   7 installations, or on other social networks.\r
   8 \r
   9 Version:\r
  10 0.9 Beta\r
  11 \r
  12 License:\r
  13 GPL/ATutor\r
  14 \r
  15 State:\r
  16 In development. \r
  17 This version is primarily available for experimentation and feedback, \r
  18 leading up to a release of a stable version about June 09. Users are encouraged \r
  19 to make feature suggestions, report bugs, and get involved in developing the \r
  20 ATutor social network. Discussions can the started in the ATutor community \r
  21 forums http://www.atutor.ca/forum/16/1.html\r
  22 \r
  23 Notes:\r
  24 Also note that ATutor Social runs with or without the OpenSocial Shindig \r
  25 server. You may point to your own Shindig server if you have one (download \r
  26 from: http://incubator.apache.org/shindig/), or use the ATutor social network \r
  27 server at http://social.atutor.ca/shindig/php. See the Administrator's \r
  28 Networking Admin panel to setup a link to a Shindig server, and link to other \r
  29 netowrks and applications, or do not use Shindig to create a self-contained \r
  30 social network using only your local ATutor installation. \r
  31 \r
  32 \r
  33 INSTALLATION\r
  34 ------------\r
  35 1. Login as ATutor admin, install this module.\r
  36 \r
  37 2. Setup Shindig if you want to have your own local social container, for a \r
  38 HOWTO on installing Shindig, please visit the following site:\r
  39 http://www.chabotc.com/guides/shindig_install/\r
  40 \r
  41 A note on shindig installation, you will need to have the following PHP Extension enabled:\r
  42 - curl\r
  43 - openssl\r
  44 \r
  45 If you don't want to setup your own Shindig, then you can use ATutor's Shindig server: http://social.atutor.ca/shindig/php\r
  46 Log in as ATutor admin, click on Networking tab, and type http://social.atutor.ca/shindig/php into the URL text input field.\r
  47 \r
  48 3. Done, now you can enjoy e-learning with social networking in your ATutor :)  \r
  49 \r
  50 \r
  51 GADGETS:\r
  52 -----------------\r
  53 One of the greatest features of Opensocial, gadgets are applications that sits on your social networking page.\r
  54 Similar to the gadgets on your iGoogle account. \r
  55 \r
  56 ATutor social networking module allows users to install any Opensocial gadgets.  Such gadgets can be found in:\r
  57 http://www.google.com/ig/directory?synd=open or http://www.labpixies.com/\r
  58 \r
  59 In order to install a gadget, click on the "Gadgets" link in the side menu, and copy and paste the URL of the gadgets' XML file.\r
  60 ie. http://www.labpixies.com/campaigns/todo/todo.xml, http://www.labpixies.com/campaigns/horoscope/horoscope.xml\r
  61 Then click "Add gadget".\r
  62 \r
  63 \r
  64 FEATURES:\r
  65 ------------------\r
  66 All Users\r
  67 \r
  68     * Search Network: Search for people on a network to display basic information about them. Login to add people as contacts.\r
  69 \r
  70 Registered Users\r
  71 \r
  72     * My Contacts: Search the network for people you know and add them to your contact list.\r
  73     * People you Might Know: To help build networks, contacts of your contacts (i.e. friends of friends) are displayed making it easy to add common contacts to your own. Random selections of a few other's contact display each time a page loads.\r
  74     * Network Activity: Keep track of what other people in your network are doing by following their activities.\r
  75     * Network Groups: Create interest groups, or join an existing ones. Invite people to join groups you belong to.\r
  76     * Gadgets: Select from thousands of OpenSocial gadgets available around the internet to customize your social network to your specification. Once a gadget has been used on a system, it becomes available to others on your network to add to their social networking tools.\r
  77     * Privacy: Select from a range of privacy settings to control who sees what parts of your profile, and control which parts of your profile are searchable by others.\r
  78 \r
  79 Instructors\r
  80 \r
  81     * Turn off ATutor Social: ATutor Social runs both inside or outside of courses. Instructors may choose to disable social networking in their courses.\r
  82 \r
  83 Administrators\r
  84 \r
  85     * ShinDig Location: The ShinDig server acts as a hub for a social network. By default social.atutor.ca acts as the central hub for the ATutor social network. Administrators may choose to point to a different ShinDig server to create a private network.\r
  86 \r
  87 Developers\r
  88 \r
  89     * OpenSocial Standard: Develop your own OpenSocial Gadgets that will plugin to ATutor, or into other OpenSocial container applications.\r
  90     * Public Source Code: All ATutor Social source code is available for public checkout from the Subversion version control repository.\r
  91 \r
  92 \r
  93 TODO:\r
  94 -------------------\r
  95 - OAuth implementation\r
  96 - Improve UI.\r
  97 - Allows multiple ATutors to connect to each other, further expand the Social Network.