dominic-dallosto / zotero-reading-list

Keep track of whether you've read items in Zotero

Zotero Reading List

An extension for Zotero that allows setting the read status (New, To Read, In Progress, Read, or Not Reading) of items.

Change an item's status by right clicking or by using the shortcut keys Alt+1 to Alt+5 (supports multiple items at once).

You can also remove an item's read status through the right click menu or with the shortcut Alt+0.

Installation

Note: The last release supporting Zotero 6 is v0.3.2. Versions starting from v1.0.0 only support Zotero 7, but the extension should automatically update to the new version when you upgrade your Zotero version.

1. Download the latest release here
2. Save the .xpi file (in Firefox, Right click -> Save Link As)
3. Install in Zotero (Tools -> Add-ons -> Gear icon in the top right -> Install Add-on From File -> Select the .xpi file you downloaded)
4. Restart Zotero to ensure proper initialisation of the Add-on
5. Right click on the item pane column header and enable the Read Status column (see below)

Options

Under Edit -> Settings -> Reading List you can configure the following options

Option	Description
Show Read Status Icons in Item Tree	Show icons along with the status of whether you've read items in the "Read Status" column. If not, just show the status names.
Enable Keyboard Shortcuts	With an item selected, pressed Alt+1, ... Alt+5 to set that item's read status.
Automatically Label New Items	When adding new items to your Zotero library, do you want them labelled as "New"?
Custom Read Statuses and Icons1	Choose custom Read Status names and icons. Keyboard shortcuts will work up to Alt+9. Note: if you delete a read status, it will remain assigned to any items - you'll need to delete / change their statuses manually.

Footnotes

1. Only supported in the Zotero 7 version of the extension ↩

zotero-reading-list's Issues

Be able to remove the read status of an item

At the moment once you've set the read status of an item, you can't remove it (except manually through editing the extra field).

It would be good if this were possible, both through the right click menu and the keyboard.

Automatically change an item's status from New to Reading when opening PDF

Should be optional.

Is there a Zotero observer we can hook into to find out when a PDF is opened?

Fix sorting by read status

Currently this doesn't work. Might just be the unicode symbols breaking it?

Update item's read status if Status Name is modified in settings

Currently, if someone modifies the Status Name (or deletes a custom status) from the Reading List in settings, library items with the old status name are not updated. Updated icons are reflected in the library items if the status name persists.

It would be nice to auto update library items when a custom status name is changed. Additionally, it'd be helpful to warn the user if they try to delete a Custom Reading Status that is in use.

I'm currently using

• Zotero Reading List 1.2.0
• Obsidian 7.0.0-beta-75

Allow filtering by Read Status in advanced search

question "Automatically Label New Items" and suggestion

Thanks a lot for your development, when adding new items to my Zotero library, I want "New" to be turned on by default, .
Feedback: Every time you open the software, you need to re-check "Automatically Label New Items"

Suggestions:

1. When I open the document, I hope the content of the label will change, for example: form new->reading.
2. Support user-defined reading status keywords
   Sincerely thank you for your development and dedication

Mark new items as `New`

Make this optional, defaulting to false

Unable to install addon

Thanks for the nice addon!

When trying to install the latest version, downloaded from here, Zotero (v6.0.33) gave the following error message:

The add-on "%S" could not be installed. It may be incompatible with this version of Zotero.

I have also tested the previous addon release (1.0.2), as well as with all other addons disabled, with the same results. Any ideas as to what might be happening here?

Enable custom Read Status types

Allow the user to define a custom list of Read Status types.

How should these interact with the icons and keyboard shortcuts? Maybe we only allow the first 9 options to have keyboard shortcuts. And it should be possible to allow any unicode character (like ⭐) for the icons.

Error with attached files

Invalid field 'readstatus' for base field

In this Zotero function:

function getFieldIDFromTypeAndBase(itemType, baseField) {
    var itemTypeID = Zotero.ItemTypes.getID(itemType);
    if (!itemTypeID) {
      throw new Error("Invalid item type '" + itemType + "'");
    }

    var baseFieldID = this.getID(baseField);
    if (!baseFieldID) {
      throw new Error("Invalid field '" + baseField + "' for base field");
    }

    // If field isn't a base field, return it if it's valid for the type
    if (!this.isBaseField(baseFieldID)) {
      return this.isValidForType(baseFieldID, itemTypeID) ? baseFieldID : false;
    }

    return _baseTypeFields[itemTypeID][baseFieldID];
  }

