ilios/user-guide

These are the markdown files contained in the User Guide

Ilios: Curriculum Management from UCSF

About

The Ilios Curriculum Management System addresses the needs of the Health Professions educational community by providing a user-friendly, flexible, and robust web application to collect, manage, analyze and deliver curricular information.

Ilios creates a comprehensive view of curricula by tracking events, learning content and activities over time. The system facilitates day-to-day administration and the delivery of information to learners; enhances curricular development, review and innovation; and reduces overhead for internal and accreditation reporting. The end result is a powerful tool creating complete and accurate pictures of complex, integrated, multi-year curricula.

Ilios manages learners and instructors and their relationships to curricular materials and activities, enabling the tracking of educational hours, roles and role transitions for participants both internal and external to an institution. Ilios also provides a robust, scalable delivery mechanism for user-centric calendar and scheduling information, with direct access to critical course information, materials, and other educational systems and services.

Ilios leverages the power of your existing online learning. With its comprehensive API, Ilios allows you to integrate with external data sources and systems. For schools using online learning systems such as Moodle or Canvas, Ilios provides a backbone of curricular information to make that deployment more robust and to complement the rich online tools, activities and materials already in use.

More Information and user documentation is available at iliosproject.org

Install and Update Instructions

Instructions for a new Install

Update Ilios

Upgrading From Ilios 2.x

Frontend Theming

For information about customizing the look and feel of the Ilios frontend for your respective institution, please visit docs/custom_theming.md for more information.

API Information

If you want to connect to the Ilios API a good place to start is docs/ilios_api.md.

Interacting with Ilios from the command line

Ilios provides a command line interface, see docs/custom_cli_commands.md for a list of available commands and how to use them.

Get Ilios

Download the latest distribution or clone the codebase.

Contact

For more information on Ilios please contact:

The Ilios Project * UCSF School of Medicine * 530 Parnassus Avenue * Box 0840 * San Francisco, CA 94143

Email: [email protected]

Development of Ilios

To get a development instance of Ilios up and running quickly, please review the steps in our Quick Setup Guide for Ilios for what is recommended and required.

user-guide's Issues

Add Information About New Icon Indicating Needs Accommodation - Virtual Learning Default

see title - here is the slider in prod to control this ...

Update Permissions Matrix With Student Advisor Role Information

We have a permissions matrix file that is referenced in the user guide that needs to be updated with the details of this new role.

Document group name truncation

As indicated in ilios/frontend#2879 (comment) we will need to document that when a group with a name that approaches 60 characters is used to generate sub groups then subgroup names will be shortened automatically.

Add Information About Assigning Vocabulary Terms to Objectives

This is for the course and session level - as well as program year level.

Program Year updated screen shot below - not live yet - due next week - final week of May 2020.

Small Group Offering Editor Needs Updated Screen Shots

see title - this area will need to be updated at some point - it's a bit outdated

Document program year objectives mapping download functionality

see https://github.com/ilios/frontend/issues/3942

Add Detailed Information About Copy Learner Group Functionality

This is also new and needs to be included in the user guide.

Add Information About Multi-Day Events - Check to Make Sure It's Up To Date

see the title - need to make sure this section in the User Guide is up to date

Figure out how to host the images in the repository

Right now all of the images are in imagur and not actually linked to the binaries in the repo. We should either link to the repo images through a relative path or institute a build process that puts them somewhere predictable.

Add Auto-generating Truncated Names of Subgroups When Name Already at Max Length

Since this is a new feature and an edge case, it needs to be documented.

This occurs when a Learner Group is selected to have Sub Groups auto-generated but the original Learner Group is already at the maximum length (59-60 chars).

Fix Existing Image Links

All of the images need to be linked properly to the images folder.

Add Details About Calendar in the Offerings Editor

New excellent functionality that needs to be documented thoroughly.

Refine Explanation of WaaG

The guide should reflect the fact that WaaG contains the work the student needs to do that week specifically. It is not a calendar and does not need "Scheduled" offerings to appear.

Verification Table in CI - Add Information About This to The Guide

See title for reference - correct AAMC language will be needed here - I will confirm with @saschaben to get this correct in the guide.

Update Usage Information Regarding Instructor Groups

They are not used so much as Instructors for a Session Offering. But this area is used to track groups of Instructors for organizational use.

Need To Update Display Name Information In User Guide

This would be in the Admin Console and other locations such as Learner Group membership, Instructor Group membership. All areas where this is touched upon need to be updated in the guide.

Add Information About Visualization and Graphs

New, evolving functionality needs to be included, even as it is likely to be expanded and changed in the future.

Update User Guide Regarding .ics feed and How to Deal With Linked ILM's

Linked ILM's require the user to follow the link to check "Pre-Work". This needs to be updated in the guide.

This is after the feed is fixed not to include the "Due Date" ILM's, which appear to be currently included in the feed.

Improve documentation for commands

We need to update
https://iliosproject.gitbooks.io/ilios-user-guide/content/alerts.html

to be more inline with our current command setup which doesn't have a configuration file, it just takes configuration on the command line.

Original request: ilios/ilios#1482

Need to Make Sure Hyper Link to Courses and Sessions is Featured

