Documents: Difference between revisions
Imported from Confluence |
|||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DrupalBack}} | |||
This section explains how to upload, manage, and link to documents on your website. | |||
{{ | {{Callout|type=tip|title=Recommended File Format|content=Whenever possible, use the '''PDF''' format when publishing documents to the website. Other file types, such as '''.docx''', '''.pptx''', and '''.xlsx''', are supported, but regardless of the format you choose, all documents must be accessible. See [[Creating Accessible Documents|Creating Accessible Documents]] for accessibility guidance and best practices.}} | ||
== 7.1 | == 7.1 PDFs vs. Web Pages == | ||
{{ | {{Callout|type=tip|title=Before You Upload a PDF|content=Before adding a PDF to your website, consider whether the content would be better presented as a webpage instead.}} | ||
While | While converting a Google Doc or Microsoft Word document to a PDF can be a convenient way to share information online, it is not always the best option for several reasons: | ||
# PDFs often present major accessibility issues. [[Use Microsoft's Accessibility Checkers|Microsoft has a built-in tool]] for all | # PDFs often present major accessibility issues. [[Use Microsoft's Accessibility Checkers|Microsoft has a built-in tool]] for all its products. For the Google Workspace suite, everyone on campus has access to [https://blogs.swarthmore.edu/its/2019/03/18/grackle-making-google-documents-accessible/ Grackle]. '''Very Important:''' Departments that publish PDFs online are responsible for ensuring the files meet all of Swarthmore's accessibility standards. Inaccessible PDFs are subject to removal. | ||
# PDFs are harder to update than | # PDFs are harder to update than HTML pages. Updating a PDF requires fixing the original source document, rerunning accessibility checks, uploading a new version, and updating any links that reference it. Updating a webpage avoids these additional steps. | ||
# | # Older PDFs often continue to appear in search engine results even after they have been removed from a website. This can result in visitors accessing outdated information. A webpage, by contrast, typically presents only the current version. | ||
To learn more about | To learn more about creating accessible PDFs with Google Workspace and Microsoft Office, see [[Creating PDFs|Creating PDFs]]. | ||
=== When should your content be a PDF? === | === When should your content be a PDF? === | ||
Rarely is the simple answer. There is one | Rarely is the simple answer. There is one situation where a PDF may be the better choice: | ||
* Does the document | * Does the document require highly precise formatting that must be preserved for printing or distribution? If so, a PDF may be appropriate. '''Important:''' Even in this case, the PDF must still be fully accessible. | ||
Otherwise, a webpage | Otherwise, publishing the content as a webpage is usually the better option. | ||
== 7.2 | == 7.2 Accessibility Requirements == | ||
All documents hosted on [ | All documents hosted on [https://www.swarthmore.edu Swarthmore.edu] must comply with the College's [https://www.swarthmore.edu/accessibility/ict-accessibility-policy ICT Accessibility Policy]. Departments are responsible for ensuring that '''all''' documents shared online are accessible. | ||
Our [[Creating PDFs|Creating PDFs]] guide provides step-by-step instructions for creating accessible documents. If you need assistance or encounter problems, please [https://support.swarthmore.edu/support/tickets/new submit a support request] and request an accessibility consultation. | |||
== | {{Callout|type=important|title=Department Responsibility|content=Correcting accessibility issues is the responsibility of the department that published the document. Documents that do not meet the College's accessibility requirements are subject to removal.}} | ||
== 7.3 Hosting Options == | |||
When hosting PDFs online, you have two primary options: '''Drupal''' or '''Google Drive'''. Each has advantages and disadvantages depending on your department's needs. | |||
* '''Drupal''' — PDFs can be uploaded directly into Drupal. | |||
** '''Pros:''' Quick and easy to use. Documents can be indexed by search engines and appear in search results. | |||
** '''Cons:''' Drupal provides only a single document library. Creating subfolders is not supported, and there are no document-level permission settings. | |||
{{Callout|type=tip|title=File Organization|content=Because all Drupal documents are stored in a single document library, it is important to use clear, consistent file names. Following good file naming practices will make documents much easier to locate and manage over time.}} | |||
* '''Google Drive''' — Documents can also be uploaded to your department's Google Drive folder. Every department has a Google Drive folder managed by ITS that can be used to share documents on your website. | |||
** '''Pros:''' Supports nested folders for organization and provides robust sharing and permission controls. For example, you can restrict a document so that it is available only to members of the Swarthmore community. | |||
** '''Cons:''' Requires signing into Google Drive, uploading the document, and creating a share link before it can be added to your website. | |||
== 7.4 Uploading a Document to Drupal == | |||
1. Highlight the text that should become a link to the document. Be sure to include the file type by appending <code>[PDF]</code> to the end of the link text. This lets visitors know they are opening a document rather than another webpage. | |||
2. Click the '''Link''' icon in the editor toolbar, or press <kbd>Command</kbd> + <kbd>K</kbd> (Mac). | |||
{{Screenshot|doc1.png|836px|Screenshot showing the Link button in the Drupal editor toolbar.|Select the text and click the Link button.}} | |||
3. The link dialog will appear next to the selected text. Click the '''Link to a Document''' button. | |||
{{Screenshot|doc2.png|839px|Screenshot showing the Link to a Document button in the link dialog.|Select '''Link to a Document''' to browse or upload files.}} | |||
4. The '''Link to a Document''' window will open. Choose either: | |||
* '''Upload Document''' to upload a new file. | |||
* '''Select Document''' to choose a document that has already been uploaded. | |||
5. Select the appropriate document using the radio button to the left. | |||
6. Click '''Select Document'''. | |||
{{Screenshot|doc3.png|892px|Screenshot of the Link to a Document dialog showing the document library.|Select an existing document or upload a new one.}} | |||
You will be returned to the previous dialog. | |||
7. Expand the '''Advanced''' section. | |||
[[ | 8. Toggle '''Open in new window''' so it is enabled (green). | ||
9. Click the green checkmark to save the link. | |||
{{Screenshot|doc4.png|479px|Screenshot showing the Advanced options with Open in new window enabled.|Enable '''Open in new window''' before saving the link.}} | |||
# The selected text will now appear as a link. | |||
# Save the page as either '''Draft''' or '''Published''', then verify that the link works. | |||
{{Screenshot|doc5.png|835px|Screenshot showing the completed document link in the editor.|Save the page before testing the link.}} | |||
{{Callout|type=tip|title=Testing Document Links|content=You cannot test a document link directly from within the editor. Clicking the link while editing will reopen the link editor instead. Save the page first (as either '''Draft''' or '''Published''') and then test the link from the rendered webpage. | |||
{{Screenshot|doc6.png|576px|Screenshot showing the link editing interface that appears when clicking a link inside the editor.|Links clicked while editing will open the link editor instead of the document.}}}} | |||
== 7.5 Uploading a Document to Google Drive == | |||
To learn more about sharing files from Google Drive, see [[Sharing a File from Google Drive|Sharing a File from Google Drive]]. | |||
1. After uploading your document to Google Drive and creating a share link, highlight the text that should become the link. Be sure to include the file type by appending <code>[PDF]</code> to the end of the link text. This lets visitors know they are opening a document rather than another webpage. | |||
2. Click the '''Link''' icon in the editor toolbar. | |||
{{Screenshot|f325a97e-9000-4038-b2c4-bca4aff0bdb5.png|714px|Screenshot showing the Link button in the Drupal editor toolbar.|Select the text and click the Link button.}} | |||
3. The link dialog will appear next to the selected text. Paste the Google Drive share link into the '''Link URL''' field. | |||
{{Screenshot|google_link_url.png|720px|Screenshot showing the Link URL field in the Drupal link editor.|Paste the Google Drive share link into the Link URL field.}} | |||
# Expand the '''Advanced''' section. | |||
# Enable the '''Open in new window''' toggle so it is active (green). This will cause the document to open in a new browser tab. | |||
# Click the green checkmark to save the link. | |||
[[Category:Drupal]] | |||
Latest revision as of 14:40, 10 July 2026
This section explains how to upload, manage, and link to documents on your website.
7.1 PDFs vs. Web Pages
While converting a Google Doc or Microsoft Word document to a PDF can be a convenient way to share information online, it is not always the best option for several reasons:
- PDFs often present major accessibility issues. Microsoft has a built-in tool for all its products. For the Google Workspace suite, everyone on campus has access to Grackle. Very Important: Departments that publish PDFs online are responsible for ensuring the files meet all of Swarthmore's accessibility standards. Inaccessible PDFs are subject to removal.
- PDFs are harder to update than HTML pages. Updating a PDF requires fixing the original source document, rerunning accessibility checks, uploading a new version, and updating any links that reference it. Updating a webpage avoids these additional steps.
- Older PDFs often continue to appear in search engine results even after they have been removed from a website. This can result in visitors accessing outdated information. A webpage, by contrast, typically presents only the current version.
To learn more about creating accessible PDFs with Google Workspace and Microsoft Office, see Creating PDFs.
When should your content be a PDF?
Rarely is the simple answer. There is one situation where a PDF may be the better choice:
- Does the document require highly precise formatting that must be preserved for printing or distribution? If so, a PDF may be appropriate. Important: Even in this case, the PDF must still be fully accessible.
Otherwise, publishing the content as a webpage is usually the better option.
7.2 Accessibility Requirements
All documents hosted on Swarthmore.edu must comply with the College's ICT Accessibility Policy. Departments are responsible for ensuring that all documents shared online are accessible.
Our Creating PDFs guide provides step-by-step instructions for creating accessible documents. If you need assistance or encounter problems, please submit a support request and request an accessibility consultation.
7.3 Hosting Options
When hosting PDFs online, you have two primary options: Drupal or Google Drive. Each has advantages and disadvantages depending on your department's needs.
- Drupal — PDFs can be uploaded directly into Drupal.
- Pros: Quick and easy to use. Documents can be indexed by search engines and appear in search results.
- Cons: Drupal provides only a single document library. Creating subfolders is not supported, and there are no document-level permission settings.
- Google Drive — Documents can also be uploaded to your department's Google Drive folder. Every department has a Google Drive folder managed by ITS that can be used to share documents on your website.
- Pros: Supports nested folders for organization and provides robust sharing and permission controls. For example, you can restrict a document so that it is available only to members of the Swarthmore community.
- Cons: Requires signing into Google Drive, uploading the document, and creating a share link before it can be added to your website.
7.4 Uploading a Document to Drupal
1. Highlight the text that should become a link to the document. Be sure to include the file type by appending [PDF] to the end of the link text. This lets visitors know they are opening a document rather than another webpage.
2. Click the Link icon in the editor toolbar, or press Command + K (Mac).
3. The link dialog will appear next to the selected text. Click the Link to a Document button.
4. The Link to a Document window will open. Choose either:
- Upload Document to upload a new file.
- Select Document to choose a document that has already been uploaded.
5. Select the appropriate document using the radio button to the left.
6. Click Select Document.
You will be returned to the previous dialog.
7. Expand the Advanced section.
8. Toggle Open in new window so it is enabled (green).
9. Click the green checkmark to save the link.
- The selected text will now appear as a link.
- Save the page as either Draft or Published, then verify that the link works.
7.5 Uploading a Document to Google Drive
To learn more about sharing files from Google Drive, see Sharing a File from Google Drive.
1. After uploading your document to Google Drive and creating a share link, highlight the text that should become the link. Be sure to include the file type by appending [PDF] to the end of the link text. This lets visitors know they are opening a document rather than another webpage.
2. Click the Link icon in the editor toolbar.
3. The link dialog will appear next to the selected text. Paste the Google Drive share link into the Link URL field.
- Expand the Advanced section.
- Enable the Open in new window toggle so it is active (green). This will cause the document to open in a new browser tab.
- Click the green checkmark to save the link.







