Skip to content

Commit 1729837

Browse files
KelketekKelketek
committed
docs: initial setup for pdf block
1 parent 27444be commit 1729837

5 files changed

Lines changed: 152 additions & 4 deletions

File tree

‎source/_images/educator_references/pdf_embed.png‎

159 KB
Loading

‎source/educators/concepts/advanced_features/pdf_embed.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. _PDF Embed:
2+
3+
########################
4+
Embedding PDFs in Your Course
5+
########################
6+
7+
.. tags:: educator, concept
8+
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 are not considered accessible. They are finalized documents intended for
18+
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.
23+
24+
Additionally, viewing PDFs on mobile devices results in a poor learner
25+
experience.
26+
27+
Nevertheless, the PDF embed block exists to handle the case of a document
28+
being unavailable in other formats, or for when variations in representing the
29+
document are unacceptable.
30+
31+
.. seealso::
32+
33+
34+
:ref:`Enable PDF Embed Tool` (how-to)
35+
36+
:ref:`Add Embedded PDF` (how-to)
37+
38+
**Maintenance chart**
39+
40+
+--------------+-------------------------------+----------------+--------------------------------+
41+
| Review Date | Working Group Reviewer | Release |Test situation |
42+
+--------------+-------------------------------+----------------+--------------------------------+
43+
| | | | |
44+
+--------------+-------------------------------+----------------+--------------------------------+

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
.. _Add Embedded PDF:
2+
3+
Add an Embedded PDF in Open edX Studio
4+
#######################################
5+
6+
.. tags:: educator, how-to
7+
8+
#. On the Course Outline page, open the unit where you want to add the PDF.
9+
10+
#. Under **Add New Component** click **Advanced** and then select **PDF**.
11+
12+
The new component is added to the unit with a default example PDF embedded.
13+
14+
.. image:: /_images/educator_references/pdf_embed.png
15+
:alt: The PDF embed component in Studio.
16+
:width: 400
17+
18+
#. In the new component, click the **Edit button, or pencil icon**.
19+
20+
#. In the **Name** field, enter the name for the new component. This will be
21+
displayed above the component as a title.
22+
23+
#. In the **PDF URL** field, set the URL of the PDF you would like to embed.
24+
25+
If you do not have an existing URL for your PDF, you may upload the PDF by
26+
:ref:`adding it as a handout<Add Course Updates and Handouts>` and copy the
27+
URL of the resulting handout.
28+
29+
#. Toggle the **PDF Download Allowed** field to optionally display a
30+
download link for the PDF.
31+
32+
.. note::
33+
34+
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.
35+
36+
37+
#. In the **Source document URL** field, optionally add the URL to the source
38+
of the PDF document.
39+
40+
This might be, for instance, the power point or word document this PDF is
41+
based on. Providing a source URL is heavily encouraged, as source files
42+
tend to have better accessibility than PDFs. Please visit the
43+
:ref:`Accessibility Best Practices Checklist` for more information.
44+
45+
#. In the **Source document button text** field, you can change the display
46+
text of the source download link.
47+
48+
#. Select **Save**.
49+
50+
51+
.. seealso::
52+
53+
54+
:ref:`PDF Embed` (concept)
55+
56+
:ref:`Enable PDF Embed Tool` (how-to)
57+
58+
59+
**Maintenance chart**
60+
61+
+--------------+-------------------------------+----------------+--------------------------------+
62+
| Review Date | Working Group Reviewer | Release |Test situation |
63+
+--------------+-------------------------------+----------------+--------------------------------+
64+
| | | | |
65+
+--------------+-------------------------------+----------------+--------------------------------+

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _Enable PDF Embed Tool:
2+
3+
Enable the PDF Embed Tool
4+
##########################
5+
6+
Before you can add an embedded PDF to your course, you must enable the pdf embed
7+
tool in Studio or OLX (open learning XML).
8+
9+
To enable the pdf embed tool in Studio, you add the ``"pdf"`` key to the
10+
**Advanced Module List** on the **Advanced Settings** page. (Be sure to include
11+
the quotation marks around the key value.) For more information, see
12+
:ref:`Enable Additional Exercises and Tools`.
13+
14+
.. seealso::
15+
16+
17+
:ref:`PDF Embed` (concept)
18+
19+
:ref:`Add Embedded PDF` (how-to)
20+
21+
22+
**Maintenance chart**
23+
24+
+--------------+-------------------------------+----------------+--------------------------------+
25+
| Review Date | Working Group Reviewer | Release |Test situation |
26+
+--------------+-------------------------------+----------------+--------------------------------+
27+
| | | | |
28+
+--------------+-------------------------------+----------------+--------------------------------+

‎source/educators/navigation/content_creation_management.rst‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@ Manage Text Components
6666

6767
.. toctree::
6868
:maxdepth: 1
69-
:glob:
69+
:glob:
7070

7171
../references/course_development/text_components/text_components.rst
7272
../how-tos/course_development/text_components/manage_text.rst
7373
../how-tos/course_development/text_components/manage_html.rst
7474
../how-tos/course_development/text_components/manage_latex.rst
7575
../how-tos/course_development/exercise_tools/add_mathjax.rst
7676
../how-tos/course_development/exercise_tools/manage_full_screen_image.rst
77-
77+
7878
.. _Add Video Components:
7979

8080
Manage Video Components
@@ -130,7 +130,7 @@ Add Mathjax
130130
:glob:
131131

132132
../references/course_development/exercise_tools/mathjax_studio.rst
133-
133+
134134

135135
Add Tags
136136
*******************************************************
@@ -165,6 +165,17 @@ Google Drive Tool
165165
../how-tos/course_development/exercise_tools/enable_google_drive_tool.rst
166166
../how-tos/course_development/exercise_tools/add_google_drive.rst
167167

168+
Embed PDFs
169+
*******************************************************
170+
171+
.. toctree::
172+
:maxdepth: 1
173+
:glob:
174+
175+
../concepts/advanced_features/pdf_embed.rst
176+
../how-tos/course_development/exercise_tools/enable_pdf_embed_tool.rst
177+
../how-tos/course_development/exercise_tools/add_embedded_pdf.rst
178+
168179
Embed IFrames
169180
*******************************************************
170181

@@ -213,7 +224,7 @@ initiative.
213224
.. toctree::
214225
:maxdepth: 1
215226
:glob:
216-
227+
217228
../how-tos/course_development/migrate_legacy_libraries.rst
218229
../concepts/instructional_design/libraries.rst
219230
../how-tos/course_development/create_library.rst

0 commit comments

Comments
 (0)