Jump to content

Documents: Difference between revisions

From Swarthmore Knowledge Base
Imported from Confluence
 
Kwhiteb1 (talk | contribs)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
The following section is about including documents on your website.
{{DrupalBack}}
This section explains how to upload, manage, and link to documents on your website.


{{Card|variant=info|title=Info|content='''NOTE:''' It is recommended that you use the PDF format when including documents to the website. Other document types such as .docs, .ppt, .xls can be added. Whatever document types you choose to add, they must be accessible. Please consult [[Creating Accessible Documents{{!}}Creating Accessible Documents]] to learn more about how.}}
{{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) PDFs vs Web Pages ==
== 7.1 PDFs vs. Web Pages ==


{{Card|variant=info|title=Info|content='''NOTE: '''Before adding PDFs to your website, you first need to determine if content would be better served as an actual webpage rather than as a PDF.}}
{{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 simply converting your source files (Google docs or Word docs) to PDFS can be a convenient way to share information online, it is not always the best option for several reasons:
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 their products. For the Google suite, everyone on campus has access to [https://blogs.swarthmore.edu/its/2019/03/18/grackle-making-google-documents-accessible/ Grackl]e. '''Very Important note:''' Departments that share PDFs online are responsible for ensuring the file meets all of Swarthmore’s accessibility standards. Inaccessible PDFs are subject to removal.
# 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 an HTML page. Updating a PDF involves multiple steps including fixing the original issue in the source file; re-running an accessibility check; re-uploading the PDF; and then updating the link(s) that point to the new file. Updating a webpage has none of these issues.
# 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.
# Old PDFs will often appear in search results even they may no appear on the website. This can become problematic when out-dated versions of a document appear in a user’s search results. A published webpage has ONLY have the current version.
# 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 using the Google and Microsoft Suites to create accessible PDFs, please visit [[Creating PDFs|Creating PDFs]].
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 circumstance where having a PDF may be the right thing to do:
Rarely is the simple answer. There is one situation where a PDF may be the better choice:


* Does the document have highly precise formatting that needs to be maintained? If yes, then a PDF. I'''MPORTANT Caveat:''' Although the intention is to allow users to print a PDF, they still must be fully accessible.
* 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 might make more sense for your new content.
Otherwise, publishing the content as a webpage is usually the better option.


== 7.2) Accessibility Requirements ==
== 7.2 Accessibility Requirements ==


All documents hosted on [http://Swarthmore.edu Swarthmore.edu] must meet the College’s [https://www.swarthmore.edu/accessibility/ict-accessibility-policy accessibility policy requirements]. Departments are responsible for ensuring that ALL documents shared online are accessible. Our [https://swatkb.atlassian.net/wiki/spaces/ACADTECH/pages/edit-v2/20909681 Creating PDFs] page provides specific how-to’s. If you still need help or get stuck, please [https://support.swarthmore.edu/support/tickets/new submit a ticket] and request an accessibility consultation.
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.


{{Card|variant=info|title=Info|content='''NOTE: '''Correcting accessibility issues is the responsibility of the department that shared the document. Inaccessible documents are subject to removal.}}
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.


== 7.3) Hosting Options ==
{{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.}}


When it comes to hosting your PDFs online, you have two options: '''Drupal '''or''' Google Drive'''. Each offers its own pros and cons. Which option you choose depends on the specific needs of your department:
== 7.3 Hosting Options ==


* '''Drupal - '''PDFs can be uploaded directly into the Drupal. <br>'''PROS:''' Quick and easy to use. Will appear in Google search results.<br>'''CONS:''' Drupal provides only with a single folder for hosting documents. Creating sub-folders is not possible. Drupal does not offer any access/permissions settings.
When hosting PDFs online, you have two primary options: '''Drupal''' or '''Google Drive'''. Each has advantages and disadvantages depending on your department's needs.


{{Card|variant=info|title=Info|content='''NOTE: '''Because all Drupal documents are located in a single folder, it is important that you pay close attention to how you name your files as file management ‘best practices’ will be essential in helping keep yourself organized.}}
* '''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 in your department’s Google Drive Folder. Every department has a Google Drive folder (setup by ITS) that you can also use to share documents on your website. <br>'''PROS: '''Google Drive allows you create as many sub-folders as you wish to help you organize your content. You can also use Google Drive’s built-in permissions settings to control access to files or folders such as making the PDF on your website only accessible to “Swarthmore-only” users.<br>'''CONS: '''Requires that you login to Google Drive, upload the PDF to the folder and create a Share link.
{{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.}}


== 7.4) Uploading a Document to Drupal ==
* '''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.


# Highlight the text that you wish to be a link to the document. Be sure to include the file type by appending [pdf] to the end of the link. This lets users know they are linking to a document and not to another webpage.
== 7.4 Uploading a Document to Drupal ==
# Click the LINK icon in the upper right corner or use the keyboard shortcut Command K (on a mac)


[[File:doc1.png|836px]]
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.
# A new window will appear next to the text that you originally highlighted. Click the '''“Link to a Document”''' button.


[[File:doc2.png|839px]]
2. Click the '''Link''' icon in the editor toolbar, or press <kbd>Command</kbd> + <kbd>K</kbd> (Mac).
# A new window will appear called “Link to a document”. At the top you choose to upload a new document or choose a document that has been previously uploaded into the website’s documents folder.
# Select the appropriate document from the list using the radio button to the left.
# Then click the '''Select Document''' button located in the lower left corner.<br>
[[File:doc3.png|892px]]


# You will be returned to previous window. Click the Advanced arrow to expand the advanced options.
{{Screenshot|doc1.png|836px|Screenshot showing the Link button in the Drupal editor toolbar.|Select the text and click the Link button.}}
# Toggle the the “Open in new window” so that it is active/green.
# Click the green check mark to save your changes.


[[File:doc4.png|479px]]
3. The link dialog will appear next to the selected text. Click the '''Link to a Document''' button.
# The text that you originally highlighted will now appear as red and underlined (indicating that it is a link).
# Save the page in DRAFT mode and then check your work.


[[File:doc5.png|835px]]
{{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.}}
{{Card|variant=info|title=Info|content='''NOTE: '''You cannot actually test the link from the editor console. You must first save the page (in Draft mode) or (in Published mode) and test from there. Clicking on the link from within the editor is only open an editing window to allow you to change or remove the link.


[[File:doc6.png{{!}}576px]]}}
4. The '''Link to a Document''' window will open. Choose either:


== 7.5) Uploading a Document to Google Drive ==
* '''Upload Document''' to upload a new file.
* '''Select Document''' to choose a document that has already been uploaded.


Learn more about Google Drive by visiting: [[Sharing a File from Google Drive|Sharing a File from Google Drive]]
5. Select the appropriate document using the radio button to the left.


# Once you’ve followed the steps to upload your document to Google dive, then highlight the text that you wish to be a link to the document. Be sure to include the file type by appending [pdf] to the end of the link. This lets users know they are linking to a document and not to another webpage.
6. Click '''Select Document'''.
# Click the LINK icon in the upper right corner.


[[File:f325a97e-9000-4038-b2c4-bca4aff0bdb5.png|714px]]
{{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.}}
# A new window will appear next to the text that you originally highlighted. Add the Google share link generated by Google Drive to the Link URL field.


[[File:google_link_url.png|720px]]
You will be returned to the previous dialog.
# Click the Advanced tab and Toggle the the “Open in new window” selector so that it is active/green. This will make the link open in a new browser tab.


7. Expand the '''Advanced''' section.


[[Category:Drupal]]
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.


<!-- Imported from Confluence page id=172818448 (https://swatkb.atlassian.net/wiki/spaces/DRUP/pages/172818448/Documents) -->
[[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.

Recommended File Format
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 for accessibility guidance and best practices.


7.1 PDFs vs. Web Pages

Before You Upload a PDF
Before adding a PDF to your website, consider whether the content would be better presented as a webpage instead.


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:

  1. 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.
  2. 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.
  3. 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.

Department Responsibility
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.
File Organization
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 [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).

Screenshot showing the Link button in the Drupal editor toolbar.
Figure: 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 showing the Link to a Document button in the link dialog.
Figure: 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 of the Link to a Document dialog showing the document library.
Figure: 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 showing the Advanced options with Open in new window enabled.
Figure: Enable Open in new window before saving the link.
  1. The selected text will now appear as a link.
  2. Save the page as either Draft or Published, then verify that the link works.
Screenshot showing the completed document link in the editor.
Figure: Save the page before testing the link.
Testing Document Links
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 showing the link editing interface that appears when clicking a link inside the editor.
Figure: 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.

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.

Screenshot showing the Link button in the Drupal editor toolbar.
Figure: 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 showing the Link URL field in the Drupal link editor.
Figure: Paste the Google Drive share link into the Link URL field.
  1. Expand the Advanced section.
  2. Enable the Open in new window toggle so it is active (green). This will cause the document to open in a new browser tab.
  3. Click the green checkmark to save the link.