Skip to content
This repository was archived by the owner on Mar 20, 2025. It is now read-only.

Commit bb1aa96

Browse files
mhoebermhoeber
committed
Birch Course Staff Guide
1 parent 12fa4c1 commit bb1aa96

File tree

109 files changed

+1358
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+1358
-5
lines changed

‎en_us/open_edx_course_authors/Makefile‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS ?=
6+
SPHINXBUILD ?= sphinx-build
7+
PAPER ?=
8+
BUILDDIR ?= build
9+
10+
# User-friendly check for sphinx-build
11+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12+
$(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/)
13+
endif
14+
15+
Q_FLAG =
16+
17+
ifeq ($(quiet), true)
18+
Q_FLAG = -Q
19+
endif
20+
21+
# Internal variables.
22+
PAPEROPT_a4 = -D latex_paper_size=a4
23+
PAPEROPT_letter = -D latex_paper_size=letter
24+
ALLSPHINXOPTS = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
25+
# the i18n builder cannot share the environment and doctrees with the others
26+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
27+
28+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
29+
30+
help:
31+
@echo "Please use \`make <target>' where <target> is one of"
32+
@echo " html to make standalone HTML files"
33+
@echo " dirhtml to make HTML files named index.html in directories"
34+
@echo " singlehtml to make a single large HTML file"
35+
@echo " pickle to make pickle files"
36+
@echo " json to make JSON files"
37+
@echo " htmlhelp to make HTML files and a HTML help project"
38+
@echo " qthelp to make HTML files and a qthelp project"
39+
@echo " devhelp to make HTML files and a Devhelp project"
40+
@echo " epub to make an epub"
41+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
42+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
43+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
44+
@echo " text to make text files"
45+
@echo " man to make manual pages"
46+
@echo " texinfo to make Texinfo files"
47+
@echo " info to make Texinfo files and run them through makeinfo"
48+
@echo " gettext to make PO message catalogs"
49+
@echo " changes to make an overview of all changed/added/deprecated items"
50+
@echo " xml to make Docutils-native XML files"
51+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
52+
@echo " linkcheck to check all external links for integrity"
53+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
54+
55+
clean:
56+
rm -rf $(BUILDDIR)/*
57+
58+
html:
59+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
60+
@echo
61+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
62+
63+
dirhtml:
64+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
65+
@echo
66+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
67+
68+
singlehtml:
69+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
70+
@echo
71+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
72+
73+
pickle:
74+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
75+
@echo
76+
@echo "Build finished; now you can process the pickle files."
77+
78+
json:
79+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
80+
@echo
81+
@echo "Build finished; now you can process the JSON files."
82+
83+
htmlhelp:
84+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
85+
@echo
86+
@echo "Build finished; now you can run HTML Help Workshop with the" \
87+
".hhp project file in $(BUILDDIR)/htmlhelp."
88+
89+
qthelp:
90+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
91+
@echo
92+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
93+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
94+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/getting_started.qhcp"
95+
@echo "To view the help file:"
96+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/getting_started.qhc"
97+
98+
devhelp:
99+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
100+
@echo
101+
@echo "Build finished."
102+
@echo "To view the help file:"
103+
@echo "# mkdir -p $$HOME/.local/share/devhelp/getting_started"
104+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/getting_started"
105+
@echo "# devhelp"
106+
107+
epub:
108+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
109+
@echo
110+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
111+
112+
latex:
113+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
114+
@echo
115+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
116+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
117+
"(use \`make latexpdf' here to do that automatically)."
118+
119+
latexpdf:
120+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121+
@echo "Running LaTeX files through pdflatex..."
122+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
123+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124+
125+
latexpdfja:
126+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
127+
@echo "Running LaTeX files through platex and dvipdfmx..."
128+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
129+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
130+
131+
text:
132+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
133+
@echo
134+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
135+
136+
man:
137+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
138+
@echo
139+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
140+
141+
texinfo:
142+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
143+
@echo
144+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
145+
@echo "Run \`make' in that directory to run these through makeinfo" \
146+
"(use \`make info' here to do that automatically)."
147+
148+
info:
149+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
150+
@echo "Running Texinfo files through makeinfo..."
151+
make -C $(BUILDDIR)/texinfo info
152+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
153+
154+
gettext:
155+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
156+
@echo
157+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
158+
159+
changes:
160+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
161+
@echo
162+
@echo "The overview file is in $(BUILDDIR)/changes."
163+
164+
linkcheck:
165+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
166+
@echo
167+
@echo "Link check complete; look for any errors in the above output " \
168+
"or in $(BUILDDIR)/linkcheck/output.txt."
169+
170+
doctest:
171+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
172+
@echo "Testing of doctests in the sources finished, look at the " \
173+
"results in $(BUILDDIR)/doctest/output.txt."
174+
175+
xml:
176+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
177+
@echo
178+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
179+
180+
pseudoxml:
181+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
182+
@echo
183+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎en_us/open_edx_course_authors/__init__.py‎

Whitespace-only changes.

‎en_us/open_edx_course_authors/source/Format Cheat Sheet.rstnouse‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
##################
2+
Format cheat sheet
3+
##################
4+
5+
Title: # above and below (as lines 1 and 3 above)
6+
7+
*********
8+
Heading 1
9+
*********
10+
11+
=========
12+
Heading 2
13+
=========
14+
15+
Heading 3
16+
*********
17+
18+
Heading 4
19+
=========
20+
21+
Heading 5
22+
^^^^^^^^^
23+
24+
************
25+
Image Format
26+
************
27+
28+
Image format, uses images as a reference from the soure/image file
29+
30+
.. image:: images/image029.png
31+
: width: 800
32+
33+
.. image:: images/image009.png
34+
:width: 800
35+
36+
****************
37+
Code Formatting
38+
****************
39+
40+
To set text in a "Code format"
41+
::
42+
-or-
43+
44+
.. code-block:: xml
45+
46+
(text in code-block:: xml is in different colors)
47+
48+
****************
49+
Table Formatting
50+
****************
51+
52+
With a header row
53+
54+
.. list-table::
55+
:widths: 15 15 70
56+
:header-rows: 1
57+
58+
* - First Name
59+
- Last Name
60+
- Residence
61+
* - Elizabeth
62+
- Bennett
63+
- Longbourne
64+
* - Fitzwilliam
65+
- Darcy
66+
- Pemberley
67+
68+
-- or --
69+
70+
With a bolded first column
71+
72+
.. list-table::
73+
:widths: 15 15 70
74+
:stub-columns: 1
75+
76+
* - First Name
77+
- Elizabeth
78+
- Fitzwilliam
79+
* - Last Name
80+
- Bennett
81+
- Darcy
82+
* - Residence
83+
- Longboure
84+
- Pemberley
85+
86+
*******************
87+
Cross-References
88+
*******************
89+
90+
For references to edX101 pages:
91+
92+
`Writing Exercises <https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/courseware/a45de3baa8a9468cbfb1a301fdcd7e86/d15cfeaff0af4dd7be4765cd0988d172/1>`_ has more in-depth discussion about problem types, and some general pedagogical considerations for adapting to the online format and a `Gallery of Response Types <https://edge.edx.org/accounts/login?next=/courses/edX/edX101/How_to_Create_an_edX_Course/courseware/a45de3baa8a9468cbfb1a301fdcd7e86/3ba055e760d04f389150a75edfecb844/1>`_
93+
94+
To cross reference between sections of a document
95+
96+
At the paragraph you are cross referencing:
97+
98+
. _Set-Grade-Brackets:
99+
100+
To make the cross reference in text:
101+
102+
see :ref:`Set Grade Brackets<Set-Grade-Brackets>`
103+
104+
To cross-reference a topic, but use your own text instead of the topic title,
105+
use the :ref: directive, but enter your own text followed by the topic anchor in
106+
angle brackets:
107+
108+
If you want to add a graded tool or exercise, add the tool as a
109+
:ref:`custom JavaScript problem<Custom JavaScript>` or an :ref:`LTI
110+
component<LTI Component>`.
111+
112+
(In this sentence, the text appears as "custom JavaScript problem" and
113+
"LTI component", and the linked-to topic titles are "Custom JavaScript
114+
Problem" and "LTI Component".)
115+
116+
External page reference
117+
118+
see `Create a Problem <http://site.Create_Problem.html>`_
119+
120+
121+
*******
122+
Tables
123+
*******
124+
125+
Example of a table with a cell that includes a bulleted list. The balnk lines before and after are critical.
126+
127+
.. list-table::
128+
:widths: 15 15 60
129+
:header-rows: 1
130+
131+
* - Field
132+
- Type
133+
- Details
134+
* - ``correct_map``
135+
- dict
136+
- For each problem ID value listed by ``answers``, provides:
137+
138+
* ``correctness``: string; 'correct', 'incorrect'
139+
* ``hint``: string; Gives optional hint. Nulls allowed.
140+
* ``hintmode``: string; None, 'on_request', 'always'. Nulls allowed.
141+
* ``msg``: string; Gives extra message response.
142+
* ``npoints``: integer; Points awarded for this ``answer_id``. Nulls allowed.
143+
* ``queuestate``: dict; None when not queued, else ``{key:'', time:''}``
144+
where ``key`` is a secret string dump of a DateTime object in the form
145+
'%Y%m%d%H%M%S'. Nulls allowed.
146+
147+
* - ``grade``
148+
- integer
149+
- Current grade value.
150+
* - ``max_grade``
151+
- integer
152+
- Maximum possible grade value.

‎en_us/open_edx_course_authors/source/building_course/course_files.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../shared/building_and_running_chapters/building_course/course_files.rst

‎en_us/open_edx_course_authors/source/building_course/course_rerun.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../shared/building_and_running_chapters/building_course/course_rerun.rst

‎en_us/open_edx_course_authors/source/building_course/creating_new_course.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../shared/building_and_running_chapters/building_course/creating_new_course.rst

‎en_us/open_edx_course_authors/source/building_course/establish_grading_policy.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../shared/building_and_running_chapters/building_course/establish_grading_policy.rst

‎en_us/open_edx_course_authors/source/building_course/export_import_course.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../shared/building_and_running_chapters/building_course/export_import_course.rst

‎en_us/open_edx_course_authors/source/building_course/handouts_updates.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../shared/building_and_running_chapters/building_course/handouts_updates.rst

‎en_us/open_edx_course_authors/source/building_course/index.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _Setting up Your Course Index:
2+
3+
##########################
4+
Setting up Your Course
5+
##########################
6+
7+
Use the chapters in this section to create and build your course.
8+
9+
For information on how to develop your course content in the Studio Outline
10+
page, see :ref:`Developing Your Course Index`.
11+
12+
.. toctree::
13+
:maxdepth: 2
14+
15+
creating_new_course
16+
provide_overview
17+
course_files
18+
handouts_updates
19+
pages
20+
textbooks
21+
establish_grading_policy
22+
course_rerun
23+
export_import_course

0 commit comments

Comments
 (0)