diff --git a/userdocs/Makefile b/userdocs/Makefile new file mode 100755 index 0000000000..06fa770521 --- /dev/null +++ b/userdocs/Makefile @@ -0,0 +1,177 @@ +# 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 + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(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 ' where 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." diff --git a/userdocs/source/Format Cheat Sheet.rst b/userdocs/source/Format Cheat Sheet.rst new file mode 100644 index 0000000000..7de5a37cc8 --- /dev/null +++ b/userdocs/source/Format Cheat Sheet.rst @@ -0,0 +1,59 @@ +****************** +Format cheat sheet +****************** + +Levels of Subheads + +#### +text +#### + +**** +text +**** + +text +**** + +text +==== + +text +^^^^ + + + + + + +Image format, uses images as a reference from the soure/image file + + .. image:: images/image029.png + : width: 800 + + .. image:: images/image009.png + :width: 800 + + +For references to edX1010 pages: + + `Writing Exercises `_ 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 `_ + +To set text in a "Code format" + :: + +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` + +External page reference + + see `Create a Problem `_ + + \ No newline at end of file diff --git a/userdocs/source/Images/286.png b/userdocs/source/Images/286.png new file mode 100644 index 0000000000..bb106b06d0 Binary files /dev/null and b/userdocs/source/Images/286.png differ diff --git a/userdocs/source/Images/Image276.png b/userdocs/source/Images/Image276.png new file mode 100644 index 0000000000..be99300ab0 Binary files /dev/null and b/userdocs/source/Images/Image276.png differ diff --git a/userdocs/source/Images/Image300.png b/userdocs/source/Images/Image300.png new file mode 100644 index 0000000000..958e73d895 Binary files /dev/null and b/userdocs/source/Images/Image300.png differ diff --git a/userdocs/source/Images/Image305.png b/userdocs/source/Images/Image305.png new file mode 100644 index 0000000000..71c94f1993 Binary files /dev/null and b/userdocs/source/Images/Image305.png differ diff --git a/userdocs/source/Images/filelist.xml b/userdocs/source/Images/filelist.xml new file mode 100644 index 0000000000..5aa5072fc0 --- /dev/null +++ b/userdocs/source/Images/filelist.xml @@ -0,0 +1,282 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/userdocs/source/Images/formularesponse.png b/userdocs/source/Images/formularesponse.png new file mode 100644 index 0000000000..035112c396 Binary files /dev/null and b/userdocs/source/Images/formularesponse.png differ diff --git a/userdocs/source/Images/formularesponse1.png b/userdocs/source/Images/formularesponse1.png new file mode 100644 index 0000000000..035112c396 Binary files /dev/null and b/userdocs/source/Images/formularesponse1.png differ diff --git a/userdocs/source/Images/formularesponse3.png b/userdocs/source/Images/formularesponse3.png new file mode 100644 index 0000000000..49bbe6f76a Binary files /dev/null and b/userdocs/source/Images/formularesponse3.png differ diff --git a/userdocs/source/Images/formularesponse6.png b/userdocs/source/Images/formularesponse6.png new file mode 100644 index 0000000000..597bef5673 Binary files /dev/null and b/userdocs/source/Images/formularesponse6.png differ diff --git a/userdocs/source/Images/image001.png b/userdocs/source/Images/image001.png new file mode 100644 index 0000000000..789270d277 Binary files /dev/null and b/userdocs/source/Images/image001.png differ diff --git a/userdocs/source/Images/image002.png b/userdocs/source/Images/image002.png new file mode 100644 index 0000000000..275cea0c14 Binary files /dev/null and b/userdocs/source/Images/image002.png differ diff --git a/userdocs/source/Images/image003.png b/userdocs/source/Images/image003.png new file mode 100644 index 0000000000..ae599cd4b7 Binary files /dev/null and b/userdocs/source/Images/image003.png differ diff --git a/userdocs/source/Images/image004.png b/userdocs/source/Images/image004.png new file mode 100644 index 0000000000..da8123cc3b Binary files /dev/null and b/userdocs/source/Images/image004.png differ diff --git a/userdocs/source/Images/image005.png b/userdocs/source/Images/image005.png new file mode 100644 index 0000000000..12db327f74 Binary files /dev/null and b/userdocs/source/Images/image005.png differ diff --git a/userdocs/source/Images/image006.png b/userdocs/source/Images/image006.png new file mode 100644 index 0000000000..56e06c3959 Binary files /dev/null and b/userdocs/source/Images/image006.png differ diff --git a/userdocs/source/Images/image007.png b/userdocs/source/Images/image007.png new file mode 100644 index 0000000000..26b655de14 Binary files /dev/null and b/userdocs/source/Images/image007.png differ diff --git a/userdocs/source/Images/image008.png b/userdocs/source/Images/image008.png new file mode 100644 index 0000000000..73e4dae3f4 Binary files /dev/null and b/userdocs/source/Images/image008.png differ diff --git a/userdocs/source/Images/image009.png b/userdocs/source/Images/image009.png new file mode 100644 index 0000000000..b3884a9512 Binary files /dev/null and b/userdocs/source/Images/image009.png differ diff --git a/userdocs/source/Images/image010.png b/userdocs/source/Images/image010.png new file mode 100644 index 0000000000..685eddd368 Binary files /dev/null and b/userdocs/source/Images/image010.png differ diff --git a/userdocs/source/Images/image011.png b/userdocs/source/Images/image011.png new file mode 100644 index 0000000000..8ebf9c7158 Binary files /dev/null and b/userdocs/source/Images/image011.png differ diff --git a/userdocs/source/Images/image012.png b/userdocs/source/Images/image012.png new file mode 100644 index 0000000000..8dafc288c6 Binary files /dev/null and b/userdocs/source/Images/image012.png differ diff --git a/userdocs/source/Images/image013.png b/userdocs/source/Images/image013.png new file mode 100644 index 0000000000..fce9491df4 Binary files /dev/null and b/userdocs/source/Images/image013.png differ diff --git a/userdocs/source/Images/image014.png b/userdocs/source/Images/image014.png new file mode 100644 index 0000000000..5e058bf6a4 Binary files /dev/null and b/userdocs/source/Images/image014.png differ diff --git a/userdocs/source/Images/image015.png b/userdocs/source/Images/image015.png new file mode 100644 index 0000000000..c8f67dd8ff Binary files /dev/null and b/userdocs/source/Images/image015.png differ diff --git a/userdocs/source/Images/image016.png b/userdocs/source/Images/image016.png new file mode 100644 index 0000000000..5c604c5c05 Binary files /dev/null and b/userdocs/source/Images/image016.png differ diff --git a/userdocs/source/Images/image017.png b/userdocs/source/Images/image017.png new file mode 100644 index 0000000000..d25d04286d Binary files /dev/null and b/userdocs/source/Images/image017.png differ diff --git a/userdocs/source/Images/image018.png b/userdocs/source/Images/image018.png new file mode 100644 index 0000000000..efa7bdf17c Binary files /dev/null and b/userdocs/source/Images/image018.png differ diff --git a/userdocs/source/Images/image019.png b/userdocs/source/Images/image019.png new file mode 100644 index 0000000000..d25d04286d Binary files /dev/null and b/userdocs/source/Images/image019.png differ diff --git a/userdocs/source/Images/image020.png b/userdocs/source/Images/image020.png new file mode 100644 index 0000000000..efa7bdf17c Binary files /dev/null and b/userdocs/source/Images/image020.png differ diff --git a/userdocs/source/Images/image021.png b/userdocs/source/Images/image021.png new file mode 100644 index 0000000000..23aff87f2a Binary files /dev/null and b/userdocs/source/Images/image021.png differ diff --git a/userdocs/source/Images/image022.png b/userdocs/source/Images/image022.png new file mode 100644 index 0000000000..8ddf270030 Binary files /dev/null and b/userdocs/source/Images/image022.png differ diff --git a/userdocs/source/Images/image023.png b/userdocs/source/Images/image023.png new file mode 100644 index 0000000000..4bb464c8ad Binary files /dev/null and b/userdocs/source/Images/image023.png differ diff --git a/userdocs/source/Images/image024.png b/userdocs/source/Images/image024.png new file mode 100644 index 0000000000..4e6848e1ac Binary files /dev/null and b/userdocs/source/Images/image024.png differ diff --git a/userdocs/source/Images/image025.png b/userdocs/source/Images/image025.png new file mode 100644 index 0000000000..fe4b20b755 Binary files /dev/null and b/userdocs/source/Images/image025.png differ diff --git a/userdocs/source/Images/image026.png b/userdocs/source/Images/image026.png new file mode 100644 index 0000000000..cc2fa020b6 Binary files /dev/null and b/userdocs/source/Images/image026.png differ diff --git a/userdocs/source/Images/image027.png b/userdocs/source/Images/image027.png new file mode 100644 index 0000000000..ab41c79c45 Binary files /dev/null and b/userdocs/source/Images/image027.png differ diff --git a/userdocs/source/Images/image028.png b/userdocs/source/Images/image028.png new file mode 100644 index 0000000000..17442a3846 Binary files /dev/null and b/userdocs/source/Images/image028.png differ diff --git a/userdocs/source/Images/image029.png b/userdocs/source/Images/image029.png new file mode 100644 index 0000000000..bbf2c01728 Binary files /dev/null and b/userdocs/source/Images/image029.png differ diff --git a/userdocs/source/Images/image030.png b/userdocs/source/Images/image030.png new file mode 100644 index 0000000000..03f0bdaf23 Binary files /dev/null and b/userdocs/source/Images/image030.png differ diff --git a/userdocs/source/Images/image031.png b/userdocs/source/Images/image031.png new file mode 100644 index 0000000000..1da52c25e5 Binary files /dev/null and b/userdocs/source/Images/image031.png differ diff --git a/userdocs/source/Images/image032.png b/userdocs/source/Images/image032.png new file mode 100644 index 0000000000..5e8096e527 Binary files /dev/null and b/userdocs/source/Images/image032.png differ diff --git a/userdocs/source/Images/image033.png b/userdocs/source/Images/image033.png new file mode 100644 index 0000000000..cdc6d2fac8 Binary files /dev/null and b/userdocs/source/Images/image033.png differ diff --git a/userdocs/source/Images/image034.png b/userdocs/source/Images/image034.png new file mode 100644 index 0000000000..8876c49b48 Binary files /dev/null and b/userdocs/source/Images/image034.png differ diff --git a/userdocs/source/Images/image035.png b/userdocs/source/Images/image035.png new file mode 100644 index 0000000000..d75deb23b9 Binary files /dev/null and b/userdocs/source/Images/image035.png differ diff --git a/userdocs/source/Images/image036.png b/userdocs/source/Images/image036.png new file mode 100644 index 0000000000..9dc3f9b656 Binary files /dev/null and b/userdocs/source/Images/image036.png differ diff --git a/userdocs/source/Images/image037.png b/userdocs/source/Images/image037.png new file mode 100644 index 0000000000..b0f50ad0e5 Binary files /dev/null and b/userdocs/source/Images/image037.png differ diff --git a/userdocs/source/Images/image038.png b/userdocs/source/Images/image038.png new file mode 100644 index 0000000000..4969b0b0a4 Binary files /dev/null and b/userdocs/source/Images/image038.png differ diff --git a/userdocs/source/Images/image039.png b/userdocs/source/Images/image039.png new file mode 100644 index 0000000000..8713cf5624 Binary files /dev/null and b/userdocs/source/Images/image039.png differ diff --git a/userdocs/source/Images/image040.png b/userdocs/source/Images/image040.png new file mode 100644 index 0000000000..10b46044e9 Binary files /dev/null and b/userdocs/source/Images/image040.png differ diff --git a/userdocs/source/Images/image041.png b/userdocs/source/Images/image041.png new file mode 100644 index 0000000000..5be601388c Binary files /dev/null and b/userdocs/source/Images/image041.png differ diff --git a/userdocs/source/Images/image042.png b/userdocs/source/Images/image042.png new file mode 100644 index 0000000000..1aaadad138 Binary files /dev/null and b/userdocs/source/Images/image042.png differ diff --git a/userdocs/source/Images/image043.png b/userdocs/source/Images/image043.png new file mode 100644 index 0000000000..560c7caeac Binary files /dev/null and b/userdocs/source/Images/image043.png differ diff --git a/userdocs/source/Images/image044.png b/userdocs/source/Images/image044.png new file mode 100644 index 0000000000..1ac3bf03b2 Binary files /dev/null and b/userdocs/source/Images/image044.png differ diff --git a/userdocs/source/Images/image045.png b/userdocs/source/Images/image045.png new file mode 100644 index 0000000000..c8470a4c25 Binary files /dev/null and b/userdocs/source/Images/image045.png differ diff --git a/userdocs/source/Images/image046.png b/userdocs/source/Images/image046.png new file mode 100644 index 0000000000..1b3e6ecfd1 Binary files /dev/null and b/userdocs/source/Images/image046.png differ diff --git a/userdocs/source/Images/image047.png b/userdocs/source/Images/image047.png new file mode 100644 index 0000000000..693581d0b5 Binary files /dev/null and b/userdocs/source/Images/image047.png differ diff --git a/userdocs/source/Images/image048.png b/userdocs/source/Images/image048.png new file mode 100644 index 0000000000..bddfa83a0c Binary files /dev/null and b/userdocs/source/Images/image048.png differ diff --git a/userdocs/source/Images/image049.png b/userdocs/source/Images/image049.png new file mode 100644 index 0000000000..ab0d4af212 Binary files /dev/null and b/userdocs/source/Images/image049.png differ diff --git a/userdocs/source/Images/image050.png b/userdocs/source/Images/image050.png new file mode 100644 index 0000000000..8c9cfa26d4 Binary files /dev/null and b/userdocs/source/Images/image050.png differ diff --git a/userdocs/source/Images/image051.png b/userdocs/source/Images/image051.png new file mode 100644 index 0000000000..f93a96890b Binary files /dev/null and b/userdocs/source/Images/image051.png differ diff --git a/userdocs/source/Images/image052.png b/userdocs/source/Images/image052.png new file mode 100644 index 0000000000..9ba79fe92c Binary files /dev/null and b/userdocs/source/Images/image052.png differ diff --git a/userdocs/source/Images/image053.png b/userdocs/source/Images/image053.png new file mode 100644 index 0000000000..48dd1a5dd1 Binary files /dev/null and b/userdocs/source/Images/image053.png differ diff --git a/userdocs/source/Images/image054.png b/userdocs/source/Images/image054.png new file mode 100644 index 0000000000..a15a5e4e84 Binary files /dev/null and b/userdocs/source/Images/image054.png differ diff --git a/userdocs/source/Images/image055.png b/userdocs/source/Images/image055.png new file mode 100644 index 0000000000..d9fa710254 Binary files /dev/null and b/userdocs/source/Images/image055.png differ diff --git a/userdocs/source/Images/image056.png b/userdocs/source/Images/image056.png new file mode 100644 index 0000000000..112f2e6dae Binary files /dev/null and b/userdocs/source/Images/image056.png differ diff --git a/userdocs/source/Images/image057.png b/userdocs/source/Images/image057.png new file mode 100644 index 0000000000..6b88144393 Binary files /dev/null and b/userdocs/source/Images/image057.png differ diff --git a/userdocs/source/Images/image058.png b/userdocs/source/Images/image058.png new file mode 100644 index 0000000000..6d6bffdea8 Binary files /dev/null and b/userdocs/source/Images/image058.png differ diff --git a/userdocs/source/Images/image059.png b/userdocs/source/Images/image059.png new file mode 100644 index 0000000000..57aa05cfa2 Binary files /dev/null and b/userdocs/source/Images/image059.png differ diff --git a/userdocs/source/Images/image060.png b/userdocs/source/Images/image060.png new file mode 100644 index 0000000000..ad9a06e159 Binary files /dev/null and b/userdocs/source/Images/image060.png differ diff --git a/userdocs/source/Images/image061.png b/userdocs/source/Images/image061.png new file mode 100644 index 0000000000..414ff8c48b Binary files /dev/null and b/userdocs/source/Images/image061.png differ diff --git a/userdocs/source/Images/image062.png b/userdocs/source/Images/image062.png new file mode 100644 index 0000000000..83ce0785d9 Binary files /dev/null and b/userdocs/source/Images/image062.png differ diff --git a/userdocs/source/Images/image063.png b/userdocs/source/Images/image063.png new file mode 100644 index 0000000000..a80108ae36 Binary files /dev/null and b/userdocs/source/Images/image063.png differ diff --git a/userdocs/source/Images/image063.psd b/userdocs/source/Images/image063.psd new file mode 100644 index 0000000000..c8864bc831 Binary files /dev/null and b/userdocs/source/Images/image063.psd differ diff --git a/userdocs/source/Images/image064.png b/userdocs/source/Images/image064.png new file mode 100644 index 0000000000..89f8940419 Binary files /dev/null and b/userdocs/source/Images/image064.png differ diff --git a/userdocs/source/Images/image065.png b/userdocs/source/Images/image065.png new file mode 100644 index 0000000000..eab327d3ff Binary files /dev/null and b/userdocs/source/Images/image065.png differ diff --git a/userdocs/source/Images/image066.png b/userdocs/source/Images/image066.png new file mode 100644 index 0000000000..e0ee45c33c Binary files /dev/null and b/userdocs/source/Images/image066.png differ diff --git a/userdocs/source/Images/image067.png b/userdocs/source/Images/image067.png new file mode 100644 index 0000000000..cfb59232e0 Binary files /dev/null and b/userdocs/source/Images/image067.png differ diff --git a/userdocs/source/Images/image068.png b/userdocs/source/Images/image068.png new file mode 100644 index 0000000000..aca7fe5b16 Binary files /dev/null and b/userdocs/source/Images/image068.png differ diff --git a/userdocs/source/Images/image069.png b/userdocs/source/Images/image069.png new file mode 100644 index 0000000000..e28673a9c1 Binary files /dev/null and b/userdocs/source/Images/image069.png differ diff --git a/userdocs/source/Images/image070.png b/userdocs/source/Images/image070.png new file mode 100644 index 0000000000..388c9e5faa Binary files /dev/null and b/userdocs/source/Images/image070.png differ diff --git a/userdocs/source/Images/image071.png b/userdocs/source/Images/image071.png new file mode 100644 index 0000000000..716205f6da Binary files /dev/null and b/userdocs/source/Images/image071.png differ diff --git a/userdocs/source/Images/image072.png b/userdocs/source/Images/image072.png new file mode 100644 index 0000000000..fa4110d75a Binary files /dev/null and b/userdocs/source/Images/image072.png differ diff --git a/userdocs/source/Images/image073.png b/userdocs/source/Images/image073.png new file mode 100644 index 0000000000..8197e476fc Binary files /dev/null and b/userdocs/source/Images/image073.png differ diff --git a/userdocs/source/Images/image074.png b/userdocs/source/Images/image074.png new file mode 100644 index 0000000000..abd0830b59 Binary files /dev/null and b/userdocs/source/Images/image074.png differ diff --git a/userdocs/source/Images/image075.png b/userdocs/source/Images/image075.png new file mode 100644 index 0000000000..716205f6da Binary files /dev/null and b/userdocs/source/Images/image075.png differ diff --git a/userdocs/source/Images/image076.png b/userdocs/source/Images/image076.png new file mode 100644 index 0000000000..f261e3bbef Binary files /dev/null and b/userdocs/source/Images/image076.png differ diff --git a/userdocs/source/Images/image077.jpg b/userdocs/source/Images/image077.jpg new file mode 100644 index 0000000000..2afc71edc2 Binary files /dev/null and b/userdocs/source/Images/image077.jpg differ diff --git a/userdocs/source/Images/image078.png b/userdocs/source/Images/image078.png new file mode 100644 index 0000000000..f1d2ad4b1d Binary files /dev/null and b/userdocs/source/Images/image078.png differ diff --git a/userdocs/source/Images/image079.png b/userdocs/source/Images/image079.png new file mode 100644 index 0000000000..31cea5b7ed Binary files /dev/null and b/userdocs/source/Images/image079.png differ diff --git a/userdocs/source/Images/image080.png b/userdocs/source/Images/image080.png new file mode 100644 index 0000000000..796c896bf2 Binary files /dev/null and b/userdocs/source/Images/image080.png differ diff --git a/userdocs/source/Images/image081.png b/userdocs/source/Images/image081.png new file mode 100644 index 0000000000..dab410ab75 Binary files /dev/null and b/userdocs/source/Images/image081.png differ diff --git a/userdocs/source/Images/image082.png b/userdocs/source/Images/image082.png new file mode 100644 index 0000000000..0c7685060e Binary files /dev/null and b/userdocs/source/Images/image082.png differ diff --git a/userdocs/source/Images/image083.png b/userdocs/source/Images/image083.png new file mode 100644 index 0000000000..e28673a9c1 Binary files /dev/null and b/userdocs/source/Images/image083.png differ diff --git a/userdocs/source/Images/image084.png b/userdocs/source/Images/image084.png new file mode 100644 index 0000000000..388c9e5faa Binary files /dev/null and b/userdocs/source/Images/image084.png differ diff --git a/userdocs/source/Images/image085.png b/userdocs/source/Images/image085.png new file mode 100644 index 0000000000..9a63511883 Binary files /dev/null and b/userdocs/source/Images/image085.png differ diff --git a/userdocs/source/Images/image086.png b/userdocs/source/Images/image086.png new file mode 100644 index 0000000000..bd3f106dfd Binary files /dev/null and b/userdocs/source/Images/image086.png differ diff --git a/userdocs/source/Images/image087.png b/userdocs/source/Images/image087.png new file mode 100644 index 0000000000..501814b85f Binary files /dev/null and b/userdocs/source/Images/image087.png differ diff --git a/userdocs/source/Images/image088.png b/userdocs/source/Images/image088.png new file mode 100644 index 0000000000..bae3f6289d Binary files /dev/null and b/userdocs/source/Images/image088.png differ diff --git a/userdocs/source/Images/image089.png b/userdocs/source/Images/image089.png new file mode 100644 index 0000000000..7f50b3ce08 Binary files /dev/null and b/userdocs/source/Images/image089.png differ diff --git a/userdocs/source/Images/image090.png b/userdocs/source/Images/image090.png new file mode 100644 index 0000000000..0f3b5d395c Binary files /dev/null and b/userdocs/source/Images/image090.png differ diff --git a/userdocs/source/Images/image091.png b/userdocs/source/Images/image091.png new file mode 100644 index 0000000000..def139c262 Binary files /dev/null and b/userdocs/source/Images/image091.png differ diff --git a/userdocs/source/Images/image092.png b/userdocs/source/Images/image092.png new file mode 100644 index 0000000000..2393d473cb Binary files /dev/null and b/userdocs/source/Images/image092.png differ diff --git a/userdocs/source/Images/image093.png b/userdocs/source/Images/image093.png new file mode 100644 index 0000000000..4466185763 Binary files /dev/null and b/userdocs/source/Images/image093.png differ diff --git a/userdocs/source/Images/image094.png b/userdocs/source/Images/image094.png new file mode 100644 index 0000000000..a9a21b313c Binary files /dev/null and b/userdocs/source/Images/image094.png differ diff --git a/userdocs/source/Images/image095.png b/userdocs/source/Images/image095.png new file mode 100644 index 0000000000..ac77e50c7b Binary files /dev/null and b/userdocs/source/Images/image095.png differ diff --git a/userdocs/source/Images/image096.png b/userdocs/source/Images/image096.png new file mode 100644 index 0000000000..b5b8fef83e Binary files /dev/null and b/userdocs/source/Images/image096.png differ diff --git a/userdocs/source/Images/image097.png b/userdocs/source/Images/image097.png new file mode 100644 index 0000000000..b4609c2d3b Binary files /dev/null and b/userdocs/source/Images/image097.png differ diff --git a/userdocs/source/Images/image098.png b/userdocs/source/Images/image098.png new file mode 100644 index 0000000000..89277628b5 Binary files /dev/null and b/userdocs/source/Images/image098.png differ diff --git a/userdocs/source/Images/image099.png b/userdocs/source/Images/image099.png new file mode 100644 index 0000000000..5adb2e3a40 Binary files /dev/null and b/userdocs/source/Images/image099.png differ diff --git a/userdocs/source/Images/image100.png b/userdocs/source/Images/image100.png new file mode 100644 index 0000000000..0ce74c4358 Binary files /dev/null and b/userdocs/source/Images/image100.png differ diff --git a/userdocs/source/Images/image101.png b/userdocs/source/Images/image101.png new file mode 100644 index 0000000000..666fb2a80f Binary files /dev/null and b/userdocs/source/Images/image101.png differ diff --git a/userdocs/source/Images/image102.png b/userdocs/source/Images/image102.png new file mode 100644 index 0000000000..73980371f0 Binary files /dev/null and b/userdocs/source/Images/image102.png differ diff --git a/userdocs/source/Images/image103.jpg b/userdocs/source/Images/image103.jpg new file mode 100644 index 0000000000..7a32879120 Binary files /dev/null and b/userdocs/source/Images/image103.jpg differ diff --git a/userdocs/source/Images/image104.png b/userdocs/source/Images/image104.png new file mode 100644 index 0000000000..b335f3e9a2 Binary files /dev/null and b/userdocs/source/Images/image104.png differ diff --git a/userdocs/source/Images/image105.png b/userdocs/source/Images/image105.png new file mode 100644 index 0000000000..c2fda0abe1 Binary files /dev/null and b/userdocs/source/Images/image105.png differ diff --git a/userdocs/source/Images/image106.png b/userdocs/source/Images/image106.png new file mode 100644 index 0000000000..c500af16b5 Binary files /dev/null and b/userdocs/source/Images/image106.png differ diff --git a/userdocs/source/Images/image107.png b/userdocs/source/Images/image107.png new file mode 100644 index 0000000000..f0516df464 Binary files /dev/null and b/userdocs/source/Images/image107.png differ diff --git a/userdocs/source/Images/image108.png b/userdocs/source/Images/image108.png new file mode 100644 index 0000000000..3a141d9132 Binary files /dev/null and b/userdocs/source/Images/image108.png differ diff --git a/userdocs/source/Images/image109.png b/userdocs/source/Images/image109.png new file mode 100644 index 0000000000..0f5ba32d1b Binary files /dev/null and b/userdocs/source/Images/image109.png differ diff --git a/userdocs/source/Images/image110.png b/userdocs/source/Images/image110.png new file mode 100644 index 0000000000..49c33860bf Binary files /dev/null and b/userdocs/source/Images/image110.png differ diff --git a/userdocs/source/Images/image111.png b/userdocs/source/Images/image111.png new file mode 100644 index 0000000000..1a917fc4dc Binary files /dev/null and b/userdocs/source/Images/image111.png differ diff --git a/userdocs/source/Images/image112.png b/userdocs/source/Images/image112.png new file mode 100644 index 0000000000..9c75a29f80 Binary files /dev/null and b/userdocs/source/Images/image112.png differ diff --git a/userdocs/source/Images/image113.png b/userdocs/source/Images/image113.png new file mode 100644 index 0000000000..e9573ecc5b Binary files /dev/null and b/userdocs/source/Images/image113.png differ diff --git a/userdocs/source/Images/image114.png b/userdocs/source/Images/image114.png new file mode 100644 index 0000000000..cf328e8266 Binary files /dev/null and b/userdocs/source/Images/image114.png differ diff --git a/userdocs/source/Images/image115.png b/userdocs/source/Images/image115.png new file mode 100644 index 0000000000..760a31ef4f Binary files /dev/null and b/userdocs/source/Images/image115.png differ diff --git a/userdocs/source/Images/image116.png b/userdocs/source/Images/image116.png new file mode 100644 index 0000000000..7ef168fa67 Binary files /dev/null and b/userdocs/source/Images/image116.png differ diff --git a/userdocs/source/Images/image117.png b/userdocs/source/Images/image117.png new file mode 100644 index 0000000000..0331bfcd86 Binary files /dev/null and b/userdocs/source/Images/image117.png differ diff --git a/userdocs/source/Images/image118.png b/userdocs/source/Images/image118.png new file mode 100644 index 0000000000..b8e085faac Binary files /dev/null and b/userdocs/source/Images/image118.png differ diff --git a/userdocs/source/Images/image119.png b/userdocs/source/Images/image119.png new file mode 100644 index 0000000000..e9e9af3b46 Binary files /dev/null and b/userdocs/source/Images/image119.png differ diff --git a/userdocs/source/Images/image120.png b/userdocs/source/Images/image120.png new file mode 100644 index 0000000000..909d977296 Binary files /dev/null and b/userdocs/source/Images/image120.png differ diff --git a/userdocs/source/Images/image121.png b/userdocs/source/Images/image121.png new file mode 100644 index 0000000000..cf0bc7cea1 Binary files /dev/null and b/userdocs/source/Images/image121.png differ diff --git a/userdocs/source/Images/image122.png b/userdocs/source/Images/image122.png new file mode 100644 index 0000000000..e6092abe45 Binary files /dev/null and b/userdocs/source/Images/image122.png differ diff --git a/userdocs/source/Images/image123.png b/userdocs/source/Images/image123.png new file mode 100644 index 0000000000..63425920b2 Binary files /dev/null and b/userdocs/source/Images/image123.png differ diff --git a/userdocs/source/Images/image124.png b/userdocs/source/Images/image124.png new file mode 100644 index 0000000000..3d8fcb5aa5 Binary files /dev/null and b/userdocs/source/Images/image124.png differ diff --git a/userdocs/source/Images/image125.png b/userdocs/source/Images/image125.png new file mode 100644 index 0000000000..f7548e517c Binary files /dev/null and b/userdocs/source/Images/image125.png differ diff --git a/userdocs/source/Images/image126.png b/userdocs/source/Images/image126.png new file mode 100644 index 0000000000..048973d07b Binary files /dev/null and b/userdocs/source/Images/image126.png differ diff --git a/userdocs/source/Images/image127.png b/userdocs/source/Images/image127.png new file mode 100644 index 0000000000..48dd1a5dd1 Binary files /dev/null and b/userdocs/source/Images/image127.png differ diff --git a/userdocs/source/Images/image128.png b/userdocs/source/Images/image128.png new file mode 100644 index 0000000000..a15a5e4e84 Binary files /dev/null and b/userdocs/source/Images/image128.png differ diff --git a/userdocs/source/Images/image129.png b/userdocs/source/Images/image129.png new file mode 100644 index 0000000000..5359c2738f Binary files /dev/null and b/userdocs/source/Images/image129.png differ diff --git a/userdocs/source/Images/image130.png b/userdocs/source/Images/image130.png new file mode 100644 index 0000000000..dcbb25930f Binary files /dev/null and b/userdocs/source/Images/image130.png differ diff --git a/userdocs/source/Images/image131.png b/userdocs/source/Images/image131.png new file mode 100644 index 0000000000..6403ffb75d Binary files /dev/null and b/userdocs/source/Images/image131.png differ diff --git a/userdocs/source/Images/image132.png b/userdocs/source/Images/image132.png new file mode 100644 index 0000000000..c1c7c764f9 Binary files /dev/null and b/userdocs/source/Images/image132.png differ diff --git a/userdocs/source/Images/image133.png b/userdocs/source/Images/image133.png new file mode 100644 index 0000000000..2c11c1be80 Binary files /dev/null and b/userdocs/source/Images/image133.png differ diff --git a/userdocs/source/Images/image134.png b/userdocs/source/Images/image134.png new file mode 100644 index 0000000000..569422ae78 Binary files /dev/null and b/userdocs/source/Images/image134.png differ diff --git a/userdocs/source/Images/image135.png b/userdocs/source/Images/image135.png new file mode 100644 index 0000000000..5de78ea393 Binary files /dev/null and b/userdocs/source/Images/image135.png differ diff --git a/userdocs/source/Images/image136.png b/userdocs/source/Images/image136.png new file mode 100644 index 0000000000..20bd222e71 Binary files /dev/null and b/userdocs/source/Images/image136.png differ diff --git a/userdocs/source/Images/image137.png b/userdocs/source/Images/image137.png new file mode 100644 index 0000000000..ba1d098380 Binary files /dev/null and b/userdocs/source/Images/image137.png differ diff --git a/userdocs/source/Images/image138.png b/userdocs/source/Images/image138.png new file mode 100644 index 0000000000..991dcf6791 Binary files /dev/null and b/userdocs/source/Images/image138.png differ diff --git a/userdocs/source/Images/image139.png b/userdocs/source/Images/image139.png new file mode 100644 index 0000000000..2c11c1be80 Binary files /dev/null and b/userdocs/source/Images/image139.png differ diff --git a/userdocs/source/Images/image140.png b/userdocs/source/Images/image140.png new file mode 100644 index 0000000000..e18b79c8d6 Binary files /dev/null and b/userdocs/source/Images/image140.png differ diff --git a/userdocs/source/Images/image141.png b/userdocs/source/Images/image141.png new file mode 100644 index 0000000000..925bd1ed36 Binary files /dev/null and b/userdocs/source/Images/image141.png differ diff --git a/userdocs/source/Images/image142.png b/userdocs/source/Images/image142.png new file mode 100644 index 0000000000..455cb32f50 Binary files /dev/null and b/userdocs/source/Images/image142.png differ diff --git a/userdocs/source/Images/image143.png b/userdocs/source/Images/image143.png new file mode 100644 index 0000000000..35355ba5b8 Binary files /dev/null and b/userdocs/source/Images/image143.png differ diff --git a/userdocs/source/Images/image144.png b/userdocs/source/Images/image144.png new file mode 100644 index 0000000000..4af225ea6f Binary files /dev/null and b/userdocs/source/Images/image144.png differ diff --git a/userdocs/source/Images/image145.png b/userdocs/source/Images/image145.png new file mode 100644 index 0000000000..83cd7861da Binary files /dev/null and b/userdocs/source/Images/image145.png differ diff --git a/userdocs/source/Images/image146.png b/userdocs/source/Images/image146.png new file mode 100644 index 0000000000..b2c780d2b3 Binary files /dev/null and b/userdocs/source/Images/image146.png differ diff --git a/userdocs/source/Images/image147.png b/userdocs/source/Images/image147.png new file mode 100644 index 0000000000..370e3377f6 Binary files /dev/null and b/userdocs/source/Images/image147.png differ diff --git a/userdocs/source/Images/image148.png b/userdocs/source/Images/image148.png new file mode 100644 index 0000000000..cb5353b25e Binary files /dev/null and b/userdocs/source/Images/image148.png differ diff --git a/userdocs/source/Images/image149.png b/userdocs/source/Images/image149.png new file mode 100644 index 0000000000..7cc50b8cd7 Binary files /dev/null and b/userdocs/source/Images/image149.png differ diff --git a/userdocs/source/Images/image150.png b/userdocs/source/Images/image150.png new file mode 100644 index 0000000000..7d0364a25c Binary files /dev/null and b/userdocs/source/Images/image150.png differ diff --git a/userdocs/source/Images/image151.png b/userdocs/source/Images/image151.png new file mode 100644 index 0000000000..2c1846c4d7 Binary files /dev/null and b/userdocs/source/Images/image151.png differ diff --git a/userdocs/source/Images/image152.png b/userdocs/source/Images/image152.png new file mode 100644 index 0000000000..a2220731cb Binary files /dev/null and b/userdocs/source/Images/image152.png differ diff --git a/userdocs/source/Images/image153.png b/userdocs/source/Images/image153.png new file mode 100644 index 0000000000..5de78ea393 Binary files /dev/null and b/userdocs/source/Images/image153.png differ diff --git a/userdocs/source/Images/image154.png b/userdocs/source/Images/image154.png new file mode 100644 index 0000000000..88050b4721 Binary files /dev/null and b/userdocs/source/Images/image154.png differ diff --git a/userdocs/source/Images/image155.png b/userdocs/source/Images/image155.png new file mode 100644 index 0000000000..2b6c3f35f6 Binary files /dev/null and b/userdocs/source/Images/image155.png differ diff --git a/userdocs/source/Images/image156.png b/userdocs/source/Images/image156.png new file mode 100644 index 0000000000..0f4e546dc2 Binary files /dev/null and b/userdocs/source/Images/image156.png differ diff --git a/userdocs/source/Images/image157.png b/userdocs/source/Images/image157.png new file mode 100644 index 0000000000..eae440ed43 Binary files /dev/null and b/userdocs/source/Images/image157.png differ diff --git a/userdocs/source/Images/image158.png b/userdocs/source/Images/image158.png new file mode 100644 index 0000000000..b3fe9dbb2a Binary files /dev/null and b/userdocs/source/Images/image158.png differ diff --git a/userdocs/source/Images/image159.png b/userdocs/source/Images/image159.png new file mode 100644 index 0000000000..64b5eeace2 Binary files /dev/null and b/userdocs/source/Images/image159.png differ diff --git a/userdocs/source/Images/image160.png b/userdocs/source/Images/image160.png new file mode 100644 index 0000000000..ac77d06991 Binary files /dev/null and b/userdocs/source/Images/image160.png differ diff --git a/userdocs/source/Images/image161.png b/userdocs/source/Images/image161.png new file mode 100644 index 0000000000..7c43e0d984 Binary files /dev/null and b/userdocs/source/Images/image161.png differ diff --git a/userdocs/source/Images/image162.png b/userdocs/source/Images/image162.png new file mode 100644 index 0000000000..64effe0eea Binary files /dev/null and b/userdocs/source/Images/image162.png differ diff --git a/userdocs/source/Images/image163.png b/userdocs/source/Images/image163.png new file mode 100644 index 0000000000..831d829a6e Binary files /dev/null and b/userdocs/source/Images/image163.png differ diff --git a/userdocs/source/Images/image164.png b/userdocs/source/Images/image164.png new file mode 100644 index 0000000000..a55584fe57 Binary files /dev/null and b/userdocs/source/Images/image164.png differ diff --git a/userdocs/source/Images/image165.png b/userdocs/source/Images/image165.png new file mode 100644 index 0000000000..4708061655 Binary files /dev/null and b/userdocs/source/Images/image165.png differ diff --git a/userdocs/source/Images/image166.png b/userdocs/source/Images/image166.png new file mode 100644 index 0000000000..86807dd1c9 Binary files /dev/null and b/userdocs/source/Images/image166.png differ diff --git a/userdocs/source/Images/image167.png b/userdocs/source/Images/image167.png new file mode 100644 index 0000000000..64b5eeace2 Binary files /dev/null and b/userdocs/source/Images/image167.png differ diff --git a/userdocs/source/Images/image168.png b/userdocs/source/Images/image168.png new file mode 100644 index 0000000000..a3e440b45d Binary files /dev/null and b/userdocs/source/Images/image168.png differ diff --git a/userdocs/source/Images/image169.png b/userdocs/source/Images/image169.png new file mode 100644 index 0000000000..7c43e0d984 Binary files /dev/null and b/userdocs/source/Images/image169.png differ diff --git a/userdocs/source/Images/image170.png b/userdocs/source/Images/image170.png new file mode 100644 index 0000000000..bbfbd9d461 Binary files /dev/null and b/userdocs/source/Images/image170.png differ diff --git a/userdocs/source/Images/image171.png b/userdocs/source/Images/image171.png new file mode 100644 index 0000000000..8c4e2d7072 Binary files /dev/null and b/userdocs/source/Images/image171.png differ diff --git a/userdocs/source/Images/image172.png b/userdocs/source/Images/image172.png new file mode 100644 index 0000000000..929dfe4299 Binary files /dev/null and b/userdocs/source/Images/image172.png differ diff --git a/userdocs/source/Images/image173.png b/userdocs/source/Images/image173.png new file mode 100644 index 0000000000..61007c0fbf Binary files /dev/null and b/userdocs/source/Images/image173.png differ diff --git a/userdocs/source/Images/image174.png b/userdocs/source/Images/image174.png new file mode 100644 index 0000000000..00e1165d63 Binary files /dev/null and b/userdocs/source/Images/image174.png differ diff --git a/userdocs/source/Images/image175.png b/userdocs/source/Images/image175.png new file mode 100644 index 0000000000..872853bd7a Binary files /dev/null and b/userdocs/source/Images/image175.png differ diff --git a/userdocs/source/Images/image176.png b/userdocs/source/Images/image176.png new file mode 100644 index 0000000000..a4a7948f82 Binary files /dev/null and b/userdocs/source/Images/image176.png differ diff --git a/userdocs/source/Images/image177.png b/userdocs/source/Images/image177.png new file mode 100644 index 0000000000..6ea99aab8b Binary files /dev/null and b/userdocs/source/Images/image177.png differ diff --git a/userdocs/source/Images/image178.png b/userdocs/source/Images/image178.png new file mode 100644 index 0000000000..d13f2b17d7 Binary files /dev/null and b/userdocs/source/Images/image178.png differ diff --git a/userdocs/source/Images/image179.png b/userdocs/source/Images/image179.png new file mode 100644 index 0000000000..d4c49cb0c8 Binary files /dev/null and b/userdocs/source/Images/image179.png differ diff --git a/userdocs/source/Images/image180.png b/userdocs/source/Images/image180.png new file mode 100644 index 0000000000..6150b573dd Binary files /dev/null and b/userdocs/source/Images/image180.png differ diff --git a/userdocs/source/Images/image181.png b/userdocs/source/Images/image181.png new file mode 100644 index 0000000000..13d905d025 Binary files /dev/null and b/userdocs/source/Images/image181.png differ diff --git a/userdocs/source/Images/image182.png b/userdocs/source/Images/image182.png new file mode 100644 index 0000000000..cb7e5b701f Binary files /dev/null and b/userdocs/source/Images/image182.png differ diff --git a/userdocs/source/Images/image183.jpg b/userdocs/source/Images/image183.jpg new file mode 100644 index 0000000000..2afc71edc2 Binary files /dev/null and b/userdocs/source/Images/image183.jpg differ diff --git a/userdocs/source/Images/image184.png b/userdocs/source/Images/image184.png new file mode 100644 index 0000000000..f1d2ad4b1d Binary files /dev/null and b/userdocs/source/Images/image184.png differ diff --git a/userdocs/source/Images/image185.png b/userdocs/source/Images/image185.png new file mode 100644 index 0000000000..51b0d51538 Binary files /dev/null and b/userdocs/source/Images/image185.png differ diff --git a/userdocs/source/Images/image186.png b/userdocs/source/Images/image186.png new file mode 100644 index 0000000000..a5e409cc2d Binary files /dev/null and b/userdocs/source/Images/image186.png differ diff --git a/userdocs/source/Images/image187.png b/userdocs/source/Images/image187.png new file mode 100644 index 0000000000..c93803670b Binary files /dev/null and b/userdocs/source/Images/image187.png differ diff --git a/userdocs/source/Images/image188.png b/userdocs/source/Images/image188.png new file mode 100644 index 0000000000..f555dac871 Binary files /dev/null and b/userdocs/source/Images/image188.png differ diff --git a/userdocs/source/Images/image189.png b/userdocs/source/Images/image189.png new file mode 100644 index 0000000000..358c157498 Binary files /dev/null and b/userdocs/source/Images/image189.png differ diff --git a/userdocs/source/Images/image190.png b/userdocs/source/Images/image190.png new file mode 100644 index 0000000000..4a65d4bef1 Binary files /dev/null and b/userdocs/source/Images/image190.png differ diff --git a/userdocs/source/Images/image191.png b/userdocs/source/Images/image191.png new file mode 100644 index 0000000000..fb12b80bbb Binary files /dev/null and b/userdocs/source/Images/image191.png differ diff --git a/userdocs/source/Images/image192.png b/userdocs/source/Images/image192.png new file mode 100644 index 0000000000..ffca24cb3c Binary files /dev/null and b/userdocs/source/Images/image192.png differ diff --git a/userdocs/source/Images/image193.png b/userdocs/source/Images/image193.png new file mode 100644 index 0000000000..524c67581a Binary files /dev/null and b/userdocs/source/Images/image193.png differ diff --git a/userdocs/source/Images/image194.png b/userdocs/source/Images/image194.png new file mode 100644 index 0000000000..54d87cd22b Binary files /dev/null and b/userdocs/source/Images/image194.png differ diff --git a/userdocs/source/Images/image195.png b/userdocs/source/Images/image195.png new file mode 100644 index 0000000000..231d323467 Binary files /dev/null and b/userdocs/source/Images/image195.png differ diff --git a/userdocs/source/Images/image196.png b/userdocs/source/Images/image196.png new file mode 100644 index 0000000000..89372357b3 Binary files /dev/null and b/userdocs/source/Images/image196.png differ diff --git a/userdocs/source/Images/image197.png b/userdocs/source/Images/image197.png new file mode 100644 index 0000000000..a7f039537f Binary files /dev/null and b/userdocs/source/Images/image197.png differ diff --git a/userdocs/source/Images/image198.png b/userdocs/source/Images/image198.png new file mode 100644 index 0000000000..d869a86c8f Binary files /dev/null and b/userdocs/source/Images/image198.png differ diff --git a/userdocs/source/Images/image199.png b/userdocs/source/Images/image199.png new file mode 100644 index 0000000000..e8a6d99d08 Binary files /dev/null and b/userdocs/source/Images/image199.png differ diff --git a/userdocs/source/Images/image200.png b/userdocs/source/Images/image200.png new file mode 100644 index 0000000000..9679a9da71 Binary files /dev/null and b/userdocs/source/Images/image200.png differ diff --git a/userdocs/source/Images/image201.png b/userdocs/source/Images/image201.png new file mode 100644 index 0000000000..a2601240f7 Binary files /dev/null and b/userdocs/source/Images/image201.png differ diff --git a/userdocs/source/Images/image202.png b/userdocs/source/Images/image202.png new file mode 100644 index 0000000000..220adc9efb Binary files /dev/null and b/userdocs/source/Images/image202.png differ diff --git a/userdocs/source/Images/image203.png b/userdocs/source/Images/image203.png new file mode 100644 index 0000000000..a87ed9f57b Binary files /dev/null and b/userdocs/source/Images/image203.png differ diff --git a/userdocs/source/Images/image204.png b/userdocs/source/Images/image204.png new file mode 100644 index 0000000000..3709a3e85b Binary files /dev/null and b/userdocs/source/Images/image204.png differ diff --git a/userdocs/source/Images/image205.png b/userdocs/source/Images/image205.png new file mode 100644 index 0000000000..e0a3904686 Binary files /dev/null and b/userdocs/source/Images/image205.png differ diff --git a/userdocs/source/Images/image206.png b/userdocs/source/Images/image206.png new file mode 100644 index 0000000000..3e0f1ada2e Binary files /dev/null and b/userdocs/source/Images/image206.png differ diff --git a/userdocs/source/Images/image207.png b/userdocs/source/Images/image207.png new file mode 100644 index 0000000000..c59aff3769 Binary files /dev/null and b/userdocs/source/Images/image207.png differ diff --git a/userdocs/source/Images/image208.png b/userdocs/source/Images/image208.png new file mode 100644 index 0000000000..245f30164e Binary files /dev/null and b/userdocs/source/Images/image208.png differ diff --git a/userdocs/source/Images/image209.png b/userdocs/source/Images/image209.png new file mode 100644 index 0000000000..647b76736f Binary files /dev/null and b/userdocs/source/Images/image209.png differ diff --git a/userdocs/source/Images/image210.png b/userdocs/source/Images/image210.png new file mode 100644 index 0000000000..6e6668723c Binary files /dev/null and b/userdocs/source/Images/image210.png differ diff --git a/userdocs/source/Images/image211.png b/userdocs/source/Images/image211.png new file mode 100644 index 0000000000..67b29a9ccc Binary files /dev/null and b/userdocs/source/Images/image211.png differ diff --git a/userdocs/source/Images/image212.png b/userdocs/source/Images/image212.png new file mode 100644 index 0000000000..6e2e7e9aae Binary files /dev/null and b/userdocs/source/Images/image212.png differ diff --git a/userdocs/source/Images/image213.png b/userdocs/source/Images/image213.png new file mode 100644 index 0000000000..d8322d197a Binary files /dev/null and b/userdocs/source/Images/image213.png differ diff --git a/userdocs/source/Images/image214.png b/userdocs/source/Images/image214.png new file mode 100644 index 0000000000..67b34527c3 Binary files /dev/null and b/userdocs/source/Images/image214.png differ diff --git a/userdocs/source/Images/image215.png b/userdocs/source/Images/image215.png new file mode 100644 index 0000000000..b46a9e6bd4 Binary files /dev/null and b/userdocs/source/Images/image215.png differ diff --git a/userdocs/source/Images/image216.png b/userdocs/source/Images/image216.png new file mode 100644 index 0000000000..0454aaff61 Binary files /dev/null and b/userdocs/source/Images/image216.png differ diff --git a/userdocs/source/Images/image217.png b/userdocs/source/Images/image217.png new file mode 100644 index 0000000000..8ecc9ada20 Binary files /dev/null and b/userdocs/source/Images/image217.png differ diff --git a/userdocs/source/Images/image218.png b/userdocs/source/Images/image218.png new file mode 100644 index 0000000000..2a9f62461f Binary files /dev/null and b/userdocs/source/Images/image218.png differ diff --git a/userdocs/source/Images/image219.png b/userdocs/source/Images/image219.png new file mode 100644 index 0000000000..a494cbd978 Binary files /dev/null and b/userdocs/source/Images/image219.png differ diff --git a/userdocs/source/Images/image220.png b/userdocs/source/Images/image220.png new file mode 100644 index 0000000000..23d08e00aa Binary files /dev/null and b/userdocs/source/Images/image220.png differ diff --git a/userdocs/source/Images/image221.png b/userdocs/source/Images/image221.png new file mode 100644 index 0000000000..c568622e56 Binary files /dev/null and b/userdocs/source/Images/image221.png differ diff --git a/userdocs/source/Images/image222.png b/userdocs/source/Images/image222.png new file mode 100644 index 0000000000..1ee3de7c7a Binary files /dev/null and b/userdocs/source/Images/image222.png differ diff --git a/userdocs/source/Images/image223.png b/userdocs/source/Images/image223.png new file mode 100644 index 0000000000..f42fccc4ef Binary files /dev/null and b/userdocs/source/Images/image223.png differ diff --git a/userdocs/source/Images/image224.png b/userdocs/source/Images/image224.png new file mode 100644 index 0000000000..c390a696c2 Binary files /dev/null and b/userdocs/source/Images/image224.png differ diff --git a/userdocs/source/Images/image225.png b/userdocs/source/Images/image225.png new file mode 100644 index 0000000000..93127e56ee Binary files /dev/null and b/userdocs/source/Images/image225.png differ diff --git a/userdocs/source/Images/image226.png b/userdocs/source/Images/image226.png new file mode 100644 index 0000000000..d1a1478a81 Binary files /dev/null and b/userdocs/source/Images/image226.png differ diff --git a/userdocs/source/Images/image227.png b/userdocs/source/Images/image227.png new file mode 100644 index 0000000000..d3f8f386f6 Binary files /dev/null and b/userdocs/source/Images/image227.png differ diff --git a/userdocs/source/Images/image228.png b/userdocs/source/Images/image228.png new file mode 100644 index 0000000000..c78f176809 Binary files /dev/null and b/userdocs/source/Images/image228.png differ diff --git a/userdocs/source/Images/image229.png b/userdocs/source/Images/image229.png new file mode 100644 index 0000000000..93127e56ee Binary files /dev/null and b/userdocs/source/Images/image229.png differ diff --git a/userdocs/source/Images/image230.png b/userdocs/source/Images/image230.png new file mode 100644 index 0000000000..d1a1478a81 Binary files /dev/null and b/userdocs/source/Images/image230.png differ diff --git a/userdocs/source/Images/image231.png b/userdocs/source/Images/image231.png new file mode 100644 index 0000000000..05d6258086 Binary files /dev/null and b/userdocs/source/Images/image231.png differ diff --git a/userdocs/source/Images/image232.png b/userdocs/source/Images/image232.png new file mode 100644 index 0000000000..2aaa4426ef Binary files /dev/null and b/userdocs/source/Images/image232.png differ diff --git a/userdocs/source/Images/image233.png b/userdocs/source/Images/image233.png new file mode 100644 index 0000000000..fc6da1c2db Binary files /dev/null and b/userdocs/source/Images/image233.png differ diff --git a/userdocs/source/Images/image234.png b/userdocs/source/Images/image234.png new file mode 100644 index 0000000000..a5eb80ee41 Binary files /dev/null and b/userdocs/source/Images/image234.png differ diff --git a/userdocs/source/Images/image235.png b/userdocs/source/Images/image235.png new file mode 100644 index 0000000000..cc38c96359 Binary files /dev/null and b/userdocs/source/Images/image235.png differ diff --git a/userdocs/source/Images/image236.png b/userdocs/source/Images/image236.png new file mode 100644 index 0000000000..65e8dbdab7 Binary files /dev/null and b/userdocs/source/Images/image236.png differ diff --git a/userdocs/source/Images/image237.png b/userdocs/source/Images/image237.png new file mode 100644 index 0000000000..d365a96f9e Binary files /dev/null and b/userdocs/source/Images/image237.png differ diff --git a/userdocs/source/Images/image238.png b/userdocs/source/Images/image238.png new file mode 100644 index 0000000000..e4bccc7d5e Binary files /dev/null and b/userdocs/source/Images/image238.png differ diff --git a/userdocs/source/Images/image239.png b/userdocs/source/Images/image239.png new file mode 100644 index 0000000000..d651f668b2 Binary files /dev/null and b/userdocs/source/Images/image239.png differ diff --git a/userdocs/source/Images/image240.png b/userdocs/source/Images/image240.png new file mode 100644 index 0000000000..502ca324ea Binary files /dev/null and b/userdocs/source/Images/image240.png differ diff --git a/userdocs/source/Images/image241.png b/userdocs/source/Images/image241.png new file mode 100644 index 0000000000..199c574eaa Binary files /dev/null and b/userdocs/source/Images/image241.png differ diff --git a/userdocs/source/Images/image242.png b/userdocs/source/Images/image242.png new file mode 100644 index 0000000000..5bf8f18797 Binary files /dev/null and b/userdocs/source/Images/image242.png differ diff --git a/userdocs/source/Images/image243.png b/userdocs/source/Images/image243.png new file mode 100644 index 0000000000..1989a02699 Binary files /dev/null and b/userdocs/source/Images/image243.png differ diff --git a/userdocs/source/Images/image244.png b/userdocs/source/Images/image244.png new file mode 100644 index 0000000000..1989a02699 Binary files /dev/null and b/userdocs/source/Images/image244.png differ diff --git a/userdocs/source/Images/image245.png b/userdocs/source/Images/image245.png new file mode 100644 index 0000000000..ce3f19c1e2 Binary files /dev/null and b/userdocs/source/Images/image245.png differ diff --git a/userdocs/source/Images/image246.png b/userdocs/source/Images/image246.png new file mode 100644 index 0000000000..c783ac9e8e Binary files /dev/null and b/userdocs/source/Images/image246.png differ diff --git a/userdocs/source/Images/image247.png b/userdocs/source/Images/image247.png new file mode 100644 index 0000000000..858f3b98ba Binary files /dev/null and b/userdocs/source/Images/image247.png differ diff --git a/userdocs/source/Images/image248.png b/userdocs/source/Images/image248.png new file mode 100644 index 0000000000..2d0c1ffc4b Binary files /dev/null and b/userdocs/source/Images/image248.png differ diff --git a/userdocs/source/Images/image249.png b/userdocs/source/Images/image249.png new file mode 100644 index 0000000000..0204a40f98 Binary files /dev/null and b/userdocs/source/Images/image249.png differ diff --git a/userdocs/source/Images/image250.png b/userdocs/source/Images/image250.png new file mode 100644 index 0000000000..3f0428e5d1 Binary files /dev/null and b/userdocs/source/Images/image250.png differ diff --git a/userdocs/source/Images/image251.png b/userdocs/source/Images/image251.png new file mode 100644 index 0000000000..dad7f6f9b8 Binary files /dev/null and b/userdocs/source/Images/image251.png differ diff --git a/userdocs/source/Images/image252.png b/userdocs/source/Images/image252.png new file mode 100644 index 0000000000..38084dd5e5 Binary files /dev/null and b/userdocs/source/Images/image252.png differ diff --git a/userdocs/source/Images/image253.png b/userdocs/source/Images/image253.png new file mode 100644 index 0000000000..14a204c3b1 Binary files /dev/null and b/userdocs/source/Images/image253.png differ diff --git a/userdocs/source/Images/image254.png b/userdocs/source/Images/image254.png new file mode 100644 index 0000000000..9f8c9878cc Binary files /dev/null and b/userdocs/source/Images/image254.png differ diff --git a/userdocs/source/Images/image255.png b/userdocs/source/Images/image255.png new file mode 100644 index 0000000000..82788ddf8d Binary files /dev/null and b/userdocs/source/Images/image255.png differ diff --git a/userdocs/source/Images/image256.png b/userdocs/source/Images/image256.png new file mode 100644 index 0000000000..9a1d6d2b6b Binary files /dev/null and b/userdocs/source/Images/image256.png differ diff --git a/userdocs/source/Images/image257.png b/userdocs/source/Images/image257.png new file mode 100644 index 0000000000..4ce464b014 Binary files /dev/null and b/userdocs/source/Images/image257.png differ diff --git a/userdocs/source/Images/image258.png b/userdocs/source/Images/image258.png new file mode 100644 index 0000000000..d4c96858ef Binary files /dev/null and b/userdocs/source/Images/image258.png differ diff --git a/userdocs/source/Images/image259.png b/userdocs/source/Images/image259.png new file mode 100644 index 0000000000..9f61d5601e Binary files /dev/null and b/userdocs/source/Images/image259.png differ diff --git a/userdocs/source/Images/image260.png b/userdocs/source/Images/image260.png new file mode 100644 index 0000000000..8c9ba471f4 Binary files /dev/null and b/userdocs/source/Images/image260.png differ diff --git a/userdocs/source/Images/image261.png b/userdocs/source/Images/image261.png new file mode 100644 index 0000000000..1dd48b32f8 Binary files /dev/null and b/userdocs/source/Images/image261.png differ diff --git a/userdocs/source/Images/image262.png b/userdocs/source/Images/image262.png new file mode 100644 index 0000000000..5c30822c7e Binary files /dev/null and b/userdocs/source/Images/image262.png differ diff --git a/userdocs/source/Images/image263.png b/userdocs/source/Images/image263.png new file mode 100644 index 0000000000..b3ffdfbbb9 Binary files /dev/null and b/userdocs/source/Images/image263.png differ diff --git a/userdocs/source/Images/image264.png b/userdocs/source/Images/image264.png new file mode 100644 index 0000000000..b10daba8f9 Binary files /dev/null and b/userdocs/source/Images/image264.png differ diff --git a/userdocs/source/Images/image265.png b/userdocs/source/Images/image265.png new file mode 100644 index 0000000000..3aa4cf6d1e Binary files /dev/null and b/userdocs/source/Images/image265.png differ diff --git a/userdocs/source/Images/image266.png b/userdocs/source/Images/image266.png new file mode 100644 index 0000000000..13774b33a9 Binary files /dev/null and b/userdocs/source/Images/image266.png differ diff --git a/userdocs/source/Images/image267.png b/userdocs/source/Images/image267.png new file mode 100644 index 0000000000..22b3473371 Binary files /dev/null and b/userdocs/source/Images/image267.png differ diff --git a/userdocs/source/Images/image268.png b/userdocs/source/Images/image268.png new file mode 100644 index 0000000000..ef03a2bc88 Binary files /dev/null and b/userdocs/source/Images/image268.png differ diff --git a/userdocs/source/Images/image269.png b/userdocs/source/Images/image269.png new file mode 100644 index 0000000000..b87abac429 Binary files /dev/null and b/userdocs/source/Images/image269.png differ diff --git a/userdocs/source/Images/image270.png b/userdocs/source/Images/image270.png new file mode 100644 index 0000000000..86cd1a38e9 Binary files /dev/null and b/userdocs/source/Images/image270.png differ diff --git a/userdocs/source/Images/image271.png b/userdocs/source/Images/image271.png new file mode 100644 index 0000000000..d5f005b0f0 Binary files /dev/null and b/userdocs/source/Images/image271.png differ diff --git a/userdocs/source/Images/image272.png b/userdocs/source/Images/image272.png new file mode 100644 index 0000000000..99a7c97df2 Binary files /dev/null and b/userdocs/source/Images/image272.png differ diff --git a/userdocs/source/Images/image273.png b/userdocs/source/Images/image273.png new file mode 100644 index 0000000000..cae36f2d8a Binary files /dev/null and b/userdocs/source/Images/image273.png differ diff --git a/userdocs/source/Images/image274.png b/userdocs/source/Images/image274.png new file mode 100644 index 0000000000..6fb589d879 Binary files /dev/null and b/userdocs/source/Images/image274.png differ diff --git a/userdocs/source/Images/image275.png b/userdocs/source/Images/image275.png new file mode 100644 index 0000000000..082e9c8de2 Binary files /dev/null and b/userdocs/source/Images/image275.png differ diff --git a/userdocs/source/Images/image277.png b/userdocs/source/Images/image277.png new file mode 100644 index 0000000000..fdc936805e Binary files /dev/null and b/userdocs/source/Images/image277.png differ diff --git a/userdocs/source/Images/image278.png b/userdocs/source/Images/image278.png new file mode 100644 index 0000000000..1d805f0e68 Binary files /dev/null and b/userdocs/source/Images/image278.png differ diff --git a/userdocs/source/Images/image279.png b/userdocs/source/Images/image279.png new file mode 100644 index 0000000000..179e4895c4 Binary files /dev/null and b/userdocs/source/Images/image279.png differ diff --git a/userdocs/source/Images/image280.png b/userdocs/source/Images/image280.png new file mode 100644 index 0000000000..35cfa9d523 Binary files /dev/null and b/userdocs/source/Images/image280.png differ diff --git a/userdocs/source/Images/image281.png b/userdocs/source/Images/image281.png new file mode 100644 index 0000000000..25f3a6e05c Binary files /dev/null and b/userdocs/source/Images/image281.png differ diff --git a/userdocs/source/Images/image282.png b/userdocs/source/Images/image282.png new file mode 100644 index 0000000000..15ef68e41b Binary files /dev/null and b/userdocs/source/Images/image282.png differ diff --git a/userdocs/source/Images/image285.png b/userdocs/source/Images/image285.png new file mode 100644 index 0000000000..449092fcd2 Binary files /dev/null and b/userdocs/source/Images/image285.png differ diff --git a/userdocs/source/Images/image286.png b/userdocs/source/Images/image286.png new file mode 100644 index 0000000000..b913e91626 Binary files /dev/null and b/userdocs/source/Images/image286.png differ diff --git a/userdocs/source/Images/image287.png b/userdocs/source/Images/image287.png new file mode 100644 index 0000000000..053e53b2c7 Binary files /dev/null and b/userdocs/source/Images/image287.png differ diff --git a/userdocs/source/Images/image288.png b/userdocs/source/Images/image288.png new file mode 100644 index 0000000000..ff4a44e6b6 Binary files /dev/null and b/userdocs/source/Images/image288.png differ diff --git a/userdocs/source/Images/image289.png b/userdocs/source/Images/image289.png new file mode 100644 index 0000000000..1a9c4f3b64 Binary files /dev/null and b/userdocs/source/Images/image289.png differ diff --git a/userdocs/source/Images/image290.png b/userdocs/source/Images/image290.png new file mode 100644 index 0000000000..08f6f6e7c7 Binary files /dev/null and b/userdocs/source/Images/image290.png differ diff --git a/userdocs/source/Images/image291.png b/userdocs/source/Images/image291.png new file mode 100644 index 0000000000..05f02f71ab Binary files /dev/null and b/userdocs/source/Images/image291.png differ diff --git a/userdocs/source/Images/image292.png b/userdocs/source/Images/image292.png new file mode 100644 index 0000000000..58e119344a Binary files /dev/null and b/userdocs/source/Images/image292.png differ diff --git a/userdocs/source/Images/image293.png b/userdocs/source/Images/image293.png new file mode 100644 index 0000000000..4766b1189b Binary files /dev/null and b/userdocs/source/Images/image293.png differ diff --git a/userdocs/source/Images/image294.png b/userdocs/source/Images/image294.png new file mode 100644 index 0000000000..02c50a245e Binary files /dev/null and b/userdocs/source/Images/image294.png differ diff --git a/userdocs/source/Images/image295.png b/userdocs/source/Images/image295.png new file mode 100644 index 0000000000..8213db3e0c Binary files /dev/null and b/userdocs/source/Images/image295.png differ diff --git a/userdocs/source/Images/image296.png b/userdocs/source/Images/image296.png new file mode 100644 index 0000000000..db32b3a541 Binary files /dev/null and b/userdocs/source/Images/image296.png differ diff --git a/userdocs/source/Images/image297.png b/userdocs/source/Images/image297.png new file mode 100644 index 0000000000..ed42259bfb Binary files /dev/null and b/userdocs/source/Images/image297.png differ diff --git a/userdocs/source/Images/image298.png b/userdocs/source/Images/image298.png new file mode 100644 index 0000000000..a7f50113ec Binary files /dev/null and b/userdocs/source/Images/image298.png differ diff --git a/userdocs/source/Images/image299.png b/userdocs/source/Images/image299.png new file mode 100644 index 0000000000..d6b8d53b59 Binary files /dev/null and b/userdocs/source/Images/image299.png differ diff --git a/userdocs/source/Images/image301.png b/userdocs/source/Images/image301.png new file mode 100644 index 0000000000..a2a9a12dca Binary files /dev/null and b/userdocs/source/Images/image301.png differ diff --git a/userdocs/source/Images/image302.png b/userdocs/source/Images/image302.png new file mode 100644 index 0000000000..d238c8750a Binary files /dev/null and b/userdocs/source/Images/image302.png differ diff --git a/userdocs/source/Images/image303.png b/userdocs/source/Images/image303.png new file mode 100644 index 0000000000..b841dfd621 Binary files /dev/null and b/userdocs/source/Images/image303.png differ diff --git a/userdocs/source/Images/imageresponse1.png b/userdocs/source/Images/imageresponse1.png new file mode 100644 index 0000000000..0c8f7d89dc Binary files /dev/null and b/userdocs/source/Images/imageresponse1.png differ diff --git a/userdocs/source/Images/imageresponse2.png b/userdocs/source/Images/imageresponse2.png new file mode 100644 index 0000000000..9a7aa2503c Binary files /dev/null and b/userdocs/source/Images/imageresponse2.png differ diff --git a/userdocs/source/Images/item0001.xml b/userdocs/source/Images/item0001.xml new file mode 100644 index 0000000000..c8543fbf7d --- /dev/null +++ b/userdocs/source/Images/item0001.xml @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/userdocs/source/Images/multipleresponse.png b/userdocs/source/Images/multipleresponse.png new file mode 100644 index 0000000000..c5f8043dd4 Binary files /dev/null and b/userdocs/source/Images/multipleresponse.png differ diff --git a/userdocs/source/Images/multipleresponse2.png b/userdocs/source/Images/multipleresponse2.png new file mode 100644 index 0000000000..d237c36b1f Binary files /dev/null and b/userdocs/source/Images/multipleresponse2.png differ diff --git a/userdocs/source/Images/multipleresponse3.png b/userdocs/source/Images/multipleresponse3.png new file mode 100644 index 0000000000..084585cd09 Binary files /dev/null and b/userdocs/source/Images/multipleresponse3.png differ diff --git a/userdocs/source/Images/numericalresponse.png b/userdocs/source/Images/numericalresponse.png new file mode 100644 index 0000000000..4b979a6683 Binary files /dev/null and b/userdocs/source/Images/numericalresponse.png differ diff --git a/userdocs/source/Images/numericalresponse2.png b/userdocs/source/Images/numericalresponse2.png new file mode 100644 index 0000000000..0b3aee83b2 Binary files /dev/null and b/userdocs/source/Images/numericalresponse2.png differ diff --git a/userdocs/source/Images/numericalresponse4.png b/userdocs/source/Images/numericalresponse4.png new file mode 100644 index 0000000000..291456b25d Binary files /dev/null and b/userdocs/source/Images/numericalresponse4.png differ diff --git a/userdocs/source/Images/numericalresponse5.png b/userdocs/source/Images/numericalresponse5.png new file mode 100644 index 0000000000..ee1fcf5da0 Binary files /dev/null and b/userdocs/source/Images/numericalresponse5.png differ diff --git a/userdocs/source/Images/option_response1.png b/userdocs/source/Images/option_response1.png new file mode 100644 index 0000000000..634a33aa75 Binary files /dev/null and b/userdocs/source/Images/option_response1.png differ diff --git a/userdocs/source/Images/optionresponse2.png b/userdocs/source/Images/optionresponse2.png new file mode 100644 index 0000000000..1a75819f4c Binary files /dev/null and b/userdocs/source/Images/optionresponse2.png differ diff --git a/userdocs/source/Images/props0002.xml b/userdocs/source/Images/props0002.xml new file mode 100644 index 0000000000..b7096ba992 --- /dev/null +++ b/userdocs/source/Images/props0002.xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/userdocs/source/Images/stringresponse.png b/userdocs/source/Images/stringresponse.png new file mode 100644 index 0000000000..da4f87689d Binary files /dev/null and b/userdocs/source/Images/stringresponse.png differ diff --git a/userdocs/source/Images/stringresponse2.png b/userdocs/source/Images/stringresponse2.png new file mode 100644 index 0000000000..97b84bd3cd Binary files /dev/null and b/userdocs/source/Images/stringresponse2.png differ diff --git a/userdocs/source/Images/themedata.xml b/userdocs/source/Images/themedata.xml new file mode 100644 index 0000000000..831879616a Binary files /dev/null and b/userdocs/source/Images/themedata.xml differ diff --git a/userdocs/source/add_syllabus.rst b/userdocs/source/add_syllabus.rst new file mode 100644 index 0000000000..c310dd50f0 --- /dev/null +++ b/userdocs/source/add_syllabus.rst @@ -0,0 +1,301 @@ +******************************************************* +Add a Syllabus, StaticPage, Update, or Course Handouts +******************************************************* + +Add a Static Page +***************** + +**Static Pages** takes you to a list of the important pages for your course that +you want students to be able to access easily. Static pages usually apply to the +whole course rather than a particular sequence. For example, your static pages +might include your syllabus or information about your grading policy. + +.. image:: images/image155.png + +When you create a static page, the name of that page appears in your course's +navigation bar at the top of the page, along with **Courseware**, **Course +Info**, and other tabs. For example, the following navigation bar includes a +**Syllabus** static page and a **Projects** static page. + +.. image:: images/image157.png + + +To add a static page: + +1. On the navigation bar, click **Course Content**, and then click **Static +Pages**. + +.. image:: images/image159.png + + +2. In the top right corner, click **New Page**. The following entry appears. + +.. image:: images/image161.png + + +3. On the right side of the box, click **Edit**. The following dialog box opens. + +.. image:: images/image163.png + +4. In the **display_name** box, type the name that you want to appear in the +navigation bar for your course. + + +5. Replace the placeholder text with your content. + +6. Click **Save**. + + +Add a Schedule +************** + + +To create a schedule for your course, you can create a Google calendar that +students can incorporate into their personal Google calendars, or you can use +HTML to create a dynamic schedule with links that students can click. You can +also include both types of calendar in your course. + +Google Calendar +=============== + + +Your Google calendar should include all release dates and due dates. You can +link to it in your course. Your calendar may look like the following calendar +for BerkeleyX's CS 169.2x course. To see this calendar live, +click +https://www.google.com/calendar/embed?src=edx.org_mcjhp2tv3ul2etfpb43hd388p4@group.calendar.g +oogle.com&ctz=America/New_York_ + +.. image:: images/image165.png + + +To create a Google calendar, access your Google account, and then click +**Calendar** at the top of the page. You can then enter your schedule +information. You can also create a link to this calendar anywhere in your +course. + +Dynamic HTML Schedule +===================== + +You can create a dynamic HTML schedule page that you update manually as the +course progresses. The template below was adapted from a version created by +Professors Dan Klein and Pieter Abbeel. + +Below is a sample course schedule that shows the way the schedule would look +during week 3 of the course. As you can see, there are no links for material +after week 3, since that information has not yet been released. + +This course uses the following release schedule: + +1. All lessons are released on Mondays. 2. All homework assignments are released +on Wednesdays, and are due on Sunday of the following week. 3. All quizzes are +released on Fridays and due on Sunday of the following week (9 days later). + + +.. image:: images/image285.png + + +To create a dynamic HTML schedule: + +1. On the navigation bar, click **Course Content**, and then click **Static +Pages**. + +.. image:: images/image159.png + +2. In the top right corner, click **New Page**. The following entry appears. + +.. image:: images/image161.png + +3. On the right side of the box, click **Edit**. The following dialog box opens. + +4. In the editor that opens, type **Schedule **in the **display_name** box. + +5. Click the **HTML** tab. + + +.. image:: images/image163.png + + +6. Go to `Appendix B `_ and copy the code for the dynamic +schedule template. + + +7. In the editor in Studio, replace the placeholder code on the HTML tab with +the code for the dynamic schedule template. + + +Course Handouts +*************** + + +Your course handouts are available on Edge from the **Course Handouts** sidebar +on the **Course Info** page. To add these items, you must create a file and +upload the file to the **>Files & Uploads** page. When you do this, a URL is +created for that file. You then use this URL to create a link to the file on the +**Handouts** sidebar. You create this link on the **Course Updates** page. + +.. note:: + + You cannot upload videos to the Files & Uploads page. + + +Upload a File to the Files & Uploads page +========================================= + + +The **Files & Uploads** page lists handouts, images, and other content that you +want to integrate into your course. + + +.. image:: images/image160.png + + +For example, if you want to include a cartoon in one of your weekly updates, you +upload the image to **Files & Uploads**. When you do this, the file receives its +own URL, and you then use that URL to create a link to the image in the body of +the course. Likewise, if you want to include a handout in the **Course +Handouts** section of the **Course Info** page or in a lesson, you upload the +handout here, and then create a link to the handout under **Course Handouts** or +in the lesson. + + +You can also use the **Files & Uploads** page to keep all of the content for +your course in one place. Content is only visible to students if you create a +link to it. You can thus keep older versions of your content. + + +For example, if you create a Word file to use in your class, and you then create +a PDF copy of that Word file, you can link to the PDF file but keep the Word +file on the **Files Uploads** page. If you later delete the file from your +personal computer, or if a colleague asks you if they can run a version of your +course but change the dates in your handout, you can easily find the Word file +on the **Files Uploads** page. + + +Note that you should be careful when you name files that you add to the **Files +& Uploads** page. Because the file name becomes part of the URL, students can +see the name of the file when they open it. Avoid using file names such as +"AnswerKey.pdf." + + +.. warning:: + + Uploading a file with the same name as a file that is already + uploaded will cause the original file to be overwritten. There is not currently + a warning when you try to upload a file that has the same name. + + +To upload a file to the **Files & Uploads** page: + + +1. On the navigation bar, click **Course Content**, and then click **Files & +Uploads**. + + +2. On the **>Files & Uploads** page, click **Upload New File**. + + +.. image:: images/image162.png + + +3. In the **Upload New File** dialog box, click **Choose File**. + + +4. In the **Open** dialog box, locate the file that you want, and then click +**Open**. + +To add another file, click **Load Another File**. To close the dialog box, click +the **x** in the top right corner. When you close the dialog box, the file +appears on the **Files & Uploads** page. + + +5. Determine the URL of your newly uploaded file. To do this, on the **Files & +Uploads** page, locate the file in the list. In the **URL** column on the right, +you can see the URL you will need to use to display an image or create a +hyperlink. + + +.. image:: images/image164.png + + +.. note:: + + Currently, you cannot delete a file after you upload it to the **Files & + Uploads** page. You can replace a file by uploading another file with the same + name, but you cannot delete the file. + + + +Add Items to the Handouts Sidebar +================================= + + +1. On the navigation bar, click **Course Content**, and then click **Updates**. + + +image:: images/image166.png + + +2. Locate the **Course Handouts** sidebar on the right, and then click **Edit**. + + +.. image:: images/image168.png + + +3. In the XML box that appears, create links to your files. + + +* To create a link to a document, enter the following syntax, where URL OF FILE +is the URL that you noted in step 5 of **Upload a File** on the **Files & +Uploads Page** and LINK TEXT is the text that you want to appear in the +**Handouts** sidebar. + +.. code-block:: html + +

