Upgrading
Image Occlusion Enhanced uses a different folder structure now. As a result, previous versions of Image Occlusion, including earlier releases of IO Enhanced, will have to be removed before installing version 1.0.0.
To remove an earlier release, go to Tools → Add-ons → Image Occlusion 2 and click Delete.... Restart Anki and then proceed with the general installation instructions for the add-on.
You can now edit existing IO notes. Please make sure to familiarize yourself with the [Wiki section on Editing](Basic use#editing-cards) before using this feature.
IO notes that were created with earlier versions of Image Occlusion will first have to be upgraded to the new note type before using the Editing feature. This is explained in more detail below.
Important: When editing a single IO note you're also editing all the others that were created at the same time. Changes to individual notes (e.g. custom remarks) will get overwritten if you edit one of the sibling notes in a set. See here for more information: [Adding Information About a Specific Label](Advanced Use#adding-information-about-a-specific-label).
- The nonoverlapping occlusion type is now called Hide All, Reveal One
- The overlapping occlusion type is now called Hide One, Reveal All
- A new occlusion type called Hide All, Reveal All is now available. Functionally this one sits between the other two in that it hides all masks on the front, but also reveals all of them on the back.
You can now switch to a different image right from the IO Editor. This won't clear any of your existing masks or field data, and is mostly meant as a quick way of switching to a different version of the same base image.
For a full list of all changes please make sure to check out the changelogs posted in the Releases section
You can continue reviewing older IO notes in your collection as before, but in order to edit them you will first have to migrate them to the new note type. Here are the step-by-step instructions you will have to follow:
WARNING: Please read the following steps carefully. Choosing the wrong options might lead to data loss. Try to familiarize yourself with the instructions by first trying them out on a smaller batch of notes. Only then proceed with larger collections. Please always create a backup of your note collection before converting notes.
You can refer to the following tutorial video for a general overview of the topics covered in this Wiki section:
Please understand that some of the points in the video might be out of date. You will always find the most recent information in this Wiki.
Your older IO notes will either be using the original Image Q/A 2.0 note type or Image Q/A 2.0 Enhanced. In order to prepare them for the next step you will first have to switch them over to the new Image Occlusion Enhanced note type. For this we will be using Anki's inbuilt Change Note Type dialog:
-
Head to the card browser
-
To get an overview of all your existing IO notes you can click on the corresponding note type entries in the sidebar on the left (above the tag section).
-
Select the IO notes you want to update (using Shift-/or Ctrl-click)
-
Go to Tools → Change Note Type
-
Set the following options in the dialog that appears next:
- New note type: Image Occlusion Enhanced
- Change card to: IO Card
-
Choose the right field assignment settings depending on the note type of the selected notes:
Image Q/A 2.0 Enhanced
- Question → Question Mask
- Answer → Answer Mask
- SVG → Original Mask
- Original Image → Image
- Header → Header
- Footer → Footer
- Remarks → Remarks
- Sources → Sources
- TempField3 → Nothing
- TempField4 → Nothing
- TempField5 → Nothing
Image Q/A 2.0
- Question → Question Mask
- Answer → Answer Mask
- SVG → Original Mask
- Original Image → Image
- Header → Header
- Footer → Footer
-
Double-check if you've set everything up properly
-
Click OK
Make sure to check if your notes have been converted correctly. If not, you might be able to undo your changes by going to Edit → Undo. This will only work for the last action in the browser. If you've modified anything in the meantime, undoing the note type change won't work anymore.
Changing your notes to the new note type alone is not enough to make them editable. The editing feature needs a few fields set up in a very specific way to work properly. Image Occlusion Enhanced comes with a note converter that can do this automatically. However, this is an experimental feature and the following caveat applies:
Important: There is no guarantee that this feature will actually succeed in updating your notes properly. To convert legacy notes the add-on will have to make a few assumptions which in some rare instances might turn out to be wrong and lead to broken notes. Notes that can't be parsed for the information needed to convert into an editable state (e.g. a valid Original Mask field) will usually be skipped by the add-on, but there might be some corner cases where that won't work
A checkpoint will be set to revert to if needed, but even with that safety measure in place you should still only use this function if you know what you are doing.
Still want to proceed? Here is how you can invoke the note converter:
- Select the notes you've just converted
- Go to Tools → Convert to Editable IO Enhanced Notes
- Read the description carefully, then click "Yes"
The note converter will now process all selected notes. This can take a while depending on the number of notes selected. A tooltip will notify you when the conversion is done.
Notes that have been successfully converted will be tagged with .io-converted, so that you can tell them apart from unconverted notes. Feel free to remove this tag as soon as you don't need it anymore.
The note converter will sometimes skip specific notes. This can occur for a variety of reasons:
- Wrong note type: Only notes with the Image Occlusion Enhanced note type will be converted
- Notes that have been processed before
- Notes that can't be parsed: Some of your notes might have been modified in a way that makes them unparsable for the note converter. This usually happens if you modify or delete the contents of one of the Masks fields