mods/atutor_opencaps/README

   1 ***********************************\r
   2 AtOpenCaps: Atutor-OpenCaps Module                                              \r
   3 ***********************************\r
   4         Copyright (C) 2010                           \r
   5         Written by Antonio Gamba-Bari\r
   6         Adaptive Technology Resource Centre - University of Toronto\r
   7 \r
   8         This program is free software. You can redistribute it and/or\r
   9         modify it under the terms of the GNU General Public License\r
  10         as published by the Free Software Foundation.\r
  11 \r
  12 ***********************************\r
  13 \r
  14 MODULE DETAILS:\r
  15 ---------------\r
  16 Module Name: AtOpenCaps\r
  17 version: 1.0\r
  18 License: GPL\r
  19 Languages: English (en), Spanish (es-es)\r
  20 \r
  21 AtOpenCaps is an Atutor's module; integrating Atutor with OpenCaps, \r
  22 an open source web-based captioning tool. \r
  23 \r
  24 This module loads media and caption files stored in Atutor's course content \r
  25 directory and manages all transactions needed to deliver and create caption \r
  26 files using OpenCaps web captioning editor. \r
  27 \r
  28 This module provides a modified version of the OpenCaps web captioning tool \r
  29 and it is located in the "opencaps" directory. However, for updates and future \r
  30 compatibility, you must check and download new version from the OpenCaps website.\r
  31 \r
  32 This module also includes a version of FlowPlayer for previewing captioned projects. \r
  33 \r
  34 For additional updates or documentation about the tools used in this module,\r
  35 please visit:\r
  36 * Atutor: http://atutor.ca\r
  37 * OpenCaps: http://opencaps.atrc.utoronto.ca\r
  38 * Flow Player: http://flowplayer.org\r
  39 \r
  40 For revisions, comments, constructive criticism/feedback,\r
  41 please post an issue at http://www.atutor.ca \r
  42 and use the keyword  "AtOpenCaps" in your post. \r
  43 I will try to get back to you as soon as I can.\r
  44 \r
  45 Enjoy ! Anto;)\r
  46 \r
  47 ***********************************\r
  48 Acknowledgments \r
  49 ***********************************\r
  50 Special thank you to Heidi Valles, Greg Gay, and Harris Wong \r
  51 for their support and acute help when I found my self lost.\r
  52 \r
  53 Additionally, I want to thank "Google Summer Code" \r
  54 (http://socghop.appspot.com/)for funding this project.\r
  55 \r
  56 \r
  57 \r
  58 \r
  59 ***********************************\r
  60 TABLE OF CONTENTS\r
  61 ***********************************\r
  62 1. Installation\r
  63         1.1. Setting Directory Permissions\r
  64         1.2. Un-installation Notes\r
  65         1.3. Known Issues\r
  66 \r
  67 2. Using AtOpenCaps\r
  68         2.1. Uploading Media Files\r
  69         2.2. Creating Projects\r
  70         2.3. Start Captioning\r
  71         2.4. Playing Captioned Media\r
  72 \r
  73 3. The Future of This Module\r
  74 \r
  75 ***********************************\r
  76 1. Installation\r
  77 ***********************************\r
  78 \r
  79 ***********************************\r
  80 1.1. Setting Directory Permissions\r
  81 ***********************************\r
  82 Open Caps requires reading and writing permissions in two directories: \r
  83 \r
  84 /ATutor/mods/AtOpenCaps/opencaps/projects\r
  85 /ATutor/mods/AtOpenCaps/opencaps/conversion_service\r
  86 \r
  87 Please set these permissions accordingly. \r
  88 \r
  89 ***********************************\r
  90 1.2. Un-installation Notes\r
  91 ***********************************\r
  92 AtOpenCaps uses Atutor database to store matching-pairs of media and caption files. \r
  93 When removing AtOpenCaps module, the the administrator can decide whether to delete this database or not.\r
  94 \r
  95 However, removing this module will NOT delete any media file or \r
  96 captions already stored in the course content directory. \r
  97 \r
  98 ***********************************\r
  99 1.3. Known Issues\r
 100 ***********************************\r
 101 This module was developed at a moment when Atutor is expanding \r
 102 its compatibility with new media players and captioning media formats. \r
 103 At the same time, OpenCaps is currently developing new strategies for \r
 104 communicating with external systems. \r
 105 \r
 106 For this reasons, AtOpenCaps module presents the following known issues:\r
 107 \r
 108 a) When OpenCaps is loaded for first time. An empty screen shows up. \r
 109 It is necessary to reload the page and then it will work.\r
 110 \r
 111 b) Atutor content rendering class is not ready to display the adequate \r
 112 tags for flowplayer version flowplayer-3.2.2.swf. Proper handlers are \r
 113 needed to allow Atutor core code to load the following FlowPlayer plugins:\r
 114 \r
 115         - flowplayer.audio-3.2.0.swf\r
 116         - flowplayer.captions-3.2.1.swf\r
 117         - flowplayer.content-3.2.0.swf\r
 118         - flowplayer.content-3.2.0.swf\r
 119 \r
 120 ***********************************\r
 121 2. Using AtOpenCaps\r
 122 ***********************************\r
 123 \r
 124 ***********************************\r
 125 2.1. Uploading Media Files\r
 126 ***********************************\r
 127 To upload a file click on the "Upload Media" tab. This will open Atutor's \r
 128 File Management utility and allow the user to upload files to the course \r
 129 content directory. For additional documentation about this utility, \r
 130 please review "Atutor HandBook": (http://help.atutor.ca/index/index.php).\r
 131 \r
 132 ***********************************\r
 133 2.2. Creating Projects\r
 134 ***********************************\r
 135 In order to create a new project, the user must first upload media \r
 136 files by clicking on the Upload Media tab. \r
 137 \r
 138 To Create a new caption Project, click on the "Add Project" tab. \r
 139 Then,  set a name of the project, select one of the available media \r
 140 files from the list, and select either to create an empty caption file \r
 141 or type the name of a caption file already uploaded to the course content.\r
 142 \r
 143 The user can also specify the width and height of the media file. \r
 144 This will be use to set the adequate size when playing captioning projects. \r
 145 If not width or height are set, a default size will be used (320x240)\r
 146 \r
 147 Note that if the user selects the option "Select An existing Caption", \r
 148 the name of the existing caption file must be typed manually. \r
 149 For example, "my_caption_file.srt"\r
 150 \r
 151 ***********************************\r
 152 2.3. Start Captioning\r
 153 ***********************************\r
 154 To start captioning, simply click on "My Caption Projects". \r
 155 Then, click on the name of the project. This will lunch Open Caps editing tool. \r
 156 \r
 157 Note: Once you have finished captioning, remember to click on the link "Finish".\r
 158 Then, click on the button "Submit Captions to Atutor".  \r
 159 \r
 160 ***********************************\r
 161 2.4. Playing Captioned Media\r
 162 ***********************************\r
 163 To preview a captioning project, click on the "Preview" tab. \r
 164 Note that by clicking on this link the last project will be opened.\r
 165 \r
 166 Finally, click on the image and the Flow player will be loaded \r
 167 using the corresponding media and caption file.\r
 168 \r
 169 ***********************************\r
 170 3. The Future of This Module\r
 171 ***********************************\r
 172 Although AtOpenCaps version 1.0 provides the basic communication \r
 173 between OpenCaps and Atutor, the ways in which captioning media can be \r
 174 played on the web is rapidly evolving. This means that there are many \r
 175 players out there capable of playing captioned media. \r
 176 \r
 177 The future development of this module will include compatibility with \r
 178 new players as well as a wide range of caption formats.\r
 179 \r