Skip to content

Commit

Permalink
Add in remaining content tagging educator's articles from Redwood (#608)
Browse files Browse the repository at this point in the history
* Add Content Tagging educators how-to articles

* Add Concept doc on taxonomy import tag IDs
  • Loading branch information
sarina authored Nov 13, 2024
1 parent d6685d9 commit 86ed268
Show file tree
Hide file tree
Showing 25 changed files with 414 additions and 10 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
.. _tag-ids-for-taxonomy-import:

Why does each tag need an ID when importing a taxonomy?
#######################################################

When creating a taxonomy via import, or updating one via re-import, the “id”
column is required. In addition, it must be unique for every row. There are two
reasons why such IDs are required.

Renaming tags
*************

First, the IDs allow you to rename tags. When you upload a new version of the
taxonomy, the IDs are compared to determine when a tag has been renamed or
deleted.

For example, if you uploaded this taxonomy and used it to tag content in your
courses:

+---------------+--------------------------------------------------------------+
| **ID** | **Value** |
+---------------+--------------------------------------------------------------+
| 1 | *Untied* States |
+---------------+--------------------------------------------------------------+
| 3 | *Canadia* |
+---------------+--------------------------------------------------------------+

Then you fixed the spelling to create this new version of the taxonomy, and re-imported it:

+---------------+--------------------------------------------------------------+
| **ID** | **Value** |
+---------------+--------------------------------------------------------------+
| 1 | United States |
+---------------+--------------------------------------------------------------+
| 17 | Canada |
+---------------+--------------------------------------------------------------+

You would find that your "*Untied* States" content would be properly tagged as
"United States", while your "*Canadia*" content would be entirely untagged. Why?

Because the ID of the first tag is the same (1), any content that was tagged
with “*Untied* States” will now be fixed to show “United States”. But because the
ID of the second tag has been changed, it is treated as a totally new tag - all
instances of the *"Canadia"* tag will be deleted, and a new “Canada” tag will be
created in the taxonomy, but no content will have that tag yet.

By keeping the ID the same (or not), you can control what will happen with new
versions of the taxonomy - adding, renaming, moving, and deleting tags as
needed. (Note that during the re-import workflow, you'll get a chance to preview
what changes will be applied before you finalize the update. That's a good time
to double-check that the right thing - rename or delete - is about to happen.)

If in doubt, a good rule of thumb is to **never change the ID once a tag has been
created**, unless you're certain you want to delete all occurrences of that tag
and re-create a new similar tag from scratch.

Matching external systems/taxonomies
************************************

Secondly, the IDs can be used to keep your taxonomy in sync with an external
system.

For example, you could have an airports taxonomy:

+---------------+--------------------------------------------------------------+
| **ID** | **Value** |
+---------------+--------------------------------------------------------------+
| ORD | Chicago O'Hare International Airport |
+---------------+--------------------------------------------------------------+
| LAS | Harry Reid International Airport |
+---------------+--------------------------------------------------------------+
| LAX | Los Angeles International Airport |
+---------------+--------------------------------------------------------------+
| BOS | Boston Logan International Airport |
+---------------+--------------------------------------------------------------+

In this case, using the airport codes as the ID makes it easy to align the tags
with other systems that reference airports, accounting for the fact that some
airport names may be different (e.g. the Boston airport may be called “General
Edward Lawrence Logan International Airport” or “Logan Airport”; the “Harry Reid
International Airport in Las Vegas” was previously known as “McCarran
International Airport”; etc.)

As another example, learning outcome standards often have unique identifiers
assigned to individual concepts. For example, the mathematics skill “`Extend The
Properties Of Exponents To Rational Exponents`_” has the ID “HS.N-RN.A.1“, which
can be used to cross-reference it across various systems and publications. If
you are creating a taxonomy related to learning outcomes, you can use these
unique identifiers as the IDs.

