Skip to content

E
edx-platform
Commit 76a52acf by Mark Hoeber
Options

Merge pull request #5230 from edx/markhoeber-doc913 

WIP: edXML Doc Draft
parents 785a3c82 f39a41ba
Showing with 855 additions and 0 deletions
docs/en_us/olx/Makefile 0 → 100644
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
PAPER ?=
BUILDDIR ?= build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
Q_FLAG =
ifeq ($(quiet), true)
Q_FLAG = -Q
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " 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 " 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/edXDocs.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/edXDocs.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/edXDocs"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/edXDocs"
@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."
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."
docs/en_us/olx/source/Images/AI_ScoredResponse.png 0 → 120000
../../../course_authors/source/Images/AI_ScoredResponse.png
\ No newline at end of file
docs/en_us/olx/source/Images/AdditionalFeedback.png 0 → 120000
../../../course_authors/source/Images/AdditionalFeedback.png
\ No newline at end of file
docs/en_us/olx/source/Images/AdvancedComponent.png 0 → 120000
../../../course_authors/source/Images/AdvancedComponent.png
\ No newline at end of file
docs/en_us/olx/source/Images/AnnotationExample.png 0 → 120000
../../../course_authors/source/Images/AnnotationExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/CITL_AssmtTypes.png 0 → 120000
../../../course_authors/source/Images/CITL_AssmtTypes.png
\ No newline at end of file
docs/en_us/olx/source/Images/CITL_SA_Rubric.png 0 → 120000
../../../course_authors/source/Images/CITL_SA_Rubric.png
\ No newline at end of file
docs/en_us/olx/source/Images/CITLsample.png 0 → 120000
../../../course_authors/source/Images/CITLsample.png
\ No newline at end of file
docs/en_us/olx/source/Images/CheckboxExample.png 0 → 120000
../../../course_authors/source/Images/CheckboxExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/ChemicalEquationExample.png 0 → 120000
../../../course_authors/source/Images/ChemicalEquationExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/CircuitSchematicExample.png 0 → 120000
../../../course_authors/source/Images/CircuitSchematicExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/CustomPythonExample.png 0 → 120000
../../../course_authors/source/Images/CustomPythonExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/DragAndDropProblem.png 0 → 120000
../../../course_authors/source/Images/DragAndDropProblem.png
\ No newline at end of file
docs/en_us/olx/source/Images/DropdownExample.png 0 → 120000
../../../course_authors/source/Images/DropdownExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/FeedbackNotAvailable.png 0 → 120000
../../../course_authors/source/Images/FeedbackNotAvailable.png
\ No newline at end of file
docs/en_us/olx/source/Images/FetchingNextSubmission.png 0 → 120000
../../../course_authors/source/Images/FetchingNextSubmission.png
\ No newline at end of file
docs/en_us/olx/source/Images/GeneExplorer.png 0 → 120000
../../../course_authors/source/Images/GeneExplorer.png
\ No newline at end of file
docs/en_us/olx/source/Images/GoogleHangout_WithPeople.png 0 → 120000
../../../course_authors/source/Images/GoogleHangout_WithPeople.png
\ No newline at end of file
docs/en_us/olx/source/Images/IFrame_1.png 0 → 120000
../../../course_authors/source/Images/IFrame_1.png
\ No newline at end of file
docs/en_us/olx/source/Images/IFrame_2.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/IFrame_2.png
\ No newline at end of file
docs/en_us/olx/source/Images/IFrame_3.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/IFrame_3.png
\ No newline at end of file
docs/en_us/olx/source/Images/IFrame_4.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/IFrame_4.png
\ No newline at end of file
docs/en_us/olx/source/Images/ImageMappedInputExample.png 0 → 120000
../../../course_authors/source/Images/ImageMappedInputExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/JavaScriptInputExample.png 0 → 120000
../../../course_authors/source/Images/JavaScriptInputExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/LTIExample.png 0 → 120000
../../../course_authors/source/Images/LTIExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/LTIPolicyKey.png 0 → 120000
../../../course_authors/source/Images/LTIPolicyKey.png
\ No newline at end of file
docs/en_us/olx/source/Images/Math5.png 0 → 120000
../../../course_authors/source/Images/Math5.png
\ No newline at end of file
docs/en_us/olx/source/Images/MathExpressionInputExample.png 0 → 120000
../../../course_authors/source/Images/MathExpressionInputExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/MathJax_HTML.png 0 → 120000
../../../course_authors/source/Images/MathJax_HTML.png
\ No newline at end of file
docs/en_us/olx/source/Images/MathJax_Problem.png 0 → 120000
../../../course_authors/source/Images/MathJax_Problem.png
\ No newline at end of file
docs/en_us/olx/source/Images/Molecule_Editor.png 0 → 120000
../../../course_authors/source/Images/Molecule_Editor.png
\ No newline at end of file
docs/en_us/olx/source/Images/MultimpleChoiceExample.png 0 → 120000
../../../course_authors/source/Images/MultimpleChoiceExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/MultimpleChoice_NumericalInput.png 0 → 120000
../../../course_authors/source/Images/MultimpleChoice_NumericalInput.png
\ No newline at end of file
docs/en_us/olx/source/Images/MultipleChoiceExample.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/MultipleChoiceExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/MultipleChoice_NumericalInput.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/MultipleChoice_NumericalInput.png
\ No newline at end of file
docs/en_us/olx/source/Images/NoMoreSubmissions.png 0 → 120000
../../../course_authors/source/Images/NoMoreSubmissions.png
\ No newline at end of file
docs/en_us/olx/source/Images/NumbericalInput_Complex.png 0 → 120000
../../../course_authors/source/Images/NumbericalInput_Complex.png
\ No newline at end of file
docs/en_us/olx/source/Images/NumericalInput_Complex.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/NumericalInput_Complex.png
\ No newline at end of file
docs/en_us/olx/source/Images/ORAComponentEditor.png 0 → 120000
../../../course_authors/source/Images/ORAComponentEditor.png
\ No newline at end of file
docs/en_us/olx/source/Images/ORA_Component.png 0 → 120000
../../../course_authors/source/Images/ORA_Component.png
\ No newline at end of file
docs/en_us/olx/source/Images/ORA_DuplicateWarning.png 0 → 120000
../../../course_authors/source/Images/ORA_DuplicateWarning.png
\ No newline at end of file
docs/en_us/olx/source/Images/ORA_ProblemName1.png 0 → 120000
../../../course_authors/source/Images/ORA_ProblemName1.png
\ No newline at end of file
docs/en_us/olx/source/Images/ORA_Prompt.png 0 → 120000
../../../course_authors/source/Images/ORA_Prompt.png
\ No newline at end of file
docs/en_us/olx/source/Images/ORA_Rubric.png 0 → 120000
../../../course_authors/source/Images/ORA_Rubric.png
\ No newline at end of file
docs/en_us/olx/source/Images/ORA_Settings.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/ORA_Settings.png
\ No newline at end of file
docs/en_us/olx/source/Images/ORA_Tasks.png 0 → 120000
../../../course_authors/source/Images/ORA_Tasks.png
\ No newline at end of file
docs/en_us/olx/source/Images/OpenEndedConsole_NewSubmissions.png 0 → 120000
../../../course_authors/source/Images/OpenEndedConsole_NewSubmissions.png
\ No newline at end of file
docs/en_us/olx/source/Images/OpenEndedPanel.png 0 → 120000
../../../course_authors/source/Images/OpenEndedPanel.png
\ No newline at end of file
docs/en_us/olx/source/Images/PA_StaffDebug_Location.png 0 → 120000
../../../course_authors/source/Images/PA_StaffDebug_Location.png
\ No newline at end of file
docs/en_us/olx/source/Images/PGI_CompEditor_Settings.png 0 → 120000
../../../course_authors/source/Images/PGI_CompEditor_Settings.png
\ No newline at end of file
docs/en_us/olx/source/Images/PGI_Single.png 0 → 120000
../../../course_authors/source/Images/PGI_Single.png
\ No newline at end of file
docs/en_us/olx/source/Images/Peer_ScoredResponse.png 0 → 120000
../../../course_authors/source/Images/Peer_ScoredResponse.png
\ No newline at end of file
docs/en_us/olx/source/Images/Periodic_Table.png 0 → 120000
../../../course_authors/source/Images/Periodic_Table.png
\ No newline at end of file
docs/en_us/olx/source/Images/PollExample.png 0 → 120000
../../../course_authors/source/Images/PollExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProbCompButton_Dropdown.png 0 → 120000
../../../course_authors/source/Images/ProbCompButton_Dropdown.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProbCompButton_Explanation.png 0 → 120000
../../../course_authors/source/Images/ProbCompButton_Explanation.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProbCompButton_MultChoice.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/ProbCompButton_MultChoice.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProbCompButton_MultipleChoice.png 0 → 120000
../../../course_authors/source/Images/ProbCompButton_MultipleChoice.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProbCompButton_NumInput.png 0 → 120000
../../../course_authors/source/Images/ProbCompButton_NumInput.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProbCompButton_TextInput.png 0 → 120000
../../../course_authors/source/Images/ProbCompButton_TextInput.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProbComponent_CheckboxIcon.png 0 → 120000
../../../course_authors/source/Images/ProbComponent_Checkboxicon.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProblemList-DemoCourse.png 0 → 120000
../../../course_authors/source/Images/ProblemList-DemoCourse.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProblemWithAdaptiveHintExample.png 0 → 120000
../../../course_authors/source/Images/ProblemWithAdaptiveHintExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProblemWrittenInLaTex.png 0 → 120000
../../../course_authors/source/Images/ProblemWrittenInLaTex.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProblemsYouHaveSubmitted.png 0 → 120000
../../../course_authors/source/Images/ProblemsYouHaveSubmitted.png
\ No newline at end of file
docs/en_us/olx/source/Images/ProteinBuilder.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/ProteinBuilder.png
\ No newline at end of file
docs/en_us/olx/source/Images/ResponseToGrade.png 0 → 120000
../../../course_authors/source/Images/ResponseToGrade.png
\ No newline at end of file
docs/en_us/olx/source/Images/TextInputExample.png 0 → 120000
../../../course_authors/source/Images/TextInputExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/ThreeAssmts_NoResponse.png 0 → 120000
../../../course_authors/source/Images/ThreeAssmts_NoResponse.png
\ No newline at end of file
docs/en_us/olx/source/Images/VitalSource.png 0 → 120000
../../../course_authors/source/Images/VitalSource.png
\ No newline at end of file
docs/en_us/olx/source/Images/WordCloudExample.png 0 → 120000
../../../course_authors/source/Images/WordCloudExample.png
\ No newline at end of file
docs/en_us/olx/source/Images/ZoomingImage_Modified.png 0 → 120000
../../../course_authors/source/Images/ZoomingImage_Modified.png
\ No newline at end of file
docs/en_us/olx/source/Images/Zooming_Image.png 0 → 120000
../../../course_authors/source/Images/Zooming_Image.png
\ No newline at end of file
docs/en_us/olx/source/Images/external-grader-correct.png 0 → 120000
../../../course_authors/source/Images/external-grader-correct.png
\ No newline at end of file
docs/en_us/olx/source/Images/external-grader-incorrect.png 0 → 120000
../../../course_authors/source/Images/external-grader-incorrect.png
\ No newline at end of file
docs/en_us/olx/source/Images/google_login.png 0 → 120000
../../../course_authors/source/Images/google_login.png
\ No newline at end of file
docs/en_us/olx/source/Images/hangout_static_page.png 0 → 120000
../../../course_authors/source/Images/hangout_static_page.png
\ No newline at end of file
docs/en_us/olx/source/Images/hangout_unit.png 0 → 120000
../../../course_authors/source/Images/hangout_unit.png
\ No newline at end of file
docs/en_us/olx/source/Images/image-modal-window.png 0 → 120000
../../../course_authors/source/Images/image-modal-window.png
\ No newline at end of file
docs/en_us/olx/source/Images/image-modal-zoomed.png 0 → 120000
../../../course_authors/source/Images/image-modal-zoomed.png
\ No newline at end of file
docs/en_us/olx/source/Images/image-modal.png 0 → 120000
../../../course_authors/source/Images/image-modal.png
\ No newline at end of file
docs/en_us/olx/source/Images/image-modeal-zoomed.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/image-modeal-zoomed.png
\ No newline at end of file
docs/en_us/olx/source/Images/image292.png 0 → 120000
../../../course_authors/source/Images/image292.png
\ No newline at end of file
docs/en_us/olx/source/Images/multiple-choice-shuffle-1.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/multiple-choice-shuffle-1.png
\ No newline at end of file
docs/en_us/olx/source/Images/multiple-choice-shuffle-2.png 0 → 120000
/Users/markhoeber/Documents/edx/edx-platform/docs/en_us/course_authors/source/Images/multiple-choice-shuffle-2.png
\ No newline at end of file
docs/en_us/olx/source/about/index.rst 0 → 100644
.. _The Course About Pages:
#################################
The Course About Pages
#################################
Use the chapters in this section to create the information prospective students
will see about your course.
.. toctree::
:maxdepth: 2
overview
short-description
\ No newline at end of file
docs/en_us/olx/source/about/overview.rst 0 → 100644
.. _Course Overview:
#################################
Course Overview
#################################
Each course must have an overview page. Students see the overview page when
searching and registering for the course.
*********************************************
Create the Overview File
*********************************************
You create an HTML file called ``overview.html`` in the ``overview`` directory.
*********************************************
Overview Sections
*********************************************
The ``overview.html`` must contain specific sections.
Each section is wrapped in ``section`` tags. The value of the ``class``
attribute specifies what the section is for and how it is displayed to
students. Within the ``section`` tags, you use valid HTML.
The overview must contain sections named the following:
* ``about``
* ``prerequisites``
* ``course-staff``
* ``teacher``
* ``faq``
.. _A Template For Course Overview:
************************************************
A Template For Your Course Overview
************************************************
Replace the placeholders in the following template with your information.
.. code-block:: html
<section class="about">
<h2>About This Course</h2>
<p>Include your long course description here. The long course description
should contain 150-400 words.</p>
<p>This is paragraph 2 of the long course description. Add more paragraphs
as needed. Make sure to enclose them in paragraph tags.</p>
<section>
<section class="prerequisites">
<h2>Prerequisites</h2>
<p>Add information about class prerequisites here.</p>
</section>
<section class="course-staff">
<h2>Course Staff</h2>
<article class="teacher">
<div class="teacher-image">
<!-- Replace the path below with the path to your faculty image. -->
<img src="/c4x/edX/edX101/asset/Placeholder_FacultyImage.jpg"
align="left" style="margin:0 20 px 0"/>
</div>
<h3>Staff Member</h3>
<p>Biography of instructor/staff member</p>
</article>
<article class="teacher">
<div class="teacher-image">
<img src="/c4x/edX/edX101/asset/Placeholder_FalcutyImage.jpg"/>
</div>
<h3>Staff Member Name</h3>
<p>Biography of instructor/staff member</p>
</article>
</section>
<section class="faq">
<section class="responses">
<h2>Frequently Asked Questions</h2>
<article class="response">
<h3>Do I need to buy a textbook?</h3>
<p>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.</p>
</article>
<article class="response">
<h3>Question 2?</h3>
<p>Answer 2.</p>
</article>
</section>
</section>
docs/en_us/olx/source/about/short-description.rst 0 → 100644
.. _Short Description:
#################################
Short Description
#################################
Optionally, you can define a short description for your course.
Students see the short description when they move their cursors over the course
image in the catalog.
*********************************************
Create the Short Description File
*********************************************
You create an HTML file called ``short_description.html`` in the ``overview``
directory.
The short description is limited to 150 characters.
Within that limit, you can add any text and HTML markup to the short
description file within that.
\ No newline at end of file
docs/en_us/olx/source/advanced-components/annotation.rst 0 → 100644
.. include:: ../../../shared/exercises_tools/annotation.rst
docs/en_us/olx/source/advanced-components/index.rst 0 → 100644
.. _Advanced Components:
#################################
Advanced Components
#################################
Use the chapters in this section to create advanced course components.
.. toctree::
:maxdepth: 2
annotation
lti_component
open_response_assessment
word_cloud
\ No newline at end of file
docs/en_us/olx/source/advanced-components/lti_component.rst 0 → 100644
.. include:: ../../../shared/exercises_tools/lti_component.rst
docs/en_us/olx/source/advanced-components/open_response_assessment.rst 0 → 100644
.. include:: ../../../shared/exercises_tools/open_response_assessment.rst
docs/en_us/olx/source/advanced-components/word_cloud.rst 0 → 100644
.. include:: ../../../shared/exercises_tools/word_cloud.rst
docs/en_us/olx/source/assets/assets.rst 0 → 100644
.. _Course Assets:
#################################
Course Assets
#################################
You must put all assets, or files that support your course, in the ``static``
directory. Assets include any image files, textbooks, handouts, and supporting
JavaScript files.
You must also define the asset in the assets policy file. See :ref:`Course
Asset Policy` for more information.
\ No newline at end of file
docs/en_us/olx/source/change_log.rst 0 → 100644
############
Change Log
############
*****************
September, 2014
*****************
.. list-table::
:widths: 10 70
:header-rows: 1
* - Date
- Change
* - 09/30/14
- Release of the *Alpha* version of this document.
docs/en_us/olx/source/components/discussion-components.rst 0 → 100644
#################################
Discussion Components
#################################
You can add inline discussion components to a vertical, or unit, in your
course.
See:
* `Create the XML File for a Discussion Component`_
* `Discussion Component XML File Elements`_
* `discussion Element Attributes`_
* `Example Discussion Component XML File`_
**********************************************
Create the XML File for a Discussion Component
**********************************************
You create an XML file in the ``discussion`` directory for each inline
discussion component in your course.
The name of the XML file must match the value of the @url_name attribute of the
``discussion`` element in the vertical XML file.
For example, if the vertical XML file contains:
.. code-block:: xml
<vertical display_name="Lesson_1_Unit_1">
<discussion url_name="Introduce_Yourself"/>
. . .
</vertical>
You create the file ``discussion/Introduce_Yourself.xml`` to define the inline
discussion component.
***************************************
Discussion Component XML File Elements
***************************************
The root element of the XML file for the HTML component is file is
``discussion``.
The ``discussion`` element contains not children.
*************************************
``discussion`` Element Attributes
*************************************
.. list-table::
:widths: 10 70
:header-rows: 1
* - Attribute
- Meaning
* - ``display_name``
- The value that is displayed to students as the name of the discussion
component.
* - ``discussion_category``
- The name of the category for the inline discussion as shown in the main
**Discussion** tab of the course.
* - ``for``
- A string that describes the discussion for students.
* - ``id``
- The unique identifier that the discussion forum service uses to refer to
this inline discussion component. This value must be unique across all
courses in the edX deployment. Therefore it is recommended that you use
the standard *<course_name>_<course_run>_<descriptor>* as in the above
example. Do not use a period (.) in the ID value.
* - ``discussion_id``
- ???
* - ``discussion_target``
- ???
*************************************
Example Discussion Component XML File
*************************************
The following example shows an XML file for a discussion component:
.. code-block:: xml
<discussion
discussion_category="Essays"
discussion_id="6e51dd8f181b44ffa6d91303a287ed3f"
discussion_target="Peer Grading"
display_name="Peer Grading"
/>
docs/en_us/olx/source/components/html-components.rst 0 → 100644
.. _HTML Components:
#################################
HTML Components
#################################
To add an HTML component to your course, you create both XML and HTML files.
See:
* `Create the XML File for an HTML Component`_
* `HTML Component XML File Elements`_
* `html Element Attributes`_
* `Example HTML Component XML File`_
* `Create the HTML File for an HTML Component`_
* `Example HTML Component Content`_
Both files, for each component, must be in the ``html`` directory.
*********************************************
Create the XML File for an HTML Component
*********************************************
You create an XML file in the ``html`` directory for each HTML component in your course.
The name of the XML file must match the value of the @url_name attribute of the ``html`` element in the vertical XML file.
For example, if the vertical XML file contains:
.. code-block:: xml
<vertical display_name="Lesson_1_Unit_1">
<html url_name="Introduction"/>
. . .
</vertical>
You create the file ``html/Introduction.xml`` to define the HTML component.
*************************************
HTML Component XML File Elements
*************************************
The root element of the XML file for the HTML component is file is ``html``.
The ``html`` element contains not children.
*************************************
``html`` Element Attributes
*************************************
.. list-table::
:widths: 10 70
:header-rows: 1
* - Attribute
- Meaning
* - ``display_name``
- The value that is displayed to students as the name of the HTML
component.
* - ``file_name``
- The name of the HTML file that contains the content for the HTML
component, without the ``.HTML`` extension.
*************************************
Example HTML Component XML File
*************************************
The following example shows an XML file for an HTML component:
.. code-block:: xml
<html filename="Introduction" display_name="Unit Introduction"/>
*********************************************
Create the HTML File for an HTML Component
*********************************************
You create an HTML file in the ``html`` directory for each HTML component in your course.
The name of the HTML file must match the value of the @file_name attribute of the ``html`` element in the component's XML file.
For example, if the component's XML file contains:
.. code-block:: xml
<html filename="Introduction" display_name="Unit Introduction"/>
You create the file ``html/Introduction.html`` to define the HTML component content.
*************************************
Example HTML Component Content
*************************************
In the component's HTML file, you add valid HTML to represent the content you
want to be displayed to students. For example, the following is from an HTML
file for the edX Demo course:
.. code-block:: html
<h2>Lesson 2: Let's Get INTERACTIVE!</h2>
<p>
<img
src="/static/interactive_x250.png" alt="Interactive" width="250"
hspace="12" vspace="12" border="0" align="right" />Now that you know your
way around an edX course let's look at some of the exciting interactive
tools you may encounter. Use the learning sequence above to explore.
&nbsp;</p>
<p>Once you have tried the interactive tools in this lesson,
make sure to check out the week 2 homework where we show you several of the
really cool interactive labs we&rsquo;ve created for past courses.
&nbsp;They&rsquo;re fun to play with. &nbsp;Many courses will have tools
and labs that you need to use to complete homework assignments.</p>
docs/en_us/olx/source/components/index.rst 0 → 100644
.. _Course Components:
#################################
Course Components
#################################
Use the chapters in this section to create course components.
.. toctree::
:maxdepth: 2
html-components
discussion-components
video-components
docs/en_us/olx/source/components/video-components.rst 0 → 100644
.. _Video Components:
#################################
Video Components
#################################
You can add video components to a vertical, or unit, in your course.
See:
* `Create the XML File for a Video Component`_
* `Video Component XML File Elements`_
* `video Element Attributes`_
* `Example Video Component XML File`_
**********************************************
Create the XML File for a Video Component
**********************************************
You create an XML file in the ``video`` directory for each video component in
your course.
The name of the XML file must match the value of the @url_name attribute of the
``video`` element in the vertical XML file.
For example, if the vertical XML file contains:
.. code-block:: xml
<vertical display_name="Lesson_1_Unit_1">
<video url_name="Introduction_Lecture"/>
. . .
</vertical>
You create the file ``video/Introduction_Lecture.xml`` to define the video
component.
*************************************
Video Component XML File Elements
*************************************
The root element of the XML file for the HTML component is file is ``video``.
The ``video`` element contains a single ``source`` element.
==============================
``source`` Element
==============================
The ``source`` element contains one attribute:
.. list-table::
:widths: 10 70
:header-rows: 1
* - Attribute
- Meaning
* - ``src``
- The file path for the video file.
*************************************
``video`` Element Attributes
*************************************
.. list-table::
:widths: 10 70
:header-rows: 1
* - Attribute
- Meaning
* - ``display_name``
- The value that is displayed to students as the name of the video
component.
* - ``youtube``
- The speed and ID pairings for the YouTube video source. The value can
contain multiple speed:ID pairs, separated by commas.
* - ``download_track``
- Whether students can download the video track. ``true`` or ``false``.
* - ``download_video``
- Whether students can download the video. ``true`` or ``false``.
* - ``html5_sources``
- The file path for the HTML5 version of the video.
* - ``show_captions``
- Whether students can view the video captions. ``true`` or ``false``.
* - ``source``
- ???
* - ``sub``
- ???
* - ``youtube_id_0_75``
- The YouTube ID for the video that plays at 75% normal speed.
* - ``youtube_id_1_0``
- The YouTube ID for the video that plays at 100% normal speed.
* - ``youtube_id_1_25``
- The YouTube ID for the video that plays at 125% normal speed.
* - ``youtube_id_1_5``
- The YouTube ID for the video that plays at 150% normal speed.
*************************************
Example Video Component XML File
*************************************
The following example shows an XML file for a discussion component:
.. code-block:: xml
<video
youtube="0.75:xGKlr7nT_Zw,1.00:o2pLltkrhGM,1.25:XGsB9bA6rGU,1.50:_HuIF16HdTA"
url_name="Introduction_Lecture"
display_name="Introduction Lecture"
download_video="true"
html5_sources="[&quot;https://s3.amazonaws.com/edx-course-videos/school/DemoCourseIntroductionVideo.mov&quot;]"
source=""
youtube_id_0_75="xGKlr7nT_Zw"
youtube_id_1_0="o2pLltkrhGM"
youtube_id_1_25="XGsB9bA6rGU"
youtube_id_1_5="_HuIF16HdTA">
<source src="https://s3.amazonaws.com/edx-course-videos/mit-6002x/6002-Tutorial-00010_100.mov"/>
</video>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment