Birch Course Staff Guide

en_us/open_edx_course_authors/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."

en_us/open_edx_course_authors/source/Format Cheat Sheet.rstnouse

@@ -0,0 +1,152 @@
+##################
+Format cheat sheet
+##################
+
+Title: # above and below (as lines 1 and 3 above)
+
+*********
+Heading 1
+*********
+
+=========
+Heading 2
+=========
+
+Heading 3
+*********
+
+Heading 4
+=========
+
+Heading 5
+^^^^^^^^^
+
+************
+Image Format
+************
+
+Image format, uses images as a reference from the soure/image file
+
+       .. image:: images/image029.png
+       : width: 800
+
+       .. image:: images/image009.png
+       :width: 800  
+
+****************
+Code Formatting
+****************
+
+To set text in a "Code format"
+        ::
+-or-
+
+.. code-block:: xml
+
+(text in code-block:: xml is in different colors)
+
+****************
+Table Formatting
+****************
+
+With a header row
+
+.. list-table::
+   :widths: 15 15 70
+   :header-rows: 1
+
+   * - First Name
+     - Last Name
+     - Residence
+   * - Elizabeth
+     - Bennett
+     - Longbourne
+   * - Fitzwilliam
+     - Darcy
+     - Pemberley
+
+-- or --
+
+With a bolded first column
+
+.. list-table::
+   :widths: 15 15 70
+   :stub-columns: 1
+
+   * - First Name
+     - Elizabeth
+     - Fitzwilliam
+   * - Last Name
+     - Bennett
+     - Darcy
+   * - Residence
+     - Longboure
+     - Pemberley
+
+*******************
+Cross-References
+*******************
+
+For references to edX101 pages:
+
+        `Writing Exercises <https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/courseware/a45de3baa8a9468cbfb1a301fdcd7e86/d15cfeaff0af4dd7be4765cd0988d172/1>`_ has more in-depth discussion about problem types, and some general pedagogical considerations for adapting to the online format and a `Gallery of Response Types <https://edge.edx.org/accounts/login?next=/courses/edX/edX101/How_to_Create_an_edX_Course/courseware/a45de3baa8a9468cbfb1a301fdcd7e86/3ba055e760d04f389150a75edfecb844/1>`_
+
+To cross reference between sections of a document
+
+At the paragraph you are cross referencing:
+
+        . _Set-Grade-Brackets:
+
+To make the cross reference in text:
+
+        see :ref:`Set Grade Brackets<Set-Grade-Brackets>`
+
+To cross-reference a topic, but use your own text instead of the topic title,
+use the :ref: directive, but enter your own text followed by the topic anchor in
+angle brackets:
+
+        If you want to add a graded tool or exercise, add the tool as a
+        :ref:`custom JavaScript problem<Custom JavaScript>` or an :ref:`LTI
+        component<LTI Component>`.
+
+        (In this sentence, the text appears as "custom JavaScript problem" and
+        "LTI component", and the linked-to topic titles are "Custom JavaScript
+        Problem" and "LTI Component".)
+
+External page reference
+
+        see `Create a Problem <http://site.Create_Problem.html>`_ 
+
+
+*******
+Tables
+*******
+
+Example of a table with a cell that includes a bulleted list. The balnk lines before and after are critical.
+
+.. list-table::
+   :widths: 15 15 60
+   :header-rows: 1
+
+   * - Field
+     - Type
+     - Details
+   * - ``correct_map``
+     - dict
+     - For each problem ID value listed by ``answers``, provides:
+
+       * ``correctness``: string; 'correct', 'incorrect'
+       * ``hint``: string; Gives optional hint. Nulls allowed. 
+       * ``hintmode``: string; None, 'on_request', 'always'. Nulls allowed. 
+       * ``msg``: string; Gives extra message response.
+       * ``npoints``: integer; Points awarded for this ``answer_id``. Nulls allowed.
+       * ``queuestate``: dict; None when not queued, else ``{key:'', time:''}``
+         where ``key`` is a secret string dump of a DateTime object in the form
+         '%Y%m%d%H%M%S'. Nulls allowed. 
+
+   * - ``grade``
+     - integer
+     - Current grade value. 
+   * - ``max_grade``
+     - integer
+     - Maximum possible grade value.

en_us/open_edx_course_authors/source/building_course/course_files.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/course_files.rst

en_us/open_edx_course_authors/source/building_course/course_rerun.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/course_rerun.rst

en_us/open_edx_course_authors/source/building_course/creating_new_course.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/creating_new_course.rst

en_us/open_edx_course_authors/source/building_course/establish_grading_policy.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/establish_grading_policy.rst

en_us/open_edx_course_authors/source/building_course/export_import_course.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/export_import_course.rst

en_us/open_edx_course_authors/source/building_course/handouts_updates.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/handouts_updates.rst

en_us/open_edx_course_authors/source/building_course/index.rst

@@ -0,0 +1,23 @@
+.. _Setting up Your Course Index:
+
+##########################
+Setting up Your Course
+##########################
+
+Use the chapters in this section to create and build your course.
+
+For information on how to develop your course content in the Studio Outline
+page, see :ref:`Developing Your Course Index`.
+
+.. toctree::
+   :maxdepth: 2
+
+   creating_new_course
+   provide_overview
+   course_files
+   handouts_updates
+   pages
+   textbooks
+   establish_grading_policy
+   course_rerun
+   export_import_course

en_us/open_edx_course_authors/source/building_course/pages.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/pages.rst

en_us/open_edx_course_authors/source/building_course/provide_overview.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/provide_overview.rst

en_us/open_edx_course_authors/source/building_course/textbooks.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/building_and_running_chapters/building_course/textbooks.rst

en_us/open_edx_course_authors/source/change_log.rst

@@ -0,0 +1,17 @@
+############
+Change Log
+############
+
+*****************
+February 2015
+*****************
+
+.. list-table::
+   :widths: 10 70
+   :header-rows: 1
+
+   * - Date
+     - Change
+   * - 24 Feb 2015
+     - Initial release of document for the Open edX Birch release.
+