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: How-to cleaning by edunext #8 #713

Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,17 @@

.. _Add a Content Experiment in OLX:

****************************************
Add a Content Experiment in OLX
****************************************
################################

.. tags:: educator, how-to

You work with multiple XML files to configure a content experiment. This
section steps through the files involved in a content experiment that shows
different content to two different groups of learners.

=====================================================
Define the Content Experiment in the Sequential File
=====================================================
*****************************************************

You reference a content experiment in the file for the subsection, or
sequential, in the ``sequential`` directory. For example:
Expand All @@ -33,9 +31,9 @@ content experiment file in the ``split_test`` directory.
.. caution::
You can only define a content experiment in a unit, or vertical, in which different collections of components are associated with different experiment groups. You cannot define a content experiment at a subsection (sequential) or section (chapter) level and have different units or subsections associated with different groups.

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

Define the Experiment Content in the Split Test File
=====================================================
******************************************************

After you define the content experiment in the sequential file, you define the
course content you want to test in the file in the ``split_test`` directory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
.. experiments. We did not use an include because file structure differs in
.. the OLX guide and shared relative paths did not work. CT Nov 2015

##########################################
.. _Test Content Experiments:

Test Content Experiments
##########################################
###########################

.. tags:: educator, how-to

Expand Down Expand Up @@ -34,4 +35,21 @@ different experiment group of learners sees.
.. note:: The example course content in this section uses content experiment
terminology ("Welcome to Group A", for example) to make the functionality
clear. Typically, you would not use terminology in course content that would
make learners aware of the experiment.
make learners aware of the experiment.

.. seealso::
:class: dropdown

:ref:`Offering Differentiated Content` (concept)

:ref:`Overview of Content Experiments` (concept)

:ref:`Configure Your Course for Content Experiments` (how-to)

:ref:`Add a Content Experiment in OLX` (how-to)

:ref:`Create Content for Content Experiment Groups` (how-to)

:ref:`Create a Content Experiment` (how-to)

:ref:`Add Content Experiments to Your Course` (reference)
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
.. _Add Components to a Library:

Add Components to a Legacy Library
##################################

.. tags:: educator, how-to

To add new :ref:`components<Create and Manage Components>` to your library,
follow these steps.

#. Log in to Studio.

#. Select **Libraries**, then select the library that you want to add
components to.

#. Select **Add Component**, then select the component type that you want to
add under **Add New Component**.

For more information about the types of components you can add to a library,
see these topics.

* :ref:`Working with Text Components<working with text components>`
* :ref:`Working with Problem Components`
* :ref:`Working with Video Components`

After you add a component to a library, you can edit its settings. These
settings are retained when the component is selected from the library and used
in a course.

When a component from the library is used in a randomized content block, you
can further edit the component as it exists in the unit, without affecting the
original version in the library. For details, refer to :ref:`Edit Components in
a Library` and :ref:`Get the Latest Version of Library Content <Get the Latest Version of Library Content>`.


.. seealso::
:class: dropdown

:doc:`/community/release_notes/sumac/content_libraries_redesign_beta`

:ref:`Content Libraries Overview` (concept)

:ref:`Create a New Library` (how-to)

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

:ref:`View the Contents of a Library` (how-to)

:ref:`Edit Components in a Library` (how-to)

:ref:`Delete a Library` (how-to)

:ref:`Give Other Users Access to Your Library` (how to)

:ref:`Exporting and Importing a Library` (how to)
164 changes: 11 additions & 153 deletions source/educators/how-tos/course_development/create_library.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Create a New Legacy Library

.. tags:: educator, how-to

Use :ref:`legacy content libraries<Content Libraries>` to build a pool of components
Use :ref:`legacy content libraries<Content Libraries Overview>` to build a pool of components
that can be used in randomized assignments in your courses.

.. warning::
Expand Down Expand Up @@ -59,165 +59,23 @@ for the library. For information about adding other users to a library after
you create it, see :ref:`Give Other Users Access to Your Library`.


.. _Edit a Library:

*********************
Edit a Legacy Library
*********************

After you create a library, the only change you can make to the initial library
information is to the name. However, at any time, you can make changes to the
components in your library, including adding or deleting components or editing
the settings of components. For details about editing the contents of a
library, see :ref:`Edit Components in a Library` and :ref:`Add Components to a
Library`.

To change the name of a library, follow these steps.

#. Log in to Studio.

#. Select **Libraries**, then select the library whose name you want to edit.

#. Select the **Edit** icon next to the library name.

The library name field becomes editable.

.. image:: /_images/educator_how_tos/ContentLibrary_EditName.png
:alt: The Edit icon to the right of the Library Name.
:width: 300

#. In the library name field, make edits or enter a new library name.

#. Select anywhere outside the library name field to save your changes.

For details about giving other users access to the library, see :ref:`Give
Other Users Access to Your Library`.

.. _Add Components to a Library:

**********************************
Add Components to a Legacy Library
**********************************

To add new :ref:`components<Developing Course Components>` to your library,
follow these steps.

#. Log in to Studio.

#. Select **Libraries**, then select the library that you want to add
components to.

#. Select **Add Component**, then select the component type that you want to
add under **Add New Component**.

For more information about the types of components you can add to a library,
see these topics.

* :ref:`Working with Text Components<working with text components>`
* :ref:`Working with Problem Components`
* :ref:`Working with Video Components`

