+++ /dev/null
-***********************************\r
-AtOpenCaps: Atutor-OpenCaps Module \r
-***********************************\r
- Copyright (C) 2010 \r
- Written by Antonio Gamba-Bari\r
- Adaptive Technology Resource Centre - University of Toronto\r
-\r
- This program is free software. You can redistribute it and/or\r
- modify it under the terms of the GNU General Public License\r
- as published by the Free Software Foundation.\r
-\r
-***********************************\r
-\r
-MODULE DETAILS:\r
----------------\r
-Module Name: AtOpenCaps\r
-version: 1.0\r
-License: GPL\r
-Languages: English (en), Spanish (es-es)\r
-\r
-AtOpenCaps is an Atutor's module; integrating Atutor with OpenCaps, \r
-an open source web-based captioning tool. \r
-\r
-This module loads media and caption files stored in Atutor's course content \r
-directory and manages all transactions needed to deliver and create caption \r
-files using OpenCaps web captioning editor. \r
-\r
-This module provides a modified version of the OpenCaps web captioning tool \r
-and it is located in the "opencaps" directory. However, for updates and future \r
-compatibility, you must check and download new version from the OpenCaps website.\r
-\r
-This module also includes a version of FlowPlayer for previewing captioned projects. \r
-\r
-For additional updates or documentation about the tools used in this module,\r
-please visit:\r
-* Atutor: http://atutor.ca\r
-* OpenCaps: http://opencaps.atrc.utoronto.ca\r
-* Flow Player: http://flowplayer.org\r
-\r
-For revisions, comments, constructive criticism/feedback,\r
-please post an issue at http://www.atutor.ca \r
-and use the keyword "AtOpenCaps" in your post. \r
-I will try to get back to you as soon as I can.\r
-\r
-Enjoy ! Anto;)\r
-\r
-***********************************\r
-Acknowledgments \r
-***********************************\r
-Special thank you to Heidi Valles, Greg Gay, and Harris Wong \r
-for their support and acute help when I found my self lost.\r
-\r
-Additionally, I want to thank "Google Summer Code" \r
-(http://socghop.appspot.com/)for funding this project.\r
-\r
-\r
-\r
-\r
-***********************************\r
-TABLE OF CONTENTS\r
-***********************************\r
-1. Installation\r
- 1.1. Setting Directory Permissions\r
- 1.2. Un-installation Notes\r
- 1.3. Known Issues\r
-\r
-2. Using AtOpenCaps\r
- 2.1. Uploading Media Files\r
- 2.2. Creating Projects\r
- 2.3. Start Captioning\r
- 2.4. Playing Captioned Media\r
-\r
-3. The Future of This Module\r
-\r
-***********************************\r
-1. Installation\r
-***********************************\r
-\r
-***********************************\r
-1.1. Setting Directory Permissions\r
-***********************************\r
-Open Caps requires reading and writing permissions in two directories: \r
-\r
-/ATutor/mods/AtOpenCaps/opencaps/projects\r
-/ATutor/mods/AtOpenCaps/opencaps/conversion_service\r
-\r
-Please set these permissions accordingly. \r
-\r
-***********************************\r
-1.2. Un-installation Notes\r
-***********************************\r
-AtOpenCaps uses Atutor database to store matching-pairs of media and caption files. \r
-When removing AtOpenCaps module, the the administrator can decide whether to delete this database or not.\r
-\r
-However, removing this module will NOT delete any media file or \r
-captions already stored in the course content directory. \r
-\r
-***********************************\r
-1.3. Known Issues\r
-***********************************\r
-This module was developed at a moment when Atutor is expanding \r
-its compatibility with new media players and captioning media formats. \r
-At the same time, OpenCaps is currently developing new strategies for \r
-communicating with external systems. \r
-\r
-For this reasons, AtOpenCaps module presents the following known issues:\r
-\r
-a) When OpenCaps is loaded for first time. An empty screen shows up. \r
-It is necessary to reload the page and then it will work.\r
-\r
-b) Atutor content rendering class is not ready to display the adequate \r
-tags for flowplayer version flowplayer-3.2.2.swf. Proper handlers are \r
-needed to allow Atutor core code to load the following FlowPlayer plugins:\r
-\r
- - flowplayer.audio-3.2.0.swf\r
- - flowplayer.captions-3.2.1.swf\r
- - flowplayer.content-3.2.0.swf\r
- - flowplayer.content-3.2.0.swf\r
-\r
-***********************************\r
-2. Using AtOpenCaps\r
-***********************************\r
-\r
-***********************************\r
-2.1. Uploading Media Files\r
-***********************************\r
-To upload a file click on the "Upload Media" tab. This will open Atutor's \r
-File Management utility and allow the user to upload files to the course \r
-content directory. For additional documentation about this utility, \r
-please review "Atutor HandBook": (http://help.atutor.ca/index/index.php).\r
-\r
-***********************************\r
-2.2. Creating Projects\r
-***********************************\r
-In order to create a new project, the user must first upload media \r
-files by clicking on the Upload Media tab. \r
-\r
-To Create a new caption Project, click on the "Add Project" tab. \r
-Then, set a name of the project, select one of the available media \r
-files from the list, and select either to create an empty caption file \r
-or type the name of a caption file already uploaded to the course content.\r
-\r
-The user can also specify the width and height of the media file. \r
-This will be use to set the adequate size when playing captioning projects. \r
-If not width or height are set, a default size will be used (320x240)\r
-\r
-Note that if the user selects the option "Select An existing Caption", \r
-the name of the existing caption file must be typed manually. \r
-For example, "my_caption_file.srt"\r
-\r
-***********************************\r
-2.3. Start Captioning\r
-***********************************\r
-To start captioning, simply click on "My Caption Projects". \r
-Then, click on the name of the project. This will lunch Open Caps editing tool. \r
-\r
-Note: Once you have finished captioning, remember to click on the link "Finish".\r
-Then, click on the button "Submit Captions to Atutor". \r
-\r
-***********************************\r
-2.4. Playing Captioned Media\r
-***********************************\r
-To preview a captioning project, click on the "Preview" tab. \r
-Note that by clicking on this link the last project will be opened.\r
-\r
-Finally, click on the image and the Flow player will be loaded \r
-using the corresponding media and caption file.\r
-\r
-***********************************\r
-3. The Future of This Module\r
-***********************************\r
-Although AtOpenCaps version 1.0 provides the basic communication \r
-between OpenCaps and Atutor, the ways in which captioning media can be \r
-played on the web is rapidly evolving. This means that there are many \r
-players out there capable of playing captioned media. \r
-\r
-The future development of this module will include compatibility with \r
-new players as well as a wide range of caption formats.\r
-\r
projects / atutor.git / blobdiff