.. _Extend The Properties Of Exponents To Rational Exponents: https://tools.achievethecore.org/coherence-map/HS/N/118/633/632/
Original file line number Diff line number Diff line change
@@ -1,28 +1,46 @@
.. _create-flat-taxonomy:

#########################################
Create a flat taxonomy by uploading a CSV
#########################################

.. tags:: educator, how-to

Tags that can be applied to content are organized into hierarchical taxonomies. Currently, the only way to create or modify a taxonomy is by uploading a CSV or JSON file.
Tags that can be applied to content are organized into hierarchical taxonomies.
Currently, the only way to create or modify a taxonomy is by uploading a CSV or
JSON file.

The simplest type of taxonomy is a flat taxonomy that doesn’t have any hierarchy. For example, if you want to tag the “difficulty” of problems as either “Easy”, “Medium”, or “Hard”, you could do that by creating a flat taxonomy. Here’s how to do that:
The simplest type of taxonomy is a flat taxonomy that doesn't have any
hierarchy. For example, if you want to tag the “difficulty” of problems as
either “Easy”, “Medium”, or “Hard”, you could do that by creating a flat
taxonomy. Here's how to do that:

#. Open any spreadsheet application (Excel, Numbers, Google Sheets, etc.) and create a new blank spreadsheet. In the first row, add two columns called **id** and **value**.
#. Open any spreadsheet application (Excel, Numbers, Google Sheets, etc.) and
create a new blank spreadsheet. In the first row, add two columns called
**id** and **value**.

.. image:: /_images/educator_how_tos/ctag_create_taxonomy_step1.png
:alt: Screenshot showing new blank spreadsheet with one row and two columns, the first column called id and the second called value.

#. Below that, enter the new tags that you want to create in the “value” column, and give each tag an ID in the “id” column. The “id” for each tag is required, but mostly relevant when you are aligning your taxonomy with some external system that uses IDs for each tag. If you don’t have that use case, just enter the same text for the id as for the value.
#. Below that, enter the new tags that you want to create in the “value” column,
and give each tag an ID in the “id” column. The “id” for each tag is
required, but mostly relevant when you are aligning your taxonomy with some
external system that uses IDs for each tag. If you don't have that use case,
just enter the same text for the id as for the value.

.. image:: /_images/educator_how_tos/ctag_create_taxonomy_step2.png
:alt: Screenshot showing a spreadsheet with two columns, the first column called id and the second called value. The same tag values are populated in the id column and the value column.

#. Save the spreadsheet using the default format, in case you want to edit it later.
#. Save the spreadsheet using the default format, in case you want to edit it
later.
#. Export the spreadsheet to a CSV file.

#. In Excel, use File > Save As…, and set the “File format” to “CSV UTF-8 (comma-delimited) (.csv)” (preferred) or “Comma Separated Values (.csv)” then enter a filename and save it.
#. In Excel, use File > Save As…, and set the “File format” to “CSV UTF-8
(comma-delimited) (.csv)” (preferred) or “Comma Separated Values (.csv)”
then enter a filename and save it.
#. In Google Sheets, use File > Download > Comma Separated Values (.csv).
#. In Numbers, use File > Export To > CSV… and use the default options.

