Skip to content

Upgrading

Jump to bottom
Glutanimate edited this page Nov 7, 2016 · 16 revisions

Upgrading From an Earlier IO Enhanced Release

Overview of Important Changes

Note Editing

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.

Occlusion Modes

  • 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.

Image Changing Button

You can now switch to a different image right from the IO Editor dialog. 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

Updating Old Notes

You can continue using and reviewing older IO notes in your collection as before, but if you want to use the new editing feature on them you will 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 you losing your notes or modifying them destructively. Please create a backup of your note collection before proceeding.

Changing The Note Type

Your older IO notes will be using either of the following note types: "Image Q/A 2.0" 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 use Anki's inbuild Change Note Type feature:

  1. Head to the card browser

  2. Select the notes you want to upgrade

  3. Go to Tools → Change Note Type

  4. Set the following options in the dialog that appears next:

    • New note type: Image Occlusion Enhanced
    • Change card to: IO Card

  5. If the notes you've selected are "Image Q/A 2.0 Enhanced" notes, use the following field assignment settings:

    • Question: Question Mask
    • Answer: Answer Mask
    • SVG: Original Mask
    • Original Image: Image
    • Header: Header
    • Footer: Footer
    • Remarks: Remarks
    • Sources: Sources
    • TempField3: Nothing (or one of the Extra fields, if you've used this in the past)
    • TempField4: Nothing (or one of the Extra fields, if you've used this in the past)
    • TempField5: Nothing (or one of the Extra fields, if you've used this in the past)

  6. If the notes you've selected are "Image Q/A 2.0" notes, use the following field assignment settings, instead:

    • Question: Question Mask
    • Answer: Answer Mask
    • SVG: Original Mask
    • Original Image: Image
    • Header: Header
    • Footer: Footer

  7. Double-check if everything is set up correctly

  8. Click OK

  9. Make sure to check if you're 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, so if you've modified anything in the meantime, undoing the note type change won't work anymore.

Make Your Notes Editable

Changing your notes to the note type alone is not enough to make them editable. The editing feature needs a number of fields set up correctly to work properly. The add-on offers an experimental feature to do this, but please read the following carefully before proceeding:

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:

  1. Select the notes you've just converted
  2. Go to Tools → Convert to Editable IO Enhanced Notes
  3. Read the description carefully again, then click "Yes"

Your notes should now be editable. You can confirm this by clicking on the IO button in the browser view.

Image Occlusion Enhanced Wiki

Clone this wiki locally