Skip to content

Commit b01b1fd

Browse files
Kelketeksarina
authored andcommitted
docs: address notes on pdf embeds
1 parent 8832899 commit b01b1fd

4 files changed

Lines changed: 38 additions & 88 deletions

File tree

source/educators/concepts/advanced_features/pdf_embed.rst

Lines changed: 0 additions & 45 deletions
This file was deleted.

source/educators/how-tos/course_development/exercise_tools/add_embedded_pdf.rst

Lines changed: 38 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,44 @@
11
.. _Add Embedded PDF:
22

3-
Add an Embedded PDF in Open edX Studio
4-
#######################################
3+
##############################
4+
Embedding PDFs in Your Course
5+
##############################
56

67
.. tags:: educator, how-to
78

8-
#. Ensure the PDF embed tool is :ref:`enabled in your course<Enable PDF Embed Tool>`.
9+
The PDF embed tool allows you to add PDF documents to your course. It uses an
10+
the browser's built-in PDF viewing capability, and provides options for
11+
downloading the document or its original source.
12+
13+
.. image:: /_images/educator_references/pdf_embed.png
14+
:alt: An embedded PDF showing trigonometry functions.
15+
:width: 500
16+
17+
PDFs have significant accessibility challenges. They are finalized documents intended
18+
for printing exactly specified copies. This makes them difficult for screen readers
19+
and other assistance technology to interpret. You are strongly encouraged to
20+
use alternative means of presenting the information in these documents, such as
21+
a :ref:`text component<Working with Text Components>`. Please visit the
22+
:ref:`Accessibility Best Practices Checklist` for more information, which also
23+
includes a guide on improving PDF accessibility if they must be used.
24+
25+
Additionally, viewing PDFs on mobile devices results in a poor learner
26+
experience.
27+
28+
Nevertheless, the PDF embed block exists to handle the case of a document
29+
being unavailable in other formats, or for when variations in representing the
30+
document are unacceptable.
31+
32+
***************************************
33+
Add an Embedded PDF in Open edX Studio
34+
***************************************
35+
36+
#. Ensure the PDF embed tool is enabled in your course.
37+
38+
To enable the pdf embed tool in Studio, add the ``"pdf"`` key to the
39+
**Advanced Module List** on the **Advanced Settings** page. (Be sure to include
40+
the quotation marks around the key value.) For more information, see
41+
:ref:`Enable Additional Exercises and Tools`.
942

1043
#. On the Course Outline page, open the unit where you want to add the PDF.
1144

@@ -39,7 +72,7 @@ Add an Embedded PDF in Open edX Studio
3972
#. In the **Source document URL** field, optionally add the URL to the source
4073
of the PDF document.
4174

42-
This might be, for instance, the power point or word document this PDF is
75+
This might be, for instance, the PowerPoint or Word document this PDF is
4376
based on. Providing a source URL is heavily encouraged, as source files
4477
tend to have better accessibility than PDFs. Please visit the
4578
:ref:`Accessibility Best Practices Checklist` for more information.
@@ -50,18 +83,10 @@ Add an Embedded PDF in Open edX Studio
5083
#. Select **Save**.
5184

5285

53-
.. seealso::
54-
55-
56-
:ref:`PDF Embed` (concept)
57-
58-
:ref:`Enable PDF Embed Tool` (how-to)
59-
60-
6186
**Maintenance chart**
6287

6388
+--------------+-------------------------------+----------------+--------------------------------+
6489
| Review Date | Working Group Reviewer | Release | Test situation |
6590
+--------------+-------------------------------+----------------+--------------------------------+
66-
| 09/02/2026 | Fox Piacenti | master | Pass |
91+
| 09/02/2026 | Fox Piacenti | Verawood | Pass |
6792
+--------------+-------------------------------+----------------+--------------------------------+

source/educators/how-tos/course_development/exercise_tools/enable_pdf_embed_tool.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

source/educators/navigation/content_creation_management.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,6 @@ Embed PDFs
172172
:maxdepth: 1
173173
:glob:
174174

175-
../concepts/advanced_features/pdf_embed.rst
176-
../how-tos/course_development/exercise_tools/enable_pdf_embed_tool.rst
177175
../how-tos/course_development/exercise_tools/add_embedded_pdf.rst
178176

179177
Embed IFrames

0 commit comments

Comments
 (0)