-
Notifications
You must be signed in to change notification settings - Fork 78
docs: initial setup for pdf block #1386
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Kelketek
wants to merge
2
commits into
openedx:main
Choose a base branch
from
open-craft:fox/pdf-block
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 92 additions & 0 deletions
92
source/educators/how-tos/course_development/exercise_tools/add_embedded_pdf.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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<Working with Text Components>`. 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. | ||
Kelketek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| #. 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<Add Course Files>` and copy the | ||
| URL of the resulting handout. | ||
Kelketek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| #. 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 | ||
Kelketek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like this would be a more useful screenshot if it included some of the Studio UI (eg. with the edit button, etc.). That might provide some more context, especially for where it's used to demonstrate what it should look like once you've selected the pdf component to add in studio.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Kelketek did you have thoughts on this one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samuelallan72 I missed the original comment, but I don't think this should be changed as it matches how screenshots are handled in other parts of the documentation, like here.