Updates Page

modcore EM: Updates Page Documentation

Warning

The updates page was discontinued in version 2.3.81.

This document provides comprehensive information regarding the "Updates" functionality within the modcore Extension Manager (short name: modcore EM). It details how to check for new versions, understand status indicators, manage notifications, and configure update settings.

1. Accessing the Updates Page

To access the "Updates" page and manage your extension's version status:

1. Open the modcore Extension Manager Popup: Click on the modcore EM icon in your Chrome toolbar.
2. Navigate to the Updates Page: In the top right corner of the popup, locate the header icons. Click on the icon with a retry arrow, labeled "Check for Updates". This will open the dedicated "Updates" page in a new tab.

2. Overview of the Updates Page Interface

The "Updates" page features a streamlined, panel-based interface accessible via a sidebar navigation. Upon opening the page, you will be directed to the "Updates" panel by default, which serves as the central hub for managing your extension's version status.

The interface is structured with the following key areas:

• Sidebar Navigation: Located on the left, this allows you to switch between the "Updates", "Notifications", and "Settings" panels.
• Main Content Area: This dynamically displays the selected panel's content, which in this case is the "Updates" panel.

3. Checking for Updates

The "Updates" panel provides real-time information about your extension's version status.

3.1 Update Check Triggering

Update checks are performed when the user visits or remains on the "Updates" page. There are no automated checks initiated in the background when the page is not active.

3.2 Manual Refresh

To manually initiate an update check:

1. Open the modcore Extension Manager: Click on the extension's icon in your Chrome toolbar.
2. Navigate to the Updates Panel: Ensure the "Updates" button in the sidebar is active.
3. Click the Refresh Button: Locate and click the refresh icon (a retry arrow) in the "Status Primary" section.
   • This action forces a new data fetch from the source, clearing any existing cached ETags to ensure the absolute latest information is retrieved.
   • A toast notification "Refreshed from source." will appear upon successful completion.

3.3 Status Indicators and Messages

The "Updates" panel prominently displays a status indicator. This indicator provides immediate feedback on the update status:

• Initializing...: The extension is starting up and preparing to check for updates.
• Checking for updates... / Refreshing data...: The extension is actively looking for new versions and notifications. A spinner icon will be visible next to the status message.
• Up to date (vX.X.X): Your extension is currently running the latest available version. The status icon will be a green checkmark.
• Update available: vX.X.X: A newer version of the extension is available for download. The status icon will be a warning icon (e.g., yellow triangle).
• Offline Mode Enabled: Update checks are currently disabled due to user settings. The status icon will be an offline icon.
• Error: An error occurred during the update check (e.g., network issue, API rate limit). An error icon (e.g., red 'X') will be displayed. Detailed error messages will appear in a dedicated "API Error Message" area below the status.

3.4 Last Checked Time

Below the main status indicator, you will find the "Last checked" timestamp. This shows when the extension last successfully performed an update check.

4. Version Details

The "Version Details" section within the "Updates" panel provides specific information about the installed and latest available versions of modcore EM.

• Installed Version: Displays the version number of the modcore EM currently installed in your browser.
• Latest Available Version: Shows the version number of the newest release found on GitHub. This field will update when a new version is detected.
• Latest Release Date: Indicates the publication date of the latest available version.
• Prerelease: Specifies whether the latest available version is a prerelease (e.g., beta, release candidate).

Each version detail (Installed Version, Latest Available Version) includes a Copy button. Clicking this button will copy the corresponding version number to your clipboard, and a "Copied!" toast notification will confirm the action.

5. Downloading Updates

When an update is available, the "Updates" panel will present a "Download Latest" button.

• Download Latest Button: Clicking this button will initiate the download of the latest available version of modcore EM. A toast notification "Download started..." will appear, or it will inform you if the download link is unavailable.

  • Note: If the chrome.downloads API is not available, the extension will attempt to open the download link in a new tab.

• View All Releases Link: This link will direct you to the official modcore Extension Manager Releases page on GitHub. This allows you to browse all past and current releases directly on GitHub.

6. "You are offline" Message / API Errors

If modcore EM displays an "You are offline" message or other API error:

• Verify Internet Connectivity: Ensure your device has an active and stable internet connection. Test by visiting other websites.
• Network Status Changes: The extension is designed to respond to network status changes. If you go offline, it will display a warning, and if you come back online, it will attempt to re-check for updates.
• API Rate Limit Exceeded: If you see an error indicating "API Rate Limit Exceeded" (Error 403), it means the GitHub API usage limit has been reached. Please wait and try again later.
• Configuration Errors: If you encounter errors like "Source Not Found" (Error 404) or "Configuration Error", this indicates an issue with the extension's internal configuration (e.g., incorrect GitHub repository URL). Such issues should be reported to the developers.
• Troubleshooting: If the issue persists, consider restarting your Chrome browser or checking your firewall/antivirus software to ensure they are not blocking the extension's network access.

7. Settings

The "Settings" panel (accessible via the sidebar navigation on the Updates page) includes options that allow you to customize the behavior of modcore EM.

• Disable Update Checks (Offline Mode):

  • Functionality: This setting allows you to prevent the extension from connecting to external update servers.
  • Impact: When enabled, the extension will enter "Offline Mode," and the update check feature will be deactivated. This also stops any potential data collection via GitHub update checks. The status indicator on the "Updates" panel will reflect "Offline Mode Enabled".
  • Note: This setting does NOT disable the "Settings" button, allowing you to re-enable update checks at any time.

• Disable All Notifications:

  • Functionality: This setting hides all notifications and the notification bell button within the extension.
  • Impact: When enabled, no new notifications will be displayed, and the "Notifications" panel will be empty.

• Show All Notifications (Including Read):

  • Functionality: This setting alters the display in the "Notifications" panel.
  • Impact: When enabled, all fetched notifications will be displayed in the list, regardless of whether they have been previously marked as read. Read notifications will be visually dimmed. The "Clear Read Notifications" button will be disabled when this setting is active.

• Toast Notification Duration:

  • Functionality: This setting allows you to choose how long temporary messages (toasts) are displayed at the bottom right of the screen.
  • Options: You can select durations of 3, 5 (Default), 8, or 10 seconds.

• Adjust Font Size:

  • Functionality: This setting allows you to adjust the base font size of the extension's interface for better readability.
  • Options: You can choose between 'Small', 'Medium' (Default), and 'Large' font sizes.