Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
word_processor_plugin_troubleshooting [2024/08/17 08:46] – [Error or non-responsive plugin buttons] dstillmanword_processor_plugin_troubleshooting [2025/02/20 04:06] (current) – [Mac] dstillman
Line 1: Line 1:
 +====== Zotero Word Processor Plugin Troubleshooting ======
 +
 This page describes some of the reported issues with the [[word_processor_integration|Zotero word processor plugins]], together with possible solutions. This page describes some of the reported issues with the [[word_processor_integration|Zotero word processor plugins]], together with possible solutions.
  
-====== All Plugins/Platforms ======+**The instructions on this page are for Zotero 7. If you're running Zotero 6, start by upgrading to Zotero 7.**
  
-===== Formatting issues ===== +===== All Plugins/Platforms =====
-Citations and bibliographies generated by the word processor plugins might appear in a different style (font, font-size, etc) than the surrounding text. The appearance of the generated text can be changed by changing the default style. For example, in LibreOffice, open the Styles Manager in Format -> Styles and Formatting or by pressing F12. Right-click on "Default", select "Modify", and make the desired changes to this style. In Word, open the Styles Manager in Format -> Styles or by clicking the "Styles Pane" or "Manage Styles" buttons on the "Home" tab of the ribbon. +
- +
-Bibliography formatting is controlled by the citation style you select in Zotero document preferences and should conform to the requirements of the style in use. The formatting of the bibliography can be modified by editing the "Bibliography" (Word) or "Bibliography 1" (LibreOffice) word processor style.+
  
-===== Zotero toolbar doesn't appear =====+==== Zotero toolbar doesn't appear ====
  
 In most cases, the Zotero plugin should appear automatically in the Word ribbon or the LibreOffice toolbar after installing Zotero and restarting the word processor. If you don't see a Zotero tab or toolbar, follow these steps: In most cases, the Zotero plugin should appear automatically in the Word ribbon or the LibreOffice toolbar after installing Zotero and restarting the word processor. If you don't see a Zotero tab or toolbar, follow these steps:
  
   - Close Word or LibreOffice.   - Close Word or LibreOffice.
-  - In the Cite pane of the [[preferences|Zotero preferences]], open the Word Processors tab, click “Install Microsoft Word Add-in” or “Install LibreOffice Add-in”, and then restart your word processor. +  - Open the [[preferences|Zotero settings]], click the Cite tab, and scroll down to the Word Processors section. Click “Install Microsoft Word Add-in” or “Install LibreOffice Add-in”, and then restart your word processor. If you get an error, see [[kb:word_processor_plugin_installation_error|Troubleshooting Errors with Word Processor Plugin Installation]]. 
-    * If you don't see the installation buttons in the Cite pane, you'll need to repair your Zotero installation: +  - If the installation completes but the Zotero tab or toolbar still doesn't appear in your word processor, follow the [[word_processor_plugin_manual_installation|manual installation instructions]].
-      - Go to Tools → Add-ons in Zotero.  +
-      - Make sure "Zotero Word for Mac", "Zotero for Windows Integration", and/or "Zotero LibreOffice Integration" are enabled. If any are not, click the "Enable" button. +
-      - If the "Enable" button is grayed out and you are unable to click it, click the "Remove" button and restart Zotero.  +
-      - If you don't see the integration plugins in Add-ons at all, then you should [[/download|re-download]] and re-install Zotero. It is not necessary to uninstall Zotero before re-installing; simply install Zotero over the top of the existing installation. (**Note:** Re-installing Zotero rarely fixes problems and should not be used as a general troubleshooting step. This is one of the few instances where re-installation is helpful.) +
-      - If you still don't see the installation buttons in the Cite → Word Processors pane of the Zotero preferences, it may help to open your [[kb:profile_directory|Zotero profile directory]], delete extensions.json, and restart Zotero. If you've installed any third-party plugins, you may need to reinstall them. +
-  - If the Zotero tab or toolbar still doesn't appear in your word processor after clicking the install button in the Zotero preferences and restarting your word processor, follow the [[word_processor_plugin_manual_installation|manual installation instructions]].+
  
 If you still don't see the plugin after performing a manual installation, follow these OS-specific troubleshooting ​steps: If you still don't see the plugin after performing a manual installation, follow these OS-specific troubleshooting ​steps:
