zoteroRoam
Report an issueRoadmap
v0.5
v0.5
  • Introduction
  • โ–ถ๏ธDemo by Cortex Futura
  • ๐Ÿ”„Updating from older versions
  • ๐Ÿ†˜Help/Getting Support
  • ๐Ÿ Getting Started
    • 1.1 Pre-requisites
    • 1.2 Installation in {{roam/js}}
    • 1.3 Basic Setup
  • ๐ŸงชUsing the extension
    • 2a. The search panel
    • 2b. In-text references
  • ๐Ÿ› ๏ธCustomizations
    • 3.1 What's Available
    • 3.2 Constructing data requests
    • 3.3 Creating your own formatting functions
      • Nesting metadata
      • Code snippets
    • 3.4 Creating custom shortcuts
    • 3.5 Other Settings
      • autocomplete
      • funcmap
      • typemap
      • Copying an item's reference
    • Extension defaults
  • About the Zotero API
    • Zotero API Docs (v3)
  • Support the project
    • Roadmap/Future Development
    • Buy me a (virtual) coffee
    • GitHub Sponsorship
Powered by GitBook
On this page

Was this helpful?

  1. Getting Started

1.3 Basic Setup

Last updated 4 years ago

Was this helpful?

The minimal requirement for the extension to run is the formulation of a data request. Here's a basic example, which requests all the items in your personal library :

// The zoteroRoam_settings object will contain all your settings for the extension
// For now, we're doing a minimal configuration, with just a single data request.
// Paste this into your roam/js block, and fill out the API key + your user ID :

zoteroRoam_settings = {
    dataRequests: {
        apikey: "your_API_key",
        dataURI: "users/your_user_id/items",
        params: "limit=100"
    }
}

After you've done this, reload your graph. A new icon should be visible in the topbar - a book :

The icon acts as a toggle for turning the extension on/off, and its background color always indicates the current state of the extension :

Once the icon turns green, the extension's functionalities will become available.

Busy - the data request is ongoing. Depending on the number of items, this may take ~20s.

Active - the data has been fully loaded, the extension is ready !

Error - something went wrong while retrieving the data. Check the browser console for details.

The extension is turned off.

๐Ÿ 
The book (right) is the extension's icon