Using Chirun through LTI#
The Chirun web frontend is an LTI 1.3 tool.
You can use this tool to link to and manage material from your learning environment.
Registering the LTI tool#
Registering to use the LTI tool with your virtual learning environment is currently a manual process.
We’re in the process of establishing how to offer use of the Chirun LTI tool to users outside Newcastle University. If you’d like to be involved, please email us.
Creating a link#
Canvas#
This video shows how to add Chirun content to your course. There’s a text version of the instructions below the video.
Choosing content#
A Chirun package can contain several items, or just one. Items can be grouped into parts.
You might like to link to each item individually from Canvas, to fit with the structure of your course, or just link to the whole package and allow students to find their own way through the notes. Or you could do both!
Adding a new package#
To begin with, you’ll have to create or upload a package to the Chirun server.
In your course’s Modules page, click the + icon to start adding a new item to a module.
Select External tool, and then Embed Chirun material.
![A dialog box headed "Add Item". The select box at the top of the dialog is set to "External Tool". There is a list of external tools underneath, and "Embed Chirun material" is highlighted.](../_images/canvas-external-tool.png)
A box pops up, containing the Chirun interface.
![A dialog box containing a link "Create a new package", and a form labelled "Import a package from another context by URL".](../_images/select-package.png)
Click Create a new package.
On the next page is a form where you can upload any source files that you have.
Or if you’re starting from scratch, you can leave the input empty and just click Submit.
I’ve selected an existing LaTeX file, notes.tex
.
![A dialog box headed "How would you like to create this package?", with links "Start from scratch", "Upload files" and "Clone a git repository".](../_images/create-new-package.png)
The package must be configured and built before you can use it. Click the link Edit or build this package.
![A dialog box reading "This package has not been built yet. Please build it to continue." Underneath is a link, "Edit or build this package".](../_images/edit-or-build.png)
You’re shown the editing interface for the package in a new tab. Click the Configure link.
![The index page for the newly created package. It begins with a header "Manage this package".](../_images/package-index.png)
Fill in the package metadata fields.
![A page titled "Configuring Unnamed package". There is a form with fields for package metadata.](../_images/config-metadata.png)
Because I uploaded a single LaTeX file, it’s been added to the configuration as a standalone item. Click on its entry in the left sidebar, and fill in its title. Students see this title, so use a title that describes the content of the document.
![A page titled "Configuring Unnamed package". The item "Lecture notes" is selected, and the form on the right contains fields to do with that item.](../_images/config-item.png)
Click the Save button. The package will be built. Once that’s done, go back to the Canvas tab. The page has updated to show that the package has been built. Click on Pick an item to use.
![A dialog containing the text "This package has been successfully built." Underneath is a link, "Pick an item to use".](../_images/pick-an-item-to-use.png)
You’re shown a list of items in the package. There’s only one in this package, so click on it.
![A dialog headed "My real course (2023) by Christian Lawson-Perfect". The text reads, "Using the theme Default. Pick the item that this link will open." A list underneath contains a single link, "Lecture notes".](../_images/item-list.png)
You’re shown a very small preview of the chosen item. Click Use this choice to confirm it’s the one you want.
![A dialog containing a frame showing a preview of the selected content. On the left is a button "Use this choice".](../_images/item-preview.png)
You’re returned to the Canvas “Add Item” box. Click on Add item.
![A dialog headed "Add Item". At the bottom is a link "Add item".](../_images/add-item.png)
Using existing material#
Once a package has been used once in your course, it’s available from the initial “add item” menu for easy access.
![A dialog box containing a list of package titles, followed by a link "Create a new package", and a form labelled "Import a package from another context by URL".](../_images/select-package-existing.png)
I’ve picked Sample Course. It contains several items, split into parts. I select Beamer Slides.
![A dialog headed "Sample Course - SAM0000 (2020) by Ann Example". The text reads, "Using the theme Default. Pick the item that this link will open." A list underneath contains several links.](../_images/item-list-several.png)
You can choose how to display slides: in the default format, as a continuous page, or as slides.
![A dialog showing a preview of the selected content, and a select box labelled "Format" with options "Default" and "Slides".](../_images/select-format.png)
This determines which format students are shown when they click on the link; they can change to another format afterwards.
Moodle#
In Moodle, select the Chirun activity type, or “external tool”, and select the Chirun preconfigured tool.
Click Select content. A modal frame opens.
You can see all packages linked to this context.
You can select a linked package to use, create a new package, or import a package created in another context by giving its management URL.
Once you’ve selected a package, if it offers more than one theme, you’re asked to pick a theme.
Then you must pick an item. When the student opens this link, they will see the item you select. They may be able to navigate to other parts of the package, depending on how the item is configured.
If the item is available in more than one HTML format, then you must finally pick the format to use.
Click Use this choice to confirm your choice. You’ll be returned to your learning environment.