[LINK TEXT]

+ + +* To create a link to an image that you've uploaded, enter the following syntax, +where URL OF FILE is the URL that you noted in step 5 of **Upload a File to +Your Assets Tab**. + +.. code-block:: html + +

+ + + +4. Click **Save**. Your files appear under **Course Handouts**. + + +Add an Announcement or Update +***************************** + + + You can add announcements or updates to welcome students to the class, + remind students of exams, notify students of changes in the course schedule, + and call out important steps students need to keep in mind. These updates + appear on the **Course Info** tab on edX or Edge. Because your course + automatically opens to the **Course Info** page, students will see the + update as soon as they sign in. + + + 1. On the **Course Content** menu, click **Updates**. The **Course Updates** + page opens. + + + .. image:: images/image185.png + + + + 2. Click **New Update**. The following dialog box opens. + + + .. image:: images/image187.png + + + The content for this box must be formatted in HTML. For a template that you + can use that includes placeholders, see `Appendix A `_. + + + 3. Enter your update formatted as HTML, and then click **Save**. \ No newline at end of file diff --git a/userdocs/source/appendices/a.rst b/userdocs/source/appendices/a.rst new file mode 100644 index 0000000000..18b4fb4e7f --- /dev/null +++ b/userdocs/source/appendices/a.rst @@ -0,0 +1,66 @@ +.. raw:: latex + + \newpage % + +======================================== + APPENDIX A-Template For Course Overview +======================================== + + +Replace the placeholders in the following template with your information. + +.. code-block:: html + +
+

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 class prerequisites here.

