Sakai KB articles

[klemay]

Part of #49.

See install guide here: https://docs.google.com/document/d/1gzWctw0zbOoifIimye24PRZuUw5OO8wQj2wSZ17UsHQ/edit#heading=h.lnap379oxyys

Articles to write:

• [x] LMS Stub
• [ ] Installing the LMS app for Sakai at the Institutional Level (just a stub; instructions coming soon)
• [x] Installing the LMS app for Sakai at the Course Level
• [x] Using the Hypothesis LMS App with Lessons in Sakai

Tasks:

• [x] Remove "Private" designation from all Sakai KB articles
• [x] Canvas KB articles: Replace GDocs links

[klemay]

Installing the Hypothesis LMS App for Sakai

In Sakai, the Hypothesis LMS app can be installed at the course or institutional level. For instructions on installing the Hypothesis app for Sakai, please see:

Installing the LMS app for Sakai at the Course Level Installing the LMS app for Sakai at the Institutional Level (coming soon)

You might also find this help article useful:

Using the Hypothesis LMS App with Lessons in Sakai

Note: We also have guides for those who wish to use our app in Sakai, Moodle, Blackboard, and D2L.

[klemay]

Installing the LMS app for Sakai at the Course Level

_Note: By default, Sakai does not set the tool_consumer_instance_guid parameter for basic LTI launches. This should be configured by an admin in the Sakai Instance properties, as tool_consumer_instance_guid is required for the Hypothesis LMS App. More information about this parameter can be found in this LTI implementation guide._

1. Generate Credentials

Visit lms.hypothes.is/welcome and fill out the form:

Required fields

The LMS Domain is the basic web address you use to access your LMS (i.e., yourschool.instructure.com). The Email field can be any valid email address that belongs to you.

Optional fields

Leave the Canvas Developer Key and Canvas Developer Secret fields blank.

Your credentials

After you fill out the form, click Generate Credentials. You will see a screen that looks like this:

Don’t close this tab/window! You will need to copy and paste these credentials later in the install process.

2. Go to Site Info > External Tools

3. Click Install LTI Tool

This is usually found in the upper right corner of the External Tools page:

4. Fill Out the External Tool Form

You will be using default settings, unless otherwise indicated.

Fill out the following information:

• Tool Title: Hypothesis
• Button Text: Hypothesis
• Launch URL: https://lms.hypothes.is/lti_launches
• Launch Key and Launch Secret: acquired in Step 1
• Privacy Settings: Check both boxes
• Services: Check boxes for Provide Roster to External Tool and Allow External Tool to store setting data

The app needs access to the information granted in Privacy Settings and Services in order to create accounts and groups using the LMS roster.

Click Save.

The app will now be successfully installed for your course site. You may wish to consult our help article on Using the Hypothesis LMS App with Lessons in Sakai.

[klemay]

Using the Hypothesis LMS App with Lessons in Sakai

Currently, the Lessons tool is the only place where we have been able to add Hypothesis-enabled readings to a Sakai course. We are researching other places in which an external tool like Hypothesis can be added to Sakai. Let us know if you can think of any!

1. Add the Lessons tool to your course site

Some Sakai instances do not enable the Lessons tool by default. If you do not see it in the left navigation menu of your course site, you'll need to add it manually.

Go to Site Info > Manage Tools:

Check the box next to the Lessons tool:

Scroll to the bottom of the page. Click Continue, and on the next page click Finish.

If you need assistance with adding the Lessons tool to your course site, please consult Sakai's documentation or your institution's LMS team.

2. Create Hypothesis-enabled Content Item

Navigate to the Lessons tool and click on the Add Content button at the top of the page:

From the Add Content menu, select Add External Tool:

Select Hypothesis from the External Tool Selector:

Click Save and you will be brought back to your Lessons page.

3. Rename the Hypothesis-enabled Content Item

Click on the Edit button next to the Content Item you've just created:

Change the Item Name and click Update Item:

You'll be brought back to your Lessons page, and the name of your Hypothesis-enabled Content Item will have changed.

4. Select a Document for Annotation

Click on the title of the Content Item.

You will have the option to enter a publicly-viewable URL (See Step 4A) or to add a PDF from Google Drive (See Step 4B).

4A Linking a publicly-viewable page or document

Use 3A: https://web.hypothes.is/help/using-the-hypothesis-app-with-modules-in-canvas/

4B: Using the Google File picker

Use 3B: https://web.hypothes.is/help/using-the-hypothesis-app-with-modules-in-canvas/

Click Submit.

You will see your Hypothesis-enabled Content Item listed on the Lessons page. When your students click on the Content Item, the web page or document will open with Hypothesis enabled and scoped to your automatically-provisioned private group: