+ 
+
+
+
+ Staff Member #1
+Biography of instructor/staff member #1
+About This Course
+Include your long course description here. The long course description should contain 150-400 words.
+ +This is paragraph 2 of the long course description. Add more paragraphs as needed. Make sure to enclose them in paragraph tags.
+Prerequisites
+Add information about course prerequisites here.
+Course Staff
+
+
+
+
+
+ Staff Member #2
+Biography of instructor/staff member #2
+Frequently Asked Questions
+Do I need to buy a textbook?
+No, a free online version of Chemistry: Principles, Patterns, and Applications, First Edition by Bruce Averill and Patricia Eldredge will be available, though you can purchase a printed version (published by FlatWorld Knowledge) if you’d like.
+Question #2
+Your answer would be displayed here.
+Include image by using the edXxml macro:
- 
+ 
Example show/hide explanation
diff --git a/common/static/images/firecode.jpg b/common/static/images/firecode.jpg new file mode 100644 index 0000000000..a20206559b Binary files /dev/null and b/common/static/images/firecode.jpg differ diff --git a/common/static/images/high_pass_filter.png b/common/static/images/high_pass_filter.png new file mode 100644 index 0000000000..5f425d4671 Binary files /dev/null and b/common/static/images/high_pass_filter.png differ diff --git a/common/static/images/mit_dome.jpg b/common/static/images/mit_dome.jpg new file mode 100644 index 0000000000..75a5bd949f Binary files /dev/null and b/common/static/images/mit_dome.jpg differ diff --git a/common/static/images/pl-course.png b/common/static/images/pl-course.png new file mode 100644 index 0000000000..1a3da9e631 Binary files /dev/null and b/common/static/images/pl-course.png differ diff --git a/common/static/images/pl-faculty.png b/common/static/images/pl-faculty.png new file mode 100644 index 0000000000..b55ba44542 Binary files /dev/null and b/common/static/images/pl-faculty.png differ diff --git a/common/static/images/simple_graph.png b/common/static/images/simple_graph.png new file mode 100644 index 0000000000..f255795025 Binary files /dev/null and b/common/static/images/simple_graph.png differ diff --git a/common/static/images/voltage_divider.png b/common/static/images/voltage_divider.png new file mode 100644 index 0000000000..1fa695b1f3 Binary files /dev/null and b/common/static/images/voltage_divider.png differ diff --git a/conf/locale/config b/conf/locale/config index fe811ee02e..2d01e1ea43 100644 --- a/conf/locale/config +++ b/conf/locale/config @@ -1 +1 @@ -{"locales" : ["en", "fr", "de"]} +{"locales" : ["en"]} diff --git a/conf/locale/en/LC_MESSAGES/messages.po b/conf/locale/en/LC_MESSAGES/messages.po new file mode 100644 index 0000000000..1bb8bf6d7f --- /dev/null +++ b/conf/locale/en/LC_MESSAGES/messages.po @@ -0,0 +1 @@ +# empty diff --git a/github-requirements.txt b/github-requirements.txt index 468d55ce65..0d7b75b89b 100644 --- a/github-requirements.txt +++ b/github-requirements.txt @@ -1,5 +1,10 @@ # Python libraries to install directly from github + +# Third-party: -e git://github.com/MITx/django-staticfiles.git@6d2504e5c8#egg=django-staticfiles -e git://github.com/MITx/django-pipeline.git#egg=django-pipeline -e git://github.com/MITx/django-wiki.git@e2e84558#egg=django-wiki -e git://github.com/dementrock/pystache_custom.git@776973740bdaad83a3b029f96e415a7d1e8bec2f#egg=pystache_custom-dev + +# Our libraries: +-e git+https://github.com/edx/XBlock.git@5ce6f70a#egg=XBlock diff --git a/i18n/dummy.py b/i18n/dummy.py index 798ee525b5..78bfdc3b58 100644 --- a/i18n/dummy.py +++ b/i18n/dummy.py @@ -86,7 +86,7 @@ class Dummy (Converter): def init_msgs(self, msgs): """ Make sure the first msg in msgs has a plural property. - msgs is list of instances of pofile.Msg + msgs is list of instances of polib.POEntry """ if len(msgs)==0: return @@ -100,8 +100,8 @@ class Dummy (Converter): def convert_msg(self, msg): """ - Takes one Msg object and converts it (adds a dummy translation to it) - msg is an instance of pofile.Msg + Takes one POEntry object and converts it (adds a dummy translation to it) + msg is an instance of polib.POEntry """ source = msg.msgid if len(source)==0: diff --git a/i18n/execute.py b/i18n/execute.py new file mode 100644 index 0000000000..3c3416b65d --- /dev/null +++ b/i18n/execute.py @@ -0,0 +1,86 @@ +import os, subprocess, logging, json + +def init_module(): + """ + Initializes module parameters + """ + global BASE_DIR, LOCALE_DIR, CONFIG_FILENAME, SOURCE_MSGS_DIR, SOURCE_LOCALE, LOG + + # BASE_DIR is the working directory to execute django-admin commands from. + # Typically this should be the 'mitx' directory. + BASE_DIR = os.path.normpath(os.path.dirname(os.path.abspath(__file__))+'/..') + + # Source language is English + SOURCE_LOCALE = 'en' + + # LOCALE_DIR contains the locale files. + # Typically this should be 'mitx/conf/locale' + LOCALE_DIR = BASE_DIR + '/conf/locale' + + # CONFIG_FILENAME contains localization configuration in json format + CONFIG_FILENAME = LOCALE_DIR + '/config' + + # SOURCE_MSGS_DIR contains the English po files. + SOURCE_MSGS_DIR = messages_dir(SOURCE_LOCALE) + + # Default logger. + LOG = get_logger() + + +def messages_dir(locale): + """ + Returns the name of the directory holding the po files for locale. + Example: mitx/conf/locale/en/LC_MESSAGES + """ + return os.path.join(LOCALE_DIR, locale, 'LC_MESSAGES') + +def get_logger(): + """Returns a default logger""" + log = logging.getLogger(__name__) + log.setLevel(logging.INFO) + log_handler = logging.StreamHandler() + log_handler.setFormatter(logging.Formatter('%(asctime)s [%(levelname)s] %(message)s')) + log.addHandler(log_handler) + return log + +# Run this after defining messages_dir and get_logger, because it depends on these. +init_module() + +def execute (command, working_directory=BASE_DIR, log=LOG): + """ + Executes shell command in a given working_directory. + Command is a string to pass to the shell. + Output is logged to log. + """ + log.info(command) + subprocess.call(command.split(' '), cwd=working_directory) + +def get_config(): + """Returns data found in config file, or returns None if file not found""" + config_path = os.path.abspath(CONFIG_FILENAME) + if not os.path.exists(config_path): + log.warn("Configuration file cannot be found: %s" % \ + os.path.relpath(config_path, BASE_DIR)) + return None + with open(config_path) as stream: + return json.load(stream) + +def create_dir_if_necessary(pathname): + dirname = os.path.dirname(pathname) + if not os.path.exists(dirname): + os.makedirs(dirname) + + +def remove_file(filename, log=LOG, verbose=True): + """ + Attempt to delete filename. + Log a warning if file does not exist. + Logging filenames are releative to BASE_DIR to cut down on noise in output. + """ + if verbose: + log.info('Deleting file %s' % os.path.relpath(filename, BASE_DIR)) + if not os.path.exists(filename): + log.warn("File does not exist: %s" % os.path.relpath(filename, BASE_DIR)) + else: + os.remove(filename) + diff --git a/i18n/extract.py b/i18n/extract.py new file mode 100755 index 0000000000..c6fedd3bfa --- /dev/null +++ b/i18n/extract.py @@ -0,0 +1,145 @@ +#!/usr/bin/python + +""" +See https://edx-wiki.atlassian.net/wiki/display/ENG/PO+File+workflow + + This task extracts all English strings from all source code + and produces three human-readable files: + conf/locale/en/LC_MESSAGES/django-partial.po + conf/locale/en/LC_MESSAGES/djangojs.po + conf/locale/en/LC_MESSAGES/mako.po + + This task will clobber any existing django.po file. + This is because django-admin.py makemessages hardcodes this filename + and it cannot be overridden. + +""" + +import os +from datetime import datetime +from polib import pofile +from execute import execute, create_dir_if_necessary, remove_file, \ + BASE_DIR, LOCALE_DIR, SOURCE_MSGS_DIR, LOG + + +# BABEL_CONFIG contains declarations for Babel to extract strings from mako template files +# Use relpath to reduce noise in logs +BABEL_CONFIG = os.path.relpath(LOCALE_DIR + '/babel.cfg', BASE_DIR) + +# Strings from mako template files are written to BABEL_OUT +# Use relpath to reduce noise in logs +BABEL_OUT = os.path.relpath(SOURCE_MSGS_DIR + '/mako.po', BASE_DIR) + + +def main (): + create_dir_if_necessary(LOCALE_DIR) + generated_files = ('django-partial.po', 'djangojs.po', 'mako.po') + + for filename in generated_files: + remove_file(os.path.join(SOURCE_MSGS_DIR, filename)) + + # Extract strings from mako templates + babel_mako_cmd = 'pybabel extract -F %s -c "TRANSLATORS:" . -o %s' % (BABEL_CONFIG, BABEL_OUT) + + # Extract strings from django source files + make_django_cmd = 'django-admin.py makemessages -l en --ignore=src/* --ignore=i18n/* ' \ + + '--extension html' + + # Extract strings from javascript source files + make_djangojs_cmd = 'django-admin.py makemessages -l en -d djangojs --ignore=src/* ' \ + + '--ignore=i18n/* --extension js' + execute(babel_mako_cmd, working_directory=BASE_DIR) + execute(make_django_cmd, working_directory=BASE_DIR) + # makemessages creates 'django.po'. This filename is hardcoded. + # Rename it to django-partial.po to enable merging into django.po later. + os.rename(os.path.join(SOURCE_MSGS_DIR, 'django.po'), + os.path.join(SOURCE_MSGS_DIR, 'django-partial.po')) + execute(make_djangojs_cmd, working_directory=BASE_DIR) + + for filename in generated_files: + LOG.info('Cleaning %s' % filename) + po = pofile(os.path.join(SOURCE_MSGS_DIR, filename)) + # replace default headers with edX headers + fix_header(po) + # replace default metadata with edX metadata + fix_metadata(po) + # remove key strings which belong in messages.po + strip_key_strings(po) + po.save() + +# By default, django-admin.py makemessages creates this header: +""" +SOME DESCRIPTIVE TITLE. +Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +This file is distributed under the same license as the PACKAGE package. +FIRST AUTHORUniversities
If you are a university wishing to collaborate or with questions about edX, please email university@edx.org.
+Accessibility
+EdX strives to create an innovative online-learning platform that promotes accessibility for everyone, including students with disabilities. We are dedicated to improving the accessibility of the platform and welcome your comments or questions at accessibility@edx.org.
+ diff --git a/local-requirements.txt b/local-requirements.txt index 177897f53d..201467d11e 100644 --- a/local-requirements.txt +++ b/local-requirements.txt @@ -2,8 +2,3 @@ -e common/lib/capa -e common/lib/xmodule -e . - -# XBlock: -# Might change frequently, so put it in local-requirements.txt, -# but conceptually is an external package, so it is in a separate repo. --e git+https://github.com/edx/XBlock.git@96d8f5f4#egg=XBlock diff --git a/rakefile b/rakefile index 766dd8a914..798e1c28bf 100644 --- a/rakefile +++ b/rakefile @@ -174,6 +174,11 @@ end desc "Install all python prerequisites for the lms and cms" task :install_python_prereqs do sh('pip install -r requirements.txt') + # Check for private-requirements.txt: used to install our libs as working dirs, + # or personal-use tools. + if File.file?("private-requirements.txt") + sh('pip install -r private-requirements.txt') + end end task :predjango do @@ -330,6 +335,12 @@ task :migrate, [:env] do |t, args| sh(django_admin(:lms, args.env, 'migrate')) end +desc "Run tests for the internationalization library" +task :test_i18n do + test = File.join(REPO_ROOT, "i18n", "tests") + sh("nosetests #{test}") +end + Dir["common/lib/*"].select{|lib| File.directory?(lib)}.each do |lib| task_name = "test_#{lib}" @@ -501,6 +512,30 @@ task :autodeploy_properties do end end +# --- Internationalization tasks + +desc "Extract localizable strings from sources" +task :extract_dev_strings do + sh(File.join(REPO_ROOT, "i18n", "extract.py")) +end + +desc "Compile localizable strings from sources. With optional flag 'extract', will extract strings first." +task :generate_i18n do + if ARGV.last.downcase == 'extract' + Rake::Task["extract_dev_strings"].execute + end + sh(File.join(REPO_ROOT, "i18n", "generate.py")) +end + +desc "Simulate international translation by generating dummy strings corresponding to source strings." +task :dummy_i18n do + source_files = Dir["#{REPO_ROOT}/conf/locale/en/LC_MESSAGES/*.po"] + dummy_locale = 'fr' + cmd = File.join(REPO_ROOT, "i18n", "make_dummy.py") + for file in source_files do + sh("#{cmd} #{file} #{dummy_locale}") + end +end # --- Develop and public documentation --- desc "Invoke sphinx 'make build' to generate docs." diff --git a/requirements.txt b/requirements.txt index 77239a4d50..d3fdd46b81 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,4 @@ -r repo-requirements.txt -Babel==0.9.6 beautifulsoup4==4.1.3 beautifulsoup==3.2.1 boto==2.6.0 @@ -62,6 +61,10 @@ newrelic==1.8.0.13 # Used for documentation gathering sphinx==1.1.3 +# Used for Internationalization and localization +Babel==0.9.6 +transifex-client==0.8 + # Used for testing coverage==3.6 factory_boy==2.0.2