Skip to content

Commit

Permalink
Merge pull request #2083 from openedx/remove-LaTeX-section
Browse files Browse the repository at this point in the history
chore: remove unsupported latex docs
  • Loading branch information
jristau1984 committed Sep 26, 2022
2 parents 77a72f3 + ee8fa1b commit 9eb39fd
Showing 1 changed file with 36 additions and 27 deletions.
63 changes: 36 additions & 27 deletions en_us/shared/course_components/create_html_component.rst
Original file line number Diff line number Diff line change
Expand Up @@ -583,52 +583,61 @@ To change the size of your image, follow these steps.
If you want to change the image back to the original size, clear the values in
the **Width** and **Height** fields.


.. JRistau (26 Sept 2022) - LaTeX editor support was removed with the rollout of
.. the new Course Authoring based Text Editor. Coursegraph shows ~100 active
.. courses that have enabled the LaTeX advanced module, and we have had no
.. issues reported since rollout of the new text editor. The LaTeX component
.. is listed as “Unsupported” in studio (TNL-9993). For these reasons, edX PM
.. has decided to remove this section of our support documentation.
.. _Import LaTeX Code:

****************************************
Import LaTeX Code into a Text Component
****************************************
.. ****************************************
.. Import LaTeX Code into a Text Component
.. ****************************************
You can import LaTeX code into a Text component. You might do this, for
example, if you want to create "beautiful math" such as the math in the
following image.
.. You can import LaTeX code into a Text component. You might do this, for
.. example, if you want to create "beautiful math" such as the math in the
.. following image.
.. image:: ../../../shared/images/HTML_LaTeX_LMS.png
.. .. image:: ../../../shared/images/HTML_LaTeX_LMS.png
:alt: Math formulas created with LaTeX in a Text component.
.. warning::
.. .. warning::
The LaTeX processor that Studio uses to convert LaTeX code to XML is a third
party tool. We recommend that you use this feature with caution. If you use
the tool, make sure that you work with your partner manager.

==========================
Enable the LaTeX Processor
==========================
.. ==========================
.. Enable the LaTeX Processor
.. ==========================
The LaTeX processor is not enabled by default. To enable it, you have to change
the advanced settings in your course.
.. The LaTeX processor is not enabled by default. To enable it, you have to change
.. the advanced settings in your course.
#. In Studio, select **Settings**, and then select **Advanced Settings**.
.. #. In Studio, select **Settings**, and then select **Advanced Settings**.
#. In the field for the **Enable LaTeX Compiler** policy key, change **false**
.. #. In the field for the **Enable LaTeX Compiler** policy key, change **false**
to **true**.
#. At the bottom of the page, select **Save Changes**.
.. #. At the bottom of the page, select **Save Changes**.
==============================================
Add a Text Component that Contains LaTeX Code
==============================================
.. ==============================================
.. Add a Text Component that Contains LaTeX Code
.. ==============================================
When the LaTeX processor is enabled, you can create a Text component that
contains LaTeX code.
.. When the LaTeX processor is enabled, you can create a Text component that
.. contains LaTeX code.
#. In the unit where you want to create the component, select **Text** under
.. #. In the unit where you want to create the component, select **Text** under
**Add New Component**, and then select **E-text Written in LaTeX**. The new
component is added to the unit.
#. Select **Edit** to open the new component.
.. #. Select **Edit** to open the new component.
#. At the bottom of the component editor, select **Launch Latex Source
.. #. At the bottom of the component editor, select **Launch Latex Source
Compiler**.
The LaTeX editor opens.
Expand All @@ -637,16 +646,16 @@ contains LaTeX code.
:alt: The LaTeX editor.
:width: 500
#. Add your LaTeX code. To do this, complete either of the following
.. #. Add your LaTeX code. To do this, complete either of the following
procedures.
* In the **High Level Source Editing** field, add your LaTeX code.
* To upload a LaTeX file from your computer, select **Upload**.
#. Select **Save & Compile to edX XML**.
.. #. Select **Save & Compile to edX XML**.
#. On the unit page, select **Preview** to verify that your content looks
.. #. On the unit page, select **Preview** to verify that your content looks
correct in the LMS.
If you see errors, go back to the unit page. Select **Edit** to open the
Expand Down

0 comments on commit 9eb39fd

Please sign in to comment.