+
+
+

Course Staff

+
+
+ + +
+

Staff Member

+

Biography of instructor/staff member

+
+
+
+ +
+

Staff Member Name

+

Biography of instructor/staff member

+
+
+
+
+

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?

+

Answer 2.

+
+
+
+ + + + + + + diff --git a/userdocs/source/appendices/b.rst b/userdocs/source/appendices/b.rst new file mode 100644 index 0000000000..7e7d985067 --- /dev/null +++ b/userdocs/source/appendices/b.rst @@ -0,0 +1,176 @@ +.. raw:: latex + + \newpage % + + +=========================================== +APPENDIX B: Code for Dynamic HTML Schedule +=========================================== + + :: + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + < td class="assignment">HW 3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Wk of Topic Read Lecture Sequence Slides HW/Q Due
10/22Topic 1Ch. 1L1: TitleL1HW 111/04
L2: TitleL2
10/29Topic 2Ch. 2 L3: TitleL3Quiz 111/11
L4: TitleL4
11/05Topic 3Ch. 3L5: TitleL5 HW 211/18
L6: TitleL6
11/12Topic 4Ch. 4 L7: TitleL7Quiz 2 11/25
L8: TitleL8
11/19Topic 5Ch. 5L9: TitleL9 12/02
L10: TitleL10
11/26Topic 6Ch. 6L11: Title L11HW 412/09
L12: TitleL12
+
+ diff --git a/userdocs/source/appendices/c.rst b/userdocs/source/appendices/c.rst new file mode 100644 index 0000000000..189b53d1a6 --- /dev/null +++ b/userdocs/source/appendices/c.rst @@ -0,0 +1,76 @@ +.. raw:: latex + + \newpage % + + +====================================== +APPENDIX C: Sample Student Login Guide +====================================== + +Create a login guide for your individual course. + +**STUDENT LOGIN GUIDE FOR [COURSE NUMBER]** + + +How to Set Up Your edX Account and Register for Your Class + +Welcome to [COURSE NAME] on edX! +This guide will walk you through setting up your student account with edX, registering for [COURSE NAME], and accessing the course materials. + +**Step 1: Open the course registration page** + +*Example* + +.. code-block:: html + + + https://edge.edx.org/courses/[YOUR_CLASS_PATH]/about [REPLACE WITH URL TO YOUR REGISTRATION PAGE ON EDGE] + + https://edge.edx.org/courses/edX/PHOTO101/Digital_SLR_Photography_101/about + + +The above URL should bring you to the course registration page: [REPLACE WITH SCREENSHOT OF YOUR REGISTRATION PAGE] + +*Example* + +.. image:: ../images/image302.png + :width: 600 + + + +**Step 2: Request to register for the course** +Click on the blue Register for [NUMBER OF YOUR CLASS] button: +[REPLACE WITH PART OF YOUR SCREENSHOT ABOVE] + +.. image:: ../images/image303.png + :width: 600 + +A pop-up user authentication window will appear. It will ask you to log in or sign up for edX. (If you already have an account with edX, use it to log in. You should now be registered for the course. Skip to Step 5. Otherwise, go on with Step 3.) + +.. image:: ../images/image305.png + :width: 600 + + +**Step 3: Create your account with edX** + +Fill out the form in the pop-up window: (Some tips:  Use an email address you check regularly. Also, the username you choose will also be your screen name in the course. This means the only name we will know you by is the username (not a first and last name). Please include your last name as part of your username so we can tell who you are on the forums.) + + +**Step 4: Activate your edX account** + +Check your email. This is where your course activation link has been sent. You must click on this to finalize your access to the course. + +Congratulations! You should now have an edX account and be registered for [ENTER YOUR COURSE NUMBER]. + +Proceed with Step 5 to access the class materials. + + +**Step 5: Log in to edX and go the course website** + +Log in to your account on edX at https://edge.edx.org/ +by using the username and password you just created. +You will be taken to the main landing page of your edX edge account, which should now include a listing for [ENTER YOUR COURSE NUMBER]: [REPLACE WITH SCREENSHOT OF YOUR COURSE] + +You can now click **View Courseware** to enter the main course website. + +If you are experiencing problems with registration or with accessing the class website, please contact [SUPPORT CONTACT NAME] at [CLASS SUPPORT EMAIL]. diff --git a/userdocs/source/appendices/d.rst b/userdocs/source/appendices/d.rst new file mode 100644 index 0000000000..0d440a4787 --- /dev/null +++ b/userdocs/source/appendices/d.rst @@ -0,0 +1,43 @@ +.. raw:: latex + + \newpage % + + +====================== +APPENDIX D: Time Zones +====================== + + **Overview** + Released course materials become visible to all students at once, and assignments with a due date will be due for all students at once, at the time specified by the setting. However, a number of places on edX and Studio present a time setting without specifying a time zone. Unless specified otherwise, most dates and times in Studio and edX are in UTC, not in your local time zone! When you specify date and time settings that do not have a time zone label, you need to convert values to UTC.  You should also ensure that students and instructors know how to interpret time settings for your course. + + **Details** + Time is stored in a specific time zone. However, this time zone may not be visible in the interface. Unlabeled time values are specified, stored, and viewed in UTC. + + EdX and Studio handle time zones as follows. + + • All times, labeled and unlabeled, are saved to the server in UTC (a.k.a. UTC or Z). + • Unlabeled times are displayed both in Studio and on edX/Edge in UTC. + • Times labeled with a particular time zone in Studio are specified in that time zone, and are converted to UTC. (This is rare.) + + For settings in Studio that are labeled with a time zone, such as the course start and end dates, enter the setting in the time zone specified (usually your local time zone). + + For time settings that are not labeled with a time zone, such as release dates and due dates for course content, convert from your local time zone, and set the dates and time settings in UTC. You can use an online time zone converter to convert from your local time zone.   + + *Note When you use an online converter, enter both the day and the time to account for daylight saving time.* + + Example US Eastern Standard Time is "UTC-5", so a New York winter due date of 5:00pm (17:00) should be entered as 10:00pm (or 22:00) in Studio. US Daylight Saving Time, however, is UTC-4, so a New York summer due date of 5:00pm would be entered as 9:00pm in Studio. + + Most of these time settings are also not labeled in the Student view on edX/Edge. When you set due dates for an assignment, make sure to tell students how to interpret the due date. You can choose one of the following options. + + • Notify students in advance that all times, unless otherwise labeled, are displayed in UTC, and point them to a time zone converter to convert to their local time zone. + • Allow students to assume that all due dates are specified in their local time zone, and specify an unadvertised grace period to invisibly extend all the due dates in your course. For example, some courses set a grace period of "1 day, 6 hours, and 1 minute" to accommodate differences in time zones and any potential system issues. + + *Note Setting a grace period is generally not recommended. It can lead to problems not closing "when they should", and may be misleading to your students.* + + If you have further questions about specifying times and time zones, or are experiencing inconsistencies in due date or release date behavior, please contact us from the edX Studio Help page. + + **References** + + http://help.edge.edx.org/discussions/questions/61-time-zones + + http://help.edge.edx.org/discussions/questions/23-grace-periods diff --git a/userdocs/source/appendices/e.rst b/userdocs/source/appendices/e.rst new file mode 100644 index 0000000000..e78d6e3701 --- /dev/null +++ b/userdocs/source/appendices/e.rst @@ -0,0 +1,910 @@ +.. raw:: latex + + \newpage % + + +========================== +APPENDIX E: Problem Types +========================== + +Option Response +=============== + +The Option Response input type allows the student to choose from a collection of +answer options, presented as a drop-down list. + +Option Response is structurally similar to Multiple Choice. Some conceptual +differences between the two include the following. + +* The Multiple Choice radio button format makes it easier for students to read very long response options. + +* The Option Response drop-down input format makes it more likely for students to think of an answer and then search for it, rather than relying purely on recognition to answer the question. The Multiple Choice format is more explicit and visual. This makes it a more appropriate choice for presenting tricky or complicated answer options which are intended to get the student to pause and think. + +Sample Problem: + +.. image:: ../images/image287.png + :width: 600 + +**Problem Code:** + +.. code-block:: xml + + + +

