Release notes/12 9 13

docs/release_notes/Makefile

@@ -0,0 +1,183 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+Q_FLAG        = 
+
+ifeq ($(quiet), true)
+Q_FLAG = -Q
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/getting_started.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/getting_started.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/getting_started"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/getting_started"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/release_notes/source/10-23-2013.rst

@@ -0,0 +1,146 @@
+###################################
+October 23, 2013
+###################################
+
+*************
+edX Studio
+*************
+
+=============
+New Features
+=============
+
+* **Improved import experience** (STUD-595)
+
+  When you import a course, the Import screen now provides real-time status updates. The Import screen tells you when the import is in the
+  following stages:
+  * Uploading
+  * Unpacking
+  * Verifying
+  * Updated Course
+  * Success (Complete)
+
+* **Improved drag and drop experience in course outlines** (STUD-575)
+
+  The ability to drag and drop sections, subsections, and units in the course outline is enhanced in the following ways:
+
+  * The visual representation of where you are moving the course element to is improved, with a pointer and blue line indicating the
+    new position.
+
+  * You can more easily drag units from one subsection to another.
+
+  * When you cancel a drop, the course element returns to its original position.
+
+  * You can no longer drag a course element below the New Unit button, which was causing confusion. 
+
+* **Text customization capability**
+
+  You can now customize some of the UI text that your students see. You do this through the text_customization key in the Advanced
+  Settings for the course. (However, edX recommends that you contact your Program Manager before you modify the text_customization key.) 
+
+* **JavaScript loading performance**
+
+  JavaScript loading is changed in ways that should improve the performance on some pages.
+  Code contributors should note that JavaScript is now loaded through require.js.
+
+
+
+==========================
+Changes and Updates
+==========================
+
+The following changes are included in this release: 
+
+* In a course outline, you can no longer drag and drop a unit below the New Unit button. (STUD-152)
+
+* Course update content outside of HTML tags is no longer erroneously removed.(STUD-590)
+
+* In a course outline, dragging a unit over the Units label no longer causes the unit to be removed. (STUD-755)
+
+* Support text in the Assignment Types section of the Grading page is updated to clarify that you enter an integer, not a percent, in the W
+  eight of Total Grade field. (STUD-771)
+
+* Certain component errors no longer prevent the course from saving correctly. (STUD-786)
+
+* When you delete a Discussion component, the discussion is completely removed from the course. (STUD-811, STUD-817) 
+
+* When you are editing a course update, the update no longer disappears if you click outside of the Edit window. (STUD-822)
+
+* When you enter the integer 7 in the Total Weight of Grade field, the value is no longer changed to a decimal. (STUD-826)
+
+
+***************************************
+edX Learning Management System 
+***************************************
+
+=============
+New Features
+=============
+
+The following changes are included in this release: 
+
+* **Fixed views in Internet Explorer 9.x**
+
+  Problems with pages in Internet Explorer 9.x are resolved.
+
+* **Disabled downloading data for large courses**
+
+  For courses with over 200 students, downloading large data sets could fail. The Download Data button on the Instructor Dashboard is now
+  temporarily disabled to avoid this problem. 
+
+* **Improved Beta Instructor Dashboard**
+
+  You can access the Beta Instructor Dashboard from the current Instructor Dashboard by clicking Try the New Beta Dashboard. The Beta
+  version continued so evolve with a streamlined design and improved architecture. Both dashboards are currently available.
+
+* **Improved video and transcript experience** (BLD-420)
+
+  When you are playing a video with the transcript hidden, you can display the transcript by hovering the mouse pointer over the CC button. 
+  You can then click a paragraph in the displayed transcript to move to that point in the video. When you move the pointer off the CC button,
+  the transcript is hidden.
+
+* **Improved Learning Tools Interoperability (LTI)** (BLD-330, BLD-347)
+
+  You can now use multiple LTI tools per page. You can also have an LTI module load external content in a new window.
+
+
+==========================
+Changes and Updates
+==========================
+
+* The link to open and close the calculator has additional aria attributes for accessibility. (BLD-164)
+
+* The Hints panel for the calculator is now accessible to screen readers. (BLD-165)
+
+* Students can now download video subtitles. (BLD-245)
+
+* Multi-speed video playback now works in Firefox browsers as expected. (BLD-287)
+
+* Window resizing no longer cuts off videos. (BLD-289)
+
+* Video HD control is now handicap accessible. (BLD-387)
+
+* You can now export courses that have LTI modules. (BLD-389)
+
+* A malformed custom parameter in an LTI component no longer permanently breaks the unit. (BLD-390)
+
+* The styles and text for the download links for videos and transcripts are updated for clarity and accessibility. (BLD-403)
+
+* The CC button in the video player now includes explanatory text that is accessible with a screen reader. (BLD-404)
+
+* LTI with the Piazza platform now works as expected. (BLD-405)
+
+* The **Close** button on dialog boxes is now defined as an HTML button and is accessible to screen readers. (LMS-582)
+
+
+******************
+Forums 
+******************
+
+The following changes are included in this release: 
+
+* The color contrast of the Report Misuse link is updated for accessibility. (FOR-200)
+
+* The Report Misuse link now includes a tooltip that is accessible to screen readers. (FOR-201)
+
+* The Report Misuse link is now included in the page tab order, for keyboard accessibility. (FOR-209)