Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FC-0068 docs: reference and how-tos reviewed by edunext 22 #775

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/educators/how-tos/copy_paste_course_content.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Copy and Paste Course Content:

#############################
Copy and Paste Course Content
#############################

Expand All @@ -16,13 +15,13 @@ Copy and Paste Course Content

For instructions on unit-level copy/paste, see :doc:`copy_paste_units`

#. Choose a component that you would like to copy. This may be a text block, a video block or a problem block.
#. Choose a component you would like to copy. This may be a text block, a video block or a problem block.

#. In the “actions” hamburger in the upper right corner of the component block,
click “Copy to Clipboard”.

.. image:: /_images/educator_how_tos/copy_paste_three_dot_menu.png
:alt: A screenshot of the actions hamburger expanded to show the "Copy to Clipboard" option
:alt: A screenshot of the actions hamburger expanded to show the "Copy to Clipboard" option

#. A notification will appear in the bottom right-hand side of the screen indicating the copy is complete. It should only take a few seconds.

Expand All @@ -31,7 +30,7 @@ Copy and Paste Course Content
#. Click “paste component”.

.. image:: /_images/educator_how_tos/copy_paste_paste_component.png
:alt: A screenshot of the New Unit page showing the new Paste Component button at the bottom
:alt: A screenshot of the New Unit page showing the new Paste Component button at the bottom

.. note::

Expand All @@ -44,4 +43,5 @@ Copy and Paste Course Content
:class: dropdown

:ref:`Copy and Paste Course Units <Copy and Paste Course Units>` (how-to)

:ref:`Add Units to the Outline` (how-to)
115 changes: 6 additions & 109 deletions source/educators/how-tos/course_development/add_edit_components.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _Add a Component:

********************
Add a Component
********************
#################

.. tags:: educator, how-to

Expand All @@ -23,113 +22,11 @@ that you want to work with.
After you add a component, it is not visible to learners until you
:ref:`publish the unit<Publish a Unit>`.

.. _Edit a Component:
.. seealso::
:class: dropdown

********************
Edit a Component
********************

To edit a component, you select **Edit** in the component's title bar in
Studio.

.. image:: /_images/educator_how_tos/unit-edit.png
:alt: A component with the Edit icon indicated in the toolbar.
:width: 400

Then, follow instructions for the type of component you are editing.

After you edit a component, the changes are not visible to learners until you
:ref:`publish the unit<Publish a Unit>`.

.. _Set the Display Name for a Component:

=====================================
Set the Display Name for a Component
=====================================

The display name identifies the component. This name appears as a heading
above the component in the LMS, and it identifies the component for you in
reporting and analytics systems.

The following illustration shows the display name of a problem in Studio and in
the LMS.

.. image:: /_images/educator_how_tos/display_names_problem.png
:alt: The identifying display name for a problem in Studio, and the LMS.
:width: 800

Unique, descriptive display names help you and your learners identify
components quickly and accurately.

To set the display name for a component, follow these steps.

#. Edit the component. A dialog box opens.

* For a discussion or video component, the dialog box opens to the list of
settings, including the **Display Name** field.

* For an HTML or problem component, the dialog box opens to an editing view.
Select **Settings** to show the list of settings, including the **Display
Name** field.

#. Edit the **Display Name** field.

.. image:: /_images/educator_how_tos/display-name.png
:alt: The settings dialog box for a problem component.
:width: 500

#. Select **Save**.

Different types of components have different fields in the **Settings** dialog
box, but all of them have a **Display Name** field.


.. _Duplicate a Component:

**********************
Duplicate a Component
**********************

When you duplicate a component, a new copy of that component is added directly
beneath the first component. You can then modify the duplicate. In many cases,
duplicating a component and editing the copy is a faster way to create new
content.

To duplicate a component, select the **Duplicate** icon in the component
header.

.. image:: /_images/educator_how_tos/unit-dup.png
:alt: A unit with the Duplicate icon selected and highlighted.

Then, follow instructions for the type of component you are editing.

After you duplicate a component, the new component is not visible to learners
until you :ref:`publish the unit<Publish a Unit>`.

.. note:: Duplicating content experiments after you have configured them is not
supported.


.. _Delete a Component:

**********************
Delete a Component
**********************

.. caution::
Be sure you want to delete the component. You cannot undo the deletion.

To delete a component, follow these steps.

#. Select the **Delete** icon in the component header.

.. image:: /_images/educator_how_tos/unit-delete.png
:alt: A unit with the Delete icon circled.

2. When you receive the confirmation prompt, select **Yes, delete this
component**.

After you delete a component in Studio, the component remains visible to
learners until you :ref:`publish the unit<Publish a Unit>`.
:ref:`Edit a Component` (how-to)

:ref:`Duplicate a Component` (how-to)

:ref:`Delete a Component` (how-to)
29 changes: 29 additions & 0 deletions source/educators/how-tos/course_development/delete_component.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _Delete a Component:

Delete a Component
##################

.. caution::
Be sure you want to delete the component. You cannot undo the deletion.

To delete a component, follow these steps.

#. Select the **Delete** icon in the component header.

