Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.3 KB

README.MD

File metadata and controls

37 lines (26 loc) · 2.3 KB
Raw

Open edX Course Content Modification Tool for Text Replacement

This tool was developed by a teaching assistant in the Tokyo Tech Online Education Development Office to replace text from a source language to a translated foreign language. We have tested this tool by replacing English text with Japanese text in html format. This tool works offline utilizing an exported course and then you need to enter data required regarding the course in the Excel sheet before executing the python script.

Python package dependenies

  • lxml, xlrd, xlwt, beautifulsoup4

Workspace folder

  • 2 python scripts
    course_struc_extract.py --> this script generates an excel file ‘conversion table’
    text_replacement.py --> this script replaces target text components to exported course
  • 4 folders
    ‘course’ folder --> Unzip an exported edX course and move into this directory
    ‘original_course’ --> copy 'course' folder and place it in this directory
    ‘source’ folder --> Move all translated texts (HTML files) to this directories
    'Example' folder --> contain an ‘conversion table’ example files (both before and after filled up contents)

How to run

  • Run a python script ‘course_struc_extract.py’ --> excel file ‘conversion_table.xlm’ will be created
  • Open the conversion_table --> manually add the path location of translated texts (HTML files) contained inside ‘source’ folder (please see example file for detail)
  • Run a ‘text_replacement.py’ --> Original text in 'course' folder will be replaced by the translated texts in 'source' folder
  • If program is successfully executed, ready-to-upload course (course.tar.gz) is created inside the 'course' folder

NOTICE!!!

  • This tool replaces only the HTML(text) component.
  • We have tested this tool only with one edX course instance thus far, and so unexpected errors could happen.
  • There is a bug after uploading a course back into edX. It is found that some text components disappeared in edX page. In our test, 1 component is missing.
  • Some HTML component listed in ‘error_files.txt’ will not have figures showed properly in edX. This happens when original component (Eng) and translated component (local language) have different number of figures