Skip to content

E
edx-platform
Commit 214091d3 by Alison Hodges
Options

Merge pull request #12467 from edx/ahodges/xrefs 

Updates and corrects href links to readthedocs
parents e5a5704b 95894da5
Showing with 53 additions and 56 deletions
common/lib/xmodule/xmodule/lti_module.py
...@@ -78,7 +78,7 @@ log = logging.getLogger(__name__) ...@@ -78,7 +78,7 @@ log = logging.getLogger(__name__)
DOCS_ANCHOR_TAG_OPEN = ( DOCS_ANCHOR_TAG_OPEN = (
"<a target='_blank' " "<a target='_blank' "
"href='http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/lti_component.html'>" "href='http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/lti_component.html'>"
) )
# Make '_' a no-op so we can scrape strings. Using lambda instead of # Make '_' a no-op so we can scrape strings. Using lambda instead of
......
common/lib/xmodule/xmodule/templates/problem/circuitschematic.yaml
...@@ -5,18 +5,18 @@ metadata: ...@@ -5,18 +5,18 @@ metadata:
data: | data: |
<problem> <problem>
<p> <p>
Circuit schematic problems allow students to create virtual circuits by Circuit schematic problems allow students to create virtual circuits by
arranging elements such as voltage sources, capacitors, resistors, and arranging elements such as voltage sources, capacitors, resistors, and
MOSFETs on an interactive grid. The system evaluates a DC, AC, or MOSFETs on an interactive grid. The system evaluates a DC, AC, or
transient analysis of the circuit. transient analysis of the circuit.
</p> </p>
<p> <p>
For more information, see For more information, see
<a href="http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/circuit_schematic_builder.html" target="_blank"> <a href="http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/circuit_schematic_builder.html" target="_blank">
Circuit Schematic Builder Problem</a> in <i>Building and Running an edX Course</i>. Circuit Schematic Builder Problem</a> in <i>Building and Running an edX Course</i>.
</p> </p>
<p> <p>
When you add the problem, be sure to select <strong>Settings</strong> When you add the problem, be sure to select <strong>Settings</strong>
to specify a <strong>Display Name</strong> and other values that apply. to specify a <strong>Display Name</strong> and other values that apply.
</p> </p>
<p>You can use the following example problems as models.</p> <p>You can use the following example problems as models.</p>
...@@ -32,7 +32,7 @@ data: | ...@@ -32,7 +32,7 @@ data: |
if response[0] == 'dc': if response[0] == 'dc':
for node in response[1:]: for node in response[1:]:
dc_value = node['output'] dc_value = node['output']
if dc_value == .5: if dc_value == .5:
correct = ['correct'] correct = ['correct']
else: else:
...@@ -61,14 +61,14 @@ data: | ...@@ -61,14 +61,14 @@ data: |
correct = ['incorrect'] correct = ['incorrect']
</answer> </answer>
</schematicresponse> </schematicresponse>
<solution> <solution>
<div class="detailed-solution"> <div class="detailed-solution">
<p>Explanation</p> <p>Explanation</p>
<p> <p>
You can form a voltage divider that evenly divides the input You can form a voltage divider that evenly divides the input
voltage with two identically valued resistors, with the sampled voltage with two identically valued resistors, with the sampled
voltage taken in between the two. voltage taken in between the two.
</p> </p>
<p><img src="/static/images/voltage_divider.png" alt=""/></p> <p><img src="/static/images/voltage_divider.png" alt=""/></p>
<p> <p>
......
common/lib/xmodule/xmodule/templates/problem/customgrader.yaml
...@@ -4,7 +4,7 @@ metadata: ...@@ -4,7 +4,7 @@ metadata:
markdown: !!null markdown: !!null
data: | data: |
<problem> <problem>
<p> <p>
In custom Python-evaluated input (also called "write-your-own-grader" In custom Python-evaluated input (also called "write-your-own-grader"
problems), the grader uses a Python script that you create and embed in problems), the grader uses a Python script that you create and embed in
the problem to evaluate a learner's response or provide hints. These the problem to evaluate a learner's response or provide hints. These
...@@ -12,7 +12,7 @@ data: | ...@@ -12,7 +12,7 @@ data: |
the most common write-your-own-grader problems. the most common write-your-own-grader problems.
</p> </p>
<p> <p>
You can use script tag format or answer tag format to create these problems. You can use script tag format or answer tag format to create these problems.
</p> </p>
<p> <p>
You can create custom Python-evaluated input problems that provide You can create custom Python-evaluated input problems that provide
...@@ -20,16 +20,16 @@ data: | ...@@ -20,16 +20,16 @@ data: |
also add images to the solution by using an HTML "img" tag. Note that also add images to the solution by using an HTML "img" tag. Note that
the "img" tag must be between the "div" tags that are inside the the "img" tag must be between the "div" tags that are inside the
"solution" tags, and that learners do not see these images until they "solution" tags, and that learners do not see these images until they
click the "Show Answer" button. click the "Show Answer" button.
</p> </p>
<p> For more information, see <a <p> For more information, see <a
href="http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/custom_python.html" target="_blank"> href="http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/custom_python.html" target="_blank">
Write-Your-Own-Grader Problem</a> in <i>Building and Running an edX Course</i>. Write-Your-Own-Grader Problem</a> in <i>Building and Running an edX Course</i>.
</p> </p>
<p>When you add the problem, be sure to select <strong>Settings</strong> <p>When you add the problem, be sure to select <strong>Settings</strong>
to specify a <strong>Display Name</strong> and other values that apply.</p> to specify a <strong>Display Name</strong> and other values that apply.</p>
<p>You can use the following example problem as a model.</p> <p>You can use the following example problem as a model.</p>
<p>______________________________________________________________________________</p> <hr />
<script type="loncapa/python"> <script type="loncapa/python">
...@@ -60,9 +60,9 @@ data: | ...@@ -60,9 +60,9 @@ data: |
<p>Explanation</p> <p>Explanation</p>
<p>Any set of integers on the line \(y = 10 - x\) and \(y = 20 - x\) satisfy these constraints.</p> <p>Any set of integers on the line \(y = 10 - x\) and \(y = 20 - x\) satisfy these constraints.</p>
<p>To add an image to the solution, use an HTML "img" tag. Make sure to include alt text.</p> <p>To add an image to the solution, use an HTML "img" tag. Make sure to include alt text.</p>
<img src="/static/images/placeholder-image.png" width="400" <img src="/static/images/placeholder-image.png" width="400"
alt="Description of image, with a primary goal of explaining its alt="Description of image, with a primary goal of explaining its
relevance to the problem or concept being illustrated for someone relevance to the problem or concept being illustrated for someone
who is unable to see the image."/> who is unable to see the image."/>
</div> </div>
</solution> </solution>
......
common/lib/xmodule/xmodule/templates/problem/drag_and_drop.yaml
...@@ -9,13 +9,13 @@ data: | ...@@ -9,13 +9,13 @@ data: |
In drag and drop problems, students respond to a question by dragging text or objects to a specific location on an image. In drag and drop problems, students respond to a question by dragging text or objects to a specific location on an image.
</p> </p>
<p> <p>
For more information, see For more information, see
<a href="http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/drag_and_drop.html" target="_blank"> <a href="http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/drag_and_drop_deprecated.html" target="_blank">
Drag and Drop Problem</a> in <i>Building and Running an edX Course</i>.</p> Drag and Drop Problem (Deprecated)</a> in <i>Building and Running an edX Course</i>.</p>
<p>When you add the problem, be sure to select <strong>Settings</strong> <p>When you add the problem, be sure to select <strong>Settings</strong>
to specify a <strong>Display Name</strong> and other values that apply.</p> to specify a <strong>Display Name</strong> and other values that apply.</p>
<p>You can use the following example problems as models.</p> <p>You can use the following example problems as models.</p>
<p>_____________________________________________________________________________</p> <hr />
<customresponse> <customresponse>
<h3>Simple Drag and Drop</h3> <h3>Simple Drag and Drop</h3>
<p>Drag each word in the scrollbar to the bucket that matches the number of letters in the word.</p> <p>Drag each word in the scrollbar to the bucket that matches the number of letters in the word.</p>
......
common/lib/xmodule/xmodule/templates/problem/formularesponse.yaml
...@@ -22,7 +22,7 @@ data: | ...@@ -22,7 +22,7 @@ data: |
<p> <p>
To create these problems, you use MathJax to change your plain text into To create these problems, you use MathJax to change your plain text into
"beautiful math." For more information about how to use MathJax in Studio, "beautiful math." For more information about how to use MathJax in Studio,
see <a href="http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/mathjax.html" target="_blank"> see <a href="http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/mathjax.html" target="_blank">
A Brief Introduction to MathJax in Studio</a> in <i>Building and Running an edx A Brief Introduction to MathJax in Studio</a> in <i>Building and Running an edx
Course</i>. Course</i>.
</p> </p>
......
common/lib/xmodule/xmodule/templates/problem/imageresponse.yaml
...@@ -9,14 +9,14 @@ data: | ...@@ -9,14 +9,14 @@ data: |
problem, students click inside a defined region in an image. You define this problem, students click inside a defined region in an image. You define this
region by including coordinates in the body of the problem. You can define region by including coordinates in the body of the problem. You can define
one rectangular region, multiple rectangular regions, or one non-rectangular one rectangular region, multiple rectangular regions, or one non-rectangular
region. For more information, see region. For more information, see
<a href="http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/image_mapped_input.html" target="_blank">Image Mapped Input <a href="http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/image_mapped_input.html" target="_blank">Image Mapped Input
Problem</a> in <i>Building and Running an edx Course</i>. Problem</a> in <i>Building and Running an edx Course</i>.
</p> </p>
<p>When you add the problem, be sure to select <strong>Settings</strong> <p>When you add the problem, be sure to select <strong>Settings</strong>
to specify a <strong>Display Name</strong> and other values that apply.</p> to specify a <strong>Display Name</strong> and other values that apply.</p>
<p>You can use the following example problem as a model.</p> <p>You can use the following example problem as a model.</p>
<p>What country is home to the Great Pyramid of Giza as well as the cities <p>What country is home to the Great Pyramid of Giza as well as the cities
of Cairo and Memphis? Click the country on the map below.</p> of Cairo and Memphis? Click the country on the map below.</p>
<imageresponse> <imageresponse>
......
common/lib/xmodule/xmodule/templates/problem/jsinput_response.yaml
...@@ -14,18 +14,19 @@ data: | ...@@ -14,18 +14,19 @@ data: |
edX grading system. edX grading system.
</p> </p>
<p> <p>
The JS Input problem that you create must use HTML, JavaScript, and cascading The JS Input problem that you create must use HTML, JavaScript, and
style sheets (CSS). You can use any application creation tool, such as the cascading style sheets (CSS). You can use any application creation tool,
Google Web Toolkit (GWT), to create your JS Input problem. such as the Google Web Toolkit (GWT), to create your JS Input problem.
</p> </p>
<p> <p>
For more information, see For more information, see
<a href="http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/custom_javascript.html" target="_blank"> <a href="http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/custom_javascript.html" target="_blank">
Custom JavaScript Problem</a> in <i>Building and Running an edX Course</i>. Custom JavaScript Problem</a> in <i>Building and Running an edX Course</i>.
</p> </p>
<p>JavaScript developers should also see <a href="http://edx.readthedocs.org/projects/edx-developer-guide/en/latest/extending_platform/javascript.html" target="_blank"> <p>JavaScript developers can also see
<a href="http://edx.readthedocs.io/projects/edx-developer-guide/en/latest/extending_platform/javascript.html" target="_blank">
Custom JavaScript Applications</a> in the <i>EdX Developer's Guide</i>.</p> Custom JavaScript Applications</a> in the <i>EdX Developer's Guide</i>.</p>
<p>When you add the problem, be sure to select <strong>Settings</strong> <p>When you add the problem, be sure to select <strong>Settings</strong>
to specify a <strong>Display Name</strong> and other values that apply.</p> to specify a <strong>Display Name</strong> and other values that apply.</p>
<p>You can use the following example problem as a model.</p> <p>You can use the following example problem as a model.</p>
...@@ -52,7 +53,7 @@ data: | ...@@ -52,7 +53,7 @@ data: |
''' '''
]]> ]]>
</script> </script>
<p>In the following image, click the objects until the cone is yellow <p>In the following image, click the objects until the cone is yellow
and the cube is blue.</p> and the cube is blue.</p>
<customresponse cfn="vglcfn"> <customresponse cfn="vglcfn">
<jsinput gradefn="WebGLDemo.getGrade" <jsinput gradefn="WebGLDemo.getGrade"
......
common/lib/xmodule/xmodule/templates/problem/latex_problem.yaml
...@@ -89,11 +89,11 @@ metadata: ...@@ -89,11 +89,11 @@ metadata:
data: | data: |
<?xml version="1.0"?> <?xml version="1.0"?>
<problem showanswer="closed" rerandomize="never" weight="10" display_name="lec1_Q2"> <problem showanswer="closed" rerandomize="never" weight="10" display_name="lec1_Q2">
<p>If you have a problem that is already written in LaTeX, you can use this problem type to <p>If you have a problem that is already written in LaTeX, you can use this problem type to
easily convert your code into XML. After you paste your code into the LaTeX editor, easily convert your code into XML. After you paste your code into the LaTeX editor,
you only need to make a few minor adjustments.</p> you only need to make a few minor adjustments.</p>
<p>For more information, see <p>For more information, see
<a href="http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/problem_in_latex.html" target="_blank"> <a href="http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/problem_in_latex.html" target="_blank">
Problem Written in LaTeX</a> in <i>Building and Running an edX Course</i>.</p> Problem Written in LaTeX</a> in <i>Building and Running an edX Course</i>.</p>
<p>You can use the following example problems as models.</p> <p>You can use the following example problems as models.</p>
<p><strong>Example Option Problem</strong></p> <p><strong>Example Option Problem</strong></p>
...@@ -225,4 +225,4 @@ data: | ...@@ -225,4 +225,4 @@ data: |
</tbody> </tbody>
</table> </table>
</p> </p>
</problem> </problem>
\ No newline at end of file
common/lib/xmodule/xmodule/templates/problem/numericalresponse.yaml
...@@ -12,12 +12,12 @@ metadata: ...@@ -12,12 +12,12 @@ metadata:
>>How many miles away from Earth is the sun? Use scientific notation to answer.<< >>How many miles away from Earth is the sun? Use scientific notation to answer.<<
= 9.3*10^7 = 9.3*10^7
or= 9.296*10^7 or= 9.296*10^7
>>The square of what number is -100?<< >>The square of what number is -100?<<
= 10*i = 10*i
[explanation] [explanation]
The sun is 93,000,000, or 9.3*10^7, miles away from Earth. The sun is 93,000,000, or 9.3*10^7, miles away from Earth.
...@@ -32,12 +32,10 @@ data: | ...@@ -32,12 +32,10 @@ data: |
that learners can see below the response field.</p> that learners can see below the response field.</p>
<p>The system can handle several types of characters, including basic <p>The system can handle several types of characters, including basic
operators, fractions, exponents, and common constants such as i. You can operators, fractions, exponents, and common constants such as i. You can
refer learners to refer learners to
<a href="http://edx.readthedocs.org/projects/edx-guide-for-students/en/latest/SFD_mathformatting.html" target="_blank"> <a href="http://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/completing_assignments/SFD_mathformatting.html#math-formatting" target="_blank">Entering Mathematical and Scientific Expressions</a> in the <i>EdX Learner's Guide</i> for information about how to enter text into the field.</p>
Entering Mathematical and Scientific Expressions</a> in the <i>edX Guide for <p>When you add the problem, be sure to select <strong>Settings</strong>
Students</i> for information about how to enter text into the field.</p>
<p>When you add the problem, be sure to select <strong>Settings</strong>
to specify a <strong>Display Name</strong> and other values that apply.</p> to specify a <strong>Display Name</strong> and other values that apply.</p>
<p>You can use the following example problems as models.</p> <p>You can use the following example problems as models.</p>
...@@ -57,4 +55,4 @@ data: | ...@@ -57,4 +55,4 @@ data: |
<p>-100 is the square of 10 times the imaginary number, i.</p> <p>-100 is the square of 10 times the imaginary number, i.</p>
</div> </div>
</solution> </solution>
</problem> </problem>
\ No newline at end of file
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