14.2. How to “manually” install, uninstall or upgrade an add-on

Add-ons are found in the two following addon/ directories:

  1. Bundled add-ons (such as "XMLmind Spell Checker" and "DITA configuration") are found in XXE_install_dir/addon/ (or any of its subdirectories).

  2. Optional add-ons (such as "Hunspell Spell Checker" and "TEI Lite configuration") are found in XXE_user_preferences_dir/addon/ (or any of its subdirectories), where XXE user preferences directory is:

    • $HOME/.xxe10/ on Linux,

    • $HOME/Library/Application Support/XMLmind/XMLEditor10/ on the Mac,

    • %APPDATA%\XMLmind\XMLEditor10\ on Windows. Example: C:\Users\john\AppData\Roaming\XMLmind\XMLEditor10\.

      If you cannot see the "AppData" directory using Microsoft Windows File Manager, turn on ToolsFolderOptionsViewFile and FoldersShow hidden files and folders.

When “manually” installing an add-on, you may choose either of the two above addon/ directories. However, it is recommended to use XXE_user_preferences_dir/addon/ because this way, your add-ons will be automatically upgraded the next time you'll upgrade XXE.

Procedure 9.8. “Manually” install an add-on
  1. Visit this "Add-ons" page using your web browser to download the add-on distribution.

  2. Unzip the add-on distribution in either XXE_user_preferences_dir/addon/ (recommended) or XXE_install_dir/addon/.

    For example, unzipping bidi_support-N_N_N.zip in XXE_user_preferences_dir/addon/ creates subdirectory XXE_user_preferences_dir/addon/bidi_support/.

  3. Clear the Quick Start cache.

    [Note]How to clear the Quick Start cache?

    The simplest and quickest is to delete “by hand” directory XXE_user_preferences_dir/cache/ (if it exists).

    Alternatively, this can be done from within XXE by selecting OptionsPreferences and then clicking the Clear button found after the "Quick Start cache" toggle in the Advanced|Cached Data section.

  4. Restart XXE and check installed add-ons using OptionsInstall Add-ons.

Procedure 9.9. “Manually” uninstall an add-on
  1. Delete the subdirectory of addon/ containing the distribution of the add-on.

    For example, uninstall the "Bidi Support" add-on by deleting subdirectory XXE_user_preferences_dir/addon/bidi_support/.

  2. Clear the Quick Start cache. See note above explaining how to do this.

  3. Restart XXE and check installed add-ons using OptionsInstall Add-ons.

Procedure 9.10. “Manually” upgrade an add-on
  1. Delete the subdirectory of addon/ containing the distribution of the old version of add-on.

  2. Visit this "Add-ons" page using your web browser to download the distribution of the new version of the add-on.

  3. Unzip the distribution of the new version of the add-on in either XXE_user_preferences_dir/addon/ (recommended) or XXE_install_dir/addon/.

  4. Clear the Quick Start cache. See note above explaining how to do this.

  5. Restart XXE and check installed add-ons using OptionsInstall Add-ons.