After you add a component to a library, you can edit its settings. These
settings are retained when the component is selected from the library and used
in a course.

When a component from the library is used in a randomized content block, you
can further edit the component as it exists in the unit, without affecting the
original version in the library. For details, refer to :ref:`Edit Components in
a Library` and :ref:`Get the Latest Version of Library Content <Get the Latest Version of Library Content>`.

.. _View the Contents of a Library:

*************************************
View the Contents of a Legacy Library
*************************************

To view the entire contents of a library in Studio, follow these steps.

#. Log in to Studio.

#. Select **Libraries**, then select the library whose components you want to
view.

#. Optionally, select **Hide Previews** at the top right of the library page to
collapse the component previews and see only the list of component display
names. To return to the full preview of components in the library, select
**Show Previews**.

The components in the library are shown in the order in which they were added,
with the most recently added at the bottom. If your library has more than 10
components, additional components are shown on other pages.

The range of the components shown on the current page, and the total number of
components, are shown at the top of the page.

You can navigate through the pages in the following ways.

* Use the **<** and **>** buttons at the top and bottom of the list to navigate
to the previous and next pages.

* At the bottom of the page, you can edit the first number in the page range.
Select the number to place your cursor in the field, then enter the page
number you want to jump to.

.. image:: /_images/educator_how_tos/file_pagination.png
:alt: Image showing a pair of page numbers with the first number circled.
:width: 300

To view the list of matching components in the library, see :ref:`View the
Matching Components in a Randomized Content Block`.

To view the randomized content that was assigned to a specific learner, see
:ref:`Specific Student View`.


.. _Edit Components in a Library:

***********************************
Edit Components in a Legacy Library
***********************************

After you have added components to a library, you can edit, duplicate, or
delete them.

For step-by-step instructions for editing, duplicating, or deleting components,
refer to the following topics.

* :ref:`Edit a Component`
* :ref:`Duplicate a Component`
* :ref:`Delete a Component`

.. note:: If you modify components in your library that are in use in a course,
these updates in the "source" library are not reflected in the course unless
you manually update the randomized content block in the course unit. For
details about updating library components used in your course to match the
latest version in the library, see :ref:`Get the Latest Version of Library
Content`.

.. _Delete a Library:

***********************
Delete a Legacy Library
***********************

You cannot delete a library. Instead, you can discontinue use of an unwanted
library. To do so, first make sure that none of its components are in use in
any courses, then delete all components in the library. You can also :ref:`edit
the name of the library<Edit a Library>` to make it clear to other course team
members that the library should not be used as a source of randomized
assignment content in courses.

For details about deleting components in a library, see :ref:`Edit Components
in a Library`.


.. seealso::
:class: dropdown

:doc:`/community/release_notes/sumac/content_libraries_redesign_beta`

:ref:`Content Libraries Overview` (concept)

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

:ref:`Add Components to a Library` (how-to)

:ref:`View the Contents of a Library` (how-to)

:ref:`Edit Components in a Library` (how-to)

:ref:`Delete a Library` (how-to)

:ref:`Give Other Users Access to Your Library` (how to)

:ref:`Exporting and Importing a Library` (how to)
40 changes: 40 additions & 0 deletions source/educators/how-tos/course_development/delete_library.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.. _Delete a Library:

Delete a Legacy Library
########################

.. tags:: educator, how-to

You cannot delete a library. Instead, you can discontinue use of an unwanted
library. To do so, follow the next steps:

#. First, make sure that none of its components are in use in
any courses.

#. Delete all components in the library.

#. :ref:`Edit the name of the library<Edit a Library>` to make it clear to other course team
members that the library should not be used as a source of randomized
assignment content in courses.


.. seealso::
:class: dropdown

:doc:`/community/release_notes/sumac/content_libraries_redesign_beta`

:ref:`Content Libraries Overview` (concept)

:ref:`Create a New Library` (how-to)

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

:ref:`Add Components to a Library` (how-to)

:ref:`View the Contents of a Library` (how-to)

:ref:`Edit Components in a Library` (how-to)

:ref:`Give Other Users Access to Your Library` (how to)

:ref:`Exporting and Importing a Library` (how to)
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.. _Edit Components in a Library:

Edit Components in a Legacy Library
####################################

.. tags:: educator, how-to

After you have :ref:`Add Components to a Library`, you can edit, duplicate, or
delete them.

For step-by-step instructions for editing, duplicating, or deleting components,
refer to the following topics.

* :ref:`Edit a Component`
* :ref:`Duplicate a Component`
* :ref:`Delete a Component`

.. note:: If you modify components in your library that are in use in a course,
these updates in the "source" library are not reflected in the course unless
you manually update the randomized content block in the course unit. For
details about updating library components used in your course to match the
latest version in the library, see :ref:`Get the Latest Version of Library
Content`.


.. seealso::
:class: dropdown

:doc:`/community/release_notes/sumac/content_libraries_redesign_beta`

:ref:`Content Libraries Overview` (concept)

:ref:`Create a New Library` (how-to)

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

:ref:`Add Components to a Library` (how-to)

:ref:`View the Contents of a Library` (how-to)

:ref:`Give Other Users Access to Your Library` (how to)

:ref:`Exporting and Importing a Library` (how to)
Loading