Differences

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

--- kb:annotations_in_database [2022/03/20 18:43] – [Why does Zotero store PDF annotations in its database instead of in the PDF file?] dstillman
+++ kb:annotations_in_database [2023/01/31 07:41] (current) – [Interacting with Embedded Annotations] dstillman
@@ Line 8: / Line 8: @@
 ===== Benefits of Zotero Annotations =====
-With annotations stored in the database, Zotero is able to quickly sync just the details of each new or updated annotation. By contrast, with standard PDF annotations, the entire PDF file needs to be transferred after every change, so if two people in a group added an annotation at the same time, or even just while the file was left open on one computer, it would create an unresolvable file conflict, forcing the user to choose one side or the other. This happened regularly in earlier versions of Zotero, both in personal and group libraries, and we expect PDF annotation to get far more usage as part of the app.
+With annotations stored in the database, Zotero is able to quickly sync just the details of each new or updated annotation. By contrast, with standard PDF annotations, the entire PDF file needs to be transferred after every change, so if two people in a group added an annotation at the same time, or even if a PDF was just left open on one computer, it would create an unresolvable file conflict, forcing the user to choose one side or the other. This happened regularly in earlier versions of Zotero, both in personal and group libraries, and we expect PDF annotation to get far more usage as part of the app.
-Storing annotations in the database also enables advanced functionality, such as being able to tag annotations and filter for them throughout the Zotero interface. (Currently annotation tags are limited to filtering in the PDF reader sidebar, which makes it possible to add all of a PDF's annotations with a given tag to a note, but they'll be accessible in other parts of Zotero in future versions.) We plan to add other extended features like this going forward.
+Storing annotations in the database also enables advanced functionality, such as being able to tag annotations and filter for them throughout the Zotero interface. We plan to add other extended features like this going forward.
-There are major performance benefits as well. For syncing, as discussed above, saving annotations back to the file requires Zotero to transfer the entire file — which could be many megabytes — after every change. It's also harder for Zotero to track changes to external files, so if you annotate something externally, there may be a delay before you can search for those annotations in Zotero — you might need to wait for Zotero to notice the file modification or manually trigger reprocessing.
+There are major performance benefits as well. For syncing, as discussed above, saving annotations back to the file requires Zotero to transfer the entire file — which could be many megabytes — after every change, whereas transferring just an individual annotation is instantaneous. It's also harder for Zotero to track changes to external files, so if you annotate something externally, there may be a delay before you can search for those annotations in Zotero or before the updated file syncs — you might need to wait for Zotero to notice the file modification or manually trigger reprocessing and syncing.
 We'll always try to support external workflows as efficiently as possible, but it will never match the seamless experience we're able to provide when everything is done within the app.
@@ Line 18: / Line 18: @@
 ===== Interacting with Embedded Annotations =====
-While Zotero saves its own annotations to its database, it's possible to interact with annotations embedded in a PDF file in much the same way, as well as to transfer Zotero-created annotations back to the file.
+While Zotero saves its own annotations to its database, it's possible to interact with annotations embedded in a PDF file in much the same way, as well as to export PDFs with embedded annotations.
-Embedded annotations show up in the Zotero PDF reader, and you can [[:pdf_reader#adding_annotations_to_notes|add them to Zotero notes]] in exactly the same ways as Zotero-created annotations. External annotations are read-only by default — indicated by a lock icon — but you can transfer them into Zotero by selecting File → "Import Annotations…" from within the PDF reader, after which they'll be fully editable. The annotations are removed from the PDF to avoid conflicts and duplicates.
+Embedded annotations show up in the Zotero PDF reader, and you can [[:pdf_reader#adding_annotations_to_notes|add them to Zotero notes]] in exactly the same ways as Zotero-created annotations. External annotations are read-only by default — indicated by a lock icon — but you can transfer them into Zotero by selecting File → "Import Annotations…" from within the PDF reader, after which they'll be fully editable. The annotations are removed from the PDF to avoid conflicts and duplicates. (Early versions of Zotero 6 included a "Store Annotations in File…" option as well, but it could result in file conflicts and lost data, and it [[https://forums.zotero.org/discussion/comment/404140/#Comment_404140|was removed]].)
-You can transfer Zotero annotations back to the PDF file by choosing File → "Store Annotations in File…" from within the PDF reader. You can also export a copy of the PDF with annotations embedded by using File → "Export PDF…" from the library view or "Save As…" from the PDF reader. (An upcoming option will let you omit annotations, but in the meantime you can drag PDF items to your filesystem to copy just the file.)
+You can export a copy of the PDF with annotations embedded by using File → "Export PDF…" from the library view or "Save As…" from the PDF reader. (To export the original file, drag the attachment item from the items list to your filesystem or use right-click → Show File and copy the file from there.)
-When exporting metadata (e.g., BibTeX or RIS) from your library, there's a new “Include Annotations” option under “Export Files” that will embed annotations in all exported PDFs. We plan to support other ways to export annotations in future updates.
+When exporting metadata (e.g., BibTeX or RIS) from your library, there's an “Include Annotations” option under “Export Files” that will embed annotations in all exported PDFs. We plan to support other ways to export annotations in future updates.
 ===== Using an External PDF Reader =====
-While we've tried to create a new, better PDF experience within Zotero, you can always choose to use a different PDF reader if you decide one works better for you. You can set the default PDF reader from the General pane of the Zotero preferences.
+While we've tried to create a new, better PDF experience within Zotero, which requires annotations to be stored within the database, you can always choose to use a different PDF reader if you decide one works better for you. You can set the default PDF reader from the General pane of the Zotero preferences.
-If you'd like to keep the Zotero PDF reader as the default but occasionally open a PDF externally, simply right-click on the PDF in Zotero and choose Show File, and then double-click the PDF in your filesystem. (Note that some changes, such as deleting pages, may cause problems with existing annotations in Zotero, which is why we don't expose this option directly.)
+If you'd like to keep the Zotero PDF reader as the default but occasionally open a PDF externally, simply right-click on the PDF in Zotero and choose Show File, and then double-click the PDF in your filesystem. (Annotations of course won't show up, and some changes, such as moving or deleting pages, may cause problems with existing annotations in Zotero, which is why we don't expose this option directly. Rotating and deleting individual pages can be done safely from the thumbnails tab of the Zotero PDF reader sidebar.)
 ===== Data Portability =====
@@ Line 38: / Line 37: @@
 If you choose to stop using Zotero in the future, you can trivially export your entire library with annotations embedded in your PDFs.
-In addition to the methods detailed above for exporting annotations, annotations are stored locally in Zotero's open SQLite database and are extractable using standard tools, and they're are also available via the Zotero web API.
+In addition to the methods detailed above for exporting annotations, annotations are stored locally in Zotero's open SQLite database and are extractable using standard open-source tools. They are also accessible to plugins within Zotero and to external tools via the Zotero web API.
 {{tag>kb}}