SMA documentation (Open Beta)

[alexis-]

• Documentation
  • Landing page
    • /!!\ Install a backup solution !!
    • Supported version
  • Quick start
    • Installation
      • Pre-requisites
        • Supported version (link)
        • Pre-requisite: Installing 7-zip
        • Pre-requisite: Installing vcredist 2012 / 2015-2019 x86
        • Pre-requisite: Installing .NET 4.7.2 (should be installed by default on Windows 10)
      • DL & Install & Setup
        • Are there risks ?
        • /!!\ Install a backup solution !!
        • Extracting SMA in C:\Users\<your-user>\AppData\Roaming\SuperMemoAssistant. Type %AppData% in Windows Explorer path for easier access
        • If you can't view it, go to the following link and ensure you can view hidden folders.
        • Creating a shortcut to SMA
    • Recommended backup setup
      • BitShelter
      • Creating a partition for SM collection
      • Git/Git-crypt
    • Using SMA
      • Starting SMA. Make sure SuperMemo isn't running
      • Configuring sm17/sm18 executable path (in Options)
      • Adding your collection
      • Settings
  • Reference manual
    • SMA
      • Command line parameters
        • Open collection
        • Key logger
      • Collection window options
        • path
        • trust hint
      • Settings (Ctrl+Alt+Shift+O or right-click on the robot tray icon)
        • Plugins
          • Start/Stop
          • Settings (click on gear icon)
            • Per-plugin settings
            • Per-plugin configurable hotkeys
        • General (setting max number of children, explain the connection with SuperMemo's options)
      • The files (for user doc) (rest for dev?)
        • config files (.json)
          • per module
          • shared
          • collection
        • Log config (log level, first chance exception, ... ?)
        • Plugins
          • How do they work ? (own process, etc.)
          • Developer
          • Packages (nuGet)
      • History of SMA
    • Plugins
      • PDF
        • Importing PDFs
        • SM Extracts
          • Simple extract
          • Multi-selection
          • Force image selection (right click)
        • Sub-PDF Extracts
          • Bookmark extracts
          • Page range extracts
        • Dictionary
          • Using the dictionary
          • Settings
        • MathPix
          • Registering a developer account
          • Using your credentials in the PDF plugin
          • Using the OCR (alt+mouse drag)
          • Note that it integrates with multi-selection
          • Note that force image selection can be useful for embedded formulas
        • Per-PDF settings
        • File mgmt (cleaning up your collection)
        • HotKeys
          • Extract PDF (Ctrl+Shift+X)
          • Extract SM (Alt+X)
          • MarkIgnore (Ctrl+Shift+I)
          • ShowDictionary (Ctrl+D)
          • GoToPage (Ctrl+G)
          • SMLearn (Ctrl+L)
          • LearnAndReschedule (Ctrl+Shift+L)
          • SMReschedule (Ctrl+J)
          • SMLaterToday (Ctrl+Shift+J)
          • SMDone (Ctrl+Shift+Enter)
          • SMDelete (Ctrl+Shift+Del)
          • SMPrevious (Alt+Left)
          • SMNext (Alt+Right)
          • SMParent (Ctrl+Alt+Up)
          • SMChild (Ctrl+Alt+Down)
          • SMPrevSibling (Ctrl+Alt+Left)
          • SMNextSibling (Ctrl+Alt+Right)
          • UIShowOptions (Ctrl+O)
          • UIToggleBookmarks (Ctrl+B)
          • UIFocusViewer (Alt+C)
          • UIFocusBookmarks (Alt+B)
        • Non-hotkeys
          • OCR (Alt+Click)
          • Image area selection (Hold left click)
          • Force image area selection (Hold right click)
          • Zoom (Ctrl+Wheel)
          • Extend text selection (Shift+Click, Shift+Left/Right)
          • Deselect (Escape)
          • PDF navigation (Up/Down/Left/Right/Pg. Down/Pg. Up/Home/End)
          • Select word (Double click)
          • Select paragraph (Triple click)
          • Select page text (Quadra click)
          • Select page (double click on empty space in page)
          • Extend page selection (Shift+Click page)
          • Add to selection (Hold ctrl)
          • Select image (Click image)
        • FAQ
          • When I click the whole page is selected as an image

            Your pdf is made of images, either use an OCR and remove the images, or use force image area selection

          • My PDF won't load and there is an error in the logs

            Create an issue ticket on github and upload your logs and PDF file

          • How to I jump to a specific page number ?

            Ctrl+G

      • LaTeX
        • Setup
          • Installing MiKTeX
          • Adding the bin folder to the PATH environment variable (also require restarting the plugin)
          • MiKTeX options: allowing packages to be downloaded on the fly (https://media.discordapp.net/attachments/419205993164046340/649464954730315776/unknown.png)
          • MiKTeX options: "Directories" should be configured like so (https://media.discordapp.net/attachments/419205993164046340/649652803509288960/unknown.png)
        • Using LaTeX. Same convention as Anki:
          • [$] = inline TeX formula
          • [$$] = \begin{math}
          • [latex] = full LaTeX document
          • LaTeX -> Image
          • Image -> LaTeX
        • Advanced config (.json)
      • Import
        • Browser Import (Ctrl+Shift+Alt+A)
          • Adding extensions
            • Chrome (should also work with spin-offs, like Brave)
            • Firefox
          • Importing tabs from SuperMemo
          • Importing tabs from the Browser (right-click the robot icon)
        • Url Import (Ctrl+Shift+Alt+B)
        • Importing feeds
          • How to add feeds (RSS/Atom)
          • Feeds will be downloaded every time you start SMA (show popup)
          • Feeds can be downloaded manually (button in the settings)
        • Website configuration
          • What is it for ? (allows you to customize how specific websites are imported in your SM)
          • Configuring the website urls
          • Setting the location in your Knowledge tree
          • Setting the priority
          • Filtering the content (e.g. remove the navigation bars, advertising, etc.)
          • How to add title to references
          • How to add date to references
          • Using cookies (e.g. for website requiring a subscription)
          • Misc (no need to go in detail)
            • Changing your user agent
            • Render svg
            • Inline images
            • Appending a parameter to the url (link parameter)
            • Execute javascript: not finished yet
      • Dictionary
        • Also works in SuperMemo (select word in html component, press Ctrl+Alt+Shift+D)
        • Settings
          • Default dictionary language
          • Choosing the location in your KT
          • Changing the presentation of word definitions extracts (Mustache template)

[alexis-]

Temporary notes:

- Supported versions
- Are there risks ?
- command line parameters
	- Open collection
	- Key logger
- Collection window options
	- path
	- trust hint
- How does it work ?
	- The files (for user doc) (rest for dev?)
	- config files (.json)
		- per module
		- shared
		- collection
		- Log config (log level, first chance exception, ... ?)
	- Plugins
		- Developer
		- Packages (nuGet)
	- If you're interested in nerdy details, go to dev doc
	- History of SMA
- Plugins
	- How they work ? (own process, etc.)
	- LaTeX
		- Advanced config (.json)
	- PDF
		- HotKeys
			- Extract PDF (Ctrl+Shift+X)
			- Extract SM (Alt+X)
			- MarkIgnore (Ctrl+Shift+I)
			- ShowDictionary (Ctrl+D)
			- GoToPage (Ctrl+G)
			- SMLearn (Ctrl+L)
			- LearnAndReschedule (Ctrl+Shift+L)
			- SMReschedule (Ctrl+J)
			- SMLaterToday (Ctrl+Shift+J)
			- SMDone (Ctrl+Shift+Enter)
			- SMDelete (Ctrl+Shift+Del)
			- SMPrevious (Alt+Left)
			- SMNext (Alt+Right)
			- SMParent (Ctrl+Alt+Up)
			- SMChild (Ctrl+Alt+Down)
			- SMPrevSibling (Ctrl+Alt+Left)
			- SMNextSibling (Ctrl+Alt+Right)
			- UIShowOptions (Ctrl+O)
			- UIToggleBookmarks (Ctrl+B)
			- UIFocusViewer (Alt+C)
			- UIFocusBookmarks (Alt+B)
		- Non-hotkeys
			- OCR (Alt+Click)
			- Image area selection (Hold left click)
			- Force image area selection (Hold right click)
			- Zoom (Ctrl+Wheel)
			- Extend text selection (Shift+Click, Shift+Left/Right)
			- Deselect (Escape)
			- PDF navigation (Up/Down/Left/Right/Pg. Down/Pg. Up/Home/End)
			- Select word (Double click)
			- Select paragraph (Triple click)
			- Select page text (Quadra click)
			- Select page (double click on empty space in page)
			- Extend page selection (Shift+Click page)
			- Add to selection (Hold ctrl)
			- Select image (Click image)
		- FAQ
			- When I click the whole page is selected as an image
				> Your pdf is made of images, either use an OCR and remove the images, or use force image area selection
			- My PDF won't load and there is an error in the logs
				> Create an [issue ticket on github](https://github.com/supermemo/SuperMemoAssistant.Plugins.PDF/issues) and upload your PDF
- Bug reporting
- Settings
	- Plugins
	- Layout

	
	
- Dev doc
	- Copy from user doc
	- Different projects / Project layout
	- Plugins
		- PluginHost (doesn't load Interop)
		- ISMAPluginManager
		- ISuperMemoAssistant
		- ISMAPlugin
		- SMAPluginBase
		- Dictionary
			- Implementing dictionary in your plugin (Interop)
			- Implementing a new dictionary API (Interop)
		- Import
			- Implementing web imports in your plugin (Interop)
			- How does it work ?
				- Browser plugins
				- Native host exe
				- Import plugin <> IPC <> Native host
	- Interaction with SuperMemo
		- Calls
			- native calls (delphi, inject lib, message pump)
			- NativeData.json
			- SMNatives
			- How to update offsets ?
		- Registries
			- Hooks
			- Sparse clustered array
			- Versioning (RegistryUpdater, SuperMemo17 folder, ..)
			- Explain the different parts (content, components, controls, registries, element, UI, ...)
		- Rationale behind "UI"
		- SMHookEngine
	- Interop
		- Resources (SM icons)
		- Extensions
		- Utilities (\Sys)
	- Services
		- Keyboard hooks
		- Configuration svc
		- [Pkg] Settings UI
		- [Pkg] HTML
		- [Pkg] Media.Images
- mshtml nuget