Skip to content

Commit

Permalink
FC-0068 docs: Reference cleaning by edunext openedx#3
Browse files Browse the repository at this point in the history
This PR corrects simple RST standard errors in some educator documentation references and erases one edX reference.
  • Loading branch information
Apgomeznext committed Dec 17, 2024
1 parent c8ef505 commit 4f63b98
Show file tree
Hide file tree
Showing 10 changed files with 149 additions and 188 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
.. _Dropdown Problem XML:

******************************
Dropdown Problem OLX Reference
******************************
##############################

.. tags:: educator, reference

========

Template
========
********

.. code-block:: xml
Expand Down Expand Up @@ -36,9 +35,9 @@ Template
</demandhint>
</problem>
========
Elements
========
********

For dropdown problems, the ``<problem>`` element can include this
hierarchy of child elements.
Expand All @@ -57,74 +56,65 @@ hierarchy of child elements.
In addition, standard HTML tags can be used to format text.

--------------------
====================
``<optionresponse>``
--------------------
====================

Required. Indicates that the problem is a dropdown problem.

^^^^^^^^^^
Attributes
^^^^^^^^^^

**Attributes:**


None.

^^^^^^^^
Children
^^^^^^^^

**Children:**


* ``<label>``
* ``<description>``
* ``<optioninput>``
* ``<solution>``

-----------
===========
``<label>``
-----------
===========

Required. Identifies the question or prompt. You can include HTML tags within
this element.

^^^^^^^^^^
Attributes
^^^^^^^^^^
**Attributes:**

None.

^^^^^^^^
Children
^^^^^^^^

**Children:**

None.

-----------------
=================
``<description>``
-----------------
=================

Optional. Provides clarifying information about how to answer the question. You
can include HTML tags within this element.

^^^^^^^^^^
Attributes
^^^^^^^^^^
**Attributes:**

None.

^^^^^^^^
Children
^^^^^^^^
**Children:**

None.

-----------------
=================
``<optioninput>``
-----------------
=================

Required. Designates an answer option.

^^^^^^^^^^
Attributes
^^^^^^^^^^
**Attributes:**

.. list-table::
:widths: 20 80
Expand All @@ -143,23 +133,19 @@ Attributes
- Used if the ``options`` attribute is set. Required. Indicates
which of the answer options is correct.

^^^^^^^^
Children
^^^^^^^^
**Children:**

* ``<option>``
* ``<optionhint>``

------------
============
``<option>``
------------
============

Designates an answer option. Either a set of ``<option>`` child elements or the
``options`` attribute for ``<optioninput>`` is required.

^^^^^^^^^^
Attributes
^^^^^^^^^^
**Attributes:**

.. list-table::
:widths: 20 80
Expand All @@ -175,68 +161,56 @@ Attributes
If the ``<option>`` element is used, ``<optionhint>`` is a child of
``<option>``.

----------------
================
``<optionhint>``
----------------
================

Optional. Specifies feedback for the answer.

^^^^^^^^^^
Attributes
^^^^^^^^^^
**Attributes:**

None.

^^^^^^^^
Children
^^^^^^^^
**Children:**

None.

--------------
==============
``<solution>``
--------------
==============

Optional. Identifies the explanation or solution for the problem, or for one of
the questions in a problem that contains more than one question.

This element contains an HTML division ``<div>``. The division contains one or
more paragraphs ``<p>`` of explanatory text.

----------------
================
``<demandhint>``
----------------
================

Optional. Specifies hints for the learner. For problems that include multiple
questions, the hints apply to the entire problem.

^^^^^^^^^^
Attributes
^^^^^^^^^^
**Attributes:**

None.

^^^^^^^^
Children
^^^^^^^^
**Children:**

``<hint>``

----------
==========
``<hint>``
----------
==========

Required. Specifies additional information that learners can access if needed.

^^^^^^^^^^
Attributes
^^^^^^^^^^
**Attributes:**

