{"data":{"allMdx":{"nodes":[{"frontmatter":{"title":"Page not found","description":null},"rawBody":"---\ntitle: Page not found\n---\n\nimport { Box } from '@xstyled/styled-components'\nimport { Article, ScreenContainer, Button } from '../components'\nimport { Link } from \"gatsby\"\nimport notFoundImageURL from '../images/404.png'\n\n\n \n \n There's a leak in the website.\n \n \n \n The page you are looking for does not actually exist.\n \n
\n \n
\n \n\n","slug":"404"},{"frontmatter":{"title":"Page Management","description":"page management"},"rawBody":"---\ntitle: Page Management\nsection: Classes\ndescription: page management\norder: 7\n---\n\n\n# Page Management\n\n \n\nA module may have one or more pages which contain the learning material. The order of pages in the module can be customized by the Educator in order to guide trainees through the content. Students will see module pages in the order set by the Educator.\n\n\n## List of Pages\n\nThe pages of a module are listed on the **Pages** tab of a module page and visible to trainees in the order displayed.\n\n\n\n To see the pages in a module \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Pages** tab\n\n\n\n\n\n To edit a page name \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Pages** tab\n\n 7. Select one or more pages from the pages list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 8. Right-click on the page (or pages) to bring up the context menu\n\n 9. Click **Edit**\n\n 10. In the popup dialog, type a new name in the **Page Name** field\n\n 11. Click on the **Update** button to save your changes, or click on the **Cancel** button to cancel\n\n\n\n\n\n To adjust the order of pages \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Pages** tab\n\n 7. Click and hold on the  icon to the left of the page name, then drag it up or down to the desired position\n\n\n\n\n\n To customize the columns in the page list \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Pages** tab\n\n 7. Click on the  button at the top right of the page list\n\n 8. To add a column, click on the  button next to a field in the **Available Columns** section\n\n 9. To remove a column, click on the  button next to a field in the **Visible Columns** section\n\n 10. (Optional) To reorder the position of a visible column, click and drag the column's name up or down\n\n 11. Click on the **Save** button\n\n\n\n\n## Create a New Page\n\nPages are rich-text documents that may contain didactic information as well as interactive components. Pages may contain formatted text, images, hyperlinks, whole slide images, and various [question types](/docs/editing-pages/question-types/). Pages that are designated as “graded” will be included in the automated scoring calculations.\n\n\n\n To add a page to a module \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Pages** tab\n\n 7. Click on the **Add Page** button\n\n 8. In the popup dialog, provide a name in the **Page Name** field\n\n 9. Click on the **Submit** button\n\n\n\n\n\n To edit the contents of a page \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Pages** tab\n\n 7. Enter into a page by clicking on its name\n\n 8. Edit the content in the rich text editor. See [Editing Pages](/docs/editing-pages/rich-text-editor/) for more details\n\n 9. Click on the **Save** button to save your changes\n\n 10. (Optional) Click on the **Preview Page** button to see how the content will render for Students\n\n\n\n\n## Duplicate an Existing Page\n\nDuplication provides an easy mechanism to duplicate previously generated pages in a new module or class. A duplicated page retains all the contents of the original but none of the student responses that may have been provided in the original. All questions in the duplicate copy must be answered by students, irrespective of responses that may have been provided in the original page.\n\n\n\n To duplicate a page \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Pages** tab\n\n 7. Select one or more pages from the pages list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 8. Right-click on the page (or pages) to bring up the context menu\n\n 9. Click **Copy**\n\n 10. (Optional) In the popup dialog, type a name for the new page(s)\n\n 11. (Optional) Select the class and module to copy the module to:\n 1. Click on the **Edit** button next to **Location**\n 2. Select or simply type the name of the class from the **Class** dropdown (by default, the current class is selected)\n 3. Select or simply type the name of the module from the **Module** dropdown (by default, the current module is selected)\n\n 12. Click on the **Copy** button\n\n\n\n\n## Delete a Page\n\nExercise extreme caution when deleting pages. All content related to a deleted page is immediately purged from the system, including reports and results that may have been available.\n\n
\n It’s not possible to recover deleted pages.\n
\n\n\n\n To delete a page \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Pages** tab\n\n 7. Select one or more pages from the pages list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 8. Right-click on the page (or pages) to bring up the context menu\n\n 9. Click **Delete**\n\n 10. In the popup dialog, review the names or total number of pages to be deleted\n\n 11. Type \"DELETE\" in the text box to confirm deletion\n\n 12. Click on the **Delete** button\n\n\n","slug":"docs/classes/page-management"},{"frontmatter":{"title":"Class Management","description":"class management"},"rawBody":"---\ntitle: Class Management\nsection: Classes\ndescription: class management\norder: 5\n---\n\n\n# Class Management\n\n \n\nClasses have properties that mimic in-person classes such as start and end dates, students, a bulletin board, and reports. See [Data Model - Classes](/docs/general/data-model/#classes) for more details. To deliver teaching material to a new cohort of trainees, Educators may create a new class and content from scratch or duplicate an existing class in order to reuse its content.\n\nIt’s not necessary to delete classes since past classes can be hidden, out of sight and out of mind, until they are needed again. Retaining past classes may be helpful for reusing content and also for accessing historical reports.\n\n\n## List of Classes\n\nAll classes are listed on the Classes page, in a tabular format that can be sorted. It may be helpful to hide past classes in this view as the list of classes grows over time.\n\nWhen either the **Start Date** or **End Date** are not defined for a class, the class listing displays \"Any time\" in the appropriate column.\n\n\n\n To view the class list \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n\n\n\n\n To sort the class list \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on any of the table headers until the desired sort order is shown (sort order is shown with  for ascending order and  for descending order adjacent to the column header)\n\n\n\n\n\n To hide past classes \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on the  button at the top right of the class list\n\n 4. Set the **Show past classes** toggle (determined by the class End Date)\n\n\n\n\n\n To search for a specific class \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Type the name or a portion of the name of a class in the **Search for a class...** bar above the class list\n\n\n\n\n\n To customize the columns in the class list \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on the  button at the top right of the class list\n\n 4. To add a column, click on the  button next to a field in the **Available Columns** section\n\n 5. To remove a column, click on the  button next to a field in the **Visible Columns** section\n\n 6. (Optional) To reorder the position of a visible column, click and drag the column's name up or down\n\n 7. Click on the **Save** button\n\n\n\n\n## Create a New Class\n\nCreating a new class should be considered for courses that have not previously been offered through the platform or for courses that differ significantly from previous offerings. In these cases, the Educator will be required to provide new content, possibly by porting content from external sources. It is also possible to pull sections (e.g., individual modules and/or pages) from existing classes using the convenient duplication functions.\n\n\n\n To add a new class \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on the **Add Class** button and in the popup dialog that appears:\n 1. Provide a name in the **Class Name** field\n 2. (Optional) Set the **Start Date** field to limit the availability of the class\n 3. (Optional) Set the **End Date** field to limit the availability of the class\n\n 4. Click on the **Submit** button\n\n\n
\n Set the Start Date and/or End Date for classes to limit their availability. Without a start and end date, Students enrolled in a class will be able to see class content even though it may not be ready.\n
\n\n\n\n
\n Be sure to add content to your new class and enroll Students.\n
\n\n\n## Duplicate an Existing Class\n\nClasses are designed to be duplicated easily, so that the contents from past classes can be readily reused with new cohorts while preserving (the reports and contents of) past iterations. When a class is duplicated, only its contents are copied into a new class (i.e., modules and pages are copied but Students, reports and bulletins are not). After duplication, new Students should be enrolled in the duplicate class and start and end dates should be adjusted as necessary.\n\n\n\n To duplicate a class \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Select one or more classes from the class list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them (to see past classes, ensure the **Show past classes** toggle is enabled)\n\n 4. Right-click on the class (or classes) to bring up the context menu\n\n 5. Click **Copy**\n\n 6. In the popup dialog, type a name for the new class\n\n 7. Click on the **Copy** button\n\n\n
\n The Copy Class dialog only pops up when copying a single item. Copying multiple classes will use the default name \"Copy of class name\" for each of the duplicates.\n
\n\n\n\n\n## Edit Class Properties\n\n\n\n To edit a class's properties (name and availability dates) \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Select one or more classes from the class list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them (to see past classes, ensure the **Show past classes** toggle is enabled)\n\n 4. Right-click on the class (or classes) to bring up the context menu\n\n 5. Click **Edit**\n\n 6. In the popup dialog that appears:\n 1. (Optional) Type a new name in the **Class Name** field\n 2. (Optional) Set the **Start Date** field to limit the availability of the class\n 3. (Optional) Set the **End Date** field to limit the availability of the class\n\n 7. Click on the **Update** button to save your changes, or click on the **Cancel** button to cancel\n\n\n\n\n## Student Management\n\nThe Students tab shows the tabular list of Students currently enrolled in the class, making it convenient to sort the entries. Each entry shows the Student's name, email address, date of enrollment in the class, last login time, and current account status.\n\n\n\n\n To sort the list of Students \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. (Optional) Filter the classes by name using the **Search for a class...** bar above the class list\n\n 4. Click on a class name from the class list\n\n 5. Select the **Students** tab\n\n 6. From the table header, click on a column until the desired sort order is shown (sort order is shown with  for ascending order and  for descending order in the table header adjacent to the selected column)\n\n\n\n\n### Enrolling Students\n\nStudents can be enrolled in classes after they have been added as a user in the platform. All new users receive an account activation notice by email and will be required to create a password to log in.\n\n
\n Students will not receive a notification when enrolled in a class.\n
\n\n \n\n
\n Students can see classes they have been enrolled in by logging into the platform.\n
\n\n\n\n To create a user account for a Student \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n 3. Click on the **Create User** button\n\n 4. Enter the student’s name in the **Name** field\n\n 5. Enter the student’s email address in the **Email** field\n\n 6. Select \"Student\" from the **Role** dropdown\n\n 7. Click on the **Create User** button to finish\n\n\n\n\n\n To enroll Students in a class \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. (Optional) Filter the classes by name using the **Search for a class...** bar above the class list\n\n 4. Click on a class name from the class list\n\n 5. Select the **Students** tab\n\n 6. Search for the Student's name from the **Add a Student...** dropdown and click on their name; repeat as necessary\n\n 7. Click on the **Add Student(s)** button that appears to the right of the dropdown\n\n\n\n\n\n To remove Students from a class \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. (Optional) Filter the classes by name using the **Search for a class...** bar above the class list\n\n 4. Click on a class name from the class list\n\n 5. Select the **Students** tab\n\n 6. Select one or more Students by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 7. Right-click on the Student (or Students) to bring up the context menu, or click on the **Student(s) Selected** button that appears at the top right of the table\n\n 8. Click **Remove**\n\n 9. Click on the **Yes** button to confirm deletion\n\n\n
\n Removing a Student will revoke their access to the class and hide their results from reports.\n
\n\n\n\n\n## Class Bulletin\n\nThe class bulletin provides an area to deliver announcements to the class. If enabled, trainees will have access to the bulletin board. Furthermore, each time the bulletin board is modified the Educator may choose to notify trainees. You may choose to not notify trainees about changes in the bulletin, if the changes/edits are minor (e.g., a grammatical correction). If the notify option is chosen, trainees will receive an in-app notification about the change the next time they open the class.\n\n
\n Adjust the Display page toggle to show or hide the bulletin to Students.\n
\n\n\n\n To edit the class bulletin \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. (Optional) Filter the classes by name using the **Search for a class...** bar above the class list\n\n 4. Click on a class name from the class list\n\n 5. Select the **Bulletin** tab\n\n 6. Edit the contents of the bulletin message\n\n 7. Adjust the **Display page** toggle to show or hide the bulletin\n\n 8. Click on the **Save** button\n\n 9. When prompted, choose **Notify Students** to notify\\* Students about this change, or choose **Don’t Notify** to save the changes without notifying Students\n\n 10. (Optional) Click on the **Preview Page** button to see how the content will render for Students\n\n\n \\*The notice is delivered via the  icon next to the **Bulletin** tab when a Student enters the class. Users that are logged in while the change is performed will not see the notice until a page refresh is performed (keyboard shortcut F5) or until the next time they log in, and still only when they (re)enter the affected class.\n\n\n\n\n## Deleting Classes\n\nExercise extreme caution when deleting classes. All content related to a deleted class is immediately purged from the system, including reports and results that may have been available.\n\n
\n It’s not possible to recover deleted classes.\n
\n\n\n\n To delete a class \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Select one or more classes from the class list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them (to see past classes, ensure the **Show past classes** toggle is enabled)\n\n 4. Right-click on the class (or classes) to bring up the context menu\n\n 5. Click **Delete**\n\n 6. In the popup dialog, review the IDs or total number of classes to be deleted\n\n 7. Type \"DELETE\" in the text box to confirm deletion\n\n 8. Click on the **Delete** button\n\n\n","slug":"docs/classes/class-management"},{"frontmatter":{"title":"Editing Pages","description":"editing pages"},"rawBody":"---\ntitle: Editing Pages\nsection: Editing Pages\ndescription: editing pages\norder: 11\n---\n\n\n# Editing Pages\n\n \n\nEditing pages will be familiar to anyone that has used a rich text editor. Many of the controls for formatting text (bold, underline, italics), creating lists, and adding headings will behave in a familiar fashion. Use the toolbar on the page of each page to see the list of available formatting options. In addition to formatted text, pages may contain media types (images and video), whole slide images, hyperlinks, and a variety of question types.\n\n## Grading\n\nPages may be marked as graded and only graded pages are considered when calculating student scores. Graded pages will be shown with a  icon in the left sidebar.\n\nWhen grading is enabled for a page, all the questions on the page will be marked for grading. This makes it easier for trainees to differentiate between graded pages and non-graded pages as they navigate through a class. Questions that appear on non-graded pages may be used as practice questions or to simply stimulate students and create engagement as content is delivered.\n\n\n\n To toggle the graded option for a page \n\n 1. Navigate to a page\n\n 2. Adjust the **This page will be graded** toggle\n\n\n","slug":"docs/editing-pages/editing-pages"},{"frontmatter":{"title":"","description":null},"rawBody":"---\nslug: /docs/\ntitle: \"\"\norder: 0\n---\n\n\n# PathcoreScholar™\n\n## User Manual\n\n[Release Notes - v2.0.1](https://docs.pathcore.com/scholar/release-notes/v2.0.1/)\n\n\n","slug":"docs/"},{"frontmatter":{"title":"Button Types","description":"button types"},"rawBody":"---\ntitle: Button Types\nsection: Editing Pages\ndescription: button types\norder: 14\n---\n\n\n# Button Types\n\n \n\n## Popup Button\n\nA popup button provides a mechanism for adding rich text content that is hidden until requested by trainees. Trainees reveal the hidden content simply by clicking on the popup button, which expands to reveal its content. Popup buttons may be associated with points that are awarded or deducted when the popup button is first clicked by trainees.\n\nA popup button that provides zero points can help declutter pages, by hiding (minimizing) detailed information until it’s needed. However, a popup button with non-zero points can be used to mimic certain real-life situations where the impact of requesting the information is non-trivial. For example, trainees that frivolously request unnecessary information can be penalized when requesting content through popup buttons. Conversely, trainees can be rewarded with points for requesting popup content that is relevant for the task at hand.\n\n\n\n To create a popup button \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the button inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Pop-Up** from the dropdown menu\n\n\n\n\n\n To edit a popup button \n\n 1. Navigate to a popup button on the page\n\n 2. Click on the  button next to the button\n\n 3. Enter the text that appears on the button in the **Button text** field\n\n 4. (Optional) Enter the points awarded for the popup in the **Points for opening** field\n\n 5. (Optional) Change the button to a thumbnail popup by clicking on the **+ Add Button Thumbnail** button and selecting an image using one of the available methods:\n 1. From the **Repository** tab, navigate to a folder and select an image, or\n 2. From the **Search** tab, search for an image by name and select it\n\n 6. Enter the content to display when the button is clicked in the **Popup contents** field\n\n 7. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n\n\n\n To remove a thumbnail from a popup button \n\n 1. Navigate to a popup button on the page\n\n 2. Click on the  button next to the button\n\n 3. Click on the **Remove Thumbnail** button\n\n 4. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n\n\n\n To remove a popup button from a page \n\n 1. Navigate to a popup button on the page\n\n 2. Position the cursor below the popup button in the rich text editor\n\n 3. Press the **Backspace** key (on Windows) or **Delete** key (on macOS) on your keyboard twice\n\n\n\n\n## Hidden Data Button\n\nA hidden data button provides a mechanism for incorporating a menu of hidden information until requested by trainees. Trainees can “request” items from the menu with an explicit action (i.e., by selecting the menu items and clicking the **Submit** button). The menu can be used to deliver, upon request, textual information or a supported media type. Each menu item may be associated with points that are awarded or deducted as these are requested.\n\nHidden data buttons, like popup buttons, can be used to mimic real-life situations where the impact of requesting information is non-trivial. For example, in a laboratory setting, hidden data buttons can be used to provide a menu of ancillary tests; trainees can be penalized for frivolous requests and rewarded for valid requests.\n\n\n\n To create a hidden data button \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the button inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Hidden Data** from the dropdown menu\n\n\n\n\n\n To edit a hidden data button \n\n 1. Navigate to a hidden data button on the page\n\n 2. Click on the  button next to the button\n\n 3. Enter the text that appears on the button in the **Button text** field\n\n 4. Add an action item to the popup; repeat as necessary\n 1. Click on the **+ Add Item** button\n 2. Enter the item name in the **Name** column\n 3. Select the type of content for this item from the **Type** dropdown (_Text_, _Image_, or _Image Viewer_)\n 4. In the **Response** column, provide the content to be shown to the Student when this item is selected:\n 1. For _Text_ types: enter the message in the provided field\n 2. For _Image_ types: click the **+** button to choose an image from the Repository\\*\n 3. For _Image Viewer_ types: click the **+** button to choose an image from the Repository\\*\n\n 5. Enter the points awarded for the range in the **Points** field\n\n 5. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n \\*Select an image using one of the available methods:\n - From the **Repository** tab, navigate to a folder and select an image, or\n - From the **Search** tab, search for an image by name and select it\n\n\n\n\n\n To remove an action item from a hidden data button menu \n\n 1. Navigate to a hidden data button on the page\n\n 2. Click on the  button next to the button\n\n 3. Click on the  button to the right side of the action item to remove it\n\n 4. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n\n\n\n To remove a hidden data button from a page \n\n 1. Navigate to a hidden data button on the page\n\n 2. Position the cursor below the hidden data button in the rich text editor\n\n 3. Press the **Backspace** key (on Windows) or **Delete** key (on macOS) on your keyboard twice\n\n\n","slug":"docs/editing-pages/button-types"},{"frontmatter":{"title":"","description":null},"rawBody":"# FAQ page\n","slug":"faq"},{"frontmatter":{"title":"Media Types","description":"media types"},"rawBody":"---\ntitle: Media Types\nsection: Editing Pages\ndescription: media types\norder: 12\n---\n\n\n# Media Types\n\n \n\n## Images\n\nImages can be intermixed into the content of pages. Images are best suited for photographs, clip art, figures, and similar content which are low resolution and do not need to be annotated.\n\nImages are presented to Students like regular images on most websites; that is they are visible on the page, as laid out by the Educator, and can be viewed in gallery-mode when they are clicked.\n\n\n### Inserting Static Images From the Repository\n\nStatic images can be inserted from the content of the Repository. Where the image inserted is not a standard image (e.g., JPEG, PNG, GIF), the system will insert the thumbnail equivalent (e.g., when inserting whole slide images). To insert whole slide images, see [Image Viewer](#image-viewer).\n\n\n\n To find and insert an image from the Repository \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the image inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Image** from the dropdown menu\n\n 5. Select an image using one of the available methods:\n 1. From the **Repository** tab, navigate to a folder and select an image, or\n 2. From the **Search** tab, search for an image by name and select it\n\n\n\n\n### Inserting Static Images From the Clipboard\n\nStatic images can be inserted directly into pages from the computer’s clipboard. Note that these images are automatically stored in the **Scholar Uploads/MODULE-NAME** folder of the Repository for future reference, where **MODULE-NAME** is the name of the current module.\n\n\n\n To insert an image from the clipboard \n\n 1. Navigate to a page\n\n 2. Press the **Ctrl + V** keyboard keys to paste from your clipboard\n\n\n\n\n### Static Images Properties\n\nEducators can control the layout and size of static images. Regardless of the size, trainees can expand these images and view them in gallery mode, which shows static images at their maximum resolution (but never larger than the screen size).\n\n\n\n To modify the size of a static image \n\n 1. Click on the image to reveal the alignment options\n\n 2. Hover over the left or right edge of the image until your cursor changes to a double-headed arrow\n\n 3. Click and drag the side of the image to adjust the image size\n\n\n\n\n\n To modify alignment of a static image \n\n 1. Click on the image to reveal the alignment options above the image border\n\n 2. Choose one of the available alignment options\n -  **Inline left align**: The image is aligned to the left and breaks up surrounding text\n -  **Floating left align**: The image is aligned to the left and surrounding text wraps around it\n -  **Inline center align**: the image is aligned in the center of the page and breaks up surrounding text\n -  **Floating right align**: The image is aligned to the right and surrounding text wraps around it\n\n\n\n\n\n To remove a static image from a page \n\n 1. Select an image on the page\n\n 2. Press the **Delete** key on your keyboard\n\n\n\n\n## Image Viewer\n\nImage Viewer is best suited for images that would normally require panning and zooming, such as whole slide images, medical images, and images that an Educator would like to annotate using the available markup tools. Image Viewer presents images in a full-featured viewing environment. Educators can also control the annotations that are visible and other properties designed for pathology and medical images.\n\n### Inserting Interactive Images\n\nInteractive images can only be inserted from the Repository; ensure images have been uploaded to the Repository before insertion. These images can be presented in two modes:\n\n- **Inline**: embeds an interactive virtual slide Viewer directly on the page (in Student View) that is 877 pixels x 480 pixels (w, h)\n- **Thumbnail**: embeds thumbnails of the images (in Student View) that once clicked launch an interactive virtual slide Viewer\n- Both modes provide the option to view all of the images [Side-by-Side](/docs/classes/student-view/#side-by-side-view)\n\n\n\n To insert an Image Viewer \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the Image Viewer inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Image Viewer** from the dropdown menu\n\n 5. Add one or more images; repeat as necessary\n 1. Click on the **+ Image** button\n 2. Select an image using one of the available methods:\n 1. From the **Repository** tab, navigate to a folder and select an image, or\n 2. From the **Search** tab, search for an image by name and select it\n 3. (Optional) Set the image properties. See [Interactive Image Properties](#interactive-image-properties) for details\n 4. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n 6. Click on the desired _Display mode_ button: **Inline** or **Thumbnail**\n\n\n\n\n\n To add an image to an Image Viewer \n\n 1. Navigate to an Image Viewer on the page\n\n 2. Click on the **+ Image** button\n\n 3. Select an image using one of the available methods:\n 1. From the **Repository** tab, navigate to a folder and select an image, or\n 2. From the **Search** tab, search for an image by name and select it\n\n 4. (Optional) Set the image properties. See [Interactive Image Properties](#interactive-image-properties). for details\n\n 5. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n\n\n\n To change an image in an Image Viewer \n\n 1. Navigate to an Image Viewer on the page\n\n 2. Click on the image thumbnail to change\n\n 3. Click on the **Change Image** button\n\n 4. Select an image using one of the available methods:\n 1. From the **Repository** tab, navigate to a folder and select an image, or\n 2. From the **Search** tab, search for an image by name and select it\n\n 5. (Optional) Set the image properties. See [Interactive Image Properties](#interactive-image-properties) for details\n\n 6. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n\n\n\n To remove an image from an Image Viewer \n\n 1. Navigate to an Image Viewer on the page\n\n 2. Hover over the image thumbnail to remove\n\n 3. Click on the **X** at the top right corner of the thumbnail\n\n 4. Click on the **Yes** button to confirm\n\n\n\n\n\n To remove an Image Viewer from a page \n\n 1. Navigate to an Image Viewer on the page\n\n 2. Click on the  button at the top right corner of the block\n\n\n\n\n### Interactive Image Properties\n\nEducators may choose the set of annotations that should be visible to Students on each interactive image and can set the default (initial) region of interest to be shown to Students. By default interactive images are configured to make all annotations visible to Students and the interactive Viewer will display a zoomed out version of the image, ensuring the entire image is visible at first sight.\n\n\n\n To make all annotations on an image visible to Students \n\n 1. Navigate to an Image Viewer on the page\n\n 2. Click on the image thumbnail to change\n\n 3. Enable the **Show all annotations by default** toggle\n\n\n\n\n\n To make some annotations on an image visible to Students \n\n 1. Navigate to an Image Viewer on the page\n\n 2. Click on the image thumbnail to change\n\n 3. Disable the **Show all annotations by default** toggle\n\n 4. Click on the **Set Visible Annotations** button\n\n 5. In the provided dialog, select the annotations that should be visible from the list on the left and click on the **Done** button at the top right corner\n\n\n\n\n\n To set the default region of interest for an image \n\n 1. Navigate to an Image Viewer on the page\n\n 2. Click on the image thumbnail to change\n\n 3. Pan and zoom the image to the desired default area\n\n 4. Click on the **Set Initial Position** button\n\n\n\n\n## Videos\n\nExternal video clips from a number of video stream sites can be embedded in pages. The following streaming services are supported:\n\n- YouTube\n- Vimeo\n- DailyMotion\n\n\n\n To insert a video clip \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the video inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Video** from the dropdown menu\n\n 5. In the **Video URL** field, paste the URL of the video. Typically the URL can be obtained using the share button of video players or from your browser’s address bar\n\n 6. Click on the **Select** button\n\n\n\n\n\n To change a video clip \n\n 1. Navigate to a video block on the page\n\n 2. Click on the  button at the top right corner of the block\n\n 3. Paste the new video URL in the **Video URL** field\n\n 4. Click on the **Change** button\n\n\n\n\n\n To remove a video clip from a page \n\n 1. Navigate to a video block on the page\n\n 2. Click on the  button at the top right corner of the block\n\n\n","slug":"docs/editing-pages/media-types"},{"frontmatter":{"title":"Student View","description":"student view"},"rawBody":"---\ntitle: Student View\nsection: Classes\ndescription: student view\norder: 9\n---\n\n\n# Student View\n\n \n\n\n## Home Page\n\nWhen Students log in to PathcoreScholar, the first screen displayed is their home page.\n\n### Greeting\n\nAn optional, customized greeting message can be displayed on the home page. If this message has been updated since the last time the Student logged in, this is indicated via the text \"Updated\" next to the title of the page and a  icon next to the  **Home** button in the left-hand [navigation sidebar](#navigation-sidebar). The last time the message was updated is always displayed below the message itself.\n\n\n### List of Classes\n\nThe Student's home page also displays all of their currently active classes. Classes are listed by name, and each shows the number of modules contained within as well as the start and end date, if set.\n\n
\n Only active classes — i.e., those where the current date is between the defined start and end dates — are displayed on the Student's home page.\n
\n\n\n### Navigation Sidebar\n\nThe left-hand sidebar can be used to quickly access available classes, modules, and pages.\n\nClick on the  button next to a class name in the sidebar to expand it and display the list of modules for that class. Click on the  button again to collapse the list. Modules in the list can be expanded and collapsed in the same manner to display the list of pages for that module.\n\nModules and pages in the list can have an icon next to their name to indicate the following:\n-  **Gray Briefcase**: This module contains graded pages\n-  **Blue Briefcase**: All graded pages in this module have been completed\n-  **Lock**: This module is past its due date, or is not yet available\n-  **Gray Checkmark**: This page contains graded questions\n-  **Blue Checkmark**: All graded questions in this page have been completed\n\n\n## Classes\n\nA class contains a set of modules and an optional bulletin board. Modules are how a class's content is organized, akin to chapters in a book.\n\n### List of Modules\n\nThe modules for a class are listed on the **Modules** tab of a class page. The order of the modules is set by the Educator.\n\n
\n Modules which are not currently available — i.e., those that are past their due date or that have not yet started — are displayed with their names grayed out.\n
\n\n### Class Bulletin\n\nA class may also have a bulletin written by the Educator to deliver announcements to all the Students in that class. If enabled, a **Bulletin** tab will be available. If the bulletin has been updated since the last time the Student logged in, this is indicated via a  icon next to the **Bulletin** tab.\n\n\n## Modules\n\nA module contains one or more pages of learning material created and organized by the Educator.\n\n### List of Pages\n\nThe pages of a module are listed on the **Pages** tab of a module page. The order of the pages is set by the Educator.\n\n\n## Pages\n\nPages are rich-text documents that may contain didactic information as well as interactive components. Pages may contain formatted text, images, hyperlinks, whole slide images, and various question types. Pages that are designated as “graded” will be included in scoring calculations.\n\n\n### Image Viewer Blocks\n\nAn Image Viewer block provides a way for Students to view one or more images in the [Viewer](#viewer), which is a full-featured viewing environment best suited for images that would normally require panning and zooming. The Educator decides whether to embed an inline Viewer or provide thumbnails to click through to a popup dialog.\n\n\n\n To open an embedded image in the Viewer in a new browser tab \n\n 1. Hover over the Image Viewer Block\n\n 2. Click on the  **Open Image** button at the top left of the block\n\n\n\n\n\n To open an image thumbnail in the Viewer in a new browser tab \n\n 1. Hover over the Image Viewer Block\n\n 2. Click on the image thumbnail\n\n 3. Click on the  **Open Image** button at the top left of the popup dialog\n\n\n\n\n### Question Blocks\n\nThere are several question types available such as multiple choice, number input, and short answer, among others. Most question types provide an opportunity for the Educator to give feedback in the form of a \"response message\". Response messages may be used to reinforce why a particular response is correct or to guide trainees toward the correct answer in case of incorrect answers.\n\n
\n Response messages are NOT shown to Students for graded pages.\n
\n\n#### Multiple Choice Question\n\nMultiple choice questions provide a list of options for Students to select and have one correct answer.\n\nIf the page is not graded, a unique response message may be provided for each choice.\n\n#### Number Input Question\n\nThe number input question allows Students to input a number in response to a question. Educators have a great deal of flexibility when it comes to defining the correct answer(s) through one or more value ranges. Each range is associated with a point value, making it easy to reward accurate answers with more points and incorrect answers with fewer, or even negative, points.\n\nIf the page is not graded, a unique response message may be provided for each range of values.\n\n#### Short Answer Question\n\nThe short answer question type allows Students to respond to a question using free-form text. This is the only question type that must be scored manually by an Educator.\n\nIf the page is not graded, a response message may be provided after answering.\n\n#### Pin Drop Question\n\nPin drop questions provide a unique and interactive process for Students to identify relevant structures on an image. Rather than narrowing the field-of-view for a question, Educators can ask trainees to locate structures present in the image with pins. With the pin drop question, each \"pin\" corresponds to a structure that the Educator wants identified and trainees are expected to drag the pins over the corresponding areas in the image.\n\n\n## Viewer\n\nWhether embedded, in a popup dialog, or a separate browser tab, the Viewer displayed to Students provides a subset of the features offered to an Educator or Administrator. Notable changes include:\n- The image name and slide label are hidden from Students\n- Students are unable to add annotations\n- (Optional) Some or all of the annotations may be hidden from Students\n- The left sidebar is not available to Students. Therefore they do not have access to any of the features of the Image Information, Browse Folder, Image Adjustment, Overlays, Annotations, nor Share Image panels.\n\n\n### Side-by-Side View\n\nSide-by-Side View allows multiple images to be viewed simultaneously in the Viewer. Each image is confined to a dedicated panel within the viewing area and retains all the usual capabilities that are available when viewing a single image (e.g., annotating, panning, and zooming).\n\n\n\n To enter Side-by-Side View \n\n 1. Navigate to a page that includes an [Image Viewer](/docs/editing-pages/media-types/#image-viewer) block\n\n 2. Click on the **View Side-by-Side**  button below the inline Viewer or the thumbnail view of the images\n\n\n\n\n\n To exit Side-by-Side View \n\n 1. Click on the  button at the right corner of the Viewer top bar\n\n\n\n\n#### Panel Layout\n\nWhen in Side-by-Side View, the Viewer is divided into a row of image panels. These panels can be rearranged or individually hidden by the Student.\n\n\n\n To rearrange image panels \n\n 1. Click on the  button in the Viewer top bar to display the Slide Arrangement dialog\n\n 2. Click and hold on the  icon to the left of the image and drag it up or down to change its position\n\n\n\n\n\n To show/hide image panels \n\n 1. Click on the  button in the Viewer top bar to display the Slide Arrangement dialog\n\n 2. Click on the  button to the right of an image to toggle its visibility\n\n\n\n\n#### Panel Controls\n\nSide-by-Side View divides the available on-screen space for the Viewer into one or more panels, depending on the number of images that have been chosen. While each panel can be independently controlled, only one panel can be controlled at any given point in time.\n\n
\n The selected (controllable) image is denoted with a blue border around its panel.\n
\n\n\n\n To select an image for navigation \n\n 1. Click into any panel to activate it. Note the blue border that appears around the active panel\n\n 2. Use the standard [Basic Controls](/docs/viewer/basic-controls/) to navigate the image\n\n\n\n\n\n To enable the rotation tool for the selected panel \n\n 1. Hover or click on the image to reveal the toolbar at the top left of the panel\n\n 2. Click on the  button to expand the toolbar if necessary\n\n 3. Click on the  button in the toolbar to show or hide the rotation tool\n\n\n\n\n#### Color Management\n\nFor RGB images, the color correction profile of an image in a panel can be adjusted. The capabilities that are available in the Viewer are also available in Side-by-Side View panels. See [Color Management](/docs/viewer/basic-controls/#color-management) for more details.\n\n\n\n To change the color management profile for the selected panel \n\n 1. Hover or click on the image to reveal the toolbar at the top left of the panel\n\n 2. Click on the  button to expand the toolbar if necessary\n\n 3. Click on the  button dropdown in the toolbar to reveal the color management dialog\n\n 4. Select one of the available ICC color profiles\n\n\n\n\n#### Single Panel Mode\n\nSide-by-Side View reduces the screen area available for each image in the set. If more screen area is required, it's possible to temporarily expand one panel to return to a single image configuration.\n\n\n\n To expand a single image panel \n\n 1. Hover or click on the image to reveal the toolbar at the top left of the panel\n\n 2. Click on the  button to expand the toolbar if necessary\n\n 3. Click on the  button\n\n\n\n\n\n To minimize an expanded panel (to return to Side-by-Side View mode) \n\n 1. Hover or click on the image to reveal the toolbar at the top left of the panel\n\n 2. Click on the  button to expand the toolbar if necessary\n\n 3. Click on the  button\n\n\n\n\n#### Synchronization\n\nImages can be synchronized so that panning and magnification actions are performed simultaneously on all images in the Viewer which have been marked as \"synchronized\".\n\n\n\n To synchronize specific images \n\n 1. Hover or click on the image to reveal the toolbar at the top left of the panel\n\n 2. Click on the  button\n\n 3. Repeat steps 1 and 2 for each image to synchronize\n\n\n\n\n\n To synchronize the row of images \n\n 1. Hover or click on any image from the row to be synchronized, to reveal the toolbar at the top left of the panel\n\n 2. Click on the  button next to the  button\n\n 3. Select **Synchronize Row** from the dropdown menu\n\n\n\n\n\n To synchronize all images in the Viewer \n\n 1. Click on the  button in the Viewer top bar to display the synchronize menu\n\n 2. Select **Synchronize All** from the dropdown menu\n\n\n\n\n#### Magnification\n\nThe magnification of the currently selected image can be applied to all synchronized images or to all images in the Viewer.\n\nIf you zoom an image that is part of a synchronized set, the change in magnification is also applied to other images in the set. When an image is pushed past its native resolution, the Viewer applies a [digital zoom](/docs/viewer/basic-controls/#digital-zoom).\n\n
\n When the digital zoom is applied as a result of zooming another image in the synchronized set, there is no restriction enforced. In this manner, it is possible to attain a digital zoom greater than the 400% limit for a single image.\n
\n\n\n\n To apply the current magnification to all images in the Viewer \n\n 1. Click on the current image magnification in the Viewer top bar\n\n 2. Select **Apply to All Slides** from the dropdown menu\n\n\n\n\n\n To apply the current magnification to synchronized images \n\n 1. Click on the current image magnification in the Viewer top bar\n\n 2. Select **Apply to Synchronized Slides** from the dropdown menu\n\n\n","slug":"docs/classes/student-view"},{"frontmatter":{"title":"Rich Text Editor","description":"rich text editor"},"rawBody":"---\ntitle: Rich Text Editor\nsection: Editing Pages\ndescription: rich text editor\norder: 10\n---\n\n\n# Rich Text Editor\n\n \n\nPages are rich-text documents that are editable. Pages may contain formatted text, images, hyperlinks, whole slide images, and various types of questions. Pages that are designated as “graded” will be included in the automated scoring calculations.\n\n\n## Formatting\n\nThe following formatting options are available in the editor:\n\n- Text styles (H1, H2, H3, quotes)\n- Font styles (bold, underline, and italics)\n- Quoted text\n- Enumerated lists\n- Bullet lists\n\n\n## Hyperlinks\n\nHyperlinks can be useful to link to another page or module in PathcoreScholar, link to content from the Repository or to link to external resources.\n\n\n\n To create a hyperlink \n\n 1. Navigate to a page\n\n 2. Highlight some text to be hyperlinked\n\n 3. Click on the  button in the rich text editor toolbar\n\n 4. Type or paste the URL into the field that appears and press the **Enter** key\n\n\n\n\n\n To delete a hyperlink \n\n 1. Navigate to a page\n\n 2. Highlight the hyperlinked text\n\n 3. Click on the  button to remove the hyperlink or press the **Delete** key on your keyboard to remove the text entirely\n\n\n","slug":"docs/editing-pages/rich-text-editor"},{"frontmatter":{"title":"","description":null},"rawBody":"---\nslug: /\nredirect: /docs/\n---\n","slug":""},{"frontmatter":{"title":"Module Management","description":"module management"},"rawBody":"---\ntitle: Module Management\nsection: Classes\ndescription: module management\norder: 6\n---\n\n\n# Module Management\n\n \n\nClasses may have one or more modules. Modules provide organizational benefits, akin to chapters in a book. The order of modules can be customized by the Educator in order to guide trainees through their contents and modules may have availability dates, allowing Educators to gate their content. See [Data model - Modules](/docs/general/data-model/#modules) for more information.\n\nModules that are not accessible due to their availability dates will be grayed out for trainees.\n\nWhen the module availability dates are not defined (the default case), the module is available to students enrolled in the class as long as the class is available.\n\n\n## List of Modules\n\nThe modules for a class are listed on the **Modules** tab of a class page and visible to trainees in the order displayed, despite their availability dates.\n\nWhen either the **Available from** date or **Due by** date are not defined for a module, the module listing displays \"Any time\" in the appropriate column.\n\n\n\n To see the module list for a class \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. (Optional) Enable the **Show past classes** toggle to see past classes\n\n 4. (Optional) Filter the classes by name using the **Search for a class...** bar above the class list\n\n 5. Click on a class name from the class list\n\n 6. Select the **Modules** tab\n\n\n\n\n\n To edit a module's properties (name and availability dates) \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. (Optional) Filter the modules by name using the **Search for a module...** bar above the module list\n\n 6. Select one or more modules from the module list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 7. Right-click on the module (or modules) to bring up the context menu\n\n 8. Click **Edit**\n\n 9. In the popup dialog that appears:\n 1. (Optional) Type a new name in the **Module Name** field\n 2. (Optional) Set the **Available Date** field to limit the availability of the module\n 3. (Optional) Set the **Due Date** field to limit the availability of the module\n\n 10. Click on the **Update** button to save your changes, or click on the **Cancel** button to cancel\n\n\n\n\n\n To adjust the order of modules \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click and hold on the  icon to the left of the module name, then drag it up or down to the desired position\n\n\n\n\n\n To customize the columns in the module list \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on the  button at the top right of the module list\n\n 6. To add a column, click on the  button next to a field in the **Available Columns** section\n\n 7. To remove a column, click on the  button next to a field in the **Visible Columns** section\n\n 8. (Optional) To reorder the position of a visible column, click and drag the column's name up or down\n\n 9. Click on the **Save** button\n\n\n\n\n## Create a New Module\n\nWhen you create a new module, its **Available from** and **Due by** dates are not set. When these values are not defined (the default case), the module is available to students enrolled in the class as long as the class is available. Students can see and access available modules by logging in.\n\n\n\n To add a module to a class \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on the **Add Module** button and in the popup dialog that appears:\n 1. Provide a name in the **Module Name** field\n 2. (Optional) Set the **Available Date** field to limit the availability of the module\n 3. (Optional) Set the **Due Date** field to limit the availability of the module\n\n 6. Click on the **Submit** button\n\n\n\n\n## Duplicate an Existing Module\n\nDuplication provides an easy mechanism to recycle previously generated content in the same class or a different class. A duplicated module retains all the contents of the original module but none of the responses that may have been provided in the original module. All questions in the duplicate copy must be answered by students, irrespective of responses that may have been provided in the original module.\n\n\n\n To duplicate a module \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Select one or more modules from the module list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 6. Right-click on the module (or modules) to bring up the context menu\n\n 7. Click **Copy**\n\n 8. (Optional) In the popup dialog, type a name for the new module. This option is only available when copying a single module\n\n 9. (Optional) Select the class to copy the module to:\n 1. Click on the **Edit** button next to **Location**\n 2. Select or simply type the name of the class from the **Class** dropdown (by default, the current class is selected)\n\n 10. Click on the **Copy** button\n\n\n\n\n## Delete a Module\n\nExercise extreme caution when deleting modules. All content related to a deleted module is immediately purged from the system, including reports and results that may have been available.\n\n
\n It’s not possible to recover deleted modules.\n
\n\n\n\n To delete a module \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Select one or more modules from the module list by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 6. Right-click on the module (or modules) to bring up the context menu\n\n 7. Click **Delete**\n\n 8. In the popup dialog, review the names or total number of modules to be deleted\n\n 9. Type \"DELETE\" in the text box to confirm deletion\n\n 10. Click on the **Delete** button\n\n\n\n\n## Module Notice\n\nEducators may deliver module-specific messages using an in-app notification system. A notice contains a message that is displayed when a student first opens the module, and can be referenced by students anytime after that. Each time a notice is modified, you may notify trainees again. Use the notice to inform trainees about prerequisites for a module, changes that have been made since the module was first published, or other pertinent information.\n\n
\n Adjust the Display page toggle to show or hide the notice to Students.\n
\n\n\n\n To edit the module notice \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. (Optional) Filter the modules by name using the **Search for a module...** bar above the module list\n\n 6. Click on a module name from the module list\n\n 7. Select the **Notice** tab\n\n 8. Edit the contents of the notice message\n\n 9. Adjust the **Display page** toggle to show or hide the notice\n\n 10. Click on the **Save** button\n\n 11. When prompted, choose **Notify Students** to notify\\* Students about this change, or choose **Don’t Notify** to save the changes without notifying Students\n\n 12. (Optional) Click on the **Preview Page** button to see how the content will render for Students\n\n\n \\*The notice is delivered via a popup dialog when entering the module. Users that are logged in when the change is performed will not see the notice until a page refresh is performed (keyboard shortcut F5) or until the next time they log in, and still only when they (re)enter the affected module.\n\n\n","slug":"docs/classes/module-management"},{"frontmatter":{"title":"Core Concepts","description":"core concepts"},"rawBody":"---\ntitle: Core Concepts\nsection: General\ndescription: core concepts\norder: 0\n---\n\n\n# Core Concepts\n\n \n\nPathcoreScholar is an e-learning platform designed for delivering self-directed online training. At the core of PathcoreScholar is the ability to deliver didactic content as well as interactive content through the use of whole slide images and unique assessment tools.\n\n\n## Self-Directed E-Learning\n\nPathcoreScholar is a browser-based application that can be accessed using any modern browser. It supports self-directed e-learning by enabling trainees to review course content at their own convenience (anytime and anywhere), away from the laboratory setting. Educators can deliver didactic content, incorporate whole slide images, make use of interactive questions and provide feedback in response to trainee inputs (interactively).\n\n\n## Diagnostic Simulator\n\nPathcoreScholar has been designed using the flight simulator pedagogy, allowing trainees to learn in a patient-safe environment. Core to PathcoreScholar is the ability to provide trainees with opportunities to enhance their confidence and skills through independent decision-making exercises, simulating diagnostic conditions in the laboratory or clinic. Within a simulation, cases can be presented, ancillary tests can be made available upon request and the diagnostic journey can be assessed in an automated fashion. Along the way, educators may provide feedback to ensure the learning opportunities are maximized.\n\n\n## Automated Grading\n\nAll [question types](/docs/editing-pages/question-types/) and many of the interactions in PathcoreScholar are tracked and can be graded automatically, with the exception of [short answer](/docs/editing-pages/question-types/#short-answer-question) questions. These capabilities can save significant time for educators, particularly in the medical school setting where class sizes are large.\n\nEducators can incorporate negative and positive point values in assessments in order to create an environment where guessing is penalized. Educators can view comprehensive reports for individual students or the entire class at any time, making it convenient for tracking learning outcomes and for measuring the change in performance over time.\n\n\n## Everlasting Content\n\nE-learning provides educators with the ability to develop content that can be easily improved over time. PathcoreScholar provides the ability to duplicate and edit past classes and move content between classes to ensure that the current version of a class is the best version. Educators retain, at their fingertips, the ability to review all the previous iterations of a class including student performance data.\n","slug":"docs/general/core-concepts"},{"frontmatter":{"title":"Data Model","description":"data model"},"rawBody":"---\ntitle: Data Model\nsection: General\ndescription: data model\norder: 1\n---\n\n\n# Data Model\n\n \n\nClasses have a three-level hierarchical structure defined by Class > Modules > Pages. In other words, classes contain modules which contain pages. In this model, a class is a top-level concept akin to a book, a module is akin to a book chapter and a page is akin to a section within the chapter. In PathcoreScholar, pages contain all the teaching material while classes and modules provide administration and organizational benefits.\n\n\n## Classes\n\nClasses have several properties that mimic in-person classes such as start and end dates, students, a bulletin board, and reports.\n\n\n### Class ID\n\nEach class has a unique, system-generated ID that is shown just below the class name on the home page and is visible in the class URL. This ensures that classes can be identified even when they have the same name, and that each class has a stable URL.\n\n\n### Class Name\n\nClasses must have a name, which does not have to be unique. This allows the same class to be cloned repeatedly and offered to a new set of Students and/or at different times\n\n\n### Class Availability\n\nClasses may have a **Start Date** and an **End Date** to define class availability. When these values are not defined for a class (the default case), the class is always available to enrolled Students.\n\nStudents can see and access classes that are available to them by logging in.\n\n\n### Enrolled Students\n\nClasses may have one or more Students enrolled. Only Educators can enroll Students in a class. Students can see available classes they are enrolled in by logging into the platform.\n\n\n## Modules\n\nClasses may have one or more modules. Modules provide organizational benefits, akin to chapters in a book. The order of modules can be customized by the Educator in order to guide trainees through class contents. Students will see class modules in the order set by the Educator.\n\n\n### Module ID\n\nEach module has a unique, system-generated ID. This ensures that modules can be identified even when they have the same name, and that each module has a stable URL.\n\n\n### Module Name\n\nModule must have a name, which does not have to be unique.\n\n\n### Module Availability\n\nModules have an **Available from** and a **Due by** date. When these values are not defined (the default case), modules are available to Students enrolled in the class as long as the class is available.\n\nStudents can see and access available modules by logging in.\n\n\n## Pages\n\nPages are rich-text documents that may contain didactic information as well as interactive components. Pages may contain formatted text, images, hyperlinks, whole slide images, and various [question types](/docs/editing-pages/question-types/). Pages that are designated as “graded” will be included in the automated scoring calculations.\n\n\n### Graded Pages\n\nPages may be marked as graded. When a page is marked as graded, all the questions and some of the activities performed on the page are tracked and can be used to generate a score for trainees in an automated way.\n","slug":"docs/general/data-model"},{"frontmatter":{"title":"Question Types","description":"question types"},"rawBody":"---\ntitle: Question Types\nsection: Editing Pages\ndescription: question types\norder: 13\n---\n\n\n# Question Types\n\n \n\nThere are several question types available such as multiple choice, number input, and short answer, among others. Each type has the question text to be presented to Students and the maximum number of points available for correct responses (to enable automated scoring).\n\nMost question types also provide an opportunity for the Educator to give feedback in the form of a “response message”. In the case of multiple choice questions, a unique response message may be provided for each choice. Response messages may be used to reinforce why a particular response is correct or to guide trainees toward the correct answer in case of incorrect answers. Where a page is marked as “graded”, response messages are NOT shown to Students.\n\nStudent responses are automatically saved in real time as these are entered to minimize the possibility that work will be lost in the event of a computer or network failure. In the event of an internet outage, trainees will be immediately warned that auto-save will resume when internet connectivity is available. Navigating between pages is not possible without an internet connection.\n\n
\n Response messages are NOT shown to Students for graded pages.\n
\n\n\n## Multiple Choice Question\n\nMultiple choice questions provide a list of options for Students to select and have one correct answer. Multiple choice questions can be displayed to Students in one of two modes:\n\n- **List**: choices are displayed in a vertical list for the Student to choose from\n- **Dropdown**: choices are embedded in a searchable dropdown field\n\nThe dropdown display mode is suitable for questions that have many potential answers because it’s much more compact and Students can search for or scroll to the desired answer.\n\n\n\n To create a multiple choice question \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the question inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Multiple Choice** from the dropdown menu\n\n 5. Type the question in the **Question** section\n\n 6. (Optional) Add a **Featured Image**:\n 1. From the **Repository** tab, navigate to a folder and select an image, or\n 2. From the **Search** tab, search for an image by name and select it\n\n 7. Click on the **+ Add Choices** button\n\n 8. In the popup dialog, click on the **Add New Choice** button; repeat as necessary\n 1. Enter the text in the **Choice** field\n 2. (Optional) Add a response by clicking on the **+ Add Response Message** button and entering the response message in the field that appears\n\n 9. Specify the correct answer from the list of choices by clicking on the white circle to the left of the choice text (a green circle indicates the correct choice)\n\n 10. Click on the **Apply** button to save the choices\n\n 11. (Optional) Enter the points awarded for the question in the **Points** field\n\n 12. Click on the desired _display mode_ button: **List** or **Dropdown**\n\n\n\n\n\n To add a choice to a multiple choice question \n\n 1. Navigate to a multiple choice question on the page\n\n 2. Click on the **+ Add Choices** button\n\n 3. In the popup dialog, click on the **Add New Choice** button; repeat as necessary\n 1. Enter the text in the **Choice** field\n 2. (Optional) Add a response by clicking on the **+ Add Response Message** button and entering the response message in the field that appears\n\n 4. Specify the correct answer from the list of choices by clicking on the white circle to the left of the choice text (a green circle indicates the correct choice)\n\n 5. Click on the **Apply** button to save the choices\n\n\n\n\n\n To remove a choice from a multiple choice question \n\n 1. Navigate to a multiple choice question on the page\n\n 2. Click on the  button next to \"Correct Answer\" at the bottom left of the block\n\n 3. In the popup dialog, click on the  button to the right side of the choice to remove it\n\n 4. Specify the correct answer from the list of choices by clicking on the white circle to the left of the choice text (a green circle indicates the correct choice)\n\n 5. Click on the **Apply** button to save the choices\n\n\n\n\n\n To bulk add choices to a multiple choice question \n\n 1. Navigate to a multiple choice question on the page\n\n 2. Click on the **+ Add Choices** button\n\n 3. In the popup dialog, click on the **Bulk Add Choices** button\n\n 4. In the second popup dialog, type or paste one choice per line (by pressing the **Enter** key on your keyboard)\n\n 5. Click on the **Save** button\n\n 6. Specify the correct answer from the list of choices by clicking on the white circle to the left of the choice text (a green circle indicates the correct choice)\n\n 7. Click on the **Apply** button to save the choices\n\n\n\n\n\n To remove a multiple choice question from a page \n\n 1. Navigate to a multiple choice question on the page\n\n 2. Click on the  button at the top right corner of the block\n\n\n\n\n## Number Input Question\n\nThe number input question allows trainees to input a number in response to a question. Educators have a great deal of flexibility when it comes to defining the correct answer(s) through one or more value ranges. Each range is associated with a point value, making it easy to reward accurate answers with more points and incorrect answers with fewer, or even negative, points.\n\nFor example, say a question awards:\n\n- three points for an input of 6\n- awards one point for inputs 7 or 8\n- **takes away** three points for (nonsensical) inputs that are < 0 or > 10, and 0 points for all other inputs\n\nThen the following ranges need to be defined:\n\n- 3 points for a value in the range [6, 6]\n- 1 point for a value in the range [7, 8]\n- 0 points for a value in the range [0, 10]\n- -3 points for a value in the range [-Infinity, Infinity]\n\n
\n When an input overlaps multiple ranges, the points awarded come from the overlapping range with the highest point value.\n
\n\n\n\n To create a number input question \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the question inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Number Input** from the dropdown menu\n\n 5. Type the question in the **Question** section\n\n 6. (Optional) Enable the **Integer** toggle to only allow integer (whole number) values\n\n 7. Add the first range:\n 1. Enter the value for the **Range Minimum**. The default value is \"-Infinity\" if this field is left blank\n 2. (Optional) Adjust the **Inclusive** toggle below the field (this toggle is hidden and assumed to be enabled when the **Integer** toggle is enabled)\n 3. Enter the value for the **Range Maximum**. The default value is \"Infinity\" if this field is left blank\n 4. (Optional) Adjust the **Inclusive** toggle below the field (this toggle is hidden and assumed to be enabled when the **Integer** toggle is enabled)\n 5. Enter the points awarded for the range in the **Points** field\n 6. (Optional) Add a response by clicking on the **+ Add Response Message** button and entering the response message in the field that appears\n\n\n\n\n\n To add a range to a number input question \n\n 1. Navigate to a number input question on the page\n\n 2. Click on the **+Add Range** button at the bottom of the question block\n\n 3. Enter the value for the **Range Minimum**. The default value is \"-Infinity\" if this field is left blank\n\n 4. (Optional) Adjust the **Inclusive** toggle below the field (this toggle is hidden and assumed to be enabled when the **Integer** toggle is enabled)\n\n 5. Enter the value for the **Range Maximum**. The default value is \"Infinity\" if this field is left blank\n\n 6. (Optional) Adjust the **Inclusive** toggle below the field (this toggle is hidden and assumed to be enabled when the **Integer** toggle is enabled)\n\n 7. Enter the points awarded for the range in the **Points** field\n\n 8. (Optional) Add a response by clicking on the **+ Add Response Message** button and entering the response message in the field that appears\n\n\n\n\n\n To remove a range from a number input question \n\n 1. Navigate to a number input question on the page\n\n 2. Click on the  button to the right side of the range to remove it\n\n\n\n\n\n To remove a number input question from a page \n\n 1. Navigate to a number input question on the page\n\n 2. Click on the  button at the top right corner of the block\n\n\n\n\n## Short Answer Question\n\nThe short answer question type allows Students to respond to a question using free-form text. This is the only question type that cannot be scored automatically. Educators must assign an appropriate score for short answer questions via the reports section.\n\n
\n Short answers are graded manually in the reports view\n
\n\n\n\n To create a short answer question \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the question inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Short Answer** from the dropdown menu\n\n 5. Type the question in the **Question** section\n\n 6. (Optional) Add a response by clicking on the **+ Add Response Message** button and entering the response message in the field that appears\n\n 7. Enter the maximum points available for a correct answer in the **Points** field\n\n\n\n\n\n To manually assign a grade for a short answer question \n\n 1. Navigate to a page\n\n 2. Click on the **Reports** tab\n\n 3. Select a Student from the dropdown field at the top right corner of the page\n\n 4. Scroll down to a short answer question\n\n 5. Click on the **Edit** button associated with the question\n\n 6. Enter a new score (must be less than or equal to the maximum number of points available for the question)\n\n 7. Click on the **Save** button\n\n\n\n\n\n To remove a short answer question from a page \n\n 1. Navigate to a short answer question on the page\n\n 2. Click on the  button at the top right corner of the block\n\n\n\n\n## Pin Drop Question\n\nPin drop questions provide a unique and interactive process for trainees to identify relevant structures on an image. Rather than narrowing the field-of-view for a question, Educators can ask trainees to locate structures present in the image with pins. With the pin drop question, each “pin” corresponds to a structure that the Educator wants identified and trainees are expected to drag the pins over the corresponding areas in the image.\n\nEducators can privately define the corresponding “region” for each pin, allowing the system to automatically grade the responses and if desired, provide instant feedback to trainees. The region provided must be an existing annotation that has been created on the image.\n\n\n\n To create a pin drop question \n\n 1. Navigate to a page\n\n 2. Position the cursor in the rich text editor where you want the question inserted\n\n 3. Click on the  button at the right hand corner of the rich text editor toolbar\n\n 4. Select **Pin-Drop** from the dropdown menu\n\n 5. Select an image using one of the available methods:\n 1. From the **Repository** tab, navigate to a folder and select an image, or\n 2. From the **Search** tab, search for an image by name and select it\n\n 6. Enter the points awarded for the question in the **Points** field\n\n 7. Type the question in the **Question** section\n\n 8. Add a pin for each structure to be identified; repeat as necessary\n 1. Click on the **+ Add Pin** button\n 2. (Optional) Provide a description to identify the structure that corresponds to the pin\n 3. (Optional) Select a unique color for the pin by clicking on the colored circle to the left\n 4. Click on the **Set Regions** button, then in the provided dialog, select the appropriate annotations from the list on the left and click on the **Done** button at the top right corner\n\n\n\n\n\n To remove a pin from a pin drop question \n\n 1. Navigate to a pin drop question on the page\n\n 2. Click on the  button to the right side of the pin to remove it\n\n\n\n\n\n To make all annotations on the featured image visible to Students \n\n 1. Navigate to a pin drop question on the page\n\n 2. Enable the **Show all annotations by default** toggle\n\n\n\n\n\n To make some annotations on the featured image visible to Students \n\n 1. Navigate to a pin drop question on the page\n\n 2. Disable the **Show all annotations by default** toggle\n\n 3. Click on the **Set Visible Annotations** button\n\n 4. In the provided dialog, select the annotations that should be visible from the list on the left and click on the **Done** button at the top right corner\n\n\n\n\n\n To set the default region of interest for the featured image \n\n 1. Navigate to a pin drop question on the page\n\n 2. Pan and zoom the image to the desired default area\n\n 3. Click on the **Set Initial Position** button\n\n\n\n\n\n To remove a pin drop question from a page \n\n 1. Navigate to a pin drop question on the page\n\n 2. Click on the  button at the top right corner of the block\n\n\n","slug":"docs/editing-pages/question-types"},{"frontmatter":{"title":"Roles","description":"roles"},"rawBody":"---\ntitle: Roles\nsection: General\ndescription: roles\norder: 2\n---\n\n\n# Roles\n\n \n\nThere are two types of users (roles) in the platform: an Educator role and a Student role. As the role names suggest, there are different levels of access to the content and well defined abilities. See [user management](/docs/settings/user-management/) for details.\n\n\n## Educators\n\nEducators have access to the Repository — a virtual file system for managing files and images — and can create and manage classes. Educators can also modify class content, enroll Students, and view reports (class and Student statistics).\n\nEducators access the platform via a dedicated dashboard that Students cannot access. Similarly, Students have a dedicated dashboard that Educators can’t access. However, Educators can preview pages (i.e., class content) to verify the layout and consistency of class content as it would be seen by Students.\n\n\n## Students\n\nStudents can only access the classes they have been enrolled in which are currently available as well as the team’s [Landing Page](/docs/settings/landing-page/). Students' access to classes is limited to the [class availability](/docs/classes/class-management/#edit-class-properties) dates and the content that has been linked into the class.\n\nStudent responses and activities are automatically saved by the system. In the event Students lose their internet connection, autosave cannot function. They will receive a notification with the option to re-save by clicking “Try Again” once an internet connection is available. Students will not be able to navigate through the class without a connection to the internet.\n","slug":"docs/general/roles"},{"frontmatter":{"title":"Class Reports","description":"class reports"},"rawBody":"---\ntitle: Class Reports\nsection: Reports\ndescription: class reports\norder: 8\n---\n\n\n# Class Reports\n\n \n\nClass reports summarize trainees' activity and performance in real time. Class reports provide both aggregated statistics for a class as well individual statistics.\n\n\n## Class Statistics\n\nClass statistics provided in class reports provide a breakdown by module of the following values:\n\n- Average score (per module)\n- Number of responses (per module)\n\n\n\n To see class statistics at class level \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Reports** tab\n\n 5. Select the **Class Statistics** tab\n\n 6. (Optional) To drill down further, click on a module name to see aggregate class statistics for that module\n\n 7. (Optional) The time the report data was last fetched is shown at the top right of the list. To refresh the displayed statistics:\n 1. Click on the  button at the top right of the list\n 2. In the popup menu, click on **Refresh Report**\n\n\n\n\n## Student Statistics\n\nStudent statistics provided in class reports provide the average score for students in the class.\n\n\n\n To see student statistics at class level \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Reports** tab\n\n 5. Select the **Student Statistics** tab\n\n 6. (Optional) To see a Student's scores for each module, click on **View Results**\n\n\n\n\n## Exporting Class Data\n\nClass data can be exported in a CSV file format, which is compatible with most spreadsheet applications. The export contains the responses provided by all trainees for all questions in the class, along with the graded scores, where applicable, and other information about the questions.\n\n\n\n To export class statistics \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the class list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Reports** tab\n\n 5. Click on the **Export Class Report** button at the top right corner of the page\n\n\n","slug":"docs/reports/class-reports"},{"frontmatter":{"title":"Repository Overview","description":"repository overview"},"rawBody":"---\ntitle: Repository Overview\ndescription: repository overview\norder: 0\nsection: Repository\n---\n\n\n# Repository Overview\n\n \n\n\n## A Virtual File System\n\nThe Repository is a virtual file system that is accessible from any internet-enabled device. It supports nested folders and all file types, like the file system on your computer, which is convenient for organizing and retaining your team's important files, images and related information.\n\n\n## Built-in Image Viewer\n\nAny of the [supported image formats](/docs/repository/supported-formats/#supported-image-formats), such as whole slide images, DICOM images and photos, can be viewed with the built-in image Viewer on-demand, using streaming technologies. However, many of the non-image data files will need to be downloaded and viewed using external software.\n\n\n## Supported Metadata Types\n\nRepositories provide flexible and customizable methods for creating and tracking metadata. The following metadata types are supported at folder-level and file-level:\n\n- Fields (key-value pairs)\n- Tags\n\nAdditionally, for image files (i.e., files that have been identified as images) the following metadata types are also supported:\n\n- [Annotations](/docs/viewer/annotations-panel/)\n- [Snapshots](/docs/viewer/snapshots/)\n- [Overlays](/docs/viewer/overlays/)\n\n\n## Unlimited Folders\n\nFolders in the Repository can be nested to any depth and can contain all types of files. The top level of the Repository can only contain folders (i.e., no files) which is convenient for organizing data for different Students, groups, years, etc.\n\n\n## Names and IDs\n\nWhile all entries in the Repository have names, names do not have to be unique because each entry has a unique ID. By convention, folders have integer IDs while files have alphanumeric IDs.\n","slug":"docs/repository/repository-overview"},{"frontmatter":{"title":"Data Ingestion","description":"data ingestion"},"rawBody":"---\ntitle: Data Ingestion\ndescription: data ingestion\norder: 3\nsection: Repository\n---\n\n\n# Data Ingestion\n\n \n\nThere are several ways to upload images into the Repository. Depending on the desired workflow and volume of data to be ingested, use one of the following methods:\n\n- Upload files manually in a browser\n- Upload in bulk from a PC using the Upload Client software\n- Upload through the API for customized workflows\n\n\n## Manual Uploads\n\nFiles can be manually uploaded into a folder using drag and drop or through a file selection dialog. Multiple images can be selected for upload using either method. The status of uploaded files will be indicated through a progress notification at the top of the screen as well as a progress bar on each new item in the [Folder Listing](/docs/repository/folder-listing/).\n\n\n\n To upload file(s) using drag and drop \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Drag one or more files onto the folder listing area (until the “Drop files to upload” notification appears) then drop the files\n\n 3. To check upload status, click on the **Details** button from the upload progress notification at the top of the screen\n\n\n\n\n\n To upload file(s) using a file selection dialog \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the  button at the top right of the item list\n\n 3. In the popup menu, click **Upload**\n\n 4. Click in the blue box to activate the file selection dialog or simply drag files into the blue box; repeat as required for other files\n\n 5. Click on the **Start Upload** button to start upload\n\n 6. Click on the **X** button to minimize the File Uploads dialog\n\n 7. To check upload status, click on the **Details** button from the upload progress notification at the top of the screen\n\n\n\n\n\n To check the status of recently uploaded files \n\n 1. Look for the upload progress notification at the top of the screen\n\n 2. Click on the **Details** button on the notification\n\n\n\n\n\n To locate recently uploaded files \n\n 1. Look for the upload progress notification at the top of the screen and, if it has not been dismissed, click on the **Details** button\n\n 2. Click on the  button below any of the recently uploaded files\n\n 3. Click on the **X** button in the top right hand corner of the File Uploads dialog\n\n\n\n\n\n To clear the completed list of recently uploaded files \n\n 1. Look for the upload progress notification at the top of the screen and, if it has not been dismissed, click on the **Details** button\n\n 2. Click on the **Clear Completed** button\n\n\n\n\n\n To clear the upload progress history and remove it from view \n\n 1. Look for the upload progress notification at the top of the screen\n\n 2. Click on the **Dismiss** button on the notification\n\n\n
\n Refreshing the page while uploads are in progress will terminate in progress uploads and clear the list of recently uploaded files.\n
\n\n\n\n
\n Image formats that have multiple files per image (e.g., MRXS, VSI, AFI, NDPIS) must be packaged into a single archive file (e.g., tar) with the index files appearing at the root of the archive and all other related files and folders in the usual place relative to the index file. The system will automatically unpack these files after upload is complete.\n
\n\n\n## Upload Client\n\nWhere the volume of images to be uploaded is large, it can be more efficient to upload images with a dedicated tool. The Upload Client is a Windows application that has been designed for automating image uploads. It can be configured to upload images that appear in a “watch” folder and, optionally, to delete these after a successful upload. Once the images are uploaded, they are available for review in the Unsorted Uploads section of the application, from where they can be moved to the appropriate folder in the Repository.\n\nThe Upload Client can be configured to detect and upload images that are generated by a whole slide image scanner or it can be used to batch upload images on demand.\n\n
\n Contact Pathcore Support to access the upload client and learn more.\n
\n\n\n## Custom Built Uploader\n\nUsers can develop custom upload workflows using the API, which provides methods for adding files and metadata to the Repository. Contact [Pathcore Support](mailto:support@pathcore.com) to learn more.\n","slug":"docs/repository/data-ingestion"},{"frontmatter":{"title":"Folder Listing","description":"folder listing"},"rawBody":"---\ntitle: Folder Listing\ndescription: folder listing\norder: 1\nsection: Repository\n---\n\n\n# Folder Listing\n\n \n\n## Folder Navigation\n\nNavigating through the folders in the Repository is similar to other file systems. Simply click into a folder to open it (i.e., enter into it) or click on a file to launch it. Any of the [supported image formats](/docs/repository/supported-formats/#supported-image-formats), such as whole slide images, DICOM images and photos, can be viewed with the built-in image Viewer on-demand via streaming technologies. Many non-image data files will need to be downloaded and viewed using external software.\n\n\n\n To navigate to a folder \n\n 1. Click on the  **Repository** button from the left-hand sidebar\n\n 2. Navigate to a folder using the folders listing\n\n\n\n\n\n To create a new folder \n\n 1. Click on the  button at the top right of the item list\n\n 2. In the popup menu, click **Create Folder**\n\n 3. Type a name for the new folder in the field\n\n 4. Click on the **Submit** button\n\n\n\n\n## Current Folder\n\nWondering where you are? The path to the current folder is shown in a breadcrumb in the top bar of the Repository page. For example, **Repository > Folder > Subfolder**\n\nIf the breadcrumb exceeds a certain width, all of the folder names but the last are collapsed into an  ellipsis button. You can click on the ellipsis button to display the complete list of folders.\n\n
\n You can navigate to a parent folder by clicking into the breadcrumb.\n
\n\n\n### Current Folder Operations\n\nBy clicking the  button next to the current folder's name in the breadcrumb (near the top of the page) you can access a menu of operations to perform on the folder.\n\n
\n Depending on your Role some operations may not be available.\n
\n\n\n\n Move \n\n **Move** opens the Move Item dialog, allowing you to move this folder to any other accessible folder.\n\n 1. Click on the  button next to the current folder's breadcrumb\n\n 2. Click **Move**\n\n 3. In the popup dialog, select the destination folder from the available list\n\n 4. Click on the **Move to Folder** button\n\n\n\n\n\n Copy \n\n **Copy** opens the Copy Item dialog, allowing you to make a copy of this folder in another folder.\n\n 1. Click on the  button next to the current folder's breadcrumb\n\n 2. Click **Copy**\n\n 3. In the popup dialog, select the destination folder from the available list\n\n 4. Click on the **Copy to Folder** button\n\n\n\n\n\n Rename \n\n **Rename** allows you to change the name of the current folder.\n\n 1. Click on the  button next to the current folder's breadcrumb\n\n 2. Click **Rename**\n\n 3. In the popup dialog, type a new name for the folder\n\n 4. Click on the **Rename** button or press the **Enter** key to save. To discard your changes, click on the **Cancel** button or press the **Escape** key\n\n\n\n\n\n Share \n\n **Share** opens the [Share Links](/docs/share-links/share-link-overview/) dialog, which allows you to add and manage share links for the current folder.\n\n
\n A Share icon in the breadcrumb indicates share links are associated with the current folder.\n
\n\n 1. Click on the  button next to the current folder's breadcrumb\n\n 2. Click **Share**\n\n 3. The popup dialog allows you to add and manage share links. See [Managing Share Links](/docs/share-links/managing-share-links/) for more details\n\n\n\n\n\n Favorite / Unfavorite \n\n **Favorite** tags the current folder as _Starred_. Items tagged this way are quickly and easily accessible from the Starred Items List.\n **Unfavorite** removes this tag.\n See [Favorite Status](/docs/repository/repository-operations/#favorite-status) for more details.\n\n 1. Click on the  button next to the current folder's breadcrumb\n\n 2. Click **Favorite** to add the _Starred_ tag, or\n\n 3. Click **Unfavorite** to remove the tag\n\n\n\n\n\n Download \n\n **Download** opens the [Download](/docs/repository/repository-operations/#downloading) dialog, allowing you to save the contents and metadata locally.\n\n 1. Click on the  button next to the current folder's breadcrumb\n\n 2. Click **Download**\n\n 3. In the popup dialog, select what you would like to download (files and/or metadata). See [Downloading](/docs/repository/repository-operations/#downloading) for more details\n\n 4. Click on the **Download** button\n\n\n\n\n\n Delete \n\n **Delete** allows you to remove the folder and all of its contents from the Repository.\n\n
\n Deleted items cannot be recovered. Be careful with this action.\n
\n\n 1. Click on the  button next to the current folder's breadcrumb\n\n 2. Click **Delete**\n\n 3. Click on the **Yes** button to confirm if you are sure you wish to remove the item. To cancel the delete action, click on the **Cancel** button or press the **Escape** key\n\n\n\n\n## Image Labels\n\nImage labels (sometimes called slide labels) can be shown in the Repository folder listing alongside an image's preview.\n\n\n\n To toggle image labels \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the  button at the top right of the item list\n\n 3. Set the **Display labels in slide listings** toggle\n\n\n\n\n## List View\n\nList View displays the content of a folder in a tabular format and you can sort the table using the available columns. Each column corresponds to a field.\n\n\n\n To enable List View \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the **Display Mode** button at the top right of the item list. This button will appear different depending on the current display mode: List (), Compact List (), or Icon ()\n\n 3. In the popup menu, click **List**\n\n\n\n\n### Sorting in List View\n\nList View arranges repository items in a tabular fashion, making it convenient to display metadata and to sort the entries. In this mode, the columns of the table can be customized to show the Fields that are associated with each entry.\n\n
\n The table columns and sort order are automatically remembered.\n
\n\n\n\n To sort items in List View \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. From the table header, click on a column until the desired sort order is shown (sort order is shown with  for ascending order and  for descending order in the table header adjacent to the selected column)\n\n\n\n\n\n To add a column \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the  button at the top right of the item list\n\n 3. (Optional) Filter the available fields using the search box in the **Available Columns** section\n\n 4. Click on the  button next to a field in the **Available Columns** section\n\n 5. Click on the **Save** button\n\n\n\n\n\n To remove a column \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the  button at the top right of the item list\n\n 3. Click on the  button next to a field in the **Visible Columns** section\n\n 4. Click on the **Save** button\n\n\n\n\n### Image Thumbnail\n\nThe size of the preview image (thumbnail) is controlled by the **Row height** setting\n\n
\n You can hover over the thumbnail with the cursor for a larger view\n
\n\n\n\n To change the Row Height \n\n 1. Click on the  button at the top right of the item list\n\n 2. Use the slider to adjust **Row height** to the desired value\n\n 3. Click on the **Save** button\n\n\n\n\n## Compact List View\n\nCompact List View displays the content of a folder in a tabular format similar to List View, however image thumbnails are not shown and the rows are more compact. This allows you to see more entries at a time on a smaller display. You can still sort the table using the available columns. Each column corresponds to a field.\n\n\n\n To enable Compact List View \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the **Display Mode** button at the top right of the item list. This button will appear different depending on the current display mode: List (), Compact List (), or Icon ()\n\n 3. In the popup menu, click **Compact List**\n\n\n\n\n### Sorting in Compact List View\n\nSorting in Compact List View is the same as [sorting in List View](#sorting-in-list-view). See that section for more details.\n\n\n## Icon View\n\nIcon View displays the content of a folder as a series of icons. Icon View provides larger image thumbnails and labels, making it easier to preview image content. In this mode, metadata can only be seen for the selected item from the **Metadata** tab of the right-hand sidebar.\n\n\n\n To enable Icon View \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the **Display Mode** button at the top right of the item list. This button will appear different depending on the current display mode: List (), Compact List (), or Icon ()\n\n 3. In the popup menu, click **Icon**\n\n\n\n\n\n To view metadata for an entry \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Select an entry by clicking on it\n\n 3. View associated metadata in the **Metadata** tab of the right-hand panel (or the bottom panel when viewing on a mobile device). You may need to click on the  button if the panel is collapsed\n\n\n\n\n### Sorting in Icon View\n\nThe folder items in Icon View can be sorted by item name, type, or last modified time.\n\n\n\n To sort items in Icon View \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the  button at the top right of the item list\n\n 3. Select the desired sort option from the **Sort By** dropdown: **Name**, **Type**, or **Last Modified**\n\n\n","slug":"docs/repository/folder-listing"},{"frontmatter":{"title":"Repository Operations","description":"repository operations"},"rawBody":"---\ntitle: Repository Operations\ndescription: repository operations\norder: 2\nsection: Repository\n---\n\n\n# Repository Operations\n\n \n\nThis section contains a list of basic operations that are available for items in the Repository.\n\n
\n Different operations are available depending on the type and number of items selected.\n
\n\n\n## Context Menu\n\nMost operations can be performed via a context menu. This menu is accessed by right-clicking on an item in the [Folder Listing](/docs/repository/folder-listing/) (or one of the currently selected items when using [Multi-Select](#multi-select)). The same menu can be accessed by clicking the  button next to the item's name in the right-hand panel. You may need to click on the  button if the panel is collapsed.\n\n
\n Depending on your Role some operations may not be available.\n
\n\n\n\n Move \n\n **Move** opens the Move Item dialog, allowing you to move the item (or items) to any accessible folder.\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Move**\n\n 3. In the popup dialog, select the destination folder from the available list\n\n 4. Click on the **Move to Folder** button\n\n\n\n\n\n Copy \n\n **Copy** opens the Copy Item dialog, allowing you to make a copy of the item (or items) in another folder.\n\n
\n When copying entries in the Repository, the underlying files are not duplicated (i.e., copies are linked to the same underlying file) and thus do not consume additional storage. However, the metadata associated with the copied entries, such as annotations and snapshots, are duplicated when an entry in the Repository is copied (i.e., duplicated entries will retain an independent copy of the original metadata).\n
\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Copy**\n\n 3. In the popup dialog, select the destination folder from the available list\n\n 4. Click on the **Copy to Folder** button\n\n\n\n\n\n View Image(s) (images only)\n\n **View Images** opens the select item (or items) in the [Viewer](/docs/viewer/overview/).\n\n
\n Only images can be opened in the Viewer.\n
\n\n\n\n\n\n Retry Type Detection (attachments only) \n\n **Retry Type Detection** attempts to force the system to detect this attachment as an image again. This can be useful if an image uploaded completely, but for whatever reason is not being recognised by PathcoreScholar as an image. If this still does not work you may need to contact [Pathcore Support](mailto:support@pathcore.com).\n\n
\n This operation only applies to attachments.\n
\n\n\n\n\n\n Rename (single item only)\n\n **Rename** allows you to change the name of the item.\n While all entries in the Repository have names, names do not have to be unique because each entry has a unique ID, see [Names and IDs](/docs/repository/repository-overview/#names-and-ids).\n\n
\n It’s not possible to rename multiple items at the same time.\n
\n\n 1. Right-click on the item to bring up the context menu\n\n 2. Click **Rename**\n\n 3. In the popup dialog, type a new name for the folder\n\n 4. Click on the **Rename** button or press the **Enter** key to save. To discard your changes, click on the **Cancel** button or press the **Escape** key\n\n\n\n\n\n Share (single item only) \n\n **Share** opens the [Share Links](/docs/share-links/share-link-overview/) dialog, which allows you to add and manage share links for the item.\n\n
\n It’s not possible to share multiple items at a time. However it is possible to share a folder of items.\n
\n\n 1. Right-click on the item to bring up the context menu\n\n 2. Click **Share**\n\n 3. The popup dialog allows you to add and manage share links. See [Managing Share Links](/docs/share-links/managing-share-links/) for more details\n\n\n\n\n\n Mark as Read / Mark as Unread \n\n An item can be marked as \"read\" (name in plain text) or \"unread\" (name in bold) depending on whether or not you have previously viewed it.\n\n See [Read Status](#read-status) for more details.\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Mark as Read** to enable the read status, or\n\n 3. Click **Mark as Unread** to clear the read status\n\n\n\n\n\n Favorite / Unfavorite \n\n **Favorite** tags the item (or items) as _Starred_. Items tagged this way are quickly and easily accessible from the Starred Items List.\n **Unfavorite** removes this tag.\n See [Favorite Status](#favorite-status) for more details.\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Favorite** to add the _Starred_ tag, or\n\n 3. Click **Unfavorite** to remove the tag\n\n\n\n\n\n Download \n\n **Download** opens the [Download](#downloading) dialog, allowing you to save items and metadata locally.\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Download**\n\n 3. In the popup dialog, select what you would like to download (files and/or metadata). See [Downloading](#downloading) for more details\n\n 4. Click on the **Download** button\n\n\n\n\n\n Delete \n\n **Delete** allows you to remove the items and all of their contents, if applicable, from the Repository.\n\n
\n Deleted items cannot be recovered. Be careful with this action.\n
\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Delete**\n\n 3. Click on the **Yes** button to confirm if you are sure you wish to remove the item. To cancel the delete action, click on the **Cancel** button or press the **Escape** key\n\n\n\n\n### Deleting Images Linked Into a Class\n\nAttempting to delete an image from the Repository that is referenced in a class will fail with an informative message about the cause. If multiple items are selected and deleted, only the images that are unused in any classes will be removed; a warning message will be displayed should any of the items be images that are referenced in a class. This helps prevent Administrators and Educators from accidentally removing resources that are currently being used in training materials.\n\nThis applies only to the following images:\n- Images used in [Image Viewer blocks](/docs/editing-pages/media-types/#image-viewer)\n- Featured images on [Multiple Choice questions](/docs/editing-pages/question-types/#multiple-choice-question)\n- Images used for [Pin-Drop questions](/docs/editing-pages/question-types/#pin-drop-question)\n- [Pop-Up button](/docs/editing-pages/button-types/#popup-button) images\n- [Hidden Data button](/docs/editing-pages/button-types/#hidden-data-button) images\n\n\n## Multi-Select\n\nOne or more files can be selected from the folder listing page in order to perform bulk operations such as download, copy or move.\n\n\n\n To select more than one file \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on an item from the file listing\n\n 3. While holding the **Ctrl** key (on Windows) or **Command** key (on macOS) select another file\n\n 4. Repeat step 3 as necessary\n\n\n\n\n\n To select more than one file in a continuous range \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the first item in the range from the file listing\n\n 3. While holding the **Shift** key, select the last file in the range\n\n\n\n\n## Read Status\n\nThe names of items (files and folders) in the Repository are in bold to indicate an item is “unread”. Once an item has been “read”, plain text font is used for the name of the item. New items are always unread and are automatically marked as read once they have been opened, viewed or downloaded by a user. The following actions will cause the status of an item to be marked as “read”:\n\n- Clicking on an image file causing the Viewer to launch\n- Clicking on any other item causing it open in the browser or be downloaded\n\nThe read status is unique for each user and can be toggled at any time, making it useful for tracking items that require further attention.\n\n
\n The “read” status can be changed manually from the Context Menu for an item.\n
\n\n\n## Favorite Status\n\nEach Repository item has a favorite status, which can be toggled by clicking on the  button adjacent to the item’s name. A solid star indicates an item has been marked as a favorite while a hollow star (default) status indicates the item is not a favorite.\n\nThe favorite status is unique for each user and can be toggled at any time, making it useful for tracking items that require further attention.\n\n\n\n To view a list of all favorited items \n\n 1. Click on the  **Starred** button in the **TAGS** section of the left-hand sidebar\n\n\n\n\n\n To toggle favorite status \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Toggle the  button next to the item to indicate the status\n\n\n\n\n## Downloading\n\nIn general, one or more files or folders can be downloaded from the Repository. When downloading a single file, the download operation will be initiated in the normal way. When downloading multiple files and/or folders (or if you include any metadata), the download operation will be initiated in the normal way after the files/folders have been combined into an archive file.\n\nCertain item types cannot be combined into a single download. For example, a Figure cannot be downloaded with any other item (including another Figure) because it has a unique export workflow.\n\n
\n Some browsers may require your permission before downloading files.\n
\n\n\n\n Download dialog options \n\n The following options are available when downloading:\n\n - **Files**: Toggle to include the selected files and folders\n - **Metadata**: Toggle to include metadata about the selected files and folders. You can further customize the additional metadata to include:\n - **Annotations**: Toggle to include your private annotations as well as shared annotations by others\n - **Snapshot Coordinates**: Toggle to include snapshot coordinates and properties\n - **Fields**: Toggle to include system metadata fields\n - **Tags**: Toggle to include tags you have assigned to the items\n - **Overlays**: Toggle to include overlay images added to images in the selected items\n - **Download as JSON** / **Download as CSV**: choose the file format of the selected metadata. These options can only be selected if metadata is included in the download\n - **.tar** / **.tar.gz** / **.zip**: This dropdown lets you select the archive format when more than one item and/or metadata are included\n\nWhen the selection contains a single item, such as an image file, attachment, or report, the file itself will be downloaded. In other cases, such as for a single saved Figure item, the download will trigger an export and preview window. When there are multiple items or a folder selected, a downloadable archive will be generated in the chosen format with the option to include metadata.\n\n\n","slug":"docs/repository/repository-operations"},{"frontmatter":{"title":"Module Reports","description":"module reports"},"rawBody":"---\ntitle: Module Reports\nsection: Reports\ndescription: module reports\norder: 9\n---\n\n\n# Module Reports\n\n \n\nModule reports summarize the Student activity in real time at the module level.\n\n\n## Module Statistics\n\nClass statistics, at module level, provide a breakdown by page of the following values:\n\n- Average class score (per page)\n- Number of responses (per page)\n- Weight of the module (number of graded points per page)\n\n\n\n To see module statistics \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Reports** tab\n\n 7. (Optional) To drill down further, click on a page name to see individual responses by Students\n\n\n\n\n## Student Responses\n\nTo see Student responses for each question, click into the page name from the module report. From this view it will also be possible to edit Student scores.\n\n\n\n To view Student responses and to edit Student scores \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Reports** tab\n\n 7. Click on the name of a page to see the page report\n\n 8. Select a Student from the dropdown field at the top right corner of the page\n\n 9. Scroll down the page to review the Student's responses\n\n 10. (Optional) To edit a score, click on the **Edit** button associated with a question and enter a new score (must be less than or equal to the maximum number of points available for the question)\n\n 11. (Optional) The time the report data was last fetched is shown at the top right of the list. To refresh the displayed statistics:\n 1. Click on the  button at the top right of the list\n 2. In the popup menu, click on **Refresh Report**\n\n\n\n\n## Exporting Module Data\n\nModule data can be exported in a CSV file format, which is compatible with most spreadsheet applications. The export contains the responses provided by all trainees for all questions in the module, along with the graded score, where applicable, and other information about the questions.\n\n\n\n To export module statistics \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **Classes** tab\n\n 3. Click on a class name from the classes list (optional: filter by name using the **Search for a class...** bar, and/or enable the **Show past classes** toggle to see past classes)\n\n 4. Select the **Modules** tab\n\n 5. Click on a module name from the modules list (optional: filter by name using the **Search for a module...** bar)\n\n 6. Select the **Reports** tab\n\n 7. Click on the **Export Module Report** button at the top right corner of the page\n\n\n","slug":"docs/reports/module-reports"},{"frontmatter":{"title":"Supported Formats","description":"supported formats"},"rawBody":"---\ntitle: Supported Formats\ndescription: supported formats\norder: 4\nsection: Repository\n---\n\n# Supported Formats\n\n \n\n## Attachments\n\nAny data file can be uploaded into the Repository. Where possible, the files are automatically identified and labeled as an “Attachment” if their contents are not viewable in the Viewer. Some attachments, such as PDF files and MS Office files may be viewable in your browser or with an application you have on your computer. In all other cases, attachments can be downloaded and processed with the appropriate application.\n\n## Supported Image Formats\n\nThe Viewer supports many proprietary whole slide image formats, DICOM standard whole slide images, some DICOM radiology formats as well common image formats.\n\n\n\n List of supported formats \n\n | Vendor | Format | Status |\n | ----------- | ---------- | ------------ |\n | 3D Histech | MRXS | Full Support |\n | Aperio | SVS | Full Support |\n | Aperio | AFI | Full Support |\n | Hamamatsu | VMS | Full Support |\n | Hamamatsu | VMU | Full Support |\n | Hamamatsu | NDPI | Full Support |\n | Hamamatsu | NDPIS | Full Support |\n | Leica | SCN | Full Support |\n | Motic | Motic SVS | Full Support |\n | Olympus | VSI | Full Support |\n | OME | OME TIFF | Full Support |\n | PerkinElmer | QPTIFF | Full Support |\n | Sakura | SVSlide | Full Support |\n | Ventana | BIF | Full Support |\n | Ventana | TIF | Full Support |\n | Zeiss | CZI | Full Support |\n | | Tiled TIFF | Full Support |\n | | BigTIFF | Full Support |\n | | JPEG2000 | Full Support |\n | | DICOM | Full Support |\n | | BMP | Full Support |\n | | JFIF | Full Support |\n | | PNG | Full Support |\n\n\n","slug":"docs/repository/supported-formats"},{"frontmatter":{"title":"Landing Page","description":"landing page"},"rawBody":"---\ntitle: Landing Page\nsection: Settings\ndescription: landing page\norder: 20\n---\n\n\n# Landing Page\n\n \n\nThe landing page can be used to provide a customized greeting message to Students within their home page. The Student’s home page is the first screen displayed to Student users upon login.\n\n
\n The landing page may contain rich text content such as formatted text and images.\n
\n\n\n\n To modify the team landing page \n\n 1. Click on the  **Home** button from the left-hand sidebar\n\n 2. Select the **About** tab\n\n 3. Edit the contents of the landing page\n\n 4. Adjust the **Display section** toggle to show or hide the landing page to Students\n\n 5. Click on the **Save** button\n\n 6. When prompted, choose **Notify Students** to notify\\* Students about this change, or choose **Don’t Notify** to save the changes without notifying Students\n\n 7. (Optional) Click on the **Preview Page** button to see how the content will render for Students\n\n\n \\*The notice is delivered via the text \"Updated\" next to the **Home of _Team Name_** title when they log in. Users that are logged in while the change is performed will not see the notice until a page refresh is performed (keyboard shortcut F5) or until the next time they log in.\n\n\n","slug":"docs/settings/landing-page"},{"frontmatter":{"title":"Search Operations","description":"search operations"},"rawBody":"---\ntitle: Search Operations\ndescription: search operations\norder: 11\nsection: Search\n---\n\n\n# Search Operations\n\n \n\nSearch can be used to perform bulk operations on the items in the Repository. All Repository operations can be performed with search results. See [Repository Operations](/docs/repository/repository-operations/) for more details.\n\n\n## Context Menu\n\nMost operations can be performed via a context menu. This menu is accessed by right-clicking on an item in the search results listing (or one of the currently selected items when using [Multi-Select](/docs/repository/repository-operations/#multi-select)). The same menu can be accessed by clicking the  button next to the item's name in the right-hand panel. You may need to click on the  button if the panel is collapsed.\n\n
\n Depending on your Role some operations may not be available.\n
\n\n\n\n Move \n\n **Move** opens the Move Item dialog, allowing you to move the item (or items) to any accessible folder.\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Move**\n\n 3. In the popup dialog, select the destination folder from the available list\n\n 4. Click on the **Move to Folder** button\n\n\n\n\n\n Copy \n\n **Copy** opens the Copy Item dialog, allowing you to make a copy of the item (or items) in another folder.\n\n
\n When copying entries in the Repository, the underlying files are not duplicated (i.e., copies are linked to the same underlying file) and thus do not consume additional storage. However, the metadata associated with the copied entries, such as annotations and snapshots, are duplicated when an entry in the Repository is copied (i.e., duplicated entries will retain an independent copy of the original metadata).\n
\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Copy**\n\n 3. In the popup dialog, select the destination folder from the available list\n\n 4. Click on the **Copy to Folder** button\n\n\n\n\n\n View Image(s) (images only)\n\n **View Images** opens the select item (or items) in the [Viewer](/docs/viewer/overview/).\n\n
\n Only images can be opened in the Viewer.\n
\n\n\n\n\n\n Retry Type Detection (attachments only) \n\n **Retry Type Detection** attempts to force the system to detect this attachment as an image again. This can be useful if an image uploaded completely, but for whatever reason is not being recognised by PathcoreScholar as an image. If this still does not work you may need to contact [Pathcore Support](mailto:support@pathcore.com).\n\n
\n This operation only applies to attachments.\n
\n\n\n\n\n\n Rename (single item only)\n\n **Rename** allows you to change the name of the item.\n While all entries in the Repository have names, names do not have to be unique because each entry has a unique ID, see [Names and IDs](/docs/repository/repository-overview/#names-and-ids).\n\n
\n It’s not possible to rename multiple items at the same time.\n
\n\n 1. Right-click on the item to bring up the context menu\n\n 2. Click **Rename**\n\n 3. In the popup dialog, type a new name for the folder\n\n 4. Click on the **Rename** button or press the **Enter** key to save. To discard your changes, click on the **Cancel** button or press the **Escape** key\n\n\n\n\n\n Share (single item only) \n\n **Share** opens the [Share Links](/docs/share-links/share-link-overview/) dialog, which allows you to add and manage share links for the item.\n\n
\n It’s not possible to share multiple items at a time. However it is possible to share a folder of items.\n
\n\n 1. Right-click on the item to bring up the context menu\n\n 2. Click **Share**\n\n 3. The popup dialog allows you to add and manage share links. See [Managing Share Links](/docs/share-links/managing-share-links/) for more details\n\n\n\n\n\n Mark as Read / Mark as Unread \n\n An item can be marked as \"read\" (name in plain text) or \"unread\" (name in bold) depending on whether or not you have previously viewed it.\n\n See [Read Status](/docs/repository/repository-operations/#read-status) for more details.\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Mark as Read** to enable the read status, or\n\n 3. Click **Mark as Unread** to clear the read status\n\n\n\n\n\n Favorite / Unfavorite \n\n **Favorite** tags the item (or items) as _Starred_. Items tagged this way are quickly and easily accessible from the Starred Items List.\n **Unfavorite** removes this tag.\n See [Favorite Status](/docs/repository/repository-operations/#favorite-status) for more details.\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Favorite** to add the _Starred_ tag, or\n\n 3. Click **Unfavorite** to remove the tag\n\n\n\n\n\n Download \n\n **Download** opens the [Download](/docs/repository/repository-operations/#downloading) dialog, allowing you to save items and metadata locally.\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Download**\n\n 3. In the popup dialog, select what you would like to download (files and/or metadata). See [Downloading](/docs/repository/repository-operations/#downloading) for more details\n\n 4. Click on the **Download** button\n\n\n\n\n\n Delete \n\n **Delete** allows you to remove the folder and all of its contents from the Repository.\n\n
\n Deleted items cannot be recovered. Be careful with this action.\n
\n\n 1. Right-click on the item (or items) to bring up the context menu\n\n 2. Click **Delete**\n\n 3. Click on the **Yes** button to confirm if you are sure you wish to remove the item. To cancel the delete action, click on the **Cancel** button or press the **Escape** key\n\n\n\n\n## Exporting\n\nSearch results can be exported as a file in CSV format. See [Exporting Results](/docs/search/exporting-results/) for more details.\n\n\n## Tagging\n\nSearch results can be bulk tagged. This allows you to quickly apply a tag or set of tags to all items that match the search query.\n\n\n\n To apply tags to all search results \n\n 1. Click on the  **Search** button from the left-hand sidebar\n\n 2. Perform a search query. See [Basic Queries](/docs/search/search-overview/#basic-queries) for more details\n\n 3. Click on the  button at the top right of the search results\n\n 4. In the popup menu, click on **Tag All Results**\n\n 5. In the popup dialog, choose a tag from the **Add a tag..** dropdown. To create a new tag, type directly into the field and click on the **+ New tag** option\n\n 6. Click on the **Tag Results** button\n\n\n","slug":"docs/search/search-operations"},{"frontmatter":{"title":"Search Overview","description":"search overview"},"rawBody":"---\ntitle: Search Overview\ndescription: search overview\norder: 10\nsection: Search\n---\n\n\n# Search Overview\n\n \n\nSearch can be used for finding files and folders based in the Repository. Search uses a versatile query language that can be used to create complex expressions. Search queries can be quite specific with support for various advanced features:\n\n- One or more conditions\n- Condition groups (i.e., brackets are supported)\n- Restricting results to a folder or set of folders\n- Restricting result type (e.g., image, folders, files, etc.)\n\n\n## Search Preambles\n\nSearch queries have preambles that can be used to narrow the search results:\n\n- The results type preamble may be used to narrow the types of items returned\n- The location preamble may be used to narrow the folders that are searched\n\n\n\n To set the result type preamble \n\n 1. Click on the  **Search** button from the left-hand sidebar\n\n 2. Choose one or more types from the **Find** dropdown\n\n\n\n\n\n To set the location preamble \n\n 1. Click on the  **Search** button from the left-hand sidebar\n\n 2. Click on the  icon and choose the set of folders for the search\n\n 3. Click on the **X** button when done and continue building the search query\n\n\n\n\n## Basic Queries\n\nTo search for a file or folder in the Repository, start by creating a search query. The search query can reference the built-in system fields: _Name_, _Created_, and _Last Modified_.\n\n\n\n To create a basic search query \n\n 1. Click on the  **Search** button from the left-hand sidebar\n\n 2. (Optional) Configure the [result type preamble](#search-preambles) from the **Find** dropdown\n\n 3. (Optional) Configure the [location preamble](#search-preambles) from the  dropdown\n\n 4. (Optional) Configure the logical operator from the **Matching** dropdown\n\n 5. Click on the **+ Condition** button; repeat as necessary\n\n a. Select a field from the dropdown\n\n b. Select an operation\n\n c. Fill the field accordingly\n\n 6. Click on the **Search** button to run the query\n\n Search results will be displayed on the same page\n\n\n\n\n## Advanced Queries\n\nAdvanced search can be fully customized and may include logical groups (i.e., bracketed expressions).\n\n\n\n To create an advanced search query \n\n 1. Click on the  **Search** button from the left-hand sidebar\n\n 2. (Optional) Configure the [result type preamble](#search-preambles) from the **Find** dropdown\n\n 3. (Optional) Configure the [location preamble](#search-preambles) from the  dropdown\n\n 4. (Optional) Configure the logical operator from the **Matching** dropdown\n\n 5. Click on the **+ Condition** button; repeat as necessary\n\n a. Select a field from the dropdown\n\n b. Select an operation\n\n c. Fill the field accordingly\n\n 6. (Optional) Click **+ Condition Group**; repeat as necessary\n\n a. Repeat step 5 as necessary\n\n 7. Click on the **Search** button to run the query\n\n Search results will be displayed on the same page\n\n\n","slug":"docs/search/search-overview"},{"frontmatter":{"title":"Roles","description":"roles"},"rawBody":"---\ntitle: Roles\nsection: Settings\ndescription: roles\norder: 17\n---\n\n\n# Roles\n\n \n\nWhile the set of roles in PathcoreScholar cannot be modified, the set of permissions associated with each role is visible. A user's permissions are the set of actions the user can perform with the data that is accessible to them (e.g., edit, view, delete). To learn more about each permission, see [Permissions](#permissions).\n\n## System Roles\n\nThere are three roles that are pre-defined in the system. These roles cannot be modified and are always available. The predefined roles are as follows:\n\n- **Administrator**: users with this role can create users, access team management functions, and have access to all classes and all the data in the Repository\n- **Educator**: users with this role can create classes, enroll existing users into classes, manage class content, access class reports, and have access to all the data in the Repository\n- **Student**: users with this role can only access the classes they have been enrolled in from the student portal and cannot access the Repository\n\n\n## Permissions\n\nPermissions define the set of actions that users can perform with the data that is accessible to them (e.g., download, edit, view).\n\n\n### Permission Flags\n\nUser permissions are achieved through a set of fine-grained flags that team Administrators can use to manage what actions users can perform with the data they can access. Permissions are divided into several categories of privileges that span actions at team level, image level, folder level, and file level.\n\n
\n All entries in the Repository that are detected as a supported image format are treated as an “Image” type and have dedicated permissions flags. All other entries in the Repository (e.g., reports, Figures, attachments) are treated as “Files” and also have dedicated permissions.\n
\n\n\n#### Team Permissions\n\nThe following flags govern team administration.\n\n| Flag | Description |\n| ----------------------- | ------------------------------------------------------------ |\n| Manage users | Allows a user to view, edit, create or delete [Users](/docs/settings/user-management/). |\n| Manage roles | Allows a user to view, edit, create or delete data groups and roles. |\n| Manage fields | Allows a user to view, edit, create or delete fields and field sets. |\n| Manage report templates | Allows a user to view, edit, create or delete report templates. |\n| Manage assignment rules | Allows a user to view, edit, create or delete assignment rules for cases. |\n| Manage uploaded files | Allows a user to view or create unsorted uploads. |\n| Manage team | Allows a user to edit the [Team Settings](/docs/settings/team-customization/). |\n\n\n#### Image Permissions\n\nThe following flags govern all entries in the Repository that are detected as a supported image format. The entries are treated as images and given the Image type.\n\n| Flag | Description |\n| -------------------------- | ------------------------------------------------------------ |\n| View | Allows a user to view an image and its metadata including fields, snapshots, overlays. |\n| View shared annotations | Allows a user to view shared annotations on an image to which they have access. |\n| Create shared annotations | Allows a user to create and delete shared annotations and change the state of a private annotation, which the user has created, to shared. |\n| Create private annotations | Allows a user to create private annotations. |\n| Download | Allows a user to download an image or attachment. |\n| Edit metadata | Allows a user to: - Edit image metadata fields - Edit image description - Edit, create, or delete image overlays - Edit, create, or delete image snapshots - Edit or delete any user’s shared annotations - Set default image rotation |\n| Manage share links | Allows a user to edit, create, or delete share links for images. |\n\n\n#### Folder Permissions\n\nThe following flags govern folders in the Repository and/or Cases in the Dashboard.\n\n| Flag | Description |\n| ------------------ | ------------------------------------------------------------ |\n| View | Allows a user to view the Repository and its folders, and cases. |\n| Create | Allows a user to create folders and cases. |\n| Edit metadata | Allows a user to edit folder-level Fields and case reports. |\n| Manage share links | Allows a user to edit, create or delete share links for folders. |\n| Delete | Allows a user to delete folders. |\n\n\n#### File Permissions\n\nThe following flags govern all entries in the Repository that are not detected as an image (e.g., reports, Figures, attachments). The entries are treated as files and have dedicated permissions.\n\n| Flag | Description |\n| ------------------ | ------------------------------------------------------------ |\n| View | Allows a user to view attachments, snapshots, reports and report templates. |\n| Upload | Allows a user to upload files, generate reports and link DICOM resources from a connected PACS into folders. |\n| Edit metadata | Allows a user to edit Fields for non-image files and reports, and run type detection on a file. |\n| Manage share links | Allows a user to edit, create, or delete share links for non-image files. |\n| Delete | Allows a user to delete all files (including image files). |\n\n\n#### Protected Health Information (PHI) Flags\n\nThe following flags govern metadata Fields.\n\n| Flag | Description |\n| -------- | ------------------------------------------------------------ |\n| View | Allows a user to view field values that have been marked with the Protected Health Information (PHI) flag and slide labels. |\n","slug":"docs/settings/roles"},{"frontmatter":{"title":"Exporting Results","description":"exporting results"},"rawBody":"---\ntitle: Exporting Results\ndescription: exporting results\norder: 12\nsection: Search\n---\n\n\n# Exporting Results\n\n \n\nSearch results can be exported as a file in CSV format. The exported file will always contain one row per search result and the columns describe the fields associated with the results. For each row/result, the available columns are populated.\n\nThe first row in the file is a header row that defines the name of all fields associated with the exported results. The columns in the file represent the union of fields available for the exported results.\n\n\n\n To export search results \n\n 1. Click on the  **Search** button from the left-hand sidebar\n\n 2. Perform a search query. See [Basic Queries](/docs/search/search-overview/#basic-queries) for more details\n\n 3. Click on the  button at the top right of the search results\n\n 4. In the popup menu, click on **Export as CSV**\n\n 5. In the popup dialog, click on the **Start Export** button. If prompted, select a location to save the downloaded file\n\n\n\n\n## Empty Columns\n\nAn empty column in the exported file is somewhat ambiguous in that it may correspond to a field that is associated with the result but is undefined, or it may correspond to a field that is not associated with the result at all.\n","slug":"docs/search/exporting-results"},{"frontmatter":{"title":"My Account","description":"my account"},"rawBody":"---\ntitle: My Account\nsection: Settings\ndescription: my account\norder: 15\n---\n\n\n# My Account\n\n \n\nMany of the restrictions that govern user accounts, such as accessible content (i.e., the files and folders visible in the Repository), and roles and permissions (i.e., the actions you can take with the files in the Repository) are controlled by your account Administrator. Contact your Administrator if you have any questions about these topics.\n\n\n## User Profile\n\nUsers can modify certain account properties and preferences such as their name, profile picture and signature. Users cannot change their email address.\n\n\n\n To change the name of your account \n\n 1. Click on the user icon at the top right of the screen\n\n 2. In the popup menu, click on **My Account**\n\n 3. Click on the Profile tab if necessary\n\n 4. Click on the **Edit** button in the Name section\n\n 5. Edit the text in the textbox\n\n 6. Click on the **Apply** button to save your changes\n\n\n\n\n\n To add or change the profile picture of your account \n\n 1. Click on the user icon at the top right of the screen\n\n 2. In the popup menu, click on **My Account**\n\n 3. Click on the Profile tab if necessary\n\n 4. Click on the **Edit** button to in the Profile Picture section\n\n 5. Click on the **Add Profile Photo** button and select an image from your PC\n\n 6. (Optional) Use the slide beneath the picture to adjust the visible content\n\n 7. Click on the **Apply** button to save your changes\n\n\n\n\n\n To add or change the signature image for your account \n\n 1. Click on the user icon at the top right of the screen\n\n 2. In the popup menu, click on **My Account**\n\n 3. Click on the Profile tab if necessary\n\n 4. Click on the **Edit** button to in the Signature section\n\n 5. Click on the **Upload Signature** button and select an image from your PC\n\n 6. Click on the **Apply** button to save your changes\n\n\n\n\n\n To change your password \n\n 1. Click on the user icon at the top right of the screen\n\n 2. In the popup menu, click on **My Account**\n\n 3. Click on the Profile tab if necessary\n\n 4. Click on **Change Password**\n\n 5. Enter your current password\n\n 6. Enter a new password\n\n 7. Renter the new password to confirm\n\n 8. Click on the **Apply** button\n\n\n\n\n## Preferences\n\n### Visiopharm Preferences [addon]\n\n\n\n To change the default application used with the Open in VIS button \n\n 1. Click on the user icon at the top right of the screen\n\n 2. In the popup menu, click on **My Account**\n\n 3. Click on the Preferences tab\n\n 4. Under the Visiopharm section, locate the **Default Application** setting\n\n 5. Select either _VIS_ or _VIS Basic_, depending on which software you have installed\n\n\n\n\n\n To change the sub-image handling behavior \n\n 1. Click on the user icon at the top right of the screen\n\n 2. In the popup menu, click on **My Account**\n\n 3. Click on the Preferences tab\n\n 4. Under the Visiopharm section, locate the **Sub-image Handling** setting\n\n 5. Select either _All Sub-images_ or _First Sub-image_\n\n\n
\n All Sub-images is only supported in versions of Visiopharm released after Q2 2022.\n
\n\n\n","slug":"docs/settings/my-account"},{"frontmatter":{"title":"Storage Statistics","description":"storage statistics"},"rawBody":"---\ntitle: Storage Statistics\nsection: Settings\ndescription: storage statistics\norder: 19\n---\n\n\n# Storage Statistics\n\n \n\nStorage statistics provide an overview of storage capacity and consumption as well as other statistics about the data in the Repository.\n\n\n## Statistics\n\nThe following storage information is reported\n\n- Total storage available\n- Storage used / free\n- Total data uploaded this week\n- Total data uploaded this month\n- Number of folders\n- Number of images\n- Number of snapshots created\n- Number of annotations created\n\n\n\n To view storage statistics \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Storage** tab\n\n\n","slug":"docs/settings/storage-statistics"},{"frontmatter":{"title":"Team Customization","description":"team customization"},"rawBody":"---\ntitle: Team Customization\nsection: Settings\ndescription: team customization\norder: 18\n---\n\n\n# Team Customization\n\n \n\nEach team has a customizable name and logo that appear in the top left corner of the screen while on the repository page.\n\n
\n Only users with the Administrator role can change the team name and logo.\n
\n\n\n## Team Name\n\n\n\n To change team name \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Team Customization** tab\n\n 3. Click on **Edit** next to Team Name\n\n 4. Type a new name in the Team Name field\n\n 5. Click on **Save** to finish\n\n\n\n\n## Team Logo\n\n
\n Maximum file size for a logo is 10 MiB.\n
\n\n\n\n To add/change team logo \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Team Customization** tab\n\n 3. Click on **Add** or **Edit** next to Team Logo\n\n 4. Click on the **Choose File** button\n\n 5. Select a file from the computer\n\n 6. Click on the **Update Logo** button to finish\n\n\n\n\n\n To remove the team logo \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Team Customization** tab\n\n 3. Click on **Edit** next to Team Logo\n\n 4. Click on the **Remove Logo** button to remove\n\n\n","slug":"docs/settings/team-customization"},{"frontmatter":{"title":"User Management","description":"user management"},"rawBody":"---\ntitle: User Management\nsection: Settings\ndescription: user management\norder: 16\n---\n\n\n# User Management\n\n \n\nThe user management capabilities allow Administrators to create new users and manage attributes of existing user accounts.\n\n
\n Only users with the Administrator role can access user management functions.\n
\n\n\n## User Accounts\n\nEach user account in the system has the following attributes:\n\n- A name\n- An email address\n- A role - the actions users can perform with the content they can access\n- Account status (e.g., active, disabled, pending activation)\n- Account creation time\n\nThe account name and email address are defined by an Administrator when the account is created. Beyond this point, only the user can change these properties (e.g., name, password, picture, and signature) from the user’s [My Account](/docs/settings/my-account/).\n\n\n\n To view the list of accounts currently registered, and their properties \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n\n\n\n\n To search for an existing user account by name, email address, role, or date created \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n 3. Type a few characters in the search bar above the user table\n\n\n\n\n\n To show/hide accounts that are not active \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n 3. Click on the  **Filter** button\n\n 4. Enable the **Show disabled users** toggle to include in the listing users which have been disabled by an Administrator\n\n 5. Enable the **Show non-activated users** toggle to include in the listing users who have not yet completed the activation process\n\n\n\n\n## Creating User Accounts\n\n### Account Creation\n\nBefore creating users, it would be helpful to have a complete understanding of [Permissions](/docs/settings/roles/#permissions). To streamline user creation, please review the existing [Roles](/docs/settings/roles/) to ensure you are familiar with the available options.\n\nNewly created accounts will be marked as “pending activation” and the new user will not be able to log in until [Account Activation](#account-activation) is completed.\n\n
\n Users with the Educator and Administrator roles can access all data in the Repository while users with the Student role are limited to classes they have been assigned to and cannot access the Repository.\n
\n\n\n\n To create a user account \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n 3. Click on the **Create User** button\n\n 4. Enter the user’s name in the **Name** field\n\n 5. Enter the user’s email address in the **Email** field\n\n 6. Select an option from the **Role** dropdown\n\n 7. Click on the **Create User** button to finish\n\n\n\n\n### Account Activation\n\nAfter a user account has been created by a team Administrator, the system will automatically send an account activation notification to the new user by email. Once received, the user may click on the **Activate** button from their email to choose a password, review the terms and conditions and complete other activation steps as may be required.\n\n
\n Activation emails are incorrectly marked as spam by some email services. Be sure to check your spam filter.\n
\n\n\n### Resending Activation Notification\n\nIf the user is having difficulty finding an activation email, even after checking their spam folder, or for any other reason, the notification can be resent by the team Administrator.\n\n\n\n To resend a user account activation notification \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n 3. Locate the user in the users table and click on the **More** menu on the right-hand side of the row\n\n 4. Select the **Resend Activation Link** option in the popup menu\n\n\n\n\n## Modifying User Accounts\n\nAn Administrator can modify the roles of users and account status. However, names associated with accounts can only be changed by the user via [My Account](/docs/settings/my-account/).\n\n\n### Modifying Roles\n\n[Roles](/docs/settings/roles/) define the set of actions that users can perform with the data they can access (e.g., download, edit, view).\n\n\n\n To modify the role associated with a user’s account \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n 3. Locate the user in the users table and click on the **More** menu on the right-hand side of the row\n\n 4. Select the **Edit Role/Permissions** option in the popup menu\n\n 5. Select an option from the **Role** dropdown\n\n 6. Click on the **Save** button\n\n\n\n\n### Invalidate User’s Session(s)\n\nBy default, users are not required to re-authenticate until they have logged out or until the application cookies have been cleared. However, an Administrator can force a user to re-authenticate by invalidating their sessions.\n\n\n\n To invalidate a user’s session \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n 3. Locate the user in the users table and click on the **More** menu on the right-hand side of the row\n\n 4. Select the **Invalidate Sessions** option in the popup menu\n\n\n\n\n### Disable User Accounts\n\nIf an account is no longer required it can be disabled. At this time, there is no way to delete user accounts, since these may be connected to audit records that are collected during normal application use. It’s important to note that the application does not collect personal information other than a user’s name and email address. In order to meet any regulatory requirements with respect to user privacy, please contact our support team.\n\n\n\n To disable a user account or to enable a previously disabled account \n\n 1. Click on the  **Settings** button from the left-hand sidebar\n\n 2. Click on the **Users** tab\n\n 3. Locate the user in the users table and click on the **More** menu on the right-hand side of the row\n\n 4. Select the **Disable Account** or **Enable Account** option in the popup menu as appropriate\n\n 5. Click on **Yes** to confirm\n\n\n","slug":"docs/settings/user-management"},{"frontmatter":{"title":"Advanced Share Link Options","description":"advanced share link options"},"rawBody":"---\ntitle: Advanced Share Link Options\ndescription: advanced share link options\nsection: Share Links\norder: 26\n---\n\n\n# Advanced Share Link Options\n##### [addon]\n\n \n\nAdvanced share link options can be used to track viewing patterns of recipients and to customize the controls that are accessible in the Viewer when the share link is accessed.\n\nTo enable advanced options, see [Image Share Links](/docs/share-links/share-link-overview/#image-share-links) and [Folder Share Links](/docs/share-links/share-link-overview/#folder-share-links).\n\n\n## Advanced Options\n\n### View Tracking\n\nView tracking is a feature of share links and has been designed for studying the viewing habits of pathologists. When enabled for a given share link, the image regions displayed in the Viewer are logged when the image is accessed via the share link. The logged information includes a timestamp for every region displayed.\n\nView tracking can be enabled for an image share link and for a folder share link. When view tracking is enabled for a folder, viewing logs will be generated for all of the images within the folder and its subfolders, recursively, when the folder share link is used to access images.\n\nTo enable view tracking, see [Image Share Links](/docs/share-links/share-link-overview/#image-share-links) and [Folder Share Links](/docs/share-links/share-link-overview/#folder-share-links). To download logs associated with view tracking history, see [Downloading Logs](#downloading-logs).\n\n
\n All access (from any user) to the image via the share link will affect the logged information.\n
\n\n\n### Collection of Annotations\n\nWhile share links are typically read-only, an exception exists for annotations. Share links can be configured to allow their recipients to create annotations. Any of the supported annotation types can be individually allowed for a given share link, to provide maximum control over the collection.\n\nAnnotations that are created via the share link will appear as shared annotations in the [Annotations Panel](/docs/viewer/annotations-panel/) for the image, are associated with the “Anonymous” user, and are visible by anyone that accesses the share link.\n\nTo enable collection of annotations, see [Image Share Links](/docs/share-links/share-link-overview/#image-share-links) and [Folder Share Links](/docs/share-links/share-link-overview/#folder-share-links). To download logs associated with annotations, see [Downloading Logs](#downloading-logs).\n\n\n### Hiding Viewer Tools\n\nThe set of Viewer tools that are visible in the Viewer when an image is accessed via a share link can be controlled to some extent. The following Viewer tools can be hidden: [Rotation Controls](/docs/viewer/basic-controls/#rotation-controls), [Color Management](/docs/viewer/basic-controls/#color-management), and the [Overview Tool](/docs/viewer/overview-tool/).\n\n\n## Downloading Logs\n\nSome of the advanced share link options can generate logs, including [view tracking](#view-tracking) and [collection of annotations](#collection-of-annotations). However, logs will only be generated when the view tracking has been enabled.\n\n\n\n To download logs of regions viewed for a share link \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Right-click on the item to bring up the context menu\n\n 3. Click **Share**\n\n 4. In the popup dialog, click on the name of a share link with the _View Tracking Enabled_ label\n\n 5. Select the **Advanced** tab\n\n 6. Click on the  **Download Data** button underneath the **Track view history** toggle\n\n\n\n\n\n To download logs of regions viewed for all share links associated with an item \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Right-click on the item to bring up the context menu\n\n 3. Click **Share**\n\n 4. In the popup dialog, click on the  button to the right of the **New Share Link** button\n\n\n\n\n### Log File Format\n\nThe log file is provided in the TSV (tab separated value) file format and is compatible with popular spreadsheet applications.\n\nEach entry in the log file has the following columns:\n\n- **Timestamp**: provides event time\n- **Source**: describes the reason the event generated the event\n- **Source ID**:\n - for Viewport events, the ID of the image\n - for Annotation events, the ID of the annotation\n- **Data**: contains the event data\n- **Data Type**: describes the type of data in the Data column\n- **Modification Method**: describes the action taken\n- **Magnification**: for Viewport events, the new magnification\n- **Image Rotation**: for Viewport events, the new rotation value (in degrees)\n- **Width**: the width of the image region on display in image coordinates @ base-level\n- **Height**: the height of the image region on display in image coordinates @ base-level\n- **Client Height**: width of the viewport in screen pixels\n- **Client Width**: height of the viewport in screen pixels\n- **Region Download Link**: a URL that provides image region overlapping with certain events and currently only supported for rect annotations (i.e., when Source is “Annotation” and DataType is “rect”)\n\n#### Source Types\n\nThe following source types are possible:\n\n- **Annotation**: produced when the annotation is created\n- **Viewport**: produced when the displayed image region changes (i.e., a pan or zoom)\n\n#### Data Types\n\nThe following Data Types are possible:\n\n- **Arrow**: Indicate the Data column contains a JSON blob that describes a series of two points produced by the arrow annotation tool\n- **Freehand**: Indicate the Data column contains a JSON blob that describes a series of points produced by the freehand annotation tool\n- **Point**: Indicate the Data column contains a JSON blob that describes a series of points produced by the bookmark annotation tool\n- **Polygon**: Indicate the Data column contains a JSON blob that describes a series of points produced by the closed polygon annotation tool\n- **Rect:** Indicate the Data column contains a JSON blob that describes a rectangle\n- **Ruler**: Indicate the Data column contains a JSON blob that describes a series of points produced by the freehand annotation tool\n\n#### Modification Methods\n\nThe following modification methods are possible:\n\n- **create**: A new annotation was created\n- **delete**: An annotation was deleted\n- **modify**: An annotation was modified\n- **move**: The displayed image region was changed\n\n### Log File Example\n\n\n\n Example of an abbreviated log file \n\n| Timestamp | Source | Source ID | Data | Data Type | Modification Method | Magnification | Image Rotation | Width | Height | Client Width | Client Height | Region Download Link |\n|:----------------------------- |:---------- |:---------- |:------------------------------------------------------------------------------------------------------ |:--------- |:------------------- |:------------- |:-------------- |:----- |:------ |:------------ |:------------- |:-------------------- |\n| 2022-09-21T16:09:24.951-03:00 | Viewport | 6GCMGgpoSS | `[{'x': -6900, 'y': 0}, {'x': 24900, 'y': 0}, {'x': 24900, 'y': 15847}, {'x': -6900, 'y': 15847}]` | rect | move | 1.14 | 0 | 31799 | 15847 | 1856 | 943 | |\n| 2022-09-21T16:09:35.048-03:00 | Annotation | 23 | `[{'x': 7032, 'y': 4831}]` | bookmark | create | 1.14 | 0 | | | 1856 | 943 | |\n| 2022-09-21T16:09:38.714-03:00 | Annotation | 24 | `[{'x': 8139, 'y': 6184}, {'x': 9580, 'y': 6184}, {'x': 9580, 'y': 9030}, {'x': 8139, 'y': 9030}]` | rect | create | 1.14 | 0 | 1441 | 2846 | 1856 | 943 | https://pathcore.com/api/image/6GCMGgpoSS/region?area=8139,6184,1441,2846 |\n| 2022-09-21T16:09:44.326-03:00 | Annotation | 24 | `[{'x': 7840, 'y': 9733}, {'x': 9281, 'y': 9733}, {'x': 9281, 'y': 12579}, {'x': 7840, 'y': 12579}]` | rect | modify | 1.14 | 0 | 1441 | 2846 | 1856 | 943 | https://pathcore.com/api/image/6GCMGgpoSS/region?area=7840,9733,1441,2846 |\n| 2022-09-21T16:09:50.518-03:00 | Annotation | 24 | | rect | delete | 1.14 | 0 | | | 1856 | 943 | |\n| 2022-09-21T16:09:53.885-03:00 | Viewport | 6GCMGgpoSS | `[{'x': -6900, 'y': 0}, {'x': 24900, 'y': 0}, {'x': 24900, 'y': 15847}, {'x': -6900, 'y': 15847}]` | rect | move | 1.14 | 299 | 31799 | 15847 | 1856 | 943 | |\n| 2022-09-21T16:09:58.879-03:00 | Viewport | 6GCMGgpoSS | `[{'x': -5602, 'y': 615}, {'x': 23472, 'y': 615}, {'x': 23472, 'y': 15104}, {'x': -5602, 'y': 15104}]` | rect | move | 1.25 | 299 | 29074 | 14489 | 1856 | 943 | |\n\n\n\n\n\n Example of an abbreviated log file in raw format \n\n```\nTimestamp\tSource\tSource ID\tData\tData Type\tModification Method\tMagnification\tImage Rotation\tWidth\tHeight\tClient Width\tClient Height\tRegion Download Link\n2022-09-21T16:09:24.951-03:00\tViewport\t6GCMGgpoSS\t[{'x': -6900, 'y': 0}, {'x': 24900, 'y': 0}, {'x': 24900, 'y': 15847}, {'x': -6900, 'y': 15847}]\trect\tmove\t1.14\t0\t31799\t15847\t1856\t943\n2022-09-21T16:09:35.048-03:00\tAnnotation\t23\t[{'x': 7032, 'y': 4831}]\tbookmark\tcreate\t1.14\t0\t\t\t1856\t943\n2022-09-21T16:09:38.714-03:00\tAnnotation\t24\t[{'x': 8139, 'y': 6184}, {'x': 9580, 'y': 6184}, {'x': 9580, 'y': 9030}, {'x': 8139, 'y': 9030}]\trect\tcreate\t1.14\t0\t1441\t2846\t1856\t943\thttps://pathcore.com/api/image/6GCMGgpoSS/region?area=8139,6184,1441,2846\n2022-09-21T16:09:44.326-03:00\tAnnotation\t24\t[{'x': 7840, 'y': 9733}, {'x': 9281, 'y': 9733}, {'x': 9281, 'y': 12579}, {'x': 7840, 'y': 12579}]\trect\tmodify\t1.14\t0\t1441\t2846\t1856\t943\thttps://pathcore.com/api/image/6GCMGgpoSS/region?area=7840,9733,1441,2846\n2022-09-21T16:09:50.518-03:00\tAnnotation\t24\t\trect\tdelete\t1.14\t0\t\t\t1856\t943\n2022-09-21T16:09:53.885-03:00\tViewport\t6GCMGgpoSS\t[{'x': -6900, 'y': 0}, {'x': 24900, 'y': 0}, {'x': 24900, 'y': 15847}, {'x': -6900, 'y': 15847}]\trect\tmove\t1.14\t299\t31799\t15847\t1856\t943\n2022-09-21T16:09:58.879-03:00\tViewport\t6GCMGgpoSS\t[{'x': -5602, 'y': 615}, {'x': 23472, 'y': 615}, {'x': 23472, 'y': 15104}, {'x': -5602, 'y': 15104}]\trect\tmove\t1.25\t299\t29074\t14489\t1856\t943\n```\n\n\n","slug":"docs/share-links/advanced-share-link-options"},{"frontmatter":{"title":"Embedding an Image","description":"embedding an image"},"rawBody":"---\ntitle: Embedding an Image\ndescription: embedding an image\nsection: Share Links\norder: 25\n---\n\n\n# Embedding an Image\n\n \n\nThe embed feature of share links may be used to create interactive experiences with images on your own web pages or to simply show notable images and annotations. To embed an image into a webpage, copy the HTML snippet provided in the share link properties dialog into your own website. Image embedding uses the HTML tag and behaves like embedded maps that are commonly used on many websites.\n\nEmbedded images are powered by share links and have the same restrictions and behave in a similar fashion. The embed code retrieved from the Viewer provides additional flexibility — primarily the ability to control the recipient's initial view. However, the initial view for embedded images may be affected by the size of the window that renders the image.\n\n
\n Embedded images may not work in browsers that restrict third-party cookies.\n
\n\n\n\n To retrieve the embed code for an image from the Repository \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Right-click on the image to bring up the context menu\n\n 3. Click **Share**\n\n 4. In the popup dialog, click on the name of the share link or click on the **New Share Link** button to create a new one\n\n 5. Click on the **Embed Image** tab\n\n 6. (Optional) Configure the embedded image settings\n 1. (Optional) Set the **Width** (may include units such as % and px)\n 2. (Optional) Set the **Height** (may include units such as % and px)\n\n 7. Click on the  button to the right of the HTML snippet to copy it to the clipboard\n\n 8. Paste the HTML snippet into your webpage\n\n\n\n\n\n To retrieve the embed code for an image from within the Viewer \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the name of the share link or click on the **New Share Link** button to create a new one \n\n 4. Click on the **Embed Image** tab\n\n 5. (Optional) Configure the embedded image settings\n 1. (Optional) Set the **Width** (may include units such as % and px)\n 2. (Optional) Set the **Height** (may include units such as % and px)\n 3. (Optional) Enable the **Start at current location** toggle to use the current view as the initial view for the embedded image \n\n 6. Click on the  button to the right of the HTML snippet to copy it to the clipboard\n\n 7. Paste the HTML snippet into your webpage\n\n\n","slug":"docs/share-links/embedding-an-image"},{"frontmatter":{"title":"Managing Share Links","description":"managing share links"},"rawBody":"---\ntitle: Managing Share Links\ndescription: managing share links\nsection: Share Links\norder: 24\n---\n\n\n# Managing Share Links\n\n \n\nShare links can be viewed, edited and deleted after they have been created. In order to see the share links that have been generated for an item, right-click on the item in the Repository and select **Share** from the context menu. At present, there is no way to see all the shared links that have been generated by all users and for all images and folders.\n\n
\n If there are any share links associated with an item, a share icon is displayed to the right of its name in the Repository listing. Hovering over the icon shows how many share links are associated with the item.\n
\n\n\n\n To edit a share link for the current folder from the Repository \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the  button next to the current folder's breadcrumb. This icon only appears if at least one share link has been created for the current folder\n\n 3. In the popup dialog, click on the name of the share link to edit\n\n 4. (Optional) Configure the link. See [Share Link Properties](/docs/share-links/share-link-overview/#share-link-properties) for more details\n 1. (Optional) Document the purpose of the link in the **Name** field\n 2. (Optional) Choose an expiry date by clicking on the **Expires** field, or choose a preset lifetime from below the field\n 3. (Optional) Enable the **Anonymize data** toggle. See [Anonymize Data](/docs/share-links/share-link-overview/#anonymize-data) for more details\n 4. (Optional) Enable the **Show annotations** toggle to make shared annotations visible via the share link\n\n 5. (Optional) In the **Link** tab, click on the  button to the right of the link field to copy the URL\n\n 6. (Optional) Email the share link to the intended recipients\n 1. Add one or more email addresses to the **Email this link** section\n 2. (Optional) Add a message for the recipients to the **Message** section\n 3. Click on the **Send Email** button\n\n 7. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n
\n All changes are saved automatically.\n
\n\n\n\n\n\n To delete a share link for the current folder from the Repository \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the  button next to the current folder's breadcrumb. This icon only appears if at least one share link has been created for the current folder\n\n 3. In the popup dialog, click on the  button adjacent to the share link\n\n 4. Click on the **Delete Link** button to confirm if you are sure you wish to remove the item. To cancel the delete action, click on the **Cancel** button or press the **Escape** key\n\n\n\n\n\n To edit a share link for any item from the Repository \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Right-click on the item to bring up the context menu\n\n 3. Click **Share**\n\n 4. In the popup dialog, click on the name of the share link to edit\n\n 5. (Optional) Configure the link. See [Share Link Properties](/docs/share-links/share-link-overview/#share-link-properties) for more details\n 1. (Optional) Document the purpose of the link in the **Name** field\n 2. (Optional) Choose an expiry date by clicking on the **Expires** field, or choose a preset lifetime from below the field\n 3. (Optional) Enable the **Anonymize data** toggle. See [Anonymize Data](/docs/share-links/share-link-overview/#anonymize-data) for more details\n 4. (Optional) Enable the **Show annotations** toggle to make shared annotations visible via the share link\n\n 6. (Optional) In the **Link** tab, click on the  button to the right of the link field to copy the URL\n\n 7. (Optional) Email the share link to the intended recipients\n 1. Add one or more email addresses to the **Email this link** section\n 2. (Optional) Add a message for the recipients to the **Message** section\n 3. Click on the **Send Email** button\n\n 8. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n
\n All changes are saved automatically.\n
\n\n\n\n\n\n To delete a share link for any item from the Repository \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Right-click on the item to bring up the context menu\n\n 3. Click **Share**\n\n 4. In the popup dialog, click on the  button adjacent to the share link\n\n 5. Click on the **Delete Link** button to confirm if you are sure you wish to remove the item. To cancel the delete action, click on the **Cancel** button or press the **Escape** key\n\n\n\n\n\n To edit a share link for an image from within the Viewer \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the name of the share link to edit\n\n 4. (Optional) Configure the link. See [Share Link Properties](/docs/share-links/share-link-overview/#share-link-properties) for more details\n 1. (Optional) Document the purpose of the link in the **Name** field\n 2. (Optional) Choose an expiry date by clicking on the **Expires** field, or choose a preset lifetime from below the field\n 3. (Optional) Enable the **Link to current location** toggle to set the ROI when the link is first opened to match the current position in the Viewer\n 4. (Optional) Enable the **Anonymize data** toggle. See [Anonymize Data](/docs/share-links/share-link-overview/#anonymize-data) for more details\n 5. (Optional) Enable the **Show annotations** toggle to make shared annotations visible via the share link\n\n 5. (Optional) In the **Link** tab, click on the  button to the right of the link field to copy the URL\n\n 6. (Optional) Email the share link to the intended recipients\n 1. Add one or more email addresses to the **Email this link** section\n 2. (Optional) Add a message for the recipients to the **Message** section\n 3. Click on the **Send Email** button\n\n 7. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n
\n All changes are saved automatically.\n
\n\n\n\n\n\n To delete a share link for an image from within the Viewer \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. In the popup dialog, click on the  button adjacent to the share link\n\n 4. Click on the **Delete Link** button to confirm if you are sure you wish to remove the item. To cancel the delete action, click on the **Cancel** button or press the **Escape** key\n\n\n","slug":"docs/share-links/managing-share-links"},{"frontmatter":{"title":"Annotations Panel","description":"annotations panel"},"rawBody":"---\ntitle: Annotations Panel\ndescription: annotations panel\norder: 19\nsection: Viewer\n---\n\n\n# Annotations Panel\n\n \n\nThe Annotations panel contains a list of all geometric annotations that have been drawn onto the image and allows the user to modify many of their properties.\n\n\n\n To toggle the visibility of the Annotations panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Click on the  button in the left sidebar to open the Annotations panel\n\n\n\n\n## Creating Annotations\n\n\n\n To create annotations \n\n 1. From within the Viewer, right-click on an image to open up the annotation ring\n\n 2. Select an annotation tool\n\n 3. Follow the on-screen instructions at the top of the Viewer to draw\n\n 4. Follow the on-screen instructions at the top of the Viewer to end drawing\n\n\n\nThe following annotation types are available:\n\n| Tool | Instruction to create |\n| -------- | ------------------------------------------------------------ |\n| Rect | Hold and drag to contain an area of interest. |\n| Arrow | Hold and drag to point to an area of interest. The starting point will be the arrowhead. |\n| Polygon | Click to add points. Click on the first point to close (end) the drawing or press **Z** to close automatically. Press **Ctrl + Z** to undo the last point. To pan while drawing, hold the **Shift** key and drag with the mouse. |\n| Freehand | Hold and drag to draw on the image. |\n| Ruler | Hold and drag to measure the area of interest. |\n| Ellipse | Hold and drag to contain the area of interest. The starting point will be the center of the ellipse. |\n| Bookmark | Click/tap to place an area of interest to place a bookmark pin on the image. |\n\n\n### Deleting Annotations\n\nAnnotations can be deleted from within the Viewer or from the Annotations panel.\n\n\n\n To delete an annotation from within the Viewer \n\n 1. Select an annotation to reveal a dialog by clicking the border of the rectangle, ellipse or other shape\n\n 2. Click on the  button at the bottom right of the popup dialog\n\n 3. Click on the **OK** button to confirm\n\n\n\n\n\n To delete an annotation from the Annotations panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the annotation entry to be deleted in the list\n\n 4. Click on the  button\n\n 5. Click on the **OK** button to confirm\n\n\n\n\n## Editing Annotations\n\nThe following annotation properties can be changed from the Annotations panel or by clicking on the annotation in the Viewer, which exposes a popup dialog.\n\n### Annotation Color\n\nThere are 6 possible colors for annotations, these can be changed from within the Viewer or from the Annotations panel.\n\n\n\n To change an annotation color from within the Viewer \n\n 1. Select an annotation to reveal a dialog by clicking the border of the rectangle, ellipse or other shape\n\n 2. Click on the solid circle at the top right of the popup dialog\n\n 3. Select one of the available colors\n\n\n\n\n\n To change an annotation color from the Annotations panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the annotation entry to be modified\n\n 4. Click on the solid circle at the top right of the entry\n\n 5. Select one of the available colors\n\n\n\n\n### Annotation Name\n\nThe name is a single line text field that supports unicode characters. The name is displayed on the annotation and can be changed from within the Viewer or from the Annotations panel.\n\n\n\n To rename an annotation from within the Viewer \n\n 1. Select an annotation to reveal a dialog by clicking the border of the rectangle, ellipse or other shape\n\n 2. Click on the first line of text in the popup dialog (default: “Untitled”)\n\n 3. Provide a name or edit the existing text\n\n 4. Press the **Enter** key or click away from the textbox to save your changes\n\n\n\n\n\n To rename an annotation from the Annotations panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the annotation entry to be modified\n\n 4. Click on the first line of text in the entry (default: “Untitled”)\n\n 5. Provide a name or edit the existing text\n\n 6. Press the **Enter** key or click away from the textbox to save your changes\n\n\n\n\n### Annotation Description\n\nThe description is a multiline text field that supports unicode characters and can be modified from within the Viewer or from the Annotations panel. Enter new lines by pressing **Shift + Enter**.\n\n\n\n To edit an annotation description from within the Viewer \n\n 1. Select an annotation to reveal a dialog by clicking the border of the rectangle, ellipse or other shape\n\n 2. Click on the second line of text in the popup dialog (default: “No description”)\n\n 3. Provide a description or edit the existing text\n\n 4. Press the **Enter** key or click away from the textbox to save your changes\n\n\n\n\n\n To edit an annotation description from the Annotations panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the annotation entry to be modified\n\n 4. Click on the second line of text in the entry (default: “No description”)\n\n 5. Provide a description or edit the existing text\n\n 6. Press the **Enter** key or click away from the textbox to save your changes\n\n\n\n\n### Annotation Visibility\n\nAnnotations are visible on the image by default once drawn. If you need to declutter the image, you may hide individual annotations or all annotations at once.\n\n\n\n To change the visibility of individual annotations \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the annotation entry to be modified\n\n 4. Click on the  button to toggle visibility\n\n\n\n\n\n To change the visibility of all annotations \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the  button at the top right corner of the Annotations panel to toggle visibility for all annotations\n\n\n\n\n### Annotation Sharing\n\nAnnotations may be shared with your team or kept private for the user that created them. Shared annotations are visible to all users in your team while private annotations are only visible to the user that created them.\n\nBy default, annotations are created as shared annotations. This preference can be changed from the Annotations panel by toggling the / button at the top right corner of the Annotations panel.\n\n\n\n To toggle the sharing mode for individual annotation \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the annotation entry to be modified\n\n 4. Click on the  **Shared**/ **Private** button to toggle the annotation’s sharing mode\n\n\n\n\n### Locating an Annotation\n\nWhile on the Viewer, annotations are easily visible and accessible.\n\n\n\n To locate a corresponding annotation object (on the image) from the Annotations panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the annotation entry\n\n 4. Click on the  button to jump to the annotation in the Viewer\n\n\n","slug":"docs/viewer/annotations-panel"},{"frontmatter":{"title":"Share Link Overview","description":"share link overview"},"rawBody":"---\ntitle: Share Link Overview\ndescription: share link overview\nsection: Share Links\norder: 23\n---\n\n\n# Share Link Overview\n\n \n\nHave files or folders you would like to share? You can generate a unique and, optionally, time-limited share link for an image or a folder. Share links provide read-only access (unless [Collection of Annotations](/docs/share-links/advanced-share-link-options/#collection-of-annotations) is enabled) to the item(s) being shared and their children, but do not require the recipient to authenticate (i.e., can be accessed without logging in). Share links can be used by anyone that knows the share link URL, without an account.\n\n
\n Anyone with access to the share link URL will be able to view the content associated with the share link. It’s recommended to use share links only with trusted collaborators or for public data sharing.\n
\n\n\n## Image Share Links\n\nAn image share link provides read-only access (unless [Collection of Annotations](/docs/share-links/advanced-share-link-options/#collection-of-annotations) is enabled) to a single image and its metadata such as shared annotations and analysis results. Image share links can be created from the Repository page or from within the Viewer.\n\nShare links created from within the Viewer provide additional flexibility — primarily the ability to control the recipient's initial view. See [Link to Current Location](#link-to-current-location) for more details.\n\n\n\n To create an image share link from the Repository \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Right-click on the image to bring up the context menu\n\n 3. Click **Share**\n\n 4. Click on the **New Share Link** button\n\n 5. (Optional) Configure the link. See [Share Link Properties](#share-link-properties) for more details\n 1. (Optional) Document the purpose of the link in the **Name** field\n 2. (Optional) Choose an expiry date by clicking on the **Expires** field, or choose a preset lifetime from below the field\n 3. (Optional) Enable the **Anonymize data** toggle. See [Anonymize Data](#anonymize-data) for more details\n 4. (Optional) Enable the **Show annotations** toggle to make shared annotations visible via the share link\n\n 6. (Optional) Select the **Advanced** tab to configure [advanced share link options](/docs/share-links/advanced-share-link-options/)\n 1. (Optional) Enable **Track view history**. See [View Tracking](/docs/share-links/advanced-share-link-options/#view-tracking) for more details\n 2. (Optional) In the **Customize viewer** section, you may configure the Viewer by [hiding certain tools](/docs/share-links/advanced-share-link-options/#hiding-viewer-tools)\n 3. (Optional) In the **Allow annotations** section, you may enable the [collection of annotations](/docs/share-links/advanced-share-link-options/#collection-of-annotations) by selecting tools that will be enabled for the share link\n\n 7. (Optional) In the **Link** tab, click on the  button to the right of the link field to copy the URL\n\n 8. (Optional) Email the share link to the intended recipients\n 1. Add one or more email addresses to the **Email this link** section\n 2. (Optional) Add a message for the recipients to the **Message** section\n 3. Click on the **Send Email** button\n\n 9. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n
\n All changes are saved automatically.\n
\n\n\n\n\n\n To create an image share link from within the Viewer \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the **New Share Link** button\n\n 4. (Optional) Configure the link. See [Share Link Properties](#share-link-properties) for more details\n 1. (Optional) Document the purpose of the link in the **Name** field\n 2. (Optional) Choose an expiry date by clicking on the **Expires** field, or choose a preset lifetime from below the field\n 3. (Optional) Enable the **Link to current location** toggle to set the ROI when the link is first opened to match the current position in the Viewer\n 4. (Optional) Enable the **Anonymize data** toggle. See [Anonymize Data](#anonymize-data) for more details\n 5. (Optional) Enable the **Show annotations** toggle to make shared annotations visible via the share link\n\n 5. (Optional) Select the **Advanced** tab to configure [advanced share link options](/docs/share-links/advanced-share-link-options/)\n 1. (Optional) Enable **Track view history**. See [View Tracking](/docs/share-links/advanced-share-link-options/#view-tracking) for more details\n 2. (Optional) In the **Customize viewer** section, you may configure the Viewer by [hiding certain tools](/docs/share-links/advanced-share-link-options/#hiding-viewer-tools)\n 3. (Optional) In the **Allow annotations** section, you may enable the [collection of annotations](/docs/share-links/advanced-share-link-options/#collection-of-annotations) by selecting tools that will be enabled for the share link\n\n 6. (Optional) In the **Link** tab, click on the  button to the right of the link field to copy the URL\n\n 7. (Optional) Email the share link to the intended recipients\n 1. Add one or more email addresses to the **Email this link** section\n 2. (Optional) Add a message for the recipients to the **Message** section\n 3. Click on the **Send Email** button\n\n 8. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n
\n All changes are saved automatically.\n
\n\n\n\n\n## Folder Share Links\n\nA folder share link provides read-only access (unless [Collection of Annotations](/docs/share-links/advanced-share-link-options/#collection-of-annotations) is enabled) to the contents of a folder and its subfolders recursively, including all the metadata associated with these items. A folder share link can be used to navigate the folder and its children, including any images that are contained within them. Folder share links are ideal for sharing an entire dataset, case or study.\n\n\n\n To create a share link for the current folder \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Click on the  button next to the current folder's breadcrumb\n\n 3. Click **Share**\n\n 4. Click on the **New Share Link** button\n\n 5. (Optional) Configure the link. See [Share Link Properties](#share-link-properties) for more details\n 1. (Optional) Document the purpose of the link in the **Name** field\n 2. (Optional) Choose an expiry date by clicking on the **Expires** field, or choose a preset lifetime from below the field\n 3. (Optional) Enable the **Anonymize data** toggle. See [Anonymize Data](#anonymize-data) for more details\n 4. (Optional) Enable the **Show annotations** toggle to make shared annotations visible via the share link\n\n 6. (Optional) Select the **Advanced** tab to configure [advanced share link options](/docs/share-links/advanced-share-link-options/)\n 1. (Optional) Enable **Track view history**. See [View Tracking](/docs/share-links/advanced-share-link-options/#view-tracking) for more details\n 2. (Optional) In the **Customize viewer** section, you may configure the Viewer by [hiding certain tools](/docs/share-links/advanced-share-link-options/#hiding-viewer-tools)\n 3. (Optional) In the **Allow annotations** section, you may enable the [collection of annotations](/docs/share-links/advanced-share-link-options/#collection-of-annotations) by selecting tools that will be enabled for the share link\n\n 7. (Optional) In the **Link** tab, click on the  button to the right of the link field to copy the URL\n\n 8. (Optional) Email the share link to the intended recipients\n 1. Add one or more email addresses to the **Email this link** section\n 2. (Optional) Add a message for the recipients to the **Message** section\n 3. Click on the **Send Email** button\n\n 9. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n
\n All changes are saved automatically.\n
\n\n\n\n\n\n To create a share link for a folder \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Right-click on the folder to bring up the context menu\n\n 3. Click **Share**\n\n 4. Click on the **New Share Link** button\n\n 5. (Optional) Configure the link. See [Share Link Properties](#share-link-properties) for more details\n 1. (Optional) Document the purpose of the link in the **Name** field\n 2. (Optional) Choose an expiry date by clicking on the **Expires** field, or choose a preset lifetime from below the field\n 3. (Optional) Enable the **Anonymize data** toggle. See [Anonymize Data](#anonymize-data) for more details\n 4. (Optional) Enable the **Show annotations** toggle to make shared annotations visible via the share link\n\n 6. (Optional) Select the **Advanced** tab to configure [advanced share link options](/docs/share-links/advanced-share-link-options/)\n 1. (Optional) Enable **Track view history**. See [View Tracking](/docs/share-links/advanced-share-link-options/#view-tracking) for more details\n 2. (Optional) In the **Customize viewer** section, you may configure the Viewer by [hiding certain tools](/docs/share-links/advanced-share-link-options/#hiding-viewer-tools)\n 3. (Optional) In the **Allow annotations** section, you may enable the [collection of annotations](/docs/share-links/advanced-share-link-options/#collection-of-annotations) by selecting tools that will be enabled for the share link\n\n 7. (Optional) In the **Link** tab, click on the  button to the right of the link field to copy the URL\n\n 8. (Optional) Email the share link to the intended recipients\n 1. Add one or more email addresses to the **Email this link** section\n 2. (Optional) Add a message for the recipients to the **Message** section\n 3. Click on the **Send Email** button\n\n 9. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n
\n All changes are saved automatically.\n
\n\n\n\n\n## Attachment Share Links\n\nAn attachment share link provides read-only access to any file in the Repository other than an image. Share links for attachments do not have advanced options.\n\n\n\n To create a share link for an attachment \n\n 1. Navigate to any folder in the Repository (click on the  **Repository** button from the left-hand sidebar then navigate to a folder)\n\n 2. Right-click on the item to bring up the context menu\n\n 3. Click **Share**\n\n 4. Click on the **New Share Link** button\n\n 5. (Optional) Configure the link. See [Share Link Properties](#share-link-properties) for more details\n 1. (Optional) Document the purpose of the link in the **Name** field\n 2. (Optional) Choose an expiry date by clicking on the **Expires** field, or choose a preset lifetime from below the field\n\n 6. (Optional) In the **Link** tab, click on the  button to the right of the link field to copy the URL\n\n 7. (Optional) Email the share link to the intended recipients\n 1. Add one or more email addresses to the **Email this link** section\n 2. (Optional) Add a message for the recipients to the **Message** section\n 3. Click on the **Send Email** button\n\n 8. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n
\n All changes are saved automatically.\n
\n\n\n\n\n## Share Link Properties\n\nShare links have a number of properties that make it easier to share exactly the content that is required.\n\n\n### Name\n\nShare link names can be used to distinguish different links and/or to summarize the reason for which they were created. The name is not visible to recipients of the share link.\n\n\n### Expiry Date\n\nAn expiry date may be set to limit the duration of time that share links can be accessed by recipients. Without an expiry date, recipients can access data until the links are deleted.\n\nEmbedded images inherit the expiry date of a share link, if set. After a share link has expired, the related embedded images will no longer work.\n\n\n### Anonymize Data\n\nShare links can be anonymized by enabling the **Anonymize data** toggle. With this option selected the following restrictions are applied to the share link:\n\n- Slide labels associated with WSI, other than burned-in annotations, are hidden\n- Recipients will not be able to download images\n\nEmbedded images inherit the anonymization property of a share link.\n\n
\n The option to anonymize data only applies to share links for images and folders. Share links to attachments do not have this toggle.\n
\n\n\n### Show Annotations\n\nTo make the annotations of an image visible to share link recipients, enable the **Show annotations** toggle. With this toggle selected, all shared annotations will be visible to recipients but your private annotations remain hidden.\n\nEmbedded images inherit this property from share links. When enabled, annotations on the image will be visible via an embedded image.\n\n\n### Link to Current Location\n\nThe **Link to current location** toggle, when enabled, configures the share link to replicate the current scene in the Viewer, at the moment the share link is generated, when the link is first accessed. This option is only available if a share link is created from within the Viewer. The scene is defined by the point at the center of the viewport and current magnification.\n\nEmbedded images inherit this property from share links. When enabled, the code snippet in the embedded image tab will be configured to show the current scene as the default view.\n","slug":"docs/share-links/share-link-overview"},{"frontmatter":{"title":"Basic Controls","description":"basic controls"},"rawBody":"---\ntitle: Basic Controls\ndescription: basic controls\norder: 15\nsection: Viewer\n---\n\n\n# Basic Controls\n\n \n\n\n## Panning\n\nThe Viewer supports multiple ways for navigating images in the Viewer using the mouse and keyboard.\n\n\n\n To pan an image with the mouse from within the Viewer \n\n 1. Press and hold the left mouse button anywhere on the image\n\n 2. Drag with the mouse to navigate the image\n\n\n\n\n\n To pan an image with the keyboard from within the Viewer \n\n 1. Click anywhere on the image (to set focus)\n\n 2. Use the arrow keys (up, down, left, right) to navigate the image\n\n\n\n\n## Magnification\n\nMagnification controls are automatically provided for images that define an objective magnification and for images that are heuristically determined to be whole slide images (e.g., a TIFF file containing a description from a known WSI scanner manufacturer that also has a well-defined pixel size).\n\nThe Viewer will provide preset magnification buttons that are appropriate for the current image, if this information is provided by the image or can be determined heuristically. The preset buttons are accessible from the bottom left side of the image viewport, above the current magnification. For any image where magnification can not be determined, the magnification controls are replaced with scaling controls (e.g., 50%, 100%).\n\n
\n The current magnification is displayed in the Viewer top bar and at the bottom left corner of each image\n
\n\n\n\n To change magnification (or scale factor) using the mouse from within the Viewer \n\n 1. Click anywhere on the image (to set focus)\n\n 2. Use the wheel on the mouse to change magnification fluidly\n\n\n\n\n\n To change magnification using the keyboard from within the Viewer \n\n 1. Click anywhere on the image (to set focus)\n\n 2. Use the +/- buttons to change magnification in small increments\n\n\n\n\n### Heuristically Determined Magnification\n\nImage pixel size is loosely related to the scanned magnification. WSI scanner manufacturers typically define a conversion between pixel size and magnification. Where magnification is not explicitly defined in an image, the pixel size will be used to infer the equivalent objective magnification of the image. In many cases, scanned magnification of 20x is approximately equal to 0.5μm per pixel.\n\n\n### Digital Zoom\n\nYou can zoom an image beyond its native resolution up to 400%. For example, if an image has a maximum magnification of 20x, it can be scaled up to 80x.\n\nThe current magnification is always visible in the bottom left corner of an image. When digital zoom is enabled for an image, the current magnification is shown with a blue border and an adjacent \"Digital Zoom\" indicator.\n\n\n## Focal Planes\n\nFocal planes are automatically detected when present in supported images. If the image has multiple [sub-images](/docs/viewer/image-settings/#sub-images), the focal plane for each sub-image can be independently configured by selecting the appropriate sub-image from the dropdown menu.\n\nThe focal plane controls are visible in the bottom left bottom of the image viewport only when focal planes are detected in an image.\n\n\n\n To see available focal planes for an image \n\n 1. Click on the current focal plane indicator\\* to reveal the focal plane dialog\n\n 2. Click into the Focal Plane dropdown to view available planes\n\n 3. Click on the **x** button to close the focal plane dialog\n\n\n \\* The focal plane controls consist of  and  arrows and a numeric indicator displaying the current focal plane offset (e.g., “0 μm”). If available for the current image, these controls are located on the bottom left-hand side of the image viewport immediately above the magnification controls.\n\n\n\n\n\n To change the focal plane using the mouse \n\n 1. Click on the  or  buttons on the focal plane controls\\*\n\n\n \\* The focal plane controls consist of  and  arrows and a numeric indicator displaying the current focal plane offset (e.g., “0 μm”). If available for the current image, these controls are located on the bottom left-hand side of the image viewport immediately above the magnification controls.\n\n\n\n\n\n To change the focal plane using the mouse wheel \n\n 1. Click on the image\n\n 2. Hold down the **Shift** key on the keyboard and simultaneously use the mouse wheel to fly through the available focal planes\n\n\n\n\n## Rotation Controls\n\nThe rotation tool is located on the bottom left corner of the image viewport. The rotation value is always saved for each user and will be preserved the next time you view the image.\n\n\n\n To enable the rotation tool \n\n 1. Hover or click on the image to reveal the toolbar at the top left of the panel\n\n 2. Click on the  button to expand the toolbar if necessary\n\n 3. Click on the  button in the toolbar to show or hide the rotation tool\n\n\n\n\n\n To rotate using the mouse \n\n 1. Click and drag the ball around the outside of the rotation tool to the desired value\n\n 2. Click in the middle of the rotation tool (where the rotation value is displayed) and type a value between (-360) to +360 degrees\n\n 3. To reset rotation to 0°, click in the middle of the rotation tool and type 0\n\n\n
\n The rotation tool accepts values with a precision of 0.1.\n
\n\n\n\n\n\n To rotate using the keyboard \n\n 1. Hold the **Alt** key and press the **up arrow** or **down arrow** key to rotate by 1° clockwise or counter-clockwise, respectively\n\n 2. Hold the **Alt** key and press the **PageUp** or **PageDown** key to rotate by 10° clockwise or counter-clockwise, respectively\n\n\n\n\n## Color Management\n\nThe color management tools can be used to apply an ICC color profile within the Viewer. The application of ICC profiles ensures a high degree of color reproducibility across different monitors and can be used to overcome/reduce color variability across multiple devices.\n\n
\n Color Management is available for RGB images and disabled by default; users can choose their preference.\n
\n\n\n\n To change the color management profile \n\n 1. Hover or click on the image to reveal the toolbar at the top left of the panel\n\n 2. Click on the  button to expand the toolbar if necessary\n\n 3. Click on the  button dropdown in the toolbar to reveal the color management dialog\n\n 4. Select one of the available ICC color profiles\n\n\n\n\n## Full Screen Mode\n\nTo enlarge the image viewport, so that it fills your screen, click on the  button in the Viewer top bar. When done, press the **Escape** key on your keyboard to exit full screen mode.\n\n\n## Keyboard Shortcuts\n\nThe following keyboard shortcuts are available when using the keyboard:\n\n| Shortcut | Action |\n| -------- | ------ |\n| A | Draw an arrow annotation |\n| B | Draw a bookmark annotation |\n| C | Draw an ellipse annotation |\n| P | Draw a polygon annotation |\n| F | Draw a freehand annotation |\n| R | Draw a rectangle annotation |\n| U | Draw a ruler annotation |\n| S | Create a snapshot |\n| Alt + ↑ | Rotate clockwise 1° |\n| Alt + ↓ | Rotate counter-clockwise 1° |\n| Alt + PageUp | Rotate clockwise 10° |\n| Alt + PageDown | Rotate counter-clockwise 10° |\n| Ctrl + → | Next Image |\n| Ctrl + ← | Previous Image |\n","slug":"docs/viewer/basic-controls"},{"frontmatter":{"title":"Image Settings","description":"image settings"},"rawBody":"---\ntitle: Image Settings\ndescription: image settings\norder: 21\nsection: Viewer\n---\n\n\n# Image Settings\n\n \n\nThe Image Settings panel can be used to alter the rendering of multi-channel images in the Viewer.\n\n\n## Sub-images\n\nSome image files may contain multiple fields of view spanning a larger scan area (like a collage). These image files are more complex than traditional WSI because a file contains multiple images (a.k.a. sub-images), each of which may have different scanning properties.\n\nWhile the Viewer treats each file as a single image, it allows the user to configure some of the properties of sub-images independently (e.g., focal plane and render settings).\n\nIf an image file contains sub-images that are separated by empty space (i.e., areas that are not scanned), the background color is automatically chosen, often to match the approach in the image vendor's native viewer.\n\nThe Viewer seamlessly handles overlapping sub-images and allows the highest available magnification to be used across all sub-images.\n\n\n\n To adjust the visibility of sub-images \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the  icon to toggle the visibility of any sub-image\n\n 3. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n
\n Sub-images can be distinguished from image channels because all sub-images have the same name as the image file itself.\n
\n\n\n\n\n## Channel Visibility\n\nThe visibility of each channel for non-RGB images or sub-images can be controlled independently. Once these settings are adjusted, they will be saved as preferences for the currently logged-in user.\n\n\n\n To adjust the visibility of an image channel \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the  icon to toggle the visibility of any channel\n\n 3. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n
\n Sub-images can be distinguished from image channels because all sub-images have the same name as the image file itself.\n
\n\n\n\n\n## Channel Color Corrections\n\nThere are a number of color correction options available that can be used to alter how a multi-channel image renders on-screen. The values that are shown by default are obtained from the image file itself, if available. Once these settings are adjusted, they will be saved as preferences for the currently logged-in user.\n\n
\n Color correction cannot be used on interlaced pixel types (e.g., RGB pixel type commonly used for brightfield images).\n
\n\n \n\n
\n The channels for each sub-image can be adjusted independently.\n
\n\n\n### Pseudocolor\n\nThe default color of each channel can be modified to any RGB value.\n\n\n\n To change the pseudocolor of a channel \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the colored square next to the channel name to open the color palette\n\n 3. Select a color in the palette\n\n 4. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n\n\n\n To reset the pseudocolor of a channel to its default value \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the  button next to the channel name\n\n 3. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n\n\n### Histogram Corrections\n\nThough the histogram is not visible, its properties for each image channel can be adjusted using the following parameters:\n\n- White Point, in the range [0.0, 1.0], is the saturation point on the RHS of the histogram\n- Black Point, in the range [0.0, 1.0], is the saturation point on the LHS of the histogram\n- Gamma, in the range [-2.0, 2.0], is the gamma correction factor\n\n\n\n To adjust the histogram \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the channel name to open a panel of sliders\n\n 3. Adjust any of the sliders\n\n 4. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n\n\n\n To reset the histogram to its default value \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the channel name to open a panel of sliders\n\n 3. Click on the  button next to any of the histogram values\n\n 4. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n\n\n#### Auto Scale\n\nThe \"Auto Scale\" feature automatically configures the black and white points of multi-spectral images based on the dynamic range of each channel. This can be used to improve contrast and establish baseline values for the black and white points quickly.\n\n
\n This feature is only available for multi-spectral images.\n
\n\n\n\n To automatically configure black and white points for a single channel \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the channel name to open a panel of sliders\n\n 3. Click on the **Auto Scale** button below the sliders\n\n 4. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n\n\n\n To automatically configure black and white points for all channels \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the **Auto Scale** button at the bottom of the dialog\n\n 3. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n\n\n\n To reset all black and white points to their default values \n\n 1. From within the Viewer, click on the  button at the bottom left of the Viewer to reveal the Image Settings dialog\n\n 2. Click on the **Reset Scale** button at the bottom of the dialog\n\n 3. Close the Image Settings dialog by clicking on the **X** button at the top right corner of the popup dialog\n\n\n","slug":"docs/viewer/image-settings"},{"frontmatter":{"title":"Overlays","description":"overlays"},"rawBody":"---\ntitle: Overlays\ndescription: overlays\norder: 22\nsection: Viewer\n---\n\n\n# Overlays\n\n \n\nThe overlay feature allows one or more images to be attached to an image in the Repository. This feature has been designed for visualizing image analysis results such as segmentation results.\n\nWhen multiple overlays are attached to an image, the z-position of each overlay in the stack is determined by the position of the overlay in the Overlays panel. The last entry in the panel is visually on top of the stack and subsequent entries are positioned higher in the stack. The image that overlays are attached to is positioned visually below all of the overlays.\n\n\n## Attaching Overlays\n\nOverlays are by default positioned at the top left corner of the image they have been attached to, at the base resolution layer. The initial height and width of the overlay will match the overlay's base resolution layer (i.e., pixel scaling of the overlay is not considered). An overlay image can be repositioned using the [Transform](#overlay-transform) properties.\n\n
\n Sub-images may complicate overlay positioning for the following reasons: 1) if the image has multiple sub-images, the overlay’s position is determined relative to the first sub-image, at the base resolution layer; and 2) if the overlay contains multiple sub-images, only the first sub-image is viewable.\n
\n\n\n\n Attach an overlay using drag and drop \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Upload an image from your computer by dragging a [supported image](/docs/repository/supported-formats/#supported-image-formats) file onto the sidebar\n\n\n\n\n\n Attach an overlay using the file selection dialog \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the **+** button at the top of the sidebar to reveal the **Add image overlay** dialog\n\n 3. Click in the blue box to activate the file selection dialog or simply drag an image into the blue box\n\n 4. Click on the **Start upload** button\n\n 5. (Optional) Once the upload is complete, click on the **Edit Metadata** button to edit the metadata or the **Edit** button to change the name\n\n 6. Click on the **X** button at the top right of the popup dialog or anywhere outside of the dialog box to close it\n\n\n\n\n### Deleting Overlays\n\nOverlays can be deleted from the Overlays panel.\n\n\n\n To delete an overlay from the Overlays panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the overlay entry to be modified\n\n 4. Click on the  button\n\n 5. Click on the **OK** button to confirm\n\n\n\n\n## Overlay Properties\n\n### Overlay Name\n\nThe name is a single line text field that supports unicode characters.\n\n\n\n To rename an overlay from the Overlays panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the overlay entry to be modified\n\n 4. Click on the name of the entry\n\n 5. Provide a name or edit the existing text\n\n 6. Press the **Enter** key or click away from the textbox to save your changes\n\n\n\n\n### Overlay Visibility\n\nOverlays are visible on the image by default once attached.\n\n\n\n To change the visibility of individual overlays \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Identify the overlay entry to be modified\n\n 4. Click on the  button to toggle visibility\n\n\n\n\n\n To change the visibility of all overlays \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the  button at the top right corner of the Overlays panel to toggle visibility for all overlays\n\n\n\n\n## Overlay Transform\n\nBy default, overlays are positioned at the origin (top left corner of the image's first sub-image's base resolution layer). If an uploaded overlay is meant to span a different region of interest, an appropriate transform may be defined.\n\n\n\n To reposition an overlay \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the  button next to an entry name in the panel to open the transform controls\n\n 4. Perform one of the following:\n 1. Set the X and Y values to specify the coordinates of the top left corner (with respect to the image) and set the W (width) and H (height) values to specify the extent of the overlay, or\n 2. Click on the  button to scale the overlay so that it fits the image width\n\n\n
\n All values should be provided in pixel coordinates relative to the base resolution level of the image\n
\n\n \n\n
\n Transform is available for manually created overlays but not for overlays that have been imported from image analysis systems.\n
\n\n\n\n\n\n## Overlay Rendering\n\nOverlays have a number of properties that define how they are rendered. These properties are shared for all team members and therefore, changes made by any user will be visible to other users.\n\n\n\n To change the opacity of an overlay \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Adjust the opacity slider in the range of [0, 100] for an entry in the Overlays panel\n\n\n\n\n\n To add pseudocolor to an overlay \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the **+ Add Pseudocolor** button for an entry in the Overlays panel\n\n 3. (Optional) Click on the color block to open the color palette and select a color from the palette\n\n\n\n\n\n To remove pseudocolor from an overlay \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the **x Remove** button next to the color block of an entry in the Overlays panel (only available if a pseudocolor has been previously defined)\n\n\n\n\n\n To change the composite operation for an overlay \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Select a composite mode from the dropdown for an entry in the Overlays panel. See [compositing operations](#compositing-operations) for more details. The default composite operation is “Normal”\n\n\n\n\n### Compositing Operations\n\nVarious compositing techniques are available for rendering overlaid images. These are a number of other modes that may be helpful depending on the types of images and desired effects.\n\n\n\n Overlay composition modes \n\n | Composite mode | Description |\n | ----------------- | ------------- |\n | Normal | Draw this image on top of existing content. |\n | Source In | Draw this image only where it overlaps existing content. Non-overlapping areas are made transparent. |\n | Source Out | Draw this image only where it doesn’t overlap existing content. |\n | Source Atop | Draw this image only where it overlaps existing content. |\n | Destination Over | Draw this image behind existing content. |\n | Destination In | Draw existing content only where it overlaps this image. Non-overlapping areas are made transparent. |\n | Destination Out | Draw existing content only where it does not overlap this image. |\n | Destination Atop | Draw existing content only where it overlaps this image. This image is drawn behind existing content. |\n | Lighter | Add color values of this image with the color values of the existing content. |\n | Copy | Replace the existing content with this image. |\n | XOR | This image and existing content are drawn only where there is no overlap. |\n | Multiply | Multiply the color values of this image with the color values of existing content. |\n | Screen | Color values of this image and the existing content are inverted, multiplied, then inverted again. |\n | Overlay | A combination of multiply and screen. |\n | Hard Light | Like overlay, but with the top and bottom layers swapped. |\n | Soft Light | A softer version of hard light. |\n | Darken | Retain the darkest pixel between this image and the existing content. |\n | Color Dodge | Divide the color values of the existing content by the inverted color values of this image. |\n | Color Burn | Divide the inverted color values of the existing content by the color values of this image, and then invert the result. |\n | Difference | Subtract the color values of this image from the color values of the existing content and compute the absolute value. |\n | Exclusion | Like difference, but with lower contrast. |\n | Hue | Preserve the luma and chroma of the existing content while adopting the hue of this image. |\n | Saturation | Preserve the luma and hue of the existing content while adopting the chroma of this image. |\n | Color | Preserve the luma of the existing content while adopting the hue and chroma of this image. |\n | Luminosity | Preserve the hue and chroma of the existing content while adopting the luma of this image. |\n\n\n","slug":"docs/viewer/overlays"},{"frontmatter":{"title":"Information Panel","description":"information panel"},"rawBody":"---\ntitle: Information Panel\ndescription: information panel\norder: 17\nsection: Viewer\n---\n\n\n# Information Panel\n\n \n\nThe file information panel provides information about the currently open file. In this panel, you can find the slide label (if available) as well as any metadata fields, tags and snapshots associated with the file.\n\n\n\n To toggle the visibility of the Image Information panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Click on the  button in the left sidebar to open the Information panel\n\n\n\n\n## Image (Slide) Label\n\nIf a slide label is available, it will be displayed at the top of the information panel.\n\n
\n Slide label may contain PHI and as such, the label is hidden for users that do not have the “View Protected Health Information” permission flag.\n
\n\n\n\n To view the slide label \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n\n\n\n\n To rotate the slide label \n\n 1. Hover over the label with the mouse\n\n 2. Click on the  button until the desired orientation is achieved\n\n\n\n\n## Editing Image Tags\n\nAll the tags currently associated with the file will be listed in the “Tag” section of the information panel.\n\n\n\n To add a tag \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the field showing the current tags (or **Add a tag...** if none have been added)\n\n 4. (Optional) Type a few letters to filter the list of tags\n\n 5. Select a tag from the dropdown field\n\n 6. (Optional) To create a new tag, click on the **+ New tag** button after typing a new tag name\n\n\n\n\n\n To remove an existing tag \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the **X** button of the relevant tag\n\n\n\n\n## Image Description\n\nA description can be added to an image which will be visible to all users.\n\n\n\n To edit image description \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the current description text (or **Add Description** if nothing has yet been written). This is directly below the tag section\n\n 4. Type a description of the image\n\n 5. Press **Enter** key or click anywhere else in the Viewer when done to save your changes\n\n\n\n\n## Downloading an Image\n\nOnly users with the “Download File” and “Download Image” permission flag are able to download files and images, respectively.\n\n\n\n To download the image being viewed to your computer \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the image name\n\n 4. Click on **Download** in the dropdown menu\n\n 5. If prompted, select a location to save the downloaded file\n\n\n\n\n## Deleting an Image\n\nOnly users with the “Delete File” permission flag are able to delete images.\n\n\n\n To delete the currently open and selected image \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the image name\n\n 4. Click on **Delete** in the dropdown menu\n\n 5. Click on the **OK** button to confirm\n\n\n\n\n## Editing Snapshots\n\nAny [snapshot](/docs/viewer/snapshots/) associated with the current image will be listed in the Snapshots section of the Information panel.\n\n\n\n To navigate to the location of a snapshot in the Viewer \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Select a snapshot by clicking on its thumbnail to reveal more options, then click on the **Open** button. Alternatively, you may double click on the thumbnail\n\n\n\n\n\n To download a snapshot as an image \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Select a snapshot by clicking on its thumbnail to reveal more options, then click on the **Download** button\n\n 5. Adjust preferences\n 1. (Optional) Show/hide image annotations via the show annotations toggle\n 2. (Optional) Enable the show label toggle to reveal a text overlay\n 3. (Optional) Enable the show scale bar toggle to reveal a scale bar\n\n 6. Click on the **Download** menu\n\n 7. Adjust preferences such as\n - **Size**: adjust the width or height to specify the desired size\n - **File type**: select the desired format from the dropdown\n - **White Background**: Enable to use a white background instead of the default black\n\n 8. Click on the **Download** button\n\n 9. If prompted, select a location to save the downloaded file\n\n\n\n\n\n To rename a snapshot \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Select a snapshot by clicking on its thumbnail to reveal more options, then click on the **Rename** button\n\n 5. Edit the name in the popup menu\n\n 6. Click on the **Rename** button\n\n\n\n\n\n To delete a snapshot \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Select a snapshot by clicking on its thumbnail to reveal more options, then click on the **Delete** button\n\n 5. In the popup dialog, click on the **Yes** button to confirm\n\n\n","slug":"docs/viewer/information-panel"},{"frontmatter":{"title":"Overview Tool","description":"overview tool"},"rawBody":"---\ntitle: Overview Tool\ndescription: overview tool\norder: 16\nsection: Viewer\n---\n\n\n# Overview Tool\n\n \n\nThe Image overview provides a thumbnail of the image and contains an embedded indicator for the region of the image currently shown on the Viewer. The overview tool also displays an overlaid heatmap of all the regions viewed by the logged in user at various scale factors.\n\n\n\n To maximize the overview tool \n\n 1. Click on the  **Overview** button on the bottom right corner of the image\n\n\n\n\n\n\n To minimize the overview tool \n\n 1. Click on the  button on the top left corner of the overlay tool\n\n\n\n\n### Current Region\n\nThe current region that is being displayed in the viewport is represented by the green rectangle on the image overview panel. You can also click on the overview to move the viewport to that location.\n\n\n## Heatmap\n\nThe heatmap automatically tracks all the regions viewed by the logged in user. The resolution of the heatmap is limited to the resolution of the thumbnail image used in the overview tool.\n\nThe color retained by the heatmap in a given area is the highest magnification viewed at the location. The colors of the map represent the scale at which different regions have been viewed:\n\n- Blue ≥ 10%\n- Yellow ≥ 20%\n- Purple ≥ 40%\n- Light blue ≥ 60%\n- Green ≥ 80%\n- Red ≥ 98%\n\n\n\n To toggle the visibility of the heatmap \n\n 1. Click on the  button to the top left of the overview tool\n\n\n\n\n\n To reset the heatmap \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar to open the Help panel\n\n 3. Scroll down to the end of the panel and click on **Clear Heatmap**\n\n 4. Click on the **OK** button to confirm selection\n\n\n","slug":"docs/viewer/overview-tool"},{"frontmatter":{"title":"Overview","description":"overview"},"rawBody":"---\ntitle: Overview\ndescription: overview\norder: 14\nsection: Viewer\n---\n\n\n# Overview\n\n \n\nWhen you click on an image in a folder, PathcoreScholar will open the Viewer. The Viewer is optimized for viewing whole slide images and supports a range of [image formats](/docs/repository/supported-formats/#supported-image-formats) from many current and former scanner vendors. The Viewer provides a consistent set of tools and behaviors across all supported images. Generally speaking, the Viewer supports the following data types:\n\n- RGB (e.g., brightfield images)\n- Single channel grayscale\n- Multi-channel grayscale (e.g., multispectral, fluorescence, etc.)\n","slug":"docs/viewer/overview"},{"frontmatter":{"title":"Browse Folder Panel","description":"browse folder panel"},"rawBody":"---\ntitle: Browse Folder Panel\ndescription: browse folder panel\norder: 18\nsection: Viewer\n---\n\n\n# Browse Folder Panel\n\n \n\nThe Browse Folder panel displays the list of images in the same folder as the file currently on display in the Viewer. You can view the images in List view, Icon view or Compact List view. The Browse Folder panel can be accessed by clicking the  button located on the left-hand sidebar of the Viewer.\n\n\n\n To toggle the visibility of the Browse Folder panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Click on the  button in the left sidebar to open the Browse Folder panel\n\n\n\n\n\n To open the current image's folder \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the folder name at the top of the panel\n\n\n\n\n\n To open the current image's folder in a new browser tab \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the  button to the right of the folder name\n\n\n\n\n## List Mode\n\nThe Browse Folder panel can list items using three formats: List, Compact List, and Icon.\n\n\n\n To change the list mode \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the **Display Mode** button at the top right of the item list. This button will appear different depending on the current display mode: List (), Compact List (), or Icon ()\n\n 4. Click on the desired list view mode\n\n 5. (Optional) Toggle the display of image labels in the list by clicking on **Show Labels**\n\n\n\n\n## Sort Order\n\nThe list of items in the Browse Folder panel can be sorted by any metadata field.\n\n\n\n To change the sort order \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Click on the sort order dropdown menu at the top right of the list of files. It shows the currently selected field by which it is sorting (defaults to \"Name\")\n\n 4. (Optional) Click on the arrow immediately to the right of the field name to toggle between sorting in  ascending order or  descending order\n\n\n\n\n## Name Filter\n\nThe list of items can be filtered by name for quicker browsing.\n\n\n\n To filter the list \n\n 1. Click in the search box indicated by the  icon and the text \"Filter by name...\"\n\n 2. Type in the filter you wish to apply to the names. Only the items matching this text will be displayed\n\n\n\n\n## File Read Status\n\nThe file read status indicates if a file has been previously clicked on (i.e., viewed) by the currently logged in user. An unread status is indicated by a boldface font in the Browse Folder panel and the read status is indicated by a plain face font.\n\n\n\n To toggle the read status \n\n 1. Right-click on any entry in the Browse Folder panel to bring up the context menu\n\n 2. Click **Mark as Read** to enable the read status, or\n\n 3. Click **Mark as Unread** to clear the read status\n\n\n\n\n\n To toggle the read status on multiple items \n\n 1. Select one or more items by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 2. Click the **# Selected** dropdown menu which appears at the top left of the list of files\n\n 3. Click **Mark as Read** to enable the read status, or\n\n 4. Click **Mark as Unread** to clear the read status\n\n\n\n\n## File Favorite Status\n\nAny file that has been tagged as _Starred_ by the currently logged-in user is considered a favorite. Items tagged this way are quickly and easily accessible from the Starred Items List, and are indicated by a solid star in the Browse Folder panel.\nSee [Favorite Status](/docs/repository/repository-operations/#favorite-status) for more details.\n\n\n\n To toggle the favorite status \n\n 1. Click on the  button to the left of an item name in the Browse Folder panel to add the _Starred_ tag, or\n\n 2. Click on the  button to the left of an item name in the Browse Folder panel to remove the tag\n\n\n\n\n\n To toggle the favorite status on multiple items \n\n 1. Select one or more items by holding the **Ctrl** key (on Windows) or **Command** key (on macOS) key and clicking on them\n\n 2. Click the **# Selected** dropdown menu which appears at the top left of the list of files\n\n 3. Click **Favorite** to add the _Starred_ tag, or\n\n 4. Click **Unfavorite** to remove the tag\n\n\n","slug":"docs/viewer/browse-folder-panel"},{"frontmatter":{"title":"Snapshots","description":"snapshots"},"rawBody":"---\ntitle: Snapshots\ndescription: snapshots\norder: 20\nsection: Viewer\n---\n\n\n# Snapshots\n\n \n\nSnapshots are designed for tracking and exporting regions of interest from images. The region of interest contained in a snapshot can be decorated with annotations, a label, and a scale bar prior to being exported as a PNG, JPEG, TIFF, or PDF file. These capabilities make it convenient to use snapshots, instead of image editing software, to prepare ROIs for publications or reports.\n\n
\n Though snapshots are similar to rectangular annotations, they are distinct from geometric annotations, have different properties and are typically used for exporting annotated regions for reports.\n
\n\n\n## Creating Snapshots\n\nUse the snapshot tool to define a rectangular region of interest. The bounding box of a snapshot is recorded as metadata, making it visible from the [Information Panel](/docs/viewer/information-panel/) and from the Metadata tab in the [Folder Listing](/docs/repository/folder-listing/).\n\n\n\n To create a snapshot \n\n 1. From within the Viewer, right-click on an image to open up the annotation ring\n\n 2. Select the  tool\n\n 3. Hold and drag the frame to capture a region of interest\n\n 4. (Optional) In the popup dialog, click on the first line of text (default: “Untitled Snapshot”) and provide a name for the snapshot\n\n 5. (Optional) In the popup dialog, click on the second line of text (default: “No description”) and provide a description for the snapshot\n\n\n
\n The bounding box of a snapshot cannot be edited after it has been drawn.\n
\n\n\n\n\n\n To navigate to an existing snapshot \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Select a snapshot by clicking on its thumbnail to reveal more options, then click the **Open** button. Alternatively, you may double click on the thumbnail\n\n\n\n\n## Downloading Snapshots\n\nThe contents of a snapshot can be exported as a common image format (PNG, JPEG, TIFF, or PDF) for use in presentations or other documents. There are multiple locations where existing snapshots can be found and downloaded.\n\n\n\n To download a snapshot from within the Viewer \n\n 1. From within the Viewer, locate the snapshot on the image\n\n 2. Click on the snapshot title to reveal a dialog\n\n 3. Click on the **Download** button in the popup dialog\n\n 4. Adjust preferences\n 1. (Optional) Show/hide image annotations via the show annotations toggle\n 2. (Optional) Enable the show label toggle to reveal a text overlay\n 3. (Optional) Enable the show scale bar toggle to reveal a scale bar\n\n 5. Click on the **Download** menu\n\n 6. Adjust preferences such as\n - **Size**: adjust the width or height to specify the desired size\n - **File type**: select the desired format from the dropdown\n - **White Background**: Enable to use a white background instead of the default black\n\n 7. Click on the **Download** button\n\n 8. If prompted, select a location to save the downloaded file\n\n\n\n\n\n To download a snapshot from the Information panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Select a snapshot by clicking on its thumbnail to reveal more options\n\n 5. Click on the **Download** button\n\n 6. Adjust preferences\n 1. (Optional) Show/hide image annotations via the show annotations toggle\n 2. (Optional) Enable the show label toggle to reveal a text overlay\n 3. (Optional) Enable the show scale bar toggle to reveal a scale bar\n\n 7. Click on the **Download** menu\n\n 8. Adjust preferences such as\n - **Size**: adjust the width or height to specify the desired size\n - **File type**: select the desired format from the dropdown\n - **White Background**: Enable to use a white background instead of the default black\n\n 9. Click on the **Download** button\n\n 10. If prompted, select a location to save the downloaded file\n\n\n\n\n## Snapshot Markup\n\nWhen downloading a snapshot, certain markup tools can be used to annotate the region of interest prior to download. The markup settings are not saved and must be configured each time the snapshot download dialog is activated.\n\n\n\n To include image annotations on a downloaded snapshot \n\n 1. Enable the **Show annotations** toggle in the snapshot download dialog (all annotations visible on the image will be included)\n\n 2. To hide some annotations, ensure they are hidden prior to launching the download dialog\n\n\n\n\n\n To include a label on a downloaded snapshot \n\n 1. Enable the **Show label** toggle in the snapshot download dialog\n\n 2. (Optional) Adjust the label text in the field below the toggle (default text will be the image name)\n\n 3. (Optional) Adjust the location of the label by clicking one of the four corners in the control to the left of **Alignment**\n\n 4. (Optional) Adjust the text color by clicking in the colored box to the left of **Foreground**, then selecting a color\n\n 5. (Optional) Adjust the text background color by clicking in the colored box to the left of **Background**, then selecting a color\n\n\n\n\n\n To include a scale bar on a downloaded snapshot \n\n 1. Enable the **Show scale bar** toggle in the snapshot download dialog\n\n 2. (Optional) Adjust the location of the scale bar by clicking one of the four corners in the control to the left of **Alignment**\n\n 3. (Optional) Adjust the text and scale bar color by clicking in the colored box to the left of **Foreground**, then selecting a color\n\n 4. (Optional) Adjust the **Show measurement text** toggle to show or hide the measurement\n\n 5. (Optional) Adjust the **Show border** toggle to show or hide a border around the text and scale bar\n\n 6. (Optional) Adjust the **Automatic length** toggle to determine the size of the scale bar\n - When enabled the size is determined automatically\n - When disabled the user can specify the size of the scale bar and select a unit of measurement from the dropdown\n\n 7. (Optional) Select the location of the measurement text relative to the scale bar from the **Text Alignment** dropdown (auto, left, center, or right)\n\n\n\n\n## Snapshot Properties\n\n### Snapshot Name\n\nThe name is a single line text field that supports unicode characters. The name can be changed from within the Viewer or from the Information panel.\n\n\n\n To rename a snapshot from within the Viewer \n\n 1. From within the Viewer, locate the snapshot on the image\n\n 2. Click on the snapshot title to reveal a dialog\n\n 3. Click on the first line of text in the popup dialog (default: “Untitled Snapshot”)\n\n 4. Provide a name or edit the existing text\n\n 5. Press the **Enter** key or click away from the textbox to save your changes\n\n\n\n\n\n To rename a snapshot from the Information panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Select a snapshot by clicking on its thumbnail to reveal more options\n\n 5. Click on the **Rename** button\n\n 6. Provide a name or edit the existing text in the popup dialog\n\n 7. Click on the **Rename** button or press the **Enter** key to save your changes\n\n\n\n\n### Snapshot Description\n\nThe description is a multiline text field that supports unicode characters. The description can be changed from within the Viewer. Enter new lines by pressing **Shift + Enter**.\n\n\n\n To change the description of a snapshot from within the Viewer \n\n 1. From within the Viewer, locate the snapshot on the image\n\n 2. Click on the snapshot title to reveal a dialog\n\n 3. Click on the second line of text in the popup dialog (default: “No description”)\n\n 4. Provide a description or edit the existing text\n\n 5. Press the **Enter** key or click away from the textbox to save your changes\n\n\n\n\n### Snapshot Visibility\n\nSnapshots are visible on the image by default once created. If you need to declutter the image, you may hide all snapshots at once.\n\n\n\n To change the visibility of all snapshots \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Click on the  button, adjacent to the **Snapshots** title, to toggle visibility for all snapshots\n\n\n\n\n## Deleting Snapshots\n\nSnapshots can be deleted from within the Viewer or from the Information panel.\n\n\n\n To delete a snapshot from within the Viewer \n\n 1. From within the Viewer, locate the snapshot on the image\n\n 2. Click on the snapshot title to reveal a dialog\n\n 3. Click on the **Download** button in the popup dialog\n\n 4. Click on the **OK** button to confirm\n\n\n\n\n\n To delete a snapshot from the Information panel \n\n 1. If the left sidebar is not displayed, toggle it by clicking on the **Menu >** button at the bottom left of the Viewer\n\n 2. Hover or click on the  button in the left sidebar\n\n 3. Scroll down to the **Snapshots** section\n\n 4. Select a snapshot by clicking on its thumbnail to reveal more options\n\n 4. Click on the **Delete** button\n\n 5. Click on the **Yes** button to confirm\n\n\n","slug":"docs/viewer/snapshots"}]},"site":{"siteMetadata":{"showSearch":true,"showVersions":true}}}}