Option Response is most similar to __________.

+ + + 1 + + + +
+

Explanation

+

Like Option Response, Multiple Choice also allows students to select + from a variety of pre-written responses.

+
+ + + + + + +**Template** + +.. code-block:: xml + + + + + options="('A','B')" + correct="A"/> + + + +
+
+ + + + + +**XML Attribute Information** + + + + + .. image:: ../images/option_response1.png + + + + + .. image:: ../images/optionresponse2.png + + +.. raw:: latex + + \newpage % + + +Multiple Choice +=============== + + +The Multiple Choice input type allows the student to select at most one choice +from a collection of answer choices, presented as a list of radio buttons. + +A Multiple Choice problem can have more than one correct answer, depending on +how many choices are marked as correct in the underlying XML. If all choices are +marked as incorrect, there is no correct response. + +Multiple Choice is structurally similar to Option Response. Some conceptual +differences between the two include the following. + +• The Multiple Choice radio button format makes it easier for students to read very long response options. + +• The Option Response drop-down input format makes it more likely for students to think of an answer and then search for it, rather than relying purely on recognition to answer the question. + +• The Multiple Choice format is more explicit and visual. This makes it a more appropriate choice for presenting tricky or complicated answer options which areintended to get the student to pause and think. + +Sample Problem: + +.. image:: ../images/image289.png + :width: 600 + +**Problem Code:** + +.. code-block:: xml + + +