Line 27: Line 20:
   * [[#zotero_tab_does_not_appear_in_the_word_2016_ribbon|Word 2016+ for Mac]]   * [[#zotero_tab_does_not_appear_in_the_word_2016_ribbon|Word 2016+ for Mac]]
   * [[#LibreOffice|LibreOffice]]   * [[#LibreOffice|LibreOffice]]
-===== Fixing broken documents =====+ 
 +==== Fixing broken documents ====
  
 If you can insert a Zotero citation in a new, empty document but get an error in an existing document, see [[kb:debugging_broken_documents|Troubleshooting Errors in Word Processor Documents]]. If you can insert a Zotero citation in a new, empty document but get an error in an existing document, see [[kb:debugging_broken_documents|Troubleshooting Errors in Word Processor Documents]].
-===== Field codes instead of citation/bibiliography text =====+ 
 +==== Formatting issues ==== 
 + 
 +Citations and bibliographies generated by the word processor plugins might appear in a different style (font, font-size, etc) than the surrounding text. The appearance of the generated text can be changed by changing the default style. For example, in Word, open the Styles Manager in Format → Styles or by clicking the "Styles Pane" or "Manage Styles" buttons on the "Home" tab of the ribbon. In LibreOffice, open the Styles Manager in Format → Styles and Formatting or by pressing F12. Right-click on "Default", select "Modify", and make the desired changes to this style. 
 + 
 +Bibliography formatting is controlled by the citation style you select in Zotero document preferences and should conform to the requirements of the style in use. The formatting of the bibliography can be modified by editing the "Bibliography" (Word) or "Bibliography 1" (LibreOffice) word processor style. 
 + 
 +==== Field codes instead of citation/bibliography text ====
  
 See [[kb:word_field_codes|Field Codes]]. See [[kb:word_field_codes|Field Codes]].
-===== Citations/bibliography highlighted =====+ 
 +==== Citations/bibliography highlighted ====
  
 See [[kb/citations_highlighted|Citations Highlighted]]. See [[kb/citations_highlighted|Citations Highlighted]].
  
-===== Citations converted to plain text =====+==== Citations converted to plain text ====
  
 See [[kb/existing_citations_not_detected|Existing Citations Not Detected]]. See [[kb/existing_citations_not_detected|Existing Citations Not Detected]].
  
-====== Word ======+===== Word =====
  
-===== Windows =====+==== Windows ====
  
-==== Error or non-responsive plugin buttons====+=== Error or non-responsive plugin buttons===
  
   * //"Zotero experienced an error updating your document."//   * //"Zotero experienced an error updating your document."//
   * //"Word could not communicate with Zotero. Please ensure Zotero is running and try again.”//   * //"Word could not communicate with Zotero. Please ensure Zotero is running and try again.”//
  
-If you see one of the above errors in a **new, empty document** (and not just a [[kb:debugging_broken_documents|specific existing document]]), or if no citation dialog appears when you click the plugin buttons, try the following steps, testing after each one:+If you see one of the above errors in a **new, empty document** (and not just a [[kb:debugging_broken_documents|specific existing document]]), or if no citation dialog appears when you click the plugin buttons, try the following steps, testing the plugin after each one.
  
-  - Restart your computer. Start Zotero before starting your word processor. +  - Restart your computer. Start Zotero before starting Word. 
-  - [Zotero 6 only] If you're getting a communication error, go to Tools → Add-ons in Zotero and make sure that Zotero Word for Windows Integration is enabled. +  - If the plugin still isn't working in Word, go to your [[word_processor_plugin_manual_installation#locating_your_word_startup_folder|Word Startup folder]], delete Zotero.dotm, and restart Word to make sure that the plugin is completely gone from Word. (If the "Zotero" tab isn't disappearing, see the steps in the linked section.) Once the "Zotero" tab is gone from Word, [[#zotero_toolbar_doesn_t_appear|reinstall the plugin]].
-  - Go to your [[word_processor_plugin_manual_installation#locating_your_word_startup_folder|Word Startup folder]], delete Zotero.dotm, and restart Word to make sure that the plugin is completely gone from Word. Then [[#zotero_toolbar_doesn_t_appear|reinstall the plugin]]. +
-  - Make sure you [[kb/could_not_find_a_running_word_instance|haven't disabled UAC]].+
   - Make sure that you're running Zotero as the same user as Word. Specifically, check to make sure neither program is running as administrator (right-click → Properties → Compatibility). For security and stability reasons, you should typically not run any software as administrator.   - Make sure that you're running Zotero as the same user as Word. Specifically, check to make sure neither program is running as administrator (right-click → Properties → Compatibility). For security and stability reasons, you should typically not run any software as administrator.
   - Temporarily disable any security software you're running, which could interfere with the connection between Word and Zotero.   - Temporarily disable any security software you're running, which could interfere with the connection between Word and Zotero.
   - If you've set up Zotero to use [[kb/multiple_profiles|multiple Zotero profiles]] (most people haven't), you might have configured Zotero to launch with the ''-no-remote'' command-line option. This will prevent the plugins from functioning, and if you've done this you should remove the ''-no-remote'' command-line option from the shortcut used to launch the Zotero profile. This flag should never be used with Zotero.   - If you've set up Zotero to use [[kb/multiple_profiles|multiple Zotero profiles]] (most people haven't), you might have configured Zotero to launch with the ''-no-remote'' command-line option. This will prevent the plugins from functioning, and if you've done this you should remove the ''-no-remote'' command-line option from the shortcut used to launch the Zotero profile. This flag should never be used with Zotero.
-==== Zotero tab does not appear in the Word ribbon ====+ 
 +=== Zotero tab does not appear in the Word ribbon ===
  
 First, make sure you've tried the [[#zotero_toolbar_doesn_t_appear|general troubleshooting steps]]. First, make sure you've tried the [[#zotero_toolbar_doesn_t_appear|general troubleshooting steps]].
Line 84: Line 85:
  
 If the Zotero tab still isn't showing up and this is an institutional computer, you should contact your IT department, as they may be blocking Word templates from running or modifying the user interface (e.g., the Microsoft Intune policy "Disable UI extending from documents and templates", which changes the ''noextensibilitycustomizationfromdocument'' registry key). If the Zotero tab still isn't showing up and this is an institutional computer, you should contact your IT department, as they may be blocking Word templates from running or modifying the user interface (e.g., the Microsoft Intune policy "Disable UI extending from documents and templates", which changes the ''noextensibilitycustomizationfromdocument'' registry key).
-==== Zotero tab has an empty label ====+=== Zotero tab has an empty label ===
  
 If after installing the plugin the Zotero tab has an empty label, it means Word Macro settings are preventing the Zotero plugin from running. If after installing the plugin the Zotero tab has an empty label, it means Word Macro settings are preventing the Zotero plugin from running.
Line 93: Line 94:
  
 You can find your Word Startup location in Word Options → Advanced, by clicking the "File Locations…" button at the bottom of the panel. You can find your Word Startup location in Word Options → Advanced, by clicking the "File Locations…" button at the bottom of the panel.
-==== Error "Could not find a running Word instance" ====+=== Error "Could not find a running Word instance" ===
  
 See [[kb/could_not_find_a_running_word_instance|Could not find a running Word instance]]. See [[kb/could_not_find_a_running_word_instance|Could not find a running Word instance]].
  
-==== Run-time error '5097': Word has encountered a problem. ====+=== Run-time error '5097': Word has encountered a problem. ===
 This issue affects the users of the Windows 10 October 2018 Update. To fix it you will need to change your regional format to English: This issue affects the users of the Windows 10 October 2018 Update. To fix it you will need to change your regional format to English:
  
Line 105: Line 106:
  
  
-===="This command is not available because no document is open"====+==="This command is not available because no document is open"===
 Zotero's Word add-on currently does not work for documents in OneDrive. Move your document to a different folder. Other cloud-syncing services such as Dropbox or Google Drive are not affected (note that Zotero documents should not be opened or edited in Google Drive's word proccessor as this [[#_citations_converted_to_plain_text|will break Zotero citations]]. See [[https://forums.zotero.org/discussion/41885/ms-word-2013-plugin-stopped-working-in-single-document/#Item_9|this thread]] for details and developments. Zotero's Word add-on currently does not work for documents in OneDrive. Move your document to a different folder. Other cloud-syncing services such as Dropbox or Google Drive are not affected (note that Zotero documents should not be opened or edited in Google Drive's word proccessor as this [[#_citations_converted_to_plain_text|will break Zotero citations]]. See [[https://forums.zotero.org/discussion/41885/ms-word-2013-plugin-stopped-working-in-single-document/#Item_9|this thread]] for details and developments.
-===== Mac =====+==== Mac ====
  
-==== Zotero tab does not appear in the Word 2016+ ribbon ====+=== Zotero tab does not appear in the Word 2016+ ribbon ===
  
 First, make sure you've tried the [[#zotero_toolbar_doesn_t_appear|general troubleshooting steps]]. First, make sure you've tried the [[#zotero_toolbar_doesn_t_appear|general troubleshooting steps]].
- 
-If you're still having trouble, check your [[https://support.office.com/en-us/article/about-office-what-version-of-office-am-i-using-932788b8-a3ce-44bf-bb09-e334518b8b19|specific Word version number]] and follow the appropriate steps below: 
- 
-=== Version 15.41 and higher === 
  
 Make sure you're running the latest stable version of Word. Make sure you're running the latest stable version of Word.
Line 126: Line 123:
 If Zotero.dotm still doesn't show up, you may not have correctly performed the [[word_processor_plugin_manual_installation|manual installation steps]] to copy Zotero.dotm to your current Word Startup folder. If Zotero.dotm still doesn't show up, you may not have correctly performed the [[word_processor_plugin_manual_installation|manual installation steps]] to copy Zotero.dotm to your current Word Startup folder.
  
-=== Version <15.41 === +=== “Word could not communicate with Zotero. Please ensure that Zotero is open and try again.” ===
- +
-Update Word to the latest stable version (15.41 or above). +
- +
-==== “Word could not communicate with Zotero. Please ensure that Zotero is open and try again.” ====+
  
 First, make sure the Zotero app is open and running on your computer. Note that this is the Zotero program, not the Zotero website or Zotero Connector in your browser. First, make sure the Zotero app is open and running on your computer. Note that this is the Zotero program, not the Zotero website or Zotero Connector in your browser.
  
-If Zotero is open and you're still receiving this error, there are two likely causes:+If Zotero is open and you're still receiving this error, you likely don't have the latest version of the Zotero plugin in Word. Go to your [[:word_processor_plugin_manual_installation#locating_your_word_startup_folder|Word Startup folder]], delete Zotero.dotm, restart Word, and confirm that the Zotero tab is gone from Word. If it doesn't disappear, follow the instructions for identifying your //active// Word Startup folder, delete Zotero.dotm from there as well, and reset your Word Startup folder location to the default to avoid future problems. Once the Zotero tab is gone from Word, follow the steps under [[#Zotero toolbar doesn't appear]].
  
-  - You don't have the latest version of the Zotero plugin in Word. Make sure you're running Zotero 6.0.28 or later or Zotero 7. If you're still getting the error, go to your [[:word_processor_plugin_manual_installation#locating_your_word_startup_folder|Word Startup folder]], delete Zotero.dotm, restart Word, and confirm that the Zotero tab is gone from Word. If it doesn't disappear, follow the instructions for identifying your //active// Word Startup folder, delete Zotero.dotm from there as well, and reset your Word Startup folder location to the default to avoid future problems. Once the Zotero tab is gone from Word, follow the steps under [[#Zotero toolbar doesn't appear]]. +If you modified your Zotero installation to work with multiple instances, you may need to do [[kb:multiple_instances#word|additional configuration]]. This does not apply to most users.
-  - You previously started Zotero from a disk image instead of dragging it to Applications first, or you have two copies of the Zotero app in different locations on your computer (e.g., a "Zotero" and "Zotero 2" in Applications). Close Zotero, open the [[kb:profile_directory|Zotero profile directory]], and delete extensions.json. Then restart Zotero.+
  
-If you continue to receive the error, you may have modified your Zotero installation to work with [[kb:multiple_instances|multiple instances]], in which case you need to do additional [[kb:multiple_instances#word|configuration for the Word for Mac Zotero plugin]]. +=== No response from plugin ===
-==== No response from plugin ====+
  
 If you get no response when you attempt to use the Word plugin, try the following steps: If you get no response when you attempt to use the Word plugin, try the following steps:
  
   - Restart Word and try again.   - Restart Word and try again.
-  - Close Word and go to Tools -> Add-ons -> Extensions in Zotero. Make sure Zotero Word for Mac Integration is listed and enabled. If it is disabled, enable it. If it is missing entirely, see [[#zotero_toolbar_doesn_t_appear|Zotero toolbar doesn't appear]]. After re-enabling/re-installing Zotero Word for Mac Integration, open the Cite -> Word Processors pane of Zotero preferences and click "Reinstall Microsoft Word Add-in" on the "Word Processors" tab. Restart Word and try again.+  - If the plugin still isn't working in Word, go to your [[word_processor_plugin_manual_installation#locating_your_word_startup_folder|Word Startup folder]], delete Zotero.dotm, and restart Word to make sure that the plugin is completely gone from Word. Then [[#zotero_toolbar_doesn_t_appear|reinstall the plugin]].
  
 +=== Run-time error '5': Invalid procedure call or argument ===
  
-===== Linux =====+Some macOS audio plugins Voxengo SPAN or Voloco may interfere with the Zotero Word plugin. They can be found at ''~/Library/Audio/Plug-Ins/Components''. Try temporarily removing the plugins and test if the issue persists. 
 +==== Linux ====
  
 The Zotero Word for Windows plugin does not work out of the box under WINE, CrossOver Office, or other compatibility environments for Linux. We do not support running the Word for Windows plugin under Linux, and advise users to use LibreOffice instead. If you absolutely must run Zotero in WINE, [[/forum/discussion/12426/|this forum thread]] has some helpful tips. The Zotero Word for Windows plugin does not work out of the box under WINE, CrossOver Office, or other compatibility environments for Linux. We do not support running the Word for Windows plugin under Linux, and advise users to use LibreOffice instead. If you absolutely must run Zotero in WINE, [[/forum/discussion/12426/|this forum thread]] has some helpful tips.
Line 164: Line 157:
 Thanks to Sudarlin Laoddang for providing these instructions on his [[http://sudarlin.blogspot.pt/2015/03/running-zotero-ms-word-di-wine.html?showComment=1458032475297#c6126731001028222510|blog]]. Thanks to Sudarlin Laoddang for providing these instructions on his [[http://sudarlin.blogspot.pt/2015/03/running-zotero-ms-word-di-wine.html?showComment=1458032475297#c6126731001028222510|blog]].
  
-====== LibreOffice ======+===== LibreOffice =====
  
-===== All Platforms =====+==== All Platforms ====
  
 Zotero requires LibreOffice 5.2 or later. If you are using an older version, upgrade to the current version of LibreOffice. See [[system_requirements#word_processor_plugins|System Requirements]]. Apache OpenOffice and NeoOffice are based on older versions of LibreOffice and are not supported by Zotero. Zotero requires LibreOffice 5.2 or later. If you are using an older version, upgrade to the current version of LibreOffice. See [[system_requirements#word_processor_plugins|System Requirements]]. Apache OpenOffice and NeoOffice are based on older versions of LibreOffice and are not supported by Zotero.
  
-==== Installation error ====+=== Installation error ===
  
 At the last step of LibreOffice Integration installation, you may see the message At the last step of LibreOffice Integration installation, you may see the message
Line 176: Line 169:
 //"Installation could not be completed because an error occurred."// //"Installation could not be completed because an error occurred."//
  
-See [[:kb/word_processor_plugin_installation_error#libreoffice|Troubleshooting Errors with Word Processor Plugin Installation]]+See the [[:kb/word_processor_plugin_installation_error#libreoffice|installation troubleshooting instructions]].
  
  
-==== Toolbar is missing ====+=== Toolbar is missing ===
  
-Check if there's an entry for Zotero under View -> Toolbars. If not, look for the Zotero LibreOffice Integration plugin in Tools -> Extension Manager. If it's in not there, return to Zotero and the Cite pane of Zotero preferences. On the "Word Processors" tab, click the "Install LibreOffice Add-in" button. If you get an error, refer to [[#installation_error|installation troubleshooting instructions]].+Check if there's an entry for Zotero under View → Toolbars. If not, look for the Zotero LibreOffice Integration plugin in Tools → Extension Manager. If it's in not there, return to Zotero and the Cite pane of the Zotero settings. In the "Word Processors" settings, click the "Install LibreOffice Add-in" button. If you get an error, refer to the [[:kb/word_processor_plugin_installation_error#libreoffice|installation troubleshooting instructions]]
  
-==== Buttons are unresponsive after updating LibreOffice ====+=== Buttons are unresponsive after updating LibreOffice ===
  
-Unresponsive Zotero toolbar buttons are an indication of LibreOffice not having access to a working Java JRE. Refer to the [[word_processor_plugin_troubleshooting#installation_error|Installation Error]] section.+Unresponsive Zotero toolbar buttons are an indication of LibreOffice not having access to a working Java JRE. Refer to the [[:kb/word_processor_plugin_installation_error#libreoffice|installation troubleshooting instructions]].
  
-==== Add Extension(s)...does not exist error ====+=== Add Extension(s)...does not exist error ===
  
 When attempting to manually install Zotero LibreOffice Integration, you may see the message When attempting to manually install Zotero LibreOffice Integration, you may see the message
word_processor_plugin_troubleshooting.1723898809.txt.gz · Last modified: 2024/08/17 08:46 by dstillman