.. image:: /_images/educator_how_tos/unit-delete.png
:alt: A unit with the Delete icon circled.

2. When you receive the confirmation prompt, select **Yes, delete this
component**.

After you delete a component in Studio, the component remains visible to
learners until you :ref:`publish the unit<Publish a Unit>`.

.. seealso::
:class: dropdown

:ref:`Edit a Component` (how-to)

:ref:`Duplicate a Component` (how-to)

:ref:`Add a Component` (how-to)
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. _Duplicate a Component:

Duplicate a Component
#####################

When you duplicate a component, a new copy of that component is added directly
beneath the first component. You can then modify the duplicate. In many cases,
duplicating a component and editing the copy is a faster way to create new
content.

To duplicate a component, select the **Duplicate** icon in the component
header.

.. image:: /_images/educator_how_tos/unit-dup.png
:alt: A unit with the Duplicate icon selected and highlighted.

Then, follow instructions for the type of component you are editing.

After you duplicate a component, the new component is not visible to learners
until you :ref:`publish the unit<Publish a Unit>`.

.. note:: Duplicating content experiments after you have configured them is not
supported.

.. seealso::
:class: dropdown

:ref:`Edit a Component` (how-to)

:ref:`Add a Component` (how-to)

:ref:`Delete a Component` (how-to)
66 changes: 66 additions & 0 deletions source/educators/how-tos/course_development/edit_component.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
.. _Edit a Component:

Edit a Component
################

To edit a component, you select **Edit** in the component's title bar in
Studio.

.. image:: /_images/educator_how_tos/unit-edit.png
:alt: A component with the Edit icon indicated in the toolbar.
:width: 400

Then, follow instructions for the type of component you are editing.

After you edit a component, the changes are not visible to learners until you
:ref:`publish the unit<Publish a Unit>`.

.. _Set the Display Name for a Component:

Set the Display Name for a Component
************************************

The display name identifies the component. This name appears as a heading
above the component in the LMS, and it identifies the component for you in
reporting and analytics systems.

The following illustration shows the display name of a problem in Studio and in
the LMS.

.. image:: /_images/educator_how_tos/display_names_problem.png
:alt: The identifying display name for a problem in Studio, and the LMS.
:width: 800

Unique, descriptive display names help you and your learners identify
components quickly and accurately.

To set the display name for a component, follow these steps.

#. Edit the component; a dialog box opens.

* For a discussion or video component, the dialog box opens to the list of
settings, including the **Display Name** field.

* For an HTML or problem component, the dialog box opens to an editing view.
Select **Settings** to show the list of settings, including the **Display
Name** field.

#. Edit the **Display Name** field.

.. image:: /_images/educator_how_tos/display-name.png
:alt: The settings dialog box for a problem component.
:width: 500

#. Select **Save**.

Different types of components have different fields in the **Settings** dialog
box, but all of them have a **Display Name** field.

.. seealso::
:class: dropdown

:ref:`Add a Component` (how-to)

:ref:`Duplicate a Component` (how-to)

:ref:`Delete a Component` (how-to)
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
.. _Qualtrics Survey:

#########################
Qualtrics Survey Tool
#########################

.. tags:: educator, how-to

You can administer Qualtrics surveys to your learners in your edX course. The
You can administer Qualtrics surveys to your learners in your Open edX course. The
Qualtrics survey appears in an iframe inside the course.

.. image:: /_images/educator_how_tos/Qualtrics.png
Expand All @@ -19,7 +18,7 @@ from individual learners.
.. note:: To use a Qualtrics survey, you must have a Qualtrics license.
Qualtrics licenses are available for a fee at the `Qualtrics website
<http://www.qualtrics.com>`_. If you want to include a survey but you do not
have a Qualtrics license, you can use the :ref:`edX survey tool<Survey Tool>`
have a Qualtrics license, you can use the :ref:`Open edX survey tool<Survey Tool>`
or a :ref:`Google form<Google Drive Files Tool>`.

For more information, see the following sections.
Expand All @@ -33,7 +32,6 @@ accessible before making them available through your course. For more
information, see
:ref:`Accessibility Best Practices for Course Content Development`.

*************************************
Add a Qualtrics Survey to Your Course
*************************************

Expand All @@ -52,7 +50,7 @@ Create the Qualtrics Survey
<http://www.qualtrics.com>`_ for the most up-to-date Qualtrics documentation.

#. Using your Qualtrics account, create your survey.
#. Add the statements and options that you want the survey to include.
#. Add the statements and options you want the survey to include.
#. Add the **user ID** element. This element imports data from your course
into Qualtrics.

Expand Down Expand Up @@ -108,7 +106,7 @@ Create the Text Component in Studio
* Replace the values in the ``width`` and ``height`` attributes with values
that allow your survey to appear the way you want it to. For example, you
might change ``width`` to 800 and ``height`` to 1000.
* (Optional) If your survey might be taller than the value that you set for
* (Optional) If your survey might be taller than the value you set for
``height``, in the ``scrolling`` attribute, change the value to ``yes``.
If you do not change the value to ``yes`` and your survey is taller than
the ``height`` value, learners cannot scroll down to respond to all the
Expand Down
Loading