#. Import the taxonomy following `How-To: Import and export a taxonomy <https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4154490883/How-to+Import+and+export+a+taxonomy>`_ guide.
#. Import the taxonomy following `How-To: Import and export a taxonomy
<https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4154490883/How-to+Import+and+export+a+taxonomy>`_
guide.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _add-tags-to-a-course:

##############################
Add and delete tags on courses
##############################
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
Add and delete tags on course content
#####################################

.. note::

Tags can be added to course content from three places in Studio: From the
Course Outline Page, from the Unit Page, and from individual Component
Blocks.

.. note::

Tags can be added to all four levels of the course outline: Sections,
Subsections, Units and Component Blocks. Tags do not inherit from one level
of the course to another. In other words, when a tag is added to a unit, it
is not added to the subsection that the unit is in. Likewise, if a tag is
added to a unit, it is not added to the components within.

For instructions on how to add tags to full courses, see
:ref:`add-tags-to-a-course`

Adding Tags from the Course Outline Page
****************************************

#. Choose a section, a subsection or a unit that you would like to add tags to.

#. In the 3-dot menu in the upper right corner of the content block, click
“Manage Tags”.

.. image:: /_images/educator_how_tos/ctag_course_tag_step1a_dropdown.png
:alt: Screenshot of clicking Manage tags from the hamburger menu.

#. The tag drawer will open.

.. image:: /_images/educator_how_tos/ctag_course_tag_step1b.png
:alt: Screenshot of tag drawer opening.

#. Click “Edit Tags”.

#. Click in the “Add a tag” field in any taxonomy from which you'd like to
choose tags. (For instructions on how to add and enable a taxonomy, see
:ref:`import-export-taxonomy`).

.. image:: /_images/educator_how_tos/ctag_course_tag_step3.png
:alt: Screenshot of clicking in the Add a tag field.

#. If you know the tag you would like to add, start typing the tag in the “Add a
tag” field and potential matches will display.

.. image:: /_images/educator_how_tos/ctag_course_tag_step4.png
:alt: Screenshot of field matches displaying beneath the Add a tag field.

#. If you don't know the tag you would like to add, scroll through the list of tags until you find the tag you would like to add.

.. note::

Tags may be nested as subtags, and that clicking on the arrows will open any nested tags.

.. image:: /_images/educator_how_tos/ctag_course_tag_step5.png
:alt: Screenshot of arrows next to tags with nested subtags.

#. Once you have decided which tag you would like to add, click on the checkbox
next to the tag. Add as many tags as you would like.

.. note::

Choosing a nested tag will automatically add its parent tag(s) as well.

.. image:: /_images/educator_how_tos/ctag_course_tag_step6.png
:alt: Screenshot of parent tags being automatically added.

#. When you are finished, click “Add tags”. You will see the newly added tags in the tag drawer view.

.. image:: /_images/educator_how_tos/ctag_course_tag_step7.png
:alt: Screenshot of added tags in the tag drawer.

#. Click save and close out of the tag drawer. You will see the tag count
updated in the content block.

.. image:: /_images/educator_how_tos/ctag_course_tag_step8_card.png
:alt: Screenshot of the tag count under the Course tags field.

Deleting tags from the Course Outline Page
******************************************

#. Choose a section, a subsection or a unit that you would like to delete tags
from.

#. In the 3-dot menu in the upper right corner of the content block, click
“Manage Tags”, OR, Click on the tag icon/tag count. The tag drawer will open.

#. Click “edit tags”.

#. Click the “x” button next to the tag you wish to delete.

.. warning::

If you delete a tag that is nested underneath another tag, all tags in the hierarchy will delete.

.. image:: /_images/educator_how_tos/ctag_course_tag_del_step3.png
:alt: Screenshot of x button next to tag.

#. Click “save” and close the tag drawer. You will see the tag count updated in
the content block.

Adding/deleting tags from the Unit Page
***************************************

#. Click on the “Manage Tags” button from the Unit tags widget in the right
sidebar. The tag drawer will open.

.. image:: /_images/educator_how_tos/ctag_add_delete_unit_page.png
:alt: Screenshot of tag drawer opening.

#. Continue steps 2-9 from above.

Adding/deleting tags from a Component Block
*******************************************

#. Choose a component that you would like to add tags to.

#. In the 3-dot menu in the upper right corner of the content block, click
“Manage Tags”. The tag drawer will open.

#. Continue steps 3-9 from above.
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
.. _build-taxonomy-using-template:

#################################
Build a taxonomy using a template
#################################

.. tags:: educator, how-to

Tags that can be applied to content are organized into hierarchical taxonomies. Currently, the only way to create or modify a taxonomy is by uploading a CSV or JSON file.
Tags that can be applied to content are organized into hierarchical taxonomies.
Currently, the only way to create or modify a taxonomy is by uploading a CSV or
JSON file.

The simplest type of taxonomy is a flat taxonomy that doesn’t have any hierarchy - see `“How-to: Create a flat taxonomy by uploading a CSV” <Create_flat_taxonomy_by_uploading_CSV.rst>`_ for a simpler procedure to create such a flat taxonomy. For the purposes of this guide, we’ll assume you want to create a taxonomy of cities, like this:
The simplest type of taxonomy is a flat taxonomy that doesn't have any hierarchy -
see :ref:`create-flat-taxonomy` for a simpler procedure to create
such a flat taxonomy. For the purposes of this guide, we'll assume you want to
create a taxonomy of cities, like this:

* United States

Expand Down Expand Up @@ -92,4 +99,4 @@ The simplest type of taxonomy is a flat taxonomy that doesn’t have any hierarc
* In Google Sheets, use File > Download > Comma Separated Values (.csv).
* In Numbers, use File > Export To > CSV… and use the default options.

* Import your taxonomy following the `How-to: Import and export a taxonomy guide <https://openedx.atlassian.net/l/cp/axcFGD1Q>`_.
* Import your taxonomy following the How To :ref:`import-export-taxonomy`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
.. _import-export-taxonomy:

Import and Export A Taxonomy
############################

Taxonomies can be imported via the Taxonomies Dashboard, accessible via Studio
Home.

.. image:: /_images/educator_how_tos/taxonomies_studio_home.png
:alt: The location of the Taxonomies tab on the Studio homepage is at the same level as the Courses and Libraries tabs.

.. note::

Taxonomies can be imported as either CSV or JSON files. For instructions on
how to build a taxonomy by using a taxonomy template, see
:ref:`build-taxonomy-using-template`.

Import a new taxonomy
*********************

#. Navigate to the Taxonomies page and click “Import”.

#. You will be prompted to choose a file from your local machine. Choose your
taxonomy file and click “open”.

#. You will be prompted to add a name for your taxonomy. Add a name and click
:guilabel:`OK`.

.. image:: /_images/educator_how_tos/taxonomies_new_name_prompt.png
:alt: A screenshot showing the pop up dialog box prompting for an entry of a new name

#. You will be prompted to add a description for your taxonomy. Add a
description and click :guilabel:`OK`.

.. image:: /_images/educator_how_tos/taxonomies_new_name_description.png
:alt: A screenshot showing the pop up dialog box prompting for an entry of a description for the new taxonomy

#. You will see an indicator in the lower righthand screen indicating that the
import is underway. Once the import is complete, you will receive a
notification. Click :guilabel:`OK`.

.. image:: /_images/educator_how_tos/taxonomies_import_successful.png
:alt: A screenshot showing the pop up dialog box indicating the import was successful with the text, "Taxonomy imported successfully"

#. To view your newly imported taxonomy, find the taxonomy card in your taxonomy
listing and click the title. You will see your taxonomy and all its
associated tags in the taxonomy view page.

.. image:: /_images/educator_how_tos/taxonomies_view_single_taxonomy_tags.png
:alt: A screenshot showing a single taxonomy and its nested tags

Export a taxonomy
*****************

#. Find the taxonomy you wish to export from the Taxonomy Listing Page.

#. Click on the three-dot menu and click on :guilabel:`Export`.

.. image:: /_images/educator_how_tos/taxonomies_three_dot_export.png
:alt: A screenshot showing the "Export" option available from the hamburger menu on one specific taxonomy card.

#. Select the file format you wish to export in.

#. Click :guilabel:`Export`. The file will export to your local machine.
Loading

0 comments on commit 86ed268

Please sign in to comment.