ZotQuery: an Alfred workflow for Zotero

smargheim

ZotQuery
Search your Zotero data from the comfort of your keyboard. 
 
ZotQuery is an Alfred workflow that grants the user access to the data stored in their Zotero application. For full documentation, visit the repo page at https://github.com/smargh/ZotQuery, which has a thorough README (can't figure out inserting images here). 

Note:I am currently looking for some help in expanding ZotQuery's features by building an accompanying Zotero Plugin in JavaScript. As I do not know JS and do not have the time currently to learn it thoroughly enough to achieve my goals, I am hoping that a satisfied user or curious coder would be interested in joining me in development. I have a number of ideas, but not the technical expertise to execute them. Please contact me, either here, on GitHub, or on my blog if you are interested.

ZotQuery has 3 main functions:

  • Search

  • Export

  • Cache

Under Search there are 5 options (with corresponding keywords):

  • General search (zot)

  • Title-specific search (zot:t)

  • Author-specific search (zot:a)

  • Tag-specific search (zot:tag)

  • Collection-specific search (zot:c)

The Tag-specific and Collection-specific searches actually begin first by searching for a particular tag or collection. In step-one, you search for a particular Tag or Collection; in step-two you search within that particular Tag or Collection for your query. To search your Zotero tags, use the keyword "z:tag"; for collections, use "z:col". Once you select the tag or collection, the workflow automatically brings up either the "zot:tag" or "zot:c" search for your next query.
 - - - 
Under `Export` there are 3 options:

  • Open Zotero to that item.

  • Export an author-date reference to that item.

  • Export a Markdown citation of that item.

If you merely hit return on your chosen item, option 1 will occur and Zotero will open to that item. If you hit option+return when you choose your item, you will export an author-date reference. If you hit control+return, you will export a full citation of the item in Markdown format. The two export options use the Zotero API and require that you have a Personal Zotero API key. For information on setting that up and configuring the workflow, see the README on the GitHub page. 
 - - -
Finally, there is also the Caching function. All of the query scripts are querying a JSON cache of your Zotero database. This file is created and then updated with the keyword "z:cache". 
 
This function will find your Zotero sqlite database, read its contents, and create a JSON cache of the pertinent information. The workflow is currently configured to update this JSON cache after each general query ("zot"), but you can manually update as well using the "z:cache" keyword.

 
- - -

To download, go here and click "View Raw" at the GitHub page.
 
All of the code is also up on the GitHub page, and I am open to suggestions for future features.

  • adamsmith
    neat! Not a Mac person, so I can't use this, but it looks quite handy.
    Do feel free to make a wiki account (https://www.zotero.org/support/dev/documentation) and add this to
    http://www.zotero.org/support/plugins
  • smargheim
    A quick update:

    I've added a feature to append Markdown citations to a bibliography text file, which you can export to the clipboard (keyword "z:bib") at any point. The bibliography will automatically be sorted alphabetically and have a WORKS CITED header.
  • smargheim
    NEW UPDATES:

    I've added a slew of Exporting features in the newest version of ZotQuery. Now writing with Zotero is easier than ever. ZotQuery is now the perfect tool for academics on the Mac who write in Markdown.

    + Export full citation of item in Markdown format
    + Export short refernce of item
    + Export full bibliography of all items within a chosen Collection in Markdown format
    + Export full bibliography of all items with a chosen Tag in Markdown format
    + Append full citation of item to temporary Bibliography, then
    ___+ Copy that temporary Bibliography to the clipboard (in Markdown format)

    To download, or read about all of the features, visit the GitHub page.
  • smargheim
    NEW UDATE:

    Now, in addition to Exporting your Zotero data on the fly (see above), ZotQuery allows you to open both Linked and Internal Attachments. Items with attachments have a unique icon and additional info in the Subtitle field. Simply press shift+return and the item's attachment will be opened in your default program.

    To download, or read about all of the features, visit the GitHub page.
  • smargheim
    Many bug fixes, so if you've download the workflow, I would update from the GitHub page.

    Go to the workflow and click "View Raw" for the updated workflow to begin downloading. Then simply double click to have Alfred automatically update the workflow.
  • smargheim
    I've pushed another large update to ZotQuery, which now has a user-friendly configurator and general cleaning and bug fixes.

    The full documentation can be found on the ZotQuery site on my blog: http://hackademic.postach.io/zotquery-an-alfred-workflow-for-zotero

    To download, visit the ZotQuery page on Packal (the Alfred Workflow repository): http://packal.org/workflow/zotquery
  • smargheim
    Updated to version 5.6 on Packal. Lots of new features. Download here:
    http://packal.org/workflow/zotquery
  • richiekhoo
    The Zotquery github project is reporting itself as Abandonware from 2017.
    They recommend ZotHero instead (same core features and more!).

    Setup Instructions for ZotHero:
    https://github.com/deanishe/zothero#download--installation
Sign In or Register to comment.