None.

^^^^^^^^
Children
^^^^^^^^
**Children:**

None.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _External Grader Problem Requirements:

**************************************
External Grader Problem Requirements
**************************************
####################################

.. tags:: educator, reference

Expand All @@ -17,19 +16,17 @@ An external grader problem in Studio must have the following requirements.

.. _GPG Key:

=======
GPG Key
=======
*******

Before you can add an external grader problem, you must obtain a public GNU
Privacy Guard (GPG) key. For information about how to obtain a GPG key, see the
`GnuPG website`_.

.. _XQueue Name:

===========
XQueue Name
===========
***********

The external grader problems in your course must use a specific XQueue name.
You create the name for the XQueue that your course uses when you request
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,12 @@ In this code:
based on the five gene editor problems in the MITx 7.00x course--for example,
if you want this problem to look like the second gene editor problem in the
7.00x course, you would set the **genex_problem_number** value to 2. The
number must be 1, 2, 3, 4, or 5.
number must be 1, 2, 3, 4, or 5.

.. seealso::

:class: dropdown

:ref:`Create Custom Javascript` (how to)

:ref:`Core Problem Types` (reference)
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
.. _Image Mapped Input Problem XML:

******************************
Image Mapped Input Problem XML
******************************
##############################

.. tags:: educator, reference

==========
Template
==========
********

.. code-block:: xml
Expand All @@ -26,9 +24,9 @@ Template
</problem>
=====
Tags
=====
****

* ``<imageresponse>``: Indicates that the problem is an image mapped input
problem.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,6 @@ For more information about how to use Studio as an LTI tool provider, see

:ref:`Enable_LTI_Components` (how to)

:ref:`LTI Component settings` (reference)
:ref:`LTI Component settings` (reference)

:ref:`Accessibility Best Practices for Course Content Development`
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _LTI Component settings:

**********************
LTI Component Settings
**********************
######################

.. tags:: educator, reference

Expand Down Expand Up @@ -44,7 +43,7 @@ LTI Component Settings
authentication flow. This can also be called *Login URL* on some tools.

* - LTI 1.3 Tool Public Key (LTI 1.3 only)
- The LTI 1.3 Tool's public key. This is a string that starts with
- The LTI 1.3 tool's public key. This is a string that starts with
'-----BEGIN PUBLIC KEY-----' and is required so that the LMS can check if
the messages and launch requests received have the signature from the tool.
This is not required when doing LTI 1.3 Launches without LTI Advantage.
Expand Down Expand Up @@ -161,7 +160,7 @@ LTI Component Settings
learners to interact with it.

* - Accept grades past deadline
- Specifies whether third party systems are allowed to post grades after
- Specifies whether third-party systems are allowed to post grades after
the deadline. By default, this value is set to **True**.

* - Request user's email
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Math Expression Input Problems

.. tags:: educator, reference

The math expression input problem type is a core problem type that can be added
The math expression input problem is a core problem type that can be added
to any course. At a minimum, math expression problems include a question or
prompt and a response field for a numeric answer.

Expand All @@ -27,9 +27,6 @@ appears below the response field. Unlike numerical input problems, which only
allow integers and a few select constants, math expression input problems can
include unknown variables and more complicated symbolic expressions.

For more information about how learners enter expressions, see
`Math Formatting`_ in the *Open edX Learner's Guide*.

.. note::
You can make a calculator tool available to your learners on every unit
page. For more information, see :ref:`Calculator`.
Expand All @@ -49,9 +46,9 @@ Studio`.
input problems can include complex numbers raised to fractional powers, or
positive non-complex numbers raised to fractional powers.

=====================================

Example Math Expression Input Problem
=====================================
*************************************

In the LMS, learners enter a value into a response field to complete a math
expression input problem. The following example shows a completed math
Expand Down
Loading

0 comments on commit 4f63b98

Please sign in to comment.