diff --git a/source/_images/educator_references/pdf_embed.png b/source/_images/educator_references/pdf_embed.png new file mode 100644 index 000000000..a1113df91 Binary files /dev/null and b/source/_images/educator_references/pdf_embed.png differ diff --git a/source/educators/how-tos/course_development/exercise_tools/add_embedded_pdf.rst b/source/educators/how-tos/course_development/exercise_tools/add_embedded_pdf.rst new file mode 100644 index 000000000..02f822d07 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/add_embedded_pdf.rst @@ -0,0 +1,92 @@ +.. _Add Embedded PDF: + +############################## +Embedding PDFs in Your Course +############################## + +.. tags:: educator, how-to + +The PDF embed tool allows you to add PDF documents to your course. It uses an +the browser's built-in PDF viewing capability, and provides options for +downloading the document or its original source. + +.. image:: /_images/educator_references/pdf_embed.png + :alt: An embedded PDF showing trigonometry functions. + :width: 500 + +PDFs have significant accessibility challenges. They are finalized documents intended +for printing exactly specified copies. This makes them difficult for screen readers +and other assistance technology to interpret. You are strongly encouraged to +use alternative means of presenting the information in these documents, such as +a :ref:`text component`. Please visit the +:ref:`Accessibility Best Practices Checklist` for more information, which also +includes a guide on improving PDF accessibility if they must be used. + +Additionally, viewing PDFs on mobile devices results in a poor learner +experience. + +Nevertheless, the PDF embed block exists to handle the case of a document +being unavailable in other formats, or for when variations in representing the +document are unacceptable. + +*************************************** +Add an Embedded PDF in Open edX Studio +*************************************** + +#. Ensure the PDF embed tool is enabled in your course. + + To enable the pdf embed tool in Studio, add the ``"pdf"`` key to the + **Advanced Module List** on the **Advanced Settings** page. (Be sure to include + the quotation marks around the key value.) For more information, see + :ref:`Enable Additional Exercises and Tools`. + +#. On the Course Outline page, open the unit where you want to add the PDF. + +#. Under **Add New Component** click **Advanced** and then select **PDF**. + + The new component is added to the unit with a default example PDF embedded. + + .. image:: /_images/educator_references/pdf_embed.png + :alt: The PDF embed component in Studio. + :width: 400 + +#. In the new component, click the **Edit button, or pencil icon**. + +#. In the **Name** field, enter the name for the new component. This will be + displayed above the component as a title. + +#. In the **PDF URL** field, set the URL of the PDF you would like to embed. + + If you do not have an existing URL for your PDF, you may upload the PDF by + :ref:`adding a course file` and copy the + URL of the resulting handout. + +#. Toggle the **PDF Download Allowed** field to optionally display a + download link for the PDF. + + .. note:: + + PDF display is handled by the browser's built-in PDF viewer. The option to hide the download button will not hide the browser's built-in download button if it provides one. A determined learner will always be able to download a PDF. + + +#. In the **Source document URL** field, optionally add the URL to the source + of the PDF document. + + This might be, for instance, the PowerPoint or Word document this PDF is + based on. Providing a source URL is heavily encouraged, as source files + tend to have better accessibility than PDFs. Please visit the + :ref:`Accessibility Best Practices Checklist` for more information. + +#. In the **Source document button text** field, you can change the display + text of the source download link. + +#. Select **Save**. + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release | Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 09/02/2026 | Fox Piacenti | Verawood | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/navigation/content_creation_management.rst b/source/educators/navigation/content_creation_management.rst index c2bf7c30a..f5873730f 100644 --- a/source/educators/navigation/content_creation_management.rst +++ b/source/educators/navigation/content_creation_management.rst @@ -66,7 +66,7 @@ Manage Text Components .. toctree:: :maxdepth: 1 - :glob: + :glob: ../references/course_development/text_components/text_components.rst ../how-tos/course_development/text_components/manage_text.rst @@ -74,7 +74,7 @@ Manage Text Components ../how-tos/course_development/text_components/manage_latex.rst ../how-tos/course_development/exercise_tools/add_mathjax.rst ../how-tos/course_development/exercise_tools/manage_full_screen_image.rst - + .. _Add Video Components: Manage Video Components @@ -130,7 +130,7 @@ Add Mathjax :glob: ../references/course_development/exercise_tools/mathjax_studio.rst - + Add Tags ******************************************************* @@ -165,6 +165,15 @@ Google Drive Tool ../how-tos/course_development/exercise_tools/enable_google_drive_tool.rst ../how-tos/course_development/exercise_tools/add_google_drive.rst +Embed PDFs +******************************************************* + +.. toctree:: + :maxdepth: 1 + :glob: + + ../how-tos/course_development/exercise_tools/add_embedded_pdf.rst + Embed IFrames ******************************************************* @@ -213,7 +222,7 @@ initiative. .. toctree:: :maxdepth: 1 :glob: - + ../how-tos/course_development/migrate_legacy_libraries.rst ../concepts/instructional_design/libraries.rst ../how-tos/course_development/create_library.rst