Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
debug_output [2018/04/06 18:26] – [Debug Output Logging] dstillman | debug_output [2023/12/26 02:04] (current) – [Zotero for iOS] dstillman | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Debug Output Logging ===== | + | ====== Debug Output Logging |
If you've been asked to provide a Debug ID (which is different from a [[reporting problems|Report ID]]) to help troubleshoot a problem, follow these simple steps: | If you've been asked to provide a Debug ID (which is different from a [[reporting problems|Report ID]]) to help troubleshoot a problem, follow these simple steps: | ||
- | ==== Zotero | + | ==== Zotero ==== |
- | - In the Help menu, go to Debug Output Logging and select Enable, or use Restart with Logging Enabled | + | - In the Help menu, go to Debug Output Logging and select Enable, or, to generate debug output from Zotero startup, select " |
- | - Immediately perform the relevant action (syncing, saving, importing, etc.). | + | - Immediately perform the relevant action (syncing, saving, importing, etc.) and reproduce the problem you're experiencing. |
- Before doing anything else, return to Help -> Debug Output Logging and click Submit Output, which will disable logging and submit the output to zotero.org. A window should pop up containing a Debug ID (e.g., “D12345678”). Click "Copy to Clipboard" | - Before doing anything else, return to Help -> Debug Output Logging and click Submit Output, which will disable logging and submit the output to zotero.org. A window should pop up containing a Debug ID (e.g., “D12345678”). Click "Copy to Clipboard" | ||
- | ==== Zotero 4 for Firefox ==== | + | If submitting output fails, you can return to the Debug Output Logging |
- | - Open the Advanced pane of the Zotero [[preferences|preferences]]. You can access the Zotero preferences from the gear {{: | + | |
- | - Click " | + | |
- | - Immediately perform the relevant action (syncing, saving, importing, etc.). | + | |
- | | + | |
- | - Disable debug output logging and click "Clear Output" | + | |
==== Zotero Connectors (Firefox, Chrome, and Safari) ==== | ==== Zotero Connectors (Firefox, Chrome, and Safari) ==== | ||
- Open the Zotero Connector preferences | - Open the Zotero Connector preferences | ||
- | * **Firefox: | + | * **Firefox: |
- | * **Chrome: | + | * **Chrome: |
* **Safari:** right-click anywhere on a webpage and select " | * **Safari:** right-click anywhere on a webpage and select " | ||
- | - In the Advanced tab of the Zotero Connector preferences, | + | - In the Advanced tab of the Zotero Connector preferences, under "Debug Output Logging" |
- Immediately perform all the relevant actions (e.g., import an item from a web page). | - Immediately perform all the relevant actions (e.g., import an item from a web page). | ||
- | - Go back to the Advanced tab of the Zotero Connector preferences and click Submit | + | - Go back to the Advanced tab of the Zotero Connector preferences and click Submit |
- You will be provided with a Debug ID (e.g., " | - You will be provided with a Debug ID (e.g., " | ||
- Uncheck the box next to " | - Uncheck the box next to " | ||
+ | ==== Zotero for iOS ==== | ||
- | ==== Error Submitting | + | - Tap Back in the top-left corner until you see the list of libraries. |
+ | - Tap the Gear icon. | ||
+ | - Tap "Debug Output Logging" | ||
+ | - Close the settings window. | ||
+ | - Immediately perform all relevant actions (e.g., pulling down on the items list to trigger | ||
+ | - When you're done, tap the circular stop button in the bottom-left corner of the screen. | ||
+ | - In the alert that pops up, tap Copy to copy the Debug ID to the clipboard, and then paste it into your forum thread. | ||
- | === Zotero | + | ==== Zotero |
- | If submitting output fails, you can return to the Debug Output Logging | + | - From the items list, tap Collections in the top-left corner and then Libraries. |
- | ===== Real-time Debug Output | + | - Tap the Gear icon. |
+ | - Tap "Debug Output Logging" | ||
+ | - Close the settings window. | ||
+ | - Immediately perform all relevant actions (e.g., pulling down on the items list to trigger | ||
+ | - When you're done, tap the circular stop button in the bottom-left corner of the screen. | ||
+ | - In the alert that pops up, tap Copy to copy the Debug ID to the clipboard, and then paste it into your forum thread. | ||
+ | |||
+ | ===== Logging to a Terminal Window | ||
- | If you'd like to follow Zotero' | + | If you'd like to regularly |
==== macOS ==== | ==== macOS ==== | ||
- | Close Zotero and then restart it via the command line: | + | |
- | + | * Paste '' | |
- | | + | |
- | + | ||
- | * Paste %%"%%/ | + | |
* Press Return | * Press Return | ||
- | Zotero should start up with a separate window that shows debug output and allows you to easily submit | + | You can add '' |
- | + | ||
- | To capture | + | |
- | + | ||
- | If for some reason the debug window doesn' | + | |
- | + | ||
- | If you receive the message **" | + | |
==== Windows ==== | ==== Windows ==== | ||
- | Close Zotero, and then restart it via the command line: | + | * Open cmd.exe, Cygwin shell, or another terminal |
+ | * Paste '' | ||
+ | * Press Enter. | ||
- | * Press Windows | + | Due to limitations of the available console windows on Windows, you may have a better experience using '' |
- | * Select the appropriate file and click Open. | + | |
- | * In the Run box, append %%" | + | |
- | * Click OK. | + | |
- | + | ||
- | Zotero | + | |
- | + | ||
- | To capture output for a particular action (e.g., for a translator save attempt), press Clear before performing the action and then submit the output immediately afterwards. | + | |
- | + | ||
- | If you cannot locate Zotero, find an existing shortcut to it (e.g., on your desktop or in the Start menu), right-click it, select Properties, make sure the Target field is selected, and copy it to the clipboard by pressing Ctrl-C. Click Cancel to close the shortcut | + | |
==== Linux ==== | ==== Linux ==== | ||
- | Close Zotero, and then restart it via the command line, adding the -ZoteroDebug | + | Start Zotero via the command line, adding the '' |
- | + | ||
- | Zotero should start up with a separate window that shows debug output and allows you to easily submit the output and create a Debug ID for posting to the forums. | + | |
- | + | ||
- | To capture output for a particular action (e.g., for a translator save attempt), press Clear before performing the action and then submit the output immediately afterwards. | + | |
- | If for some reason the debug window doesn' | + | To capture output when Zotero is crashing or hanging, you can use '' |
=== Developer Note === | === Developer Note === | ||
To enable Zotero debug output permanently, | To enable Zotero debug output permanently, |