Example Problem

+

How many correct responses can a Multiple Choice question have?

+ + + Only one + Only zero or one + Zero or more + Only one or more + Nobody knows + Somebody might know :) + + + +
+

Explanation

+

It depends on how many choices are marked as correct in the underlying XML.

+

Note that if all choices are marked as incorrect, there is no + correct response.

+
+ + + + +**Template** + +.. code-block:: xml + + + + + + A + B + + + + +
+ +
+ + + + +**XML Attribute Information** + + + + +.. image:: ../images/multipleresponse.png + + + + + .. image:: ../images/multipleresponse2.png + + + + + .. image:: ../images/multipleresponse3.png + + +.. raw:: latex + + \newpage % + + +Checkbox +======== + +The Checkbox input type allows the student to select zero or more choices from a +collection of answer choices, presented as a list of checkboxes. + +Remark: Questions with one Checkbox input type have exactly one correct +response. All the choices marked as correct="true" have to be selected for the +submitted answer (i.e. the response) to be considered correct. + +In particular, the response of no boxes checked off could be the single correct +response, and a Checkbox question, unlike a Multiple Choice question, cannot +have zero correct responses. + +Sample Problem: + +.. image:: ../images/image290.png + :width: 600 + + +**Problem Code:** + +.. code-block:: xml + + + +

How many correct responses can a Checkbox question have?

+ + + + Zero + One + Two or more + Nobody knows + Somebody might know :) + + + + + +**Template** + +.. code-block:: xml + + + + + + Zero + One + + + + +.. raw:: latex + + \newpage % + + +String Response +=============== + +The String Response input type provides an input box in which the student can +enter a line of text, which is then checked against a specified expected answer. + +A String Response input does not provide any answer suggestions, so it can be a +good way to get the students to engage with the material more deeply in a +sequence and look up, figure out, or remember the correct answer themselves. + +Note that a student's answer in a String Response is marked as correct if it +matches every character of the expected answer. This can be a problem with +international spelling, dates, or anything where the format of the answer is not +clear. + +Sample Problem: + +.. image:: ../images/image291.png + :width: 600 + +**Problem Code:** + +.. code-block:: xml + + +

Example Problem

+

What is the name of this unit? (What response type is this?)

+ + + + +
+

Explanation

+

The name of this unit is "String Response," written without the punctuation.

+

Arbitrary capitalization is accepted.

+
+ + + +**Template** + +.. code-block:: xml + + + + + + +
+
+ + + +**XML Attribute Information** + + + + .. image:: ../images/stringresponse.png + + + + .. image:: ../images/stringresponse2.png + + +.. raw:: latex + + \newpage % + + +Numerical Response +================== + +The Numerical Response input type accepts a line of text input from the student +and evaluates the input for correctness based on its numerical value. The input +is allowed to be a number or a mathematical expression in a fixed syntax. + +The answer is correct if it is within a specified numerical tolerance of the +expected answer. + +The expected answer can be specified explicitly or precomputed by a Python +script. + +Sample Problem: + +.. image:: ../images/image292.png + :width: 600 + + +**Problem Code**: + +.. code-block:: xml + + +

Example Problem

+ +

What base is the decimal numeral system in? + + + +

+ +

What is the value of the standard gravity constant g, measured in m/s2? Give your answer to at least two decimal places. + + + + +

+ + + + +

What is the distance in the plane between the points (pi, 0) and (0, e)? You can type math. + + + + +

+ +
+

Explanation

+

The decimal numerical system is base ten.

+

The standard gravity constant is defined to be precisely 9.80665 m/s2. + This is 9.80 to two decimal places. Entering 9.8 also works.

+

By the distance formula, the distance between two points in the plane is + the square root of the sum of the squares of the differences of each coordinate. + Even though an exact numerical value is checked in this case, the + easiest way to enter this answer is to type + sqrt(pi^2+e^2) into the editor. + Other answers like sqrt((pi-0)^2+(0-e)^2) also work. +

+
+ + + +**Templates** + +Exact values + +.. code-block:: xml + + + + + + + + +
+ +
+ + + +Answers with decimal precision + +.. code-block:: xml + + + + + + + + + +
+ +
+ + + +Answers with percentage precision + +.. code-block:: xml + + + + + + + + + +
+ +
+ + + +Answers with a live math interpretation popup display + +.. code-block:: xml + + + + + + + + + +
+ +
+ + + +Answers with scripts + +.. code-block:: xml + + + + + + + + + + + + +
+ +
+ + + + +XML Attribute Information + + + + + E = + + +

Let x be a variable, and let n be an arbitrary constant. What is the derivative of xn?

+ + + + + + + +
+

Explanation

+

Use standard arithmetic operation symbols and indicate multiplication explicitly.

+

Use the symbol ^ to raise to a power.

+

Use parentheses to specify order of operations.

+
+ + + Template + + + + + + + + + +
+ +
+ + + + +XML Attribute Information + + + +

This question consists of two parts.

+

First, enter two integers which sum to 10.

+ +
+ + + +

Now enter two (finite) decimals which sum to 20.

+ +
+ + + + +
+

Explanation

+

For the first part, any two numbers of the form n + and 10-n, where n is any integer, will work. + One possible answer would be the pair 0 and 10. +

+

For the second part, any pair x and 20-x will work, where x is any real number with a finite decimal representation. Both inputs have to be entered either in standard decimal notation or in scientific exponential notation. One possible answer would be the pair 0.5 and 19.5. Another way to write this would be 5e-1 and 1.95e1. +

+
+ + + +**Templates** + +*With displayed suggested correct answers* + +.. code-block:: xml + + + + + + +

Enter two real numbers which sum to 20:

+ +
+ + + + +
+
+ + + + +**Templates** + +*With NO suggested correct answers* + + +.. code-block:: xml + + + + + + +

Enter two real numbers which sum to 20:

+ +
+ + + + +
+
+ + + + +.. raw:: latex + + \newpage % + +Chemical Equation Response +========================== + +The Chemical Equation Response input type is a special type of Custom Response +that allows the student to enter chemical equations as answers. + +Sample Problem: + +.. image:: ../images/image296.png + :width: 600 + +**Problem Code**: + +.. code-block:: xml + + +

Example Problem

+ +

Some problems may ask for a particular chemical equation. Practice by writing out the following reaction in the box below.

+
\( \text{H}_2\text{SO}_4 \longrightarrow \text{ H}^+ + \text{ HSO}_4^-\)
+
+ + + + + if chemcalc.chemical_equations_equal(submission[0], 'H2SO4 -> H^+ + HSO4^-'): + correct = ['correct'] + else: + correct = ['incorrect'] + + + +

Some tips:

  • Only real element symbols are permitted.
  • Subscripts are entered with plain text.
  • Superscripts are indicated with a caret (^).
  • The reaction arrow (\(\longrightarrow\)) is indicated with "->".
+ So, you can enter "H2SO4 -> H^+ + HSO4^-".

+ + + +h +.. raw:: latex + + \newpage % + +Schematic Response +================== + +The Schematic Response input type provides an interactive grid on which the +student can construct a schematic answer, such as a circuit. + +Sample Problem: + +.. image:: ../images/image297.png + :width: 600 + +.. image:: ../images/image298.png + :width: 600 + +.. image:: ../images/image299.png + :width: 600 + +**Problem Code**: + +.. code-block:: xml + + + + Make a voltage divider that splits the provided voltage evenly. + + +
+ +
+ + dc_value = "dc analysis not found" + for response in submission[0]: + if response[0] == 'dc': + for node in response[1:]: + dc_value = node['output'] + + if dc_value == .5: + correct = ['correct'] + else: + correct = ['incorrect'] + + + + +

Make a high pass filter.

+
+ +
+ + ac_values = None + for response in submission[0]: + if response[0] == 'ac': + for node in response[1:]: + ac_values = node['NodeA'] + print "the ac analysis value:", ac_values + if ac_values == None: + correct = ['incorrect'] + elif ac_values[0][1] < ac_values[1][1]: + correct = ['correct'] + else: + correct = ['incorrect'] + + + + +
+

Explanation

+

A voltage divider that evenly divides the input voltage can be formed with two identically valued resistors, with the sampled voltage taken in between the two.

+

+

A simple high-pass filter without any further constaints can be formed by simply putting a resister in series with a capacitor. The actual values of the components do not really matter in order to meet the constraints of the problem.

+

+
+ + diff --git a/userdocs/source/change_log.rst b/userdocs/source/change_log.rst new file mode 100644 index 0000000000..1a1e3e3d71 --- /dev/null +++ b/userdocs/source/change_log.rst @@ -0,0 +1,21 @@ + + +********** +Change Log +********** + + +============== ================================================================ + DATE CHANGE +============== ================================================================ +7/1/2013 Online help and pdf files finalized in Sphinx 1.2b1 + +5/6/2013 Universal change to UTC for all GMT references. Changed “Add Course Catalog Information” to show URL and note that on this page, the course author sees local time from browser. Changed “Invite Students to Register” to reflect new link. + +4/18/13 “Create a Discussion” graphic change + +4/9/13 Changed order of sections (moved “Create a Lesson in Studio” after “Create a New Course”) Added content to “Export or Import a Course,”Create Lesson,” “Create Schedule,” and Upload a File to the "Files & Updates Page” sections. Revised “Add an Announcement" or Update" section. + +3/22/13 Revised “Add Manual Policy Data” section. Added “Appendix C: Time Zones” +============== ================================================================ + diff --git a/userdocs/source/checking_student_progress.rst b/userdocs/source/checking_student_progress.rst new file mode 100644 index 0000000000..cf68732c1d --- /dev/null +++ b/userdocs/source/checking_student_progress.rst @@ -0,0 +1,108 @@ +************************************************** +Checking Student Progress and Issuing Certificates +************************************************** + + +As will be discussed more in later sections, the grading policy and stored +problem scores are used to record progress through the course, determine +final grades, and issue certificates at the end. This unit will give you +some advance information about how the grading policy will be visible to the +students during the run of the course and what you will need to do at the +end of the course to give out grades. + + +Checking Progress as a Student +****************************** + + +During the run of a course, students can check their progress by clicking on +the Progress tab of the course on Edge. (This is the same page they would go +to to view subsection problem scores, as described in Viewing Scores.) The +student's progress through the graded part of the course is displayed at the +top of this page, above the subsection scores, as a chart with entries for +all the assignments, total percentage earned in the course so far and +percent needed for each grade cutoff. Here is an example of a student's +progress through edX101. + + +.. image:: images/image245.png + + + +The student will be able to see from this page that, at the time this +screenshot was taken, edX101 was graded as a Pass/Fail course with a cutoff +of 34% and that the grading rubric contained one assignment type, called +Learning Sequence, consisting of 11 assignments total. Furthermore, this +picture says that this particular student has only submitted correct +responses to two assignments, and that their current total percent grade in +the course is 6%. By hovering over each progress bar, the student would be +able to get further statistics of how much each assignment was counted as. + + +As was mentioned in the unit on Viewing Scores, further down on the Progress +page is a list of all the subsections in the course, with the scores +recorded for the student for all problems in the course. Here is a scrolled +down view of the example Progress page for the student in the example above: + + +.. image:: images/image247.png + + +Again, note that point scores from graded sections are called "Problem +Scores", while point scores from ungraded sections are called "Practice +Scores". + +.. raw:: latex + + \newpage % + +Checking Progress of Students as an Instructor +********************************************** + + +To check the progress of the student through the course, visit the +Instructor dashboard of your course in instructor view on Edge and click on +the Grades page. The Instructor dashboard for courses sometimes changes as +more course-specific tools get added. Here is the current view of the top of +the Grades page of the Instructor dashboard for edX101: + + +.. image:: images/image249.png + + +Here you see several options for viewing or downloading student grades, +viewing individual progress through a course or resetting problem attempts. + +.. note:: + + Only the top part of the Grades page is shown. The page continues + with some more information about course statistics. The link to the + student's progress page should give you a view of exactly what the student + would see, including scores for graded and ungraded assignments. + + +.. note:: + + The stored scores visible to you on the Instructor tab and to + the students from the Progress tab in the course on Edge are a snapshot of the + current state of the problem score database. They may be slightly out of + sync with actual problem scores. (Asynchronicities may happen if, for example, + the weight of a live problem was changed during an assignment, and not + everyone has yet resubmitted their answers for that problem.) Scores and grades + are usually recomputed at the end of the semester before determining final + grades and issuing Certificates. + +.. raw:: latex + + \newpage % + + +Assigning Final Grades and Issuing Certificates +*********************************************** + +The final grades of a student in the course and the grading +rubric you have set are used to determine whether the student has earned a +Certificate of Mastery for the course. The process for issuing Certificates +has to be started manually by you or by the edX support team at the end of the +course run. For more information about issuing Certificates, see TBD. + diff --git a/userdocs/source/conf.py b/userdocs/source/conf.py new file mode 100755 index 0000000000..d416509d15 --- /dev/null +++ b/userdocs/source/conf.py @@ -0,0 +1,310 @@ +# -*- coding: utf-8 -*- +# +# getting_started documentation build configuration file, created by +# sphinx-quickstart on Tue Apr 16 11:19:12 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'edX' +copyright = u'2013, EdX Doc Team' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'edxdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'getting_started.tex', u'edX Studio Documentation', + u'EdX Doc Team', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'getting_started', u'getting_started Documentation', + [u'EdX Doc Team'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'getting_started', u'getting_started Documentation', + u'EdX Doc Team', 'getting_started', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'getting_started' +epub_author = u'EdX Doc Team' +epub_publisher = u'EdX Doc Team' +epub_copyright = u'2013, EdX Doc Team' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +#epub_guide = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True + +# Fix unsupported image types using the PIL. +#epub_fix_images = False + +# Scale large images. +#epub_max_image_width = 0 + +# If 'no', URL addresses will not be shown. +#epub_show_urls = 'inline' + +# If false, no index is generated. +#epub_use_index = True + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/userdocs/source/create_discussion.rst b/userdocs/source/create_discussion.rst new file mode 100644 index 0000000000..dd89f39e7e --- /dev/null +++ b/userdocs/source/create_discussion.rst @@ -0,0 +1,122 @@ + +******************* +Create a Discussion +******************* + +To create a discussion in your course, you create a question and Discussion +component in Studio. You can then encourage the students to respond by seeding +the discussion space on edX or Edge. + + +Create a Discussion Component +***************************** + +Keep in mind the following best practices when you create a Discussion +component. + +• Be very sure that you want to add the Discussion component. Discussion +• categories are immediately visible in your forum (on the Discussion tab for +• your course) when you create them, even if the unit that contains the +• Discussion component is set to Private + +• When you create an ID for the Discussion component, be very careful—especially +• if you are adding the Discussion component to a running course. Follow the +• format in step 10 below to make sure that the ID is unique across all courses +• on edX. + +• Edit only the fields at the top of the Discussion component edit box. Do not +• change the XML in the large box. + +To add a Discussion component: + +1. Open Studio. + +2. Make a note of the **Display Name** of the Subsection you are in and the +**Display Name** of the Unit you are in. + +3. At the location in the Unit where you want to start your discussion :doc:`create_html_component` +that contains the question you want students to discuss. + +4. Directly under this new HTML component, click **Discussion** under **Add New +Component.** + +.. image:: images/image057.png + +5. When the following box appears, click **Discussion Tag.** + +.. image:: images/image059.png + +6. When the following box appears, click **Edit.** + +.. image:: images/image061.png + +The following editing box opens. You will change the values in the small boxes, +but you will not change the text in the large box. + +.. image:: images/image063.png + +.. note:: + + In the future, these boxes may be filled in for you with a default value. + +7. In the **discussion_category** box, type the name of the category that you +want to create for the discussion. You can include spaces. + +8. In the **discussion_target** box, type the name of the subcategory that you +want to create for the discussion. You can include spaces. + +.. note:: + The category and subcategory names only appear in the discussion forum for + your course. They do not appear in the discussion space inside the Unit. + +For example, if you set **discussion_category** to be “The Discussion Component” +and you set **discussion_target** to be “Online Instruction Methods,” the +category and subcategory appear as follow in the category list in the discussion +forum: + +.. image:: images/image065.png + :width: 300 + +9. In the **display_name** box, type a name for the discussion. The display name +appears when a student hovers the mouse over the ribbon. + +10. Click **Save.** + +.. raw:: latex + + \newpage % + + +Seed a Discussion Space in Your Course +************************************** + +When you create a discussion, many students may feel hesitant to be the first to +post an answer to your question. You can get the discussion started by posting +your own answer—preferably anonymously or as a student, so that students will be +more comfortable replying if they disagree with your post. + +To post as a student, follow the steps below. If you later want to reply as +yourself, log back into your usual account and omit steps 1 and 2. + +1. Set up a test account on edX or Edge with an e-mail address that is not +associated with your Course Team. + +2. Go to your course URL and register for your course. + +3. On edX or Edge, locate the Unit that contains the Discussion component. + +4. In the Unit, locate the discussion space. + +5. Click **New post.** + +6. Type a title for your post in the Title box, and then enter text for your +post. + +7. If you want to, select the **post anonymously** check box or the **follow +this post** check box. + +8. When you are satisfied with your post, click **Add Post.** + +Your new post appears at the top of list in the unit. Posts are listed in +reverse chronological order. + diff --git a/userdocs/source/create_html_component.rst b/userdocs/source/create_html_component.rst new file mode 100644 index 0000000000..33d7205dbf --- /dev/null +++ b/userdocs/source/create_html_component.rst @@ -0,0 +1,249 @@ + +************************ +Create an HTML Component +************************ + + .. image:: images/image067.png + +The HTML component is the most basic component type. These components are the +building blocks of text-based courses. They are used to add information such as +text, lists, links, and images to units. For example, you can use these +components between Problem components to add explanatory text. You can also use +HTML components to import LaTeX code into your course. + +The HTML component editor has two views: **Visual view** and **HTML view.** +Visual view offers you a “what you see is what you get” (WYSIWYG) editor for +editing a pre-formatted version of the text. HTML view gives you a text editor +in which you can edit HTML code directly. + +.. note:: + + Studio processes the HTML code entered when saving it and before rendering + it. Make sure that the component you created looks the way you expect live if + you go back and forth between Visual and HTML view. + +.. raw:: latex + + \newpage % + +Create a Basic HTML Component +***************************** + +**To create a basic, blank HTML component:** + +1. Under Add New Component, click **html**, and then click **Empty.** The +following blank component appears. + +.. image:: images/image069.png + +2. In the blank component, click **Edit.** The HTML editor opens. + +.. image:: images/image071.png + +3. Enter the information that you want, and then click **Save.** + +.. note:: + + If you want to enter links to other pages or to images or to edit the + HTML directly, switch to the HTML tab. + +.. raw:: latex + + \newpage % + +**To create a basic HTML component that includes a template you can use:** + +1. Under **Add New Component,** click **html** and then click **Announcement.** +The following screen opens. + +.. image:: images/image073.png + +2. Click **Edit.** + + The text editor opens in Visual view. Replace the template text with your + announcement text. + +.. note:: + + If you want to enter links to other pages or to images or to edit the + HTML directly, switch to the HTML tab. + +.. image:: images/image075.png + +3. Click **Save.** + +.. raw:: latex + + \newpage % + +Create Links +************ + +Link to a Handout or Image +========================== + +To link to a document, image, or other file that you uploaded to the Files & +Uploads page: + +1. Create a blank HTML component, and switch to HTML view. + +2. In the HTML box, create links to your files. + +To create a link to a document, enter the following syntax, where URL OF FILE is +the URL that you noted in step 5 of Upload a File to the Files & Uploads Page +and LINK TEXT is the text that the user will click. :: + +