This is mainly of interest to non-student Ilios users. Or students who perform non-teaching activities. There is a link to the Courses and Session page within Event Detail for these users. It is important to point out that Learning Materials and other Session-specific details can be viewed and LM's retrieved by using this link.

Describe in Detail How Admin Users Can See Draft Sessions in Profile Calendar

It can seem alarming to coordinators to see unpublished (draft) sessions when they look up a student's profile in the Admin Console. The reason these unpublished sessions are there is to review and look for potentially conflicting scheduling conflicts.

Add better definition of year selection for calendar filters

Right now, in https://iliosproject.gitbooks.io/ilios-user-guide/content/calendar_search_filter_options.html, we don't clarify the specific use for the academic year drop-down in the filters, which has caused some confusion for users.

We should add an additional screenshot pointing it out, and explain that this dropdown only and specifically controls the lists of courses and cohorts available for filtering --- not the display of information on the calendar itself, which will always show events for all available stretches of time.

Add Information About Sorting Objectives

This is new functionality and needs to be documented.

Add Detailed Information About LM Timed Release

This is a key new feature that needs to be added to the user guide in great detail.

Add Information About New Virtual Learning Link Field For Offerings

see the title - this is new as of now and needs to be added the guide

Update Rollover documentation

Currently, the rollover section does not specify how to roll over a course into the current year versus a different academic year, or inot anopther year where a course of the same name already exists. It needs to. Explanation of how the changing of a course name will alter the target year list is needed.

Add Information About Student Advisor Role

User guide update needed - student advisor role has been added to Session and Course Administration.

Add Information And Screen Shots Regarding New Session List Table Layout

Since the appearance and performance of this list of sessions and / or courses possibly too has changed significantly this needs to be documented in the user guide.

Update User Guide in the Programs Functional Area

Now that "publishing" is no longer a thing in Programs, an update with new screen shots and explanations should be done.

Update Program Year Objective Rollover in Programs

It might be helpful to provide more information around the fact that PY Objectives (and Terms etc.) get copied over into a newly created Program Year. Some info is already there - check for expanding this.

Add Information On Display Of Timed Release LM's Once Merged

Although this functionality (the messaging anyway) has not been merged and added to Ilios, it is important to note that this will need to be documented once it has been completed.

Add Information About CI Report Rollover Functionality

I don't think this is in the guide yet - it should be.

Include Screen Shots of Sessions That Cannot Be Deleted

This hasn't been released yet but will be really soon. Add a couple screen shots here ...

https://iliosproject.gitbook.io/ilios-user-guide/courses-and-sessions/sessions/delete-session

Add Information on Color Coding of Session Type Functionality

This is new and needs to be documented well.

Describe Event Detail LM Icons in Greater Detail - Required Reading

This may already be in the User Guide but I wanted to put this in for myself to make sure there is enough detail about required vs. supplemental reading in particular.

Refine The Concept of "Scheduling" Courses and Sessions

This includes clearly defining the business rules of use and well as the expected results, especially regarding what students will see when where and why.

Make Sure Inline Editing Is Covered Sufficiently

It may even require its own chapter - showing how Sessions and Offerings can both be edited in the Session list in Courses and Sessions.

Document school session attributes options

It is now possible to configure which session attributes show up on the session overview. These options are configured on the school manager.

Add Information About Inline Viewing of LM's (PDF files)

see the title - this needs to be added ASAP

Documentation Needed Regarding The Activation / De-Activation of Session Types

This is new functionality that needs to be document in the user guide as well.

Add Information About ILM Colors Being Related to Session Type

Correct License

This is not code, so the code license should not be used. Also, since we are moving to MIT, the GPL should get tossed. License should be replaced with a creative commons license covering written content:

https://creativecommons.org/licenses/by-nc/4.0/

Provide Information About the Small Group Assignment Tool

This is new functionality and needs to be added to the User Guide.

Demonstrate Updated Session List Functionality

This may be an already closed ticket duplicate. This will be used and closed when the link in the user guide to the updated session list in provided in the ticket.

Add Information About Curriculum Inventory >> Exclude

See the title - new field - needs to be documented in the User Guide.

Update Permission Matrix with Student Advisor Role Information

This is a reminder to me to update the permissions matrix with the newly-added role "Student Advisor".

Add Screen Shots of the Mobile Experience Into the User Guide

The guide mentions that screen shots are forthcoming. It needs to be so.

Provide Information About Activating / De-Activating Vocabulary Items

This is new as well and needs to be covered in the user guide.

Document Learning Materials Sort Order Manager

This feature just shipped with the latest release, please add a screenshot and instructions to the User Guide. Thanks!

Courses With No Cohort Attached Do Not Get Returned By Search

Steps to reproduce ...

• Step 1 - Perform a search that returns zero values like "Greenland"
• Step 2 - Add a Course that would get returned with a query for "Greenland".
  
• Step 3 - Perform the "Greenland" search again. Notice the lack of results. The Course added in Step 2 should have been returned.
  
• Step 4 - change the name of the Course >> "Greenland Resources" became "Greenland Treaties".
• Step 5 - run the search for "greenland" again. No Results still.
  
• Step 6 - add a session to "Greenland Treaties" as shown below.
  
• Step 7 - still no results when re-doing the greenland search.
• Step 8 - add a cohort to the course - now the results are displayed correctly