[Feature request] Ability to set matching tags for each reading status and automatically apply these as read status changes (for mobile tracking)

As Zotero for iOS doesn't have addons, the reading status is not easily accessible on mobile devices. Perhaps a workaround would be if this plugin had the ability to apply tags that match the reading status. I know this is not a clean solution, but I think it's better than nothing.

Preferences aren't saved when restarting Zotero

The default values for the preferences are True, False, True. Changing one of these then restarting Zotero will reset the preferences to their default values. So it seems like they're not being properly saved.

Automatically label new items will be unchecked every time you open zotero

Automatically label new items will be unchecked every time I open zotero. I am not sure whether this is the author's setting or a problem with my software settings.

Cannot set Custom Read Statuses and Icons

Greetings, the feature for tracking reading progress is excellent. However, I'm unable to customize read statuses. There isn't a "Setting" option under "Edit," only "Preferences," and there are no settings available for the Zotero Reading List under preferences.

I'm using Zotero version 6.0.36 on Windows and Reading List for Zotero version 0.3.2.

Install fail on release 1.2.0 with Zotero 6.0.35

The add-on "%S" could not be installed. It may be incompatible with this version of Zotero.

running on Arch Linux

EDIT: whoops, I see the NOTE in the readme. I'll edit/close this as I figure it out!

Note: The last release supporting Zotero 6 is v0.3.2. Versions starting from v1.0.0 only support Zotero 7, but the extension should automatically update to the new version when you upgrade your Zotero version.

The reading status of some pdfs is not displayed.

Hi, thanks a lot for this add-on that helps me to be more efficient!

I'm using it and I've noticed that it's working properly on most of my reading projects, but not on certain pdfs. For these pdfs, they are not showing up no matter which reading state I check. I am not sure what is wrong. Is there any way to get these pdfs to show the normal reading status as well please?

( I am using zotero 7, with windows 11.

Ignoring the read status when exporting to BibTex /BibLaTex

I tried the add-on and it is great, but I don't need the read status to be displayed in the output PDF. Is it possible to remove the read status in the output from Zotero (so that I can see it as a user, but it is not exported to BibTex / BibLaTex)?
I am using Overleaf which is able to sync Zotero bibliography.

Here is the current bibliography of my output PDF (problematic parts in bold):

Bibliography
[1] D. Osokin, “Real-time 2d multi-person pose estimation on CPU: Lightweight OpenPose,” 2018,
Publisher: arXiv Version Number: 1 Read_Status: To Read Read_Status_Date: 2023-02-16T14:04:41.638Z.
DOI: 10.48550/ARXIV.1811.12004. [Online]. Available: https://arxiv.org/abs/
1811.12004 (visited on 02/16/2023).
[2] E. T. Hall, The hidden dimension. New York: Anchor Books, 1990, 217 pp., Read_Status: To Read
Read_Status_Date: 2023-02-16T16:00:08.414Z, ISBN: 978-0-385-08476-5.

Unable to display reading status

Thanks for the open source plugin. But I am not able to display the reading status in the preview screen after installing the plugin following the steps you provided. I'm using zotero 6.0.30. there is still only the title and creator in the preview screen, there is no way to achieve the same effect as in your screenshot.

Shortcuts on macOS?

Hello, may I ask if shortcut keys can be used on macOS?

I tried using Command+Num, Option+Num, Ctrl+Num but there was no response.

cannot download add-on from webpage

Hi! Thanks so much for this amazing add-on. There's a problem with my device - the column for 'read status' does not show icons with colors anymore so I was hope to reinstall this add-on to see if it's going to get back to normal. The downloading link from the webpage doesn't work so I was hope if you could fix the link.
Would also be grateful if you could just lmk how to get the color back to the icons:

thanks!

Compatibility with Zotero7

Hi,
As the Zotero 7 beta has been released, I wanted to find out if your plugin is compatible with it or when you think you could make it compatible?