Skip to content

Main MouseoverPopup service that ContentProviders can register with to display a small popup window when a user hovers over urls in SuperMemo.

Notifications You must be signed in to change notification settings

bjsi/SuperMemoAssistant.Plugins.MouseoverPopup

Repository files navigation

Mouseover Popup Plugin for SuperMemoAssistant

Features

  • Quickly preview the content of urls for different sites by hovering over links in SuperMemo.
  • Publishes itself as a SuperMemoAssistant Service to integrate with content provider plugins such as Mouseover Wiki
  • Easily extend Mouseover Popup's capabilities by creating a new content provider.

Installation

Note: Requires installation of content provider plugins (eg. Mouseover Wiki) in order to display content.

Manual Installation

Pre-built binaries
Guide

(WIP. Not currently available)

  1. Check the releases tab on this GitHub repository.
  2. Download the latest available version.
  3. Navigate to the development plugin folder (C:\Users\<YOUR USERNAME>\SuperMemoAssistant\Plugins\Development) and extract the zip folder into the directory.

Note: If you are upgrading from an older version, you should delete the older version first.

Building from source
Prerequisites
  • Install Visual Studio 2019 or higher.
  • Select the following VS components during the install:
    • .NET desktop development
    • .NET Core cross-platform development
Guide
  1. Clone the project using git.

git clone https://github.com/bjsi/SuperMemoAssistant.Plugins.MouseoverPopup

  1. Open the cloned project folder.

  2. Double click on the solution (MouseoverPopup.sln) to open the project in Visual Studio 2019.

  3. Right click on the solution file in the Solution Explorer:

Image of Solution Explorer

  1. Select Build Solution:

Image of Build Solution Option

  1. Check that the build succeeded by confirming that the following folder exists and is not empty:

C:\Users\<YOUR USERNAME>\SuperMemoAssistant\Plugins\Development

  1. Close Visual Studio and run SuperMemoAssistant.

Manual

Usage

Configuration

Settings

You can access the settings of any SuperMemoAssistant plugin by pressing Ctrl+Alt+Shift+O and clicking the gear icon.

Contributing Guide

Issues and Suggestions

See the contribution guide for information on how to report issues or make suggestions.

Code Contributions

Pull requests are welcome!

  1. Firstly, go through the manual installation guide above.
  2. You will also require Git Hooks for VS which is used to enforce a consistent code style.

Note: you do not need to build the entire SuperMemoAssistant project to make changes to or debug a plugin.

  1. See the code section of the contribution guide for pull request instructions.
  2. If you need help, don't hesitate to get in touch with me (Jamesb) on the SMA discord channel.

About

Main MouseoverPopup service that ContentProviders can register with to display a small popup window when a user hovers over urls in SuperMemo.

Resources

Stars

Watchers

Forks

Packages

No packages published