[LINK TEXT]

+ +For example, to create a link to the HTML template for the “About” page document +whose URL is /c4x/edX/edX101/asset/AboutPage_Template.txt, use the following +code. :: + +

HTML Template for +

+ +To create a link to an image that you’ve uploaded, enter the following syntax, +where URL OF FILE is the URL that you noted in step 5 of Upload a File to the +Files & Uploads Page. :: + +

+ +For example, to create a link to the CourseImage.jpg file whose URL is +/c4x/edX/edX101/asset/CourseImage.jpg, use the following code. :: + +

+ +When you use this code, the following image appears. + +.. image:: images/image078.png + :width: 800 + +3. Click **Save.** Your files or images appear in the component. + + +.. raw:: latex + + \newpage % + + +Link to Course Units +==================== + +To direct the student to a specific place in your own course, you must add an +HTML link to that unit. To do this: + +1. Determine the relative directory of your course. + +a. On the Course Settings tab, click the blue your course URL link under Basic + Information. + +.. image:: images/image079.png + :width: 800 + +The registration page for your course opens. + +b. In the address bar at the top of the page, locate the URL. + +c. Copy the part of the URL after “.org” and before “about”, including the +forward slashes. The syntax is the following. :: + + /courses/[organization]/[course_number]/[course_name]/ + +For example, for edX101: How to Create an edX Course from edX, the complete URL +is the following. :: + + https://edge.edx.org/courses/edX/edX101/How_to_create_an_edX_course/about + +The relative directory is the following. :: + + /courses/edX/edX101/How_to_create_an_edX_course/ + +2. Determine the location ID of the target unit. Studio generates the location +ID for each unit when you create the unit. The location ID uses the following +syntax. :: + + i4x:////vertical/ + +.. note:: + + To find the location ID, open the page of the unit you are trying to link + to in Studio and look at the URL in the browser’s address bar. The location ID + is the text in the URL after edit, as in the following example. + +.. image:: images/image081.png + + +3. Open the unit that you want to link from. + +4. Under Add New Component, click html, and then click Empty. A new, blank +component appears. + +.. image:: images/image083.png + :width: 800 + +5. Click **edit**. + +6. In the HTML editor that opens, click the HTML tab. + +7. Next to the number 1, type the following. Replace relative course directory, +location id of unit, and link text with your information. :: + + [link text] + +For example, a link to the “Creating an HTML Component” unit in edx101 +resembles the following :: + + Creating an HTML + + + +.. raw:: latex + + \newpage % + +Import from LaTeX +***************** + +You can create an HTML component from imported LaTeX code. + +.. note:: + + This feature is currently under development. + +1. Under **Add New Component**, click **html**, and then click **E-text Written +in LaTeX.** + +.. image:: images/image067.png + :width: 800 + +2. In the component that appears, click Edit. + +.. image:: images/image083.png + :width: 800 + +3. The component editor opens. In the top left corner of the editor, click the +yellow **Edit High Level Source** text. + +.. image:: images/image085.png + :width: 800 + +4. In the **High Level Source Editing** screen that opens, replace the sample +code with your LaTeX code. + +.. image:: images/image087.png + :width: 800 + +5. Click **Save and compile to edX XML** to convert the LaTeX code into edX XML +code. + +.. note:: + + Studio uses a third-party LaTeX processor to convert LaTeX code to XML. + The LaTeX processor must be up and running. + +6. Click **Save**. Verify that your newly created component looks the way you +want it to. + + diff --git a/userdocs/source/create_lesson.rst b/userdocs/source/create_lesson.rst new file mode 100644 index 0000000000..f6682a9437 --- /dev/null +++ b/userdocs/source/create_lesson.rst @@ -0,0 +1,128 @@ + +************************** +Create a Lesson in Studio +************************** + +Once you have created a course, you are ready to create content for that course. + +.. warning:: + + The alpha version of Studio does not have versioning or automatic + updating of your browser between refreshes. Versioning is planned for future + refresheseleases, but, in the meantime, only one author should edit a unit, in one + browser, on only one tab.  If a unit is open for editing in multiple browser + sessions, the session that saves last will overwrite any previously saved + content without displaying a warning. Also, older browser sessions can overwrite + more recent content, so refresh your browser before you start working every time + you work with a private unit or edit a draft of a public unit. + + +Introduction +************ + +Just as in an offline course, content in an online course is broken down into +smaller pieces. In Studio, these pieces are categories called **sections, +subsections, and units** Units, in turn, are made up of **components** that +contain the actual content of your course. + +Sections, for example, may correspond to weeks in your course, while subsections +often correspond to lessons, homework assignments, or exams. A lesson is an +interwoven selection of units of different types, such as videos, text, images, +discussions, and problems. It is an interactive representation of the material +that you would cover in a typical class period. + +On the **Course Outline** page, you can see all the sections, subsections, and +units in your course at a glance, as well as whether the subsections are public +or private. + + + .. image:: images/image029.png + :width: 800 + + .. image:: images/image031.png + :width: 800 + +.. raw:: latex + + \newpage % + +Section +******* + +A section is the topmost category that you use to organize your course. Many +instructors name sections according to the number of weeks in the course—for +example, section 1 is named Week 1, section 2 is named Week 2, and so on. +Sections contain subsections, which in turn contain units. + +You can set an individual release date for each section in your course. None of +the content in the section is visible until its release date has passed. + +For more information about how to create a section, see +:doc:`create_section_sub_section`. + +.. raw:: latex + + \newpage % + +Subsection +********** + +A subsection is a subcategory of a section. Many instructors name subsections +according to the topics in their courses. Subsection names appear along with +section names in the left pane when you view your course on Edge. + + .. image:: images/image033.png + +You can set subsections to be one of the assignment types that you created when +you set up grading. You can then include assignments in the body of that +subsection. + +You can set an individual release date for each subsection in your course. None +of the content in the subsection is visible until its release date has passed. +If you do not set a release date, the subsection has the same release date as +its section. + +For more information about how to create a subsection, see +:doc:`create_section_sub_section`. + +.. raw:: latex + + \newpage % + +Unit +**** + +A unit is a further category that helps you organize your course materials. +Units contain components, which are the building blocks of lessons. Units do not +appear in the left pane with section and subsection headings. Instead, each unit +appears as a part of the course accordion at the top of the page when you view +your course on Edge. The following page shows a subsection that has two Units. + + .. image:: images/image035.png + +Note that by default, all units are set to **Private.** To make a unit visible +to students, you have to explicitly change the unit’s visibility to **Public.** +For more information see :doc:`set_content_releasedates` . + +.. raw:: latex + + \newpage % + + +Component +********* + +A component is the part of a unit that contains your actual course content. The +names of all components in a unit appear when you hover over the unit in the +course accordion at the top of the page. + +.. image:: images/image037.png + :width: 800 + +There are four types of components: Discussion components, HTML components, +Problem components, and Video components. For more information, +see :doc:`create_discussion`, :doc:`create_html_component`, :doc:`create_problem`, and :doc:`create_video` . + + + + diff --git a/userdocs/source/create_problem.rst b/userdocs/source/create_problem.rst new file mode 100644 index 0000000000..61d0a95747 --- /dev/null +++ b/userdocs/source/create_problem.rst @@ -0,0 +1,374 @@ + +**************** +Create a Problem +**************** + +Overview +******** + + +The problem component allows you to add interactive, automatically graded exercises to your course content. You can create many different types of problems +in Studio. + +By default, all problems are ungraded practice problems. To change the problems to graded problems, change the assignment type of the subsection. + +To create a problem, determine: + +• The type of problem that you want. + +• The weight to assign to the problem. + +• Whether you want to randomize the problem. + +• How to close the problem-that is, how to set the number of attempts a student has, [as well as set the due date]. + +• How you want to provide feedback to students; show answer on/off. + +This course contains several places with more information about creating exercises and integrating them into your course. + +• `Writing Exercises `_ 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 `_ + +• `Appendix E `_ contains XML documentaion for the different problem response types. + +• The `Discussion Forum `_ for this class is a good place to ask questions about exercise types, report any errors or oddities that you may encounter, and get technical support. + +• Creating problems for the online format opens a new playing field in the educational process. A big part of the community aspect of edX is to initiate and grow a `Creative Problems `_ . Please look here to be inspired by new approaches when first making your class. Please also come back to post interesting approaches that you came up with while running your class, and to share with the community what worked well and what did not. + +**Simple Editor and Advanced Editor** + + +Studio offers two interfaces for editing problem components. + +• The **Simple Editor** allows you to edit problems visually, without having to work with XML. + +• The **Advanced Editor** converts the problem to edX's XML standard and allows you to edit that XML directly. For more information about the XML for different problem types, see `Appendix E `_ . + + +Some of the simpler problem templates, including multiple choice, open in the Simple Editor and allow you to switch to the Advanced Editor. The more complicated problem types, such as Circuit Response, open in the Advanced Editor. + +.. note:: + + You can switch at any time from the Simple Editor to the Advanced Editor by clicking "Advanced Editor" in the Simple Editor interface. However, there is no way to go back from the Advanced Editor to the Simple Editor without making a new component. + +To open the Advanced Editor, click **Advanced Editor** in the top right corner of the Simple Editor. + +.. image:: images/image275.png + :width: 600px + + +The following is a multiple choice problem in the Advanced Editor. + +.. image:: images/image276.png + :width: 600px + +.. raw:: latex + + \newpage % + + +Problem Type +************ + +Links to description of all the different problem types-brief. Then include links to all the XML, etc. + +You may want to create a problem that has more than one response type. For example, you may want to create a multiple choice question, and then ask the +student to explain his or her response. You may also want a student to be able to check the answers to many problems at one time. To accomplish these +tasks, you can include multiple problems inside a single Problem component. (LINK) + +.. raw:: latex + + \newpage % + +Randomizing +*********** + +The **rerandomize** setting determines whether any random variable inputs for a problem are randomized each time a student loads the problem. +(This is only applicable to problems with randomly generated numeric variables.) + +.. raw:: latex + + \newpage % + +Scoring and Weight +****************** + +Problems store a **point score** for submitted responses. The score that a student earns is the number of correct responses the student +submits divided by the maximum score for the problem. The default maximum score, or weight, is the integer number of response type inputs the problem has. +Thus, the weight attribute for a problem with one response type input is set to 1 (one point). You can change the maximum score for an individual problem +by manually changing the problem **weight** attribute to another number. When you do this, the number of points that you specify appears next +to the problem title ( to one decimal precision). + +**WEIGHT: 0 POINTS** + +Scores are stored for all problems, but they only contribute to a student's grade in the course if they are part of a subsection marked as graded. For more +information, see the material on attempts and closing problems in 7B: Feedback and Grading. + +.. raw:: latex + + \newpage % + +**Computing Point Scores** + +The point score of a response for a problem reflects the correctness of the response and is recorded as the number of points earned out of the maximum +possible score for the problem (also known as the problem weight). The formula used for computing the recorded point score is the following: + +• **point score of response = problem weight * (# inputs correct / # total inputs)** + +• **point score of response** is the point score "earned" by this response for the problem. + +• **problem weight** is the maximum possible point score that can be earned for the problem. By default, this is the integer number of response types in that problem. This can be changed to another value by setting the weight attribute of the problem, as described in Setting Problem Attributes. + +• ** # inputs correct** is the number of values for this response that were evaluated as correct by the response type fields. + +• **# total inputs** is the total number of response type fields in the problem. + +.. raw:: latex + + \newpage % + +**Examples** + +The following are some examples of setting problem weight and computing problem scores. + + +**Example 1** + +A problem with two response type inputs and a blank weight attribute has a maximum score of 2.0 points. + +A student response to this problem that consists of one correct input value and one incorrect input value would be marked as having a score of 1.0 points +out of 2.0 points possible. + + +**Example 2** + +A problem with three response type inputs and a weight attribute of 12 has a maximum score of 12.0 points. + +A student response to this problem that consists of one correct input value and two incorrect input values would be marked as having a score of 4.0 points out of 12.0 points possible. + + +**Example 3** + +A problem with four response type inputs and a weight attribute of 2 has a maximum score of 2.0 points. + +A student response to this problem that consists of two correct input values and two incorrect input values would be marked as having a score of 0.5 of a point out of 2.0 points total. + +**PROBLEM: 20.0 POINTS** + +• The weight attribute for this problem has been changed from the default. + +• How many points is the entire problem worth? + +• What number is the weight attribute of this problem set to? + +• How many response inputs does this problem have? + +• What is the default maximum score for this problem? + +• If a response to this problem got one value right and the rest wrong, what score would it be assigned? + +.. raw:: latex + + \newpage % + +Close +***** + +To stop accepting responses and recording points, problems can be **closed.** Closed problems do not display a **Check** button. Students +can still see questions, solutions, and revealed explanations in a closed problem, but they can no longer check their work, submit responses, or change their stored score. + +There are several ways that you can close problems: + +• Set a due date for the problems in a subsection. Note that you cannot set due dates for individual problems -- only for containing subsections (assignments). By default, due dates are not set. To set a due date, see LINK. + +• Specify a grace period for your course. Note that the grace period applies to the entire course. To set a grace period, see LINK. + +• Set the number of attempts for the individual problem component. The attempts setting determines the number of times a student is allowed to check their answer by clicking Check before the problem closes. If this field is left blank, a student has unlimited attempts. If you specify a number for the attempts setting, the number of total allowed and remaining attempts appears next to the Check button for the problem. Problems with a limited number of attempts also always display a Save button that allows response values to be saved without being submitted. When there is only one submission left, the student will receive a warning, and the Check button will be replaced with a Final Check button. When no attempts are left, both the Save and Check button will disappear.For more information, see Problem Attributes. + +• Manually increase the number of attempts left for a given problem for a particular student from the Instructor tab in the live view of your course, when accessed in the Instructor view on Edge. This is recommended only for unusual situations, such as if you have to fix live problems during an exam. + +.. raw:: latex + + \newpage % + +Feedback +******** + +Studio includes several tools to provide feedback to students: the **Check** button, the **Show Answer** button, and the**Attempts** setting. When you use the **Show Answer** button, you can also provide a detailed explanation of the answer. + +TBD-SCREENSHOT OF PROBLEM WITH THESE ELEMENTS CIRCLED + +**Check Button** + +The student clicks the **Check** button to submit a response. The problem module then performs the following steps. + +• Accepts and stores the responses entered into each input. + +• Checks the response values against the correct answers or solutions using an automatic grader. + +• Visually marks the correct responses with a green check mark and the incorrect responses with a red x. + +• Stores the point score earned by this response for this problem for this student. + +If a student wants to save but not submit a response, the student can click **Save**. + +In the following problem, enter a response, and then click **Check**. The problem tells you if your response is correct or incorrect. +Additionally, although you don't see it, a point score is also automatically stored for the response you submit. + +.. image:: images/image277.png + :width: 600px + +**Show Answer button** + +When a student clicks **Show Answer**, the problem shows the correct answers next to the corresponding response inputs and reveals any +additional explanations that you have provided. **Show Answer** is controlled by the **showanswer** attribute in the problem +editor. It can be set to be never visible, always visible, or visible only when the problem has closed. [Reference: Setting Problem Attributes.] + +In the following problem, the **Show Answer ** button appears after the student has made at least one attempt to answer. Enter a response that you know is wrong, and then click **Check**. + +.. image:: images/image278.png + :width: 600px + +Now, click **Show Answer** to view the correct answer and its explanation. + +.. image:: images/image279.png + :width: 600px + + +.. raw:: latex + + \newpage % + + + +Create a Problem +**************** + +.. note:: + +You can also include non-graded exercises throughout your course. + + +To add interactive, automatically graded exercises to your course content, use the Problem component. This component allows you to include an explanation +that the student can see when the student clicks **Show Answer**. + + Studio offers several templates that you can use. Alternatively, you can create your own problem type in XML. + For detailed information about different problem types, see `Appendix E `_. + + +1. Under **Add New Component**, click **Problem**. + +.. image:: images/image096.png + :width: 600px + + +The **Select Problem Component Type** screen appears. By default, the **Common Problem Types** tab is selected. + +.. image:: images/image097.png + :width: 600px + + +To see a list of more complex problem types, click the **Advanced** tab. + + +.. image:: images/image099.png + :width: 600px + + +2. Click the problem type that you want. + +.. note:: + + To create your own problem in XML, click "Empty" to open a blank XML editor. + +A new problem component with sample template text appears. + +For example, if you click **Multiple Choice**, the following problem component appears. + +.. image:: images/image101.png + :width: 600px + + + +3. Click **Edit**. This opens the Simple Editor for the problem component. The following example shows this view for a multiple choice +problem. + +.. image:: images/image103.jpg + :width: 600px + + +4. Set the problem attributes. + +In the **display_name** box, type the text that you want the student to see when the student hovers over the icon in the bar at the top of the page. This text also appears as a header for the problem. + +a. In the **weight** box, set a weight for the problem. If you want the problem to be a practice problem, set this to zero (0). + +b. In the **rerandomize** box, + +c. In the **attempts** box, specify the number of attempts that you want to allow the student. + +d. In the **showanswer** box, enter one of the following settings. + +.. raw:: latex + + \newpage % + +**Reference** + +• **never** = The Show Answer button is never visible. + +• **closed** = The Show Answer button is not visible if either the due date has passed, or the student has no attempts left. + +• **attempted** = The Show Answer button appears after the student has checked an answer once, regardless of correctness. + +• **always** = The Show Answer button always appears. + + +5. Modify the problem text, and then click **Save** to save and check your work. Make sure to publish the draft you are working on to view the problem live. + +.. raw:: latex + + \newpage % + +Modify a Released Problem +************************* + + **WARNING: Be careful when you modify problems after they have been released!** + +Currently, problems cache the following information per student: + +• The student's last **submitted** response. + +• The score the student earned for that last response. + +• The maximum point score for that problem. + +This information is updated when a student submits a response to a problem. If the student refreshes the **Progress** page, solutions are not re-checked. If a student refreshes the page of a problem, the latest version of the problem statement is loaded, but their previous response is NOT reevaluated. Rather, the previous response is loaded on top of the current problem statement. That is **existing** student responses for a problem are not reevaluated if the problem statement or attributes are changed, until a student goes back and resubmits the problem. Furthermore, as of the time of writing, if the problem weight attribute is changed, stored scores are re-weighted (without rechecking the response) when the student reloads the **Progress** page. + +For example, you may release a problem that has two inputs. After some students have submitted answers, if you change the solution to one of the inputs, the existing student scores are not updated. + +Example: If you change the number of inputs to three, students who submitted answers before the change will have a score of 0, 1, or 2 out of 2.0. Students who submitted answers after the change will have scores of 0, 1, 2, or 3 out of 3.0 for the same problem. + +However, if you go in and change the weight of the problem, the existing scores update when you refresh the **Progress** page. + +Note that the behavior of re-grading in case of error is an edX Edge case. It is dependent on the implementation of grading, and may change. The goal in the future is to include re-grading that will allow some basic updates to live problems, whether or not students have submitted a response. + +.. raw:: latex + + \newpage % + + +Workarounds +=========== + +If you have to modify a released problem in a way that affects grading, you have two options. Note that both options require you to ask your students to go back and resubmit a problem. + + +1. Increase the number of attempts on the problem in the same Problem component. Then ask all the students in your class to redo the problem. + +2. Delete the entire Problem component in Studio and create a new Problem component with the content and settings that you want. Then ask all the students in your course to go back to this assignment and complete problem. + +Check your **Progress** view or the **Instructor** tab on Edge as described in the Viewing Scores unit to see if point scores are being stored as you expect. If there are issues with stored scores that you do not understand or cannot fix, contact support on the Studio help page. + +For a discussion of some trade-offs and some suggestions for cleaner solutions in the future, see the following `discussion thread `_ on the Studio help desk. + +You can include multiple problems of different types inside a single Problem component, even if you select a particular template when you create a problem. A template is simply an XML editor with template text already filled in. You can add to or replace the template text. \ No newline at end of file diff --git a/userdocs/source/create_section_sub_section.rst b/userdocs/source/create_section_sub_section.rst new file mode 100644 index 0000000000..3eb95dab8b --- /dev/null +++ b/userdocs/source/create_section_sub_section.rst @@ -0,0 +1,67 @@ + +******************************* +Create a Section and Subsection +******************************* + + +1. Sign in to Studio, and then click the course that you want. + + +2. On the **Course Outline** page, click **New Section.** + + +.. image:: images/image039.png + :width: 800 + + + +3. In the **New Section** Name box, type a section name, and then click +**Save**. + +.. note:: + + In most courses, the name of the first section is Week 1. + The section that you have created appears on the **Course Outline** page. + +.. image:: images/image041.png + :width: 800 + + +The name you enter also appears in the navigation ribbon, as follows. + + +.. image:: images/image043.png + :width: 800 + + +4. To create a new lesson or assessment in your section, click **New +Subsection.** + + +5. In the **New Subsection** box, enter the name for this subsection, and then +click **Save.** + +For example, if you enter **Week 1** as the section title and **Subsection 1** +as the subsection title, you see the following. + + +.. image:: images/image045.png + :width: 800 + + +If you view your course as a student would see it, you see the following. + + +.. image:: images/image047.png + :width: 800 + + +6. Click the new subsection that you just created. In this example, you would +click **Subsection 1.** You see the following screen. + + +.. image:: images/image049.png + :width: 800 + + + diff --git a/userdocs/source/create_seed_wiki b/userdocs/source/create_seed_wiki new file mode 100644 index 0000000000..3eb688f505 --- /dev/null +++ b/userdocs/source/create_seed_wiki @@ -0,0 +1,7 @@ + +************************ +Create and Seed the Wiki +************************ + +Create wiki ("seed" the wiki) + \ No newline at end of file diff --git a/userdocs/source/create_seed_wiki.rst b/userdocs/source/create_seed_wiki.rst new file mode 100644 index 0000000000..3eb688f505 --- /dev/null +++ b/userdocs/source/create_seed_wiki.rst @@ -0,0 +1,7 @@ + +************************ +Create and Seed the Wiki +************************ + +Create wiki ("seed" the wiki) + \ No newline at end of file diff --git a/userdocs/source/create_unit.rst b/userdocs/source/create_unit.rst new file mode 100644 index 0000000000..e95bba0af1 --- /dev/null +++ b/userdocs/source/create_unit.rst @@ -0,0 +1,25 @@ + +************* +Create a Unit +************* + + 1. On the **Course Outline** page, click to open the subsection where you want to create the unit. + + 2. Click **New Unit.** The following screen appears. + + .. image:: images/image051.png + :width: 800 + + + 3. In the **Display Name** box, type the name of the unit. This name appears in the course ribbon at + the top of the screen on Edge. + + Each unit has one or more components. + + -To create a discussion space where you or your students can post questions or participate in a discussion, click **Discussion.** + + -To create a component where you can add text, images, or other content, click **html.** + + -To create a problem for your students to solve, click **Problem.** + + -To add a video, click **Video.** diff --git a/userdocs/source/create_video.rst b/userdocs/source/create_video.rst new file mode 100644 index 0000000000..4fd2b3df5d --- /dev/null +++ b/userdocs/source/create_video.rst @@ -0,0 +1,60 @@ + +************** +Create a Video +************** + +Many instructors use videos to take the place of in-class lectures. You can create a video of your lecture, and interweave other components—such as discussions and problems—to promote active learning. + +To add a video to the unit, you must upload your video to YouTube, and then create a video component. You can also add a transcript to your video. + +You can include videos that run at 0.75 speed, 1.25 speed, and 1.50 speed as well as at normal speed. To do this, you must upload each of these videos to YouTube separately. + +.. note:: + + YouTube only hosts videos of up to 15 minutes. If you encode a 0.75 speed option, you must make + sure that source video segments are only 11.25 minutes long so that YouTube can host all speeds. + YouTube offers paid accounts that relax this restriction. + + +1. Upload the video that you want to YouTube. Make note of the code that appears between **watch?v** += and **&feature** in the URL. This code appears in the green box below. + +.. image:: images/image053.png + :width: 800 px + +2. In Studio, go to the unit that you want. + +3. Under **Add New Component,** click **Video.** + +4. In the screen that appears, click **default.** + +5. When the new video component appears, click **edit**.** A video component opens, and a sample video +begins playing automatically. + +6. In the **display_name** box, type the text that you want the student to see when the student hovers +the mouse over the icon in the bar at the top of the page. This text also appears as a headerfor the video. + +7. Change the codes in the green boxes to the YouTube codes that you noted in step 1. The first +code (immediately to the right of "0.75:") corresponds to the video at 0.75 speed, the next +corresponds to 1.0 speed, etc. + +.. image:: images/image055.png + :width: 800 + +8. Click **Save.** + +.. note:: + + All videos embedded using the edX player begin playing automatically. + There is currently no way to turn off the autoplay feature. + + +**To add a transcript for your video:** + +1. Save your srt.sjson file as **subs_YOUTUBEID.srt.sjson,** where **YOUTUBEID** is the YouTube ID of your video. + +2. Upload the **subs_YOUTUBEID.srt.sjson** file to the **Files & Uploads** page. + +3. Create a link to this file by following the steps in the Add Items to the Handouts Sidebar +section. + diff --git a/userdocs/source/create_welcome_announcement.rst b/userdocs/source/create_welcome_announcement.rst new file mode 100644 index 0000000000..4275009cc6 --- /dev/null +++ b/userdocs/source/create_welcome_announcement.rst @@ -0,0 +1,14 @@ + +**************************************** +Create a Welcome Announcement and E-Mail +**************************************** + + +Send e-mail (welcome and weekly) (surveys?) (TBD) + +Create welcome announcement + +Create landing page announcement (change "landing page" to "Course Info" +page) + +Create discussion forum \ No newline at end of file diff --git a/userdocs/source/establish_course_settings.rst b/userdocs/source/establish_course_settings.rst new file mode 100644 index 0000000000..d6992d2d39 --- /dev/null +++ b/userdocs/source/establish_course_settings.rst @@ -0,0 +1,221 @@ +************************* +Establish Course Settings +************************* + +Add Collaborators +***************** + + + Studio has support for rudimentary collaborative editing of a course. Users must have registered at studio.edge.edx.org, and must have activated their account via the mail link. If a user is not found, you will be notified. + + + Before you add a new user, consider the following. + + + · Invited users have full permissions to edit your course, including deleting content created by anyone else. + + + · Invited users cannot currently grant new permissions on the course. + + + · Editing conflicts are currently not managed. Thus, the state of the course might change between refreshes of the page. + + + To give another user permission to edit your course: + + + 1. On the navigation bar, click **Course Settings**, and then click **Course Team**. + + + .. image:: images/image115.png + + + + 2. Click **New User**. + + + .. image:: images/image117.png + + + 3. In the **email** box, type the mail address of the user, and then click **Add User**. + + +.. raw:: latex + + \newpage % + + + +Add Manual Policy Data +********************** + + + + You can add manual policy data on the **Advanced Settings** page. These advanced configuration options are specified using JSON key and value + pairs. + + + You should only add manual policy data if you are very familiar with valid configuration key value pairs and the ways these pairs will affect your course. + Errors on this page can cause significant problems with your course. + + + The edX program managers can help you learn about how to apply these settings. + + + 1. On the navigation bar, click **Course Settings**, and then click **Advanced Settings**. + + + 2. Click **New Manual Policy** . + + + .. image:: images/image119.png + + + 3. In the **Policy Key** box, enter the policy key. + + + 4. In the **Policy Value** box, enter the value of the policy. + + +.. raw:: latex + + \newpage % + + +Add Course Catalog Information +****************************** + + + To add scheduling information, a description, and other information for your course, use the **Course Settings** menu. + + + .. image:: images/image121.png + + + This takes you to the + +Schedule and Details Page +========================= + + +1. At the top of this page, you will find a section with the **Basic Information** for your course. It is here that you can locate the title of your course and find the URL for your course, which you can mail to students to invite students to enroll in your course. + + .. image:: images/image281.png + + +2. In the **Course Schedule** section, enter the date you want your course to start in the **Course Start Date** box, and then enter the time you want your course to start in the **Course** **Start Time** box. + + +.. note:: + + The Course Start Time on this screen will reflect the current time zone in your browser, depending on your geography. Course start times for students will show as UTC on Edge. + + +3. In the **Course Schedule** section, enter the date you want your course to end in the **Course** **End Date ** + box, and then enter the time you want your course to end in the **Course** **End Time** box. + + +Add Enrollment Information +========================== + + +1. On the navigation bar, click **Course **Settings, and then click **Schedule & Details** . + + +2. In the **Course Schedule** section, enter the date you want enrollment for your course to start in the **Enrollment Start Date** box, and then enter the time you want enrollment for your course to start in the **Enrollment Start Time** box. + + +3. In the **Course Schedule** section, enter the date you want enrollment for your course to end in the **Enrollment End Date** +box, and then enter the time you want enrollment for your course to end in the **Enrollment End Time** box. + + +.. note:: + + The Enrollment dates on this screen will reflect the current time zone in your browser, depending on your geography. Enrollment times for students will show as UTC on Edge. + + + +Add a Course Overview +===================== + + +1. On the navigation bar, click **Course Settings**, and then click ** Schedule & Details ** . + + +2. Scroll down to the **Introducing Your Course** section, and then locate the **Course Overview** box. + +.. image:: images/image123.png + + + + +3. In the **Course Overview** box, enter a description of your course. + + +The content for this box must be formated in HTML. For a template that you +can use that includes placeholders, see :doc:`appendices/a`. + + + +If your course has prerequisites, you can include that information in the course overview. + + +.. note:: + + There is no save button. Studio automatically saves your changes. + + +The following is example content for the **Course Overview** box: + + +.. image:: images/image125.png + + +Add an About Video +================== + + +You can create an About video that will appear on the **About** page for your course. + + +1. Upload the video that you want to YouTube. Make note of the code that appears between ** watch?v =** and ** &feature** in the URL. This code appears in the green box below. + + +.. image:: images/image127.png + + +2. On the navigation bar, click **Course Settings**, and then click **Schedule & Details** . + + +3. Scroll down to the **Introducing Your Course** section, and then locate the **Course** **Introduction Video** + field. If you have not already added a video, you see a blank field above an **id** box. + + +.. image:: images/image129.png + + +4. In the **your YouTube video's ID** box, enter your video code. When you add the code, the video automatically appears in the field above the **your YouTube video's ID** box. + + +.. note:: + + There is no save button. Studio automatically saves your changes. + + +For example, your course introduction video appears as follows. + + +.. image:: images/image131.png + + +Add Weekly Time Requirements Information +======================================== + + +1. On the navigation bar, click **Course Settings**, and then click **Schedule & Details** . + + +2. Scroll down to the **Requirments** section. + + +3. In the **Hours of Effort per Week** box, enter the number of hours you expect students to work on this course each week. \ No newline at end of file diff --git a/userdocs/source/establish_grading_policy.rst b/userdocs/source/establish_grading_policy.rst new file mode 100644 index 0000000000..062fb544ca --- /dev/null +++ b/userdocs/source/establish_grading_policy.rst @@ -0,0 +1,216 @@ +*************************** +Establish a Grading Policy +*************************** + + +Overview +******** + + +Grades in edX courses are based on homework assignments and exams. + + +Setting up grading in edX Studio has several steps. These steps will be explained in more detail later in the course. To skip to the detailed information, click the links below. + + +1. Establish an overall grading policy, also see :ref:`Set Grade Brackets`. + +.. image:: images/image139.png + +This is done at the course level in the **Course Settings** menu. + + +Establish whether your course is pass-fail or graded by letter, and what the thresholds are for each grade. + + +Create assignment types for the course and determine the weight of the student's total grade for each assignment type. For example, you may have 10 homework assignments, worth a total of 50% of the grade; three exams, worth a total of 10% of the grade; and one final exam, worth 20% of the grade. By default, Studio includes four assignment types when you create the course: homework, lab, midterm exam, and final exam. You can also create additional assignment types, such as quizzes. + + +2. Create subsections that contain graded assignments in the body of the course, see :ref:`Create Subsections that Contain Graded Assignments`. + + +.. image:: images/image135.png + + +Each subsection in your course can be designated as one of the assignment types that you have specified in the grading policy. You can also specify a release date and a due date. + + +.. note:: + + You can create problems in Studio without specifying that the subsection is an assignment type. However, problems do not count toward a student's grade unless you set the subsection as a graded assignment type. + +For more information on creating problems, see `Create a Problem `_ . + +3. In the assignment subsections, create individual problems + +.. image:: images/image137.png + + +You can then establish the settings for these problems (including the number of attempts a student has and the problem's point value, or weight). + +Once a grading policy is in place, students can view both their problem scores and the percent completed and current grade at the top of their **Progress** tab for the course. + +Additionally, as an instructor, you can access your students' scores on graded content. On the live published page of your course on Edge (not from the Preview page in Studio), click the **Instructor** tab. Many options appear for viewing or downloading a snapshot of the currently stored student grades. On the **Instructor** tab you can also request a link to a view of the student's individual progress page, including both graded and not graded scores. For more information, see Progress and Certificates. + + +.. _Set-Grade-Brackets: + +Set Grade Brackets +++++++++++++++++++ + +To set the thresholds for course grades: + +1. On the navigation bar, click **Course Settings**, and then click **Grading**. + +2. Under **Overall Grade Range**, click and drag the dividing line between grade divisions to move each threshold up or down. + +.. note:: + + The default grade divisions are Pass and Fail. To add more grade divisions (such as A, B, C, or D), click the plus sign (+). + + +.. image:: images/image133.png + +To remove a grade division, hover the mouse over the grade division (shown above) and then click the **Remove** link that appears above the grade division. + +.. _Set-Grace-Period: + +Set a Grace Period +++++++++++++++++++ + +You can set a grace period that extends homework due dates for your students. Note that this setting applies to the whole course; you cannot set a grace period for individual assignments. + + +1. On the navigation bar, click **Course Settings**, and then click **Grading**. + + +2. Under **Grading Rules & Policies** enter a value in the **Grace Period on Deadline** box. + + +Create Assignment Types ++++++++++++++++++++++++ + + +By default, Studio includes four assignment types for your course when you create the course: homework, lab, midterm exam, and final exam. You decide the weight of the student's total grade for each assignment type. + + +To set an assignment type: + + +1. On the navigation bar, click **Course Settings**, and then click **Grading**. + + +2. Under **Assignment Types**, locate the settings for the assignment type that you want. + + +If you want to create a new assignment type, scroll to the bottom of the page, and then click **New Assignment Type**. + + +3. Enter values in each of the following boxes. + + +**Assignment Type Name:** +This is a general category of assessment (homework, exam, exercise). All assignments within an assignment type are given equal weight. This name will be visible to students. + + +**Abbreviation:** +This is the short name that will appear next to an assignment on every student's **Progress** tab (see below). + +.. image:: images/image141.png + + +**Weight of Total Grade:** +The assignments of a particular type together account for the percent value set in **Weight of Total Grade**. + + +**Total Number:** +The number of assignments of that type that you plan to present in your course. + + +**Number of Droppable** +(optional): Specify the number of assignments that the grader will drop. The grader will omit the lowest-scored assignments first. + + +For example, the following course has two types of assignments. The overall course grade is broken down as 40% Homework and 60% Final Exam. There are eight Homework assignments, and the grader will omit the lowest-scored assignment from the final grade. Thus, the seven remaining Homework assignments are each worth 40 7 = 5.8% of the final grade. + +.. image:: images/image143.png + +Troubleshooting ++++++++++++++++ + +If you have problems creating assignment types, try the following. + +In the **Weight of Total Grade** field, omit the % sign. Be sure that your **Weight of Total Grade** fields add up to 100. + +.. _Create-Graded-Subsections: + + +.. raw:: latex + + \newpage % + +Create Subsections Containing Graded Assignments +************************************************** + +After you establish your grading rubric, you can create a graded assignment or a test for your students. To do this, you must first create a subsections and then set up grading for the subsection. This includes setting the assignment type, the assignment release date, and the due date. + + +.. note:: + + When you set a due date, keep in mind that students will be in different time zones across the world. By default, the time zone appears as UTC-not the student's local time. If you tell your students an assignment is due at 5:00 PM, make sure to specify that the time is 5:00 PM UTC and point them to a time converter. + + +Alternatively, you can :ref:`set a grace period` for your assignments to cover any misunderstandings about time. For example, some classes have set a grace period of 1 day, 6 hours, and 1 minute. This grace period applies to the entire course. + +Keep in mind that a subsection can only have one assignment type. If you want to create a homework assignment and a lab for a specific topic, you would create two subsections for that topic. You would set one subsection as the Homework assignment type and the other as the Lab assignment type. Both subsections can contain other content as well as the actual homework or lab problems. + + +All assignments of a particular type are automatically worth the same amount. Thus, a homework assignment that contains 10 problems is worth the same percentage of a student's grade as a homework assignment that contains 20 problems. If you want the assignment with 20 problems to be worth twice as much as the assignment with 10 problems, you can create two assignments. + + +1. On the navigation bar, click **Course Content**, and then click **Outline**. + + +.. image:: images/image145.png + + +2. Under **Course Outline**, locate the section where you want to add an assignment. + +3. Under the name of the section, click **New Subsection**. + +4. In the text box, replace **New Subsection** with the name of your subsection, and then click **Save**. + +Click the subsection you want. The edit page for the subsection opens. In the top right corner of the page, locate the **Subsection Settings** box. + + +.. image:: images/image147.png + +Set the assignment type. To do this, locate the blue link next to **Graded as**. Because all subsections are set to **Not Graded** by default, the text for this link is **NOT GRADED**. + +.. image:: images/image149.png + +Click this link to open a list of the assignment types that you specified in your grading rubric, and then click the assignment type that you want. + + +.. image:: images/image151.png + +Set the assignment's release date and time. To set the date, click inside the **Release date** field, and then select the date that you want in the calendar that appears. To set the release time, click inside the time input field, and then specify the time you want. + +Set a due date for the assignment. To do this, click the blue **SET A DUE DATE** link, and click inside the **Due date** box, and then select the date you want in the calendar that appears. To set the time, click inside the time input field, and then specify the time you want. + +Change a Subsection's Assignment Type ++++++++++++++++++++++++++++++++++++++ + +To set the assignment type for a subsection: + +1. On the navigation bar, click **Course Content**, and then click **Course Outline**. + +2. Under **Course Outline**, locate the subsection that you want. + +3. On the right side of the screen, click the blue check mark for the subsection, and then select the assignment type. + +.. image:: images/image153.png + +.. note:: + + If you change an assignment type name in the Grading page, make sure the assignment type names on the Course Outline still match. \ No newline at end of file diff --git a/userdocs/source/export_import_course.rst b/userdocs/source/export_import_course.rst new file mode 100644 index 0000000000..7173008487 --- /dev/null +++ b/userdocs/source/export_import_course.rst @@ -0,0 +1,116 @@ + +************************* +Export or Import a Course +************************* + +Studio has an Import tool and an Export tool that allow you to import and +export courses. + + +Export a Course +*************** + +You can export a course that has been created in Studio. You can export a +course for use by another instructor, or you can back up your course. + + +For example, you may create a course in Studio, and then run that course. A +friend or colleague, including a friend from another institution, may be +interested in running their own customized version of that course. You can +export the course that you have created and give it to the other instructor. +That instructor can then import the course, make any changes that are +necessary to reflect that instructor's situation, and then release the +course to students. + + +Or, you may export your course, and then make changes to your course in +Studio. If you later want to revert to the earlier version of your course, +you can import the version that you exported. Be careful if you do this +while you are running your course, as you could lose your students' work. + + +When you export your course, Studio creates a **.tar.gz** file that includes +the following course data: + + +1. Course structure (the order of sections and subsections) + + +2. Individual units + + +3. Individual problems + + +4. Additional pages + + +5. Files on the Files & Uploads page + + + +The exported file does not include the following data: + + +1. Student or user data + + +2. Discussion forum data + + +3. Course settings + + +4. Certificates + + +5. Grading information + + +.. raw:: latex + + \newpage % + + +Import a Course +*************** + + + +.. warning:: + + This feature should be used with caution! + Importing a new course will delete all course content currently associated + with your course and replace it with the contents of the uploaded file. + Importing a course cannot be undone. + + +You can import courses that have already been created in Studio. These can +be courses that you or someone else has created and exported. + + +The file that you import must be a **.tar.gz** file that contains, at a +minimum, a Course.xml file in a course data directory. The tar.gz file must +have the same name as the course data directory. + + +If your course uses legacy layout structures, you may not be able to edit +the course in Studio, although it will probably appear correctly on Edge. To +make sure that your course is completely editable, ensure that all of your +material is embedded in a unit. + + +To import a course: + + +1. On the navigation bar, click **Tools**, and then click **Import**. + + +.. image:: images/image243.png + + +2. Under **Course to Import**, click **Choose File**. + + +3. Locate the file that you want, and then click **Open**. + diff --git a/userdocs/source/get_started.rst b/userdocs/source/get_started.rst new file mode 100644 index 0000000000..468ff71a33 --- /dev/null +++ b/userdocs/source/get_started.rst @@ -0,0 +1,169 @@ + +.. image:: images/image001.png + + +########################### +Getting Started with Studio +########################### + + +************ +Introduction +************ + +Since the launch of edX to our original partners, we have been working to provide opportunities for additional educators to create courses on our platform. The fruits of our efforts are Edge and Studio. These tools are available not only to our edX partners, but to all faculty at consortium universities. + + + +EdX (http://edx.org) is our original, premiere learning portal. Publication to edX is available on a limited basis, depending on your university’s agreement with edX. You need specific approval from your university to release your course on the edX portal. + +Edge (http://edge.edx.org) is our newest online learning portal. It is almost identical to edX.org both visibly and functionally. + +Edge is where you view the content you create with Studio, our course authoring tool, and where students will view your course. Instructors are encouraged to use Edge to experiment with creating courses. You do not need approval to release a course on Edge—you can create a course and release it immediately. + +Studio (http://studio.edge.edx.org) is our web-based course authoring tool. It is the easiest way for educators to develop courses for the edX platform. You can create courses in Studio and view and enroll in them instantly on Edge—even before you have finished creating the course. + + + +**There is a workflow to getting started.** Here is a quick summary: + + + +1. First, go to: https://studio.edge.edx.org. Sign up and create an account. + + +.. image:: images/image009.png + :width: 800 + + +**then** + + +2. Create a course in Studio. + + +.. image:: images/image021.png + :width: 800 + + +**then** + + +3. View your course on Edge. + + +.. image:: images/image027.png + :width: 800 + +.. raw:: latex + + \newpage % + + +***************** +Create an Account +***************** + +To begin using Studio, create an account with a unique user ID and password. A Studio account isn't the same as an edX account. Even if you already have an edX account, you still need to create a separate Studio account. You can use the same e-mail address for both accounts. + +When you create your account on Studio, an account on Edge is automatically created using the same user name and password. You don't have to create separate accounts on Studio and Edge. + +Edge has two views - an Instructor view and a Student view. When you view your course on Edge, you view your course as an instructor, and you see the **Instructor** tab at the top of the page. + +.. image:: images/image007.png + :width: 800 + + +Your students will view your courses in Student view, which is similar to Instructor view, but does not include the Instructor tab or release dates. + +To create an account: + +1. Go to http://studio.edge.edX.org. The Welcome to edX Studio page opens. + +.. image:: images/image009.png + :width: 800 + + +2. Scroll to the bottom of the page and click **Sign Up & Start Making an edX Course.** + +.. image:: images/image011.png + :width: 800 + + +3. In the page that opens, fill in the fields. Required fields are marked with an asterisk (*). + + +.. image:: images/image013.png + :width: 800 + + +a. In the **Email Address** box, type your e-mail address. +b. In the **Password** box, type a unique password. +c. In the **Public Username** field, type the name you want students to see when you post on the user forum. Most websites call this the "user name". +d. In the **Full Name** box, type your full name. This name only appears in Studio. + Your students will not see this name. +e. Click to select I agree to the Terms of Service. + +.. image:: images/image017.png + :width: 800 + +4. Click **Create My Account & Start Authoring Courses,** After you click this button, the following page opens. + +.. image:: images/image015.png + :width: 800 + +5. To finish creating your account, click the link that you receive in the activation e-mail. When you click this link, the following page opens. + +.. image:: images/image017.png + :width: 800 + + .. raw:: latex + + \newpage % + +******************* +Create a New Course +******************* + +The first time that you log in to Studio, the following page opens. + +.. image:: images/image017.png + :width: 800 + +Click the **dashboard** link, and the **My Courses** page opens. + +.. image:: images/image021.png + :width: 800 + +Once you have created a course in Studio, it will be listed on this page. From here, you can start creating courses immediately by clicking the **New Course** button. + + +To create a new course: + +1. Click **New Course.** A screen opens. + + +.. note:: + + Enter your new course information carefully. This information becomes part of the URL for your course. To change the URL after the course is created, you must contact edX through the Help site (http://help.edge.edx.org).Additionally, because this information becomes part of your course URL, the total number of characters in the following three fields must be 65 or fewer. + + +2. For **Course Name**, enter the title of your course. For example, the name may be “Sets, Maps and Symmetry Groups". Use title capitalization for the course title. + +3. For **Organization**, enter the name of your university. Do not include whitespace or special characters. + +4. For **Course Number**, enter both a subject abbreviation and a number. For example, for public health course number 207, enter "PH207". For math course 101x, enter “Math101x”. Do not include whitespace or special characters in the course number. + + *Note: If your course will be open to the world, be sure to include the "x". If it is exclusively anon-campus offering, do not include the "x".* + +5. Click **Save.** + +.. image:: images/image025.png + :width: 800 + +If you click **View Live** your course appears as follows on Edge. + +.. image:: images/image027.png + :width: 800 + +*Note: Although the start date is set to the current date by default, your course will not be advertised, so it will not be visible to the general public. You can change the start date of your course in Studio.* \ No newline at end of file diff --git a/userdocs/source/index.rst b/userdocs/source/index.rst new file mode 100755 index 0000000000..5e17e39106 --- /dev/null +++ b/userdocs/source/index.rst @@ -0,0 +1,57 @@ +.. Getting_Started documentation master file, created by + sphinx-quickstart on Tue Apr 16 11:19:12 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + + + +Contents +======== + + +.. toctree:: + :maxdepth: 5 + + read_me + get_started + create_lesson + create_section_sub_section + create_unit + create_video + create_discussion + create_html_component + create_problem + set_content_releasedates + establish_course_settings + establish_grading_policy + add_syllabus + view_course_content + modify_published_content + export_import_course + create_welcome_announcement + create_seed_wiki + invite_students_to_register + checking_student_progress + change_log + + + + + + + +Appendices +========== + +.. toctree:: + :maxdepth: 3 + :glob: + + appendices/* + + + + + + + diff --git a/userdocs/source/invite_students_to_register.rst b/userdocs/source/invite_students_to_register.rst new file mode 100644 index 0000000000..4903cf3f2d --- /dev/null +++ b/userdocs/source/invite_students_to_register.rst @@ -0,0 +1,29 @@ + +*************************** +Invite Students to Register +*************************** + +To invite students to register for your course on Edge through the course +registration page, direct students to the registration page, and provide +instructions for completing the registration process. + + +1. Determine the link to your class registration page on Edge. To do this: + + +a. Click the **Settings **tab of your course in Studio, and then locate the +**Course Details** section. + + +b. Under **Basic Information**, you will see a link to email and invite +students to enroll in your course. + + +c. Click "**Invite Your Students**" link. Clicking the link creates an email +template. + + +.. image:: images/image286.png + + +d. Email this to your chosen mail list. \ No newline at end of file diff --git a/userdocs/source/latex/Makefile b/userdocs/source/latex/Makefile new file mode 100644 index 0000000000..6b87ad8814 --- /dev/null +++ b/userdocs/source/latex/Makefile @@ -0,0 +1,66 @@ +# Makefile for Sphinx LaTeX output + +ALLDOCS = $(basename $(wildcard *.tex)) +ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) +ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) + +# Prefix for archive names +ARCHIVEPRREFIX = +# Additional LaTeX options +LATEXOPTS = + +all: $(ALLPDF) +all-pdf: $(ALLPDF) +all-dvi: $(ALLDVI) +all-ps: all-dvi + for f in *.dvi; do dvips $$f; done + +all-pdf-ja: + for f in *.pdf *.png *.gif *.jpg *.jpeg; do extractbb $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + -for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.dvi; do dvipdfmx $$f; done + +zip: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +tar: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +bz2: tar + bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar + +# The number of LaTeX runs is quite conservative, but I don't expect it +# to get run often, so the little extra time won't hurt. +%.dvi: %.tex + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + +%.pdf: %.tex + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + +clean: + rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla + +.PHONY: all all-pdf all-dvi all-ps clean +.PHONY: all-pdf-ja + diff --git a/userdocs/source/modify_published_content.rst b/userdocs/source/modify_published_content.rst new file mode 100644 index 0000000000..9760147eb6 --- /dev/null +++ b/userdocs/source/modify_published_content.rst @@ -0,0 +1,62 @@ +*************************** +Modifying Published Content +*************************** + +When you set a Unit to Public, that content appears on edX or Edge when you +view the content as an instructor. If the release date has passed, the +content is also visible to students. + + +If you want to modify content after it has been set to Public, you must +create a draft. The draft does not appear on edX or Edge. However, the draft +does appear when you view your content in Preview mode. + + +To create a draft, open the Unit that you want. Note that no **Edit** button +appears on the page for that Unit, and you cannot make changes to the Unit. + + +.. image:: images/image231.png + :width: 600 + + +In the right pane, click the blue **edit a draft** link in the **Unit +Settings** box. + + +.. image:: images/image233.png + :width: 600 + + +After you click **edit a draft**, you can make changes to the Unit. You can +edit existing content or add new content. + + +.. image:: images/image235.png + :width: 600 + + +If you want to view the version of your content that is currently live, +click **Preview the published version **in the yellow banner at the top of +the page. + + +.. image:: images/image237.png + :width: 600 + + +If you want to view the draft version that you are working on, click +**Preview** under **Unit Settings**. This opens your course in Preview +mode.**** + + +.. image:: images/image239.png + :width: 600 + + +When you are done making changes to the Unit, click the blue **replace it +with this draft** link under **Unit Settings**. + + +.. image:: images/image241.png + :width: 600 diff --git a/userdocs/source/read_me.rst b/userdocs/source/read_me.rst new file mode 100644 index 0000000000..b0e543ff5e --- /dev/null +++ b/userdocs/source/read_me.rst @@ -0,0 +1,11 @@ +******* +Read Me +******* + +This version of the edX "Getting Started with Studio" help and pdf documentation is created using Sphinx 1.2b1 and LaTex. You, the user community, can help update and revise this documentation project in GitHub at :: + + edx\edX-platform\userdocs\source + +with a pull request that will need approval from an engineering contact at edX. + +The edX contact for this documenation is mchang@edx.org diff --git a/userdocs/source/set_content_releasedates.rst b/userdocs/source/set_content_releasedates.rst new file mode 100644 index 0000000000..80dcd53095 --- /dev/null +++ b/userdocs/source/set_content_releasedates.rst @@ -0,0 +1,82 @@ + +***************************************** +Set Content Release Dates and Visibility +***************************************** + +The release schedule for course material is determined by setting release dates +for sections and subsections. + +Section +******* + + To set the release date for a section: + + 1. On the **Course Content** menu, click **Course Outline**. + + 2. Find the section you are looking for in the course outline. + + 3. Under **Will Release**, click **Edit**, and then change the date. + .. image:: images/image280.png + +Subsection +********** + +Subsections inherit the release date of the section they are in, but you can +change this date so that different subsections are released at different times. + +Note that if the release date for a subsection falls before the release date for +the section that contains it, students will not be able to see the subsection +until the release date for the *section *has passed. Section release dates +override subsection release dates. + + To set the release date for a subsection: + + 1. Click to open the subsection. + + 2. Locate the **Subsection Settings** box in the top right corner. + + 3. Under **Release Date**, change the date. + +Unit +**** + +Individual units inherit the release date of the subsection they are in, but +have an additional **Visibility** setting that can be set to **Public** or +**Private**. Private units are never visible to students. + +.. note:: + +You can modify private units directly. To modify a unit that is marked +Public you must create a draft. + +For more information, see :doc:`modify_published_content` . + + + + To change the **Visibility** setting for a private unit: + + + 1. Click to open the unit. + + + 2. Locate the **Unit Settings** box in the top right corner. + + + 3. For **Visibility**, select **Public**. + + + To change the **Visibility** setting for a public unit: + + + 1. Click to open the unit. + + + 2. Locate the **Unit Settings** box in the top right corner. + + + 3. Under **Unit Settings**, click **edit a draft**. + + + 4. For **Visibility**, select **Private**. + + \ No newline at end of file diff --git a/userdocs/source/view_course_content.rst b/userdocs/source/view_course_content.rst new file mode 100644 index 0000000000..1b4876984b --- /dev/null +++ b/userdocs/source/view_course_content.rst @@ -0,0 +1,340 @@ +******************* +View Course Content +******************* + +When you create a course on Studio, you can control when students can see +the content of your course. This means that you can continue building a +course, but students won't be able to see the changes you make until you +make those changes available. You can set release dates that control when +content is released to the internet. You can also set the visibility of +specific Units (a subdivision that helps you organize your course content) +to Public or Private. By default, all content is set to Private. + + +Your content is not visible to students on edX or Edge until three +conditions are met: + +1. The course start date has passed. + +2. The release dates for the Section and Subsection that contain the + content have passed. + + +* Sections and Subsections are categories that you use to organize your +course. For example, Sections may correspond to weeks in your course, while +Subsections may correspond to the topics in your course. + + +* Neither a Section nor its contents are visible until the release date +passes. If the release date for the Section has passed, but the release date +for the Subsection has not passed, the student can see the Section heading +in the left pane. However, the student cannot see the Subsection heading or +any of the Subsection's content. + + +* Subsections inherit the release date of the Section they are in, but you +can change this date so that individual Subsections are released at different +times after the Section has been released. + + +.. image:: images/image189.png + + +.. image:: images/image191.png + + +3. You set the Unit that contains the content to Public.** By default, all +Units are set to Private. + + +There are four ways of viewing your course on edX or Edge while you are +still creating it: + + +* In Studio + + +.. note:: + + The way your course looks in Studio is not the way it looks to students on + edX or Edge. + + +* On edX or Edge in Preview mode + + Any content that is set to Private is only visible in Preview mode. + + +* On edX or Edge as an Instructor + + When you view content as an instructor, you see the **Instructor** tab at the + the top of the screen. + + +* On edX or Edge as a Student + +.. raw:: latex + + \newpage % + + +Outline View +============ + + +When you want to see the overall organization of your course in Studio, you can +go to the **Course Outline **page. On the**Course Outline **page, you can +see the "macro" outline of your course, down to individual Units. + + +.. image:: images/image193.png + + +.. raw:: latex + + \newpage % + +Subsection View +=============== + +You can also view content by Subsection. In this view, you can see the name +of the Subsection and the Units that the Subsection contains. You can see if +the Section is graded or not graded; if it is graded, you can see the +assignment type of the Subsection. You can also see if the individual Units +are set to Public or Private. Private Units appear in light gray text with +"PRIVATE" next to the Unit name. All other Units are Public. + + +.. image:: images/image195.png + + +.. raw:: latex + + \newpage % + +Unit View +========= + +When you want to see the actual text, problems, and other content in your +course, you can open an individual Unit. You then see the Components for +that Unit. You can see this content whether it is set to Public or Private, +and whether or not the release date has passed. + + +The following example shows the Studio view of two Units in the "What Does +an edX Course Look Like?" Subsection. + + +The following Unit is set to Public. The release date for the Subsection has +passed. + + +.. image:: images/image197.png + + +The following Unit is set to Private. The release date for the Subsection +has passed. + + +.. image:: images/image199.png + + +If you change the release date for the "What Does an edX Course Look Like?" +Subsection to a date in the future (in this example, January 1, 2099), you +still see both Units in Studio. + + +Public Unit +^^^^^^^^^^^ + + + +.. image:: images/image201.png + + +Private Unit +^^^^^^^^^^^^ + + + +.. image:: images/image203.png + + + +.. raw:: latex + + \newpage % + + +Preview Mode +============ + +When you view your course on edX or Edge using Preview mode, you see all the +Units of your course, regardless of whether they are set to Public or +Private and regardless of whether the release dates have passed. + + +**Using Preview mode is the only way to see content that is set to Private +**as a student would see it.** + + +You can enter Preview mode in two ways. + + +1. On any Subsection page, click** Preview Drafts**. + + +.. image:: images/image205.png + + +2. On any Unit page, click **Preview**. + + +The following example shows the **Preview** button on a page for a Unit that +is set to Public. + + +.. image:: images/image207.png + + +The following example shows the **Preview** button on a page for a Unit that +is set to Private. + + +.. image:: images/image209.png + +Example +======= + +The following example shows the first Unit of the "What Does an edX Course +Look Like?" Subsection in Preview mode. + + +.. image:: images/image211.png + + +Remember that the release date for the Subsection is in the past. However, +even if you change the release date for the "What Does an edX Course Look +Like?" Subsection to a date in the future, you still see both Units in +Preview. + + +In the "What Does an edX Course Look Like?" Subsection, Unit 1 ("Welcome to +edX 101") is set to Public, and Unit 2 ("New edX Information") is set to +Private. Both Units appear in the course ribbon at the top of the screen. + + +.. image:: images/image213.png + +When you click Unit 2 in the course ribbon, you see the content in Unit 2: + + +.. image:: images/image215.png + +**On edX or Edge as an Instructor** + +When you view your course on edX or Edge as an instructor: + + +* You see all the Units of your course that you have set to Public. +* Release dates do not matter. + + +You do not see Units that are set to Private. + + +Additionally, at the top of the page on edX or Edge, you can see the +**Instructor** tab. + + +To view your course on edX or Edge as an instructor, click **View Live**. The +**View Live **button is available in three places.** ** + +The **Course Outline** page. + + +.. image:: images/image217.png + + +Any Subsection page. + + +.. image:: images/image219.png + + + +The Unit page, if the Unit is Public. + + +.. image:: images/image221.png + +Example +======= + +The following example shows the first Unit of the "What Does an edX Course +Look Like?" Subsection as if you were viewing it on edX or Edge as an +instructor. Notice the **Instructor** tab at the top of the page. + + +.. image:: images/image223.png + + +The release date for the "What Does an edX Course Look Like?" Subsection is +set to January 1, 2099. However, you still see this Unit on edX or Edge as +an instructor. + + +On the other hand, remember that Unit 1 is set to Public, and Unit 2 is set +to Private. Unit 2 does not appear in the course ribbon at the top of the +screen. Instead, the next public unit, **Tabs**, appears. + + +.. image:: images/image225.png + +**On edX or Edge as a Current Student** + +When you view your course as a current student would see it, you can only +see material that meets all three publishing conditions: + + +The course start date has passed. + + +* The release dates for the Section and Subsection have passed. + +* The Unit that contains the material is set to Public. + + +You can use this view to make sure that material does not appear in your +course prematurely. + + +To view your course as a student, set up a test account on edX or Edge with +an e-mail address that is not associated with your Course Team, and then go +to your course URL and register for your course. + +Example +======= + +The following example shows the first Unit of the "What Does an edX Course +Look Like?" Subsection as if you were viewing it on edX or Edge as a +student. Notice that the **Instructor** tab does not appear at the top of +the page. + + +.. image:: images/image227.png + + +Remember that Unit 1 is set to Public, and Unit 2 is set to Private. Unit 2 +does not appear in the course ribbon at the top of the screen. Instead, the +next public unit, **Tabs**, appears. + + +.. image:: images/image229.png + + +If you change the release date of the Subsection to a future date (such as +January 1, 2099), the student cannot see it. + + +If you set the Unit to Private, the student cannot see it.