Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
dev:client_coding:javascript_api [2020/03/30 00:34] – [Batch Editing] Add creator editing example dstillmandev:client_coding:javascript_api [2022/07/02 18:22] (current) – [Executing the search] dstillman
Line 11: Line 11:
  
   - In the Tools → Developer menu, select Run JavaScript. Opening the Error Console, which appears in the same menu, will also be helpful.   - In the Tools → Developer menu, select Run JavaScript. Opening the Error Console, which appears in the same menu, will also be helpful.
-  - In the window that opens, enter JavaScript in the Code textbox and click Run or press Cmd-R/Ctrl-R.+  - In the window that opens, enter some JavaScript in the Code textbox and click Run or press Cmd-R/Ctrl-R.
  
 When running **asynchronous** code containing ''await'', the entered code is wrapped in an [[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function|async function]], allowing you to wait for the resolution of promises returned by functions. Most Zotero functions that access the database, disk, or network are asynchronous. In this mode, the value of a ''return'' statement will be displayed in the right-hand pane upon successful completion. E.g. returning the currently selected item(s) When running **asynchronous** code containing ''await'', the entered code is wrapped in an [[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function|async function]], allowing you to wait for the resolution of promises returned by functions. Most Zotero functions that access the database, disk, or network are asynchronous. In this mode, the value of a ''return'' statement will be displayed in the right-hand pane upon successful completion. E.g. returning the currently selected item(s)
Line 20: Line 20:
 </code> </code>
  
-In **synchronous** mode, the value of the final line will appear in the right-hand pane. The same result as above could be achieved in synchonous mode with+In **synchronous** mode, the value of the final line will appear in the right-hand pane. The same result as above could be achieved in synchronous mode with
  
 <code javascript> <code javascript>
Line 36: Line 36:
 Non-window scope applies to lower-level code that doesn't have access to the DOM. This includes the core ''Zotero'' object, which contains all other non-window code, including the data layer used for retrieving and modifying library data. In Zotero, non-window code is contained within the ''xpcom'' subdirectory. Non-window scope applies to lower-level code that doesn't have access to the DOM. This includes the core ''Zotero'' object, which contains all other non-window code, including the data layer used for retrieving and modifying library data. In Zotero, non-window code is contained within the ''xpcom'' subdirectory.
  
-Overlays and windows in Zotero can import the core ''Zotero'' object via the include.js script. Zotero methods can then be called from anywhere within the window's scope simply by calling, for example, ''var item = Zotero.Items.get(1);''.+Windows in Zotero can import the core ''Zotero'' object via the include.js script. Zotero methods can then be called from anywhere within the window's scope simply by calling, for example, ''var item = Zotero.Items.get(1);''.
  
-To access Zotero functionality from your own extension, you will need access to the core ''Zotero'' object. If your extension operates within the main browser overlay, you already have access to the ''Zotero'' object and don’t need to take further steps. Otherwise, you can import the Zotero object into other windows by including the script %%chrome://zotero/content/include.js%% within an HTML or XUL file:+To access Zotero functionality from your own extension, you will need access to the core ''Zotero'' object. If your extension operates within the main Zotero window, you already have access to the ''Zotero'' object and don’t need to take further steps. Otherwise, you can import the Zotero object into other windows by including the script %%chrome://zotero/content/include.js%% within an HTML or XUL file:
  
 <code html> <code html>
Line 87: Line 87:
     ]     ]
 ); );
-var itemID = await item.save();+var itemID = await item.saveTx();
 return itemID; return itemID;
 </code> </code>
Line 216: Line 216:
 s.addCondition('collection', 'is', collectionKey); // e.g., 'C72FDAP2' s.addCondition('collection', 'is', collectionKey); // e.g., 'C72FDAP2'
 s.addCondition('savedSearch', 'is', savedSearchKey); s.addCondition('savedSearch', 'is', savedSearchKey);
 +</code>
 +
 +=== Search by creator === 
 +
 +<code javascript>
 +var name = 'smith';
 +s.addCondition('creator', 'contains', name);
 </code> </code>
  
Line 236: Line 243:
 results: results:
  
-<code javascript>var results = await s.search();</code>+<code javascript>var itemIDs = await s.search();</code>
  
 This returns the item ids in the search as an array. The next thing to do is to get the Zotero items for the array of IDs: This returns the item ids in the search as an array. The next thing to do is to get the Zotero items for the array of IDs:
  
-<code javascript>var items = await Zotero.Items.getAsync(results);</code>+<code javascript>var items = await Zotero.Items.getAsync(itemIDs);</code>
  
 ==== Managing citations and bibliographies ==== ==== Managing citations and bibliographies ====
Line 340: Line 347:
 return fulltext; return fulltext;
 </code> </code>
 +
 +==== File I/O ====
 +
 +=== Getting the contents of a file ===
 +
 +<code javascript>
 +var path = '/Users/user/Desktop/data.json';
 +var data = await Zotero.File.getContentsAsync(path);
 +</code>
 +
 +=== Saving data to a file ===
 +
 +<code javascript>
 +var path = '/Users/user/Desktop/file.txt';
 +var data = "This is some text.";
 +await Zotero.File.putContentsAsync(path, data);
 +</code>
 +
  
 ==== To Do === ==== To Do ===
Line 356: Line 381:
  
 Before proceeding, back up your [[:zotero_data|Zotero data directory]] and temporarily disable auto-sync in the Sync pane of the Zotero preferences. Before proceeding, back up your [[:zotero_data|Zotero data directory]] and temporarily disable auto-sync in the Sync pane of the Zotero preferences.
 +
 +All examples operate on the currently selected library.
  
 ==== Example: Item Field Changes ==== ==== Example: Item Field Changes ====
Line 367: Line 394:
 var fieldID = Zotero.ItemFields.getID(fieldName); var fieldID = Zotero.ItemFields.getID(fieldName);
 var s = new Zotero.Search(); var s = new Zotero.Search();
-s.libraryID = Zotero.Libraries.userLibraryID;+s.libraryID = ZoteroPane.getSelectedLibraryID();
 s.addCondition(fieldName, 'is', oldValue); s.addCondition(fieldName, 'is', oldValue);
 var ids = await s.search(); var ids = await s.search();
Line 397: Line 424:
    
 var s = new Zotero.Search(); var s = new Zotero.Search();
-s.libraryID = Zotero.Libraries.userLibraryID;+s.libraryID = ZoteroPane.getSelectedLibraryID();
 s.addCondition('creator', 'is', oldName); s.addCondition('creator', 'is', oldName);
 var ids = await s.search(); var ids = await s.search();
Line 422: Line 449:
 return ids.length + " item(s) updated";</code> return ids.length + " item(s) updated";</code>
  
-==== Example: Delete Tags By Name ====+==== Example: Convert Manual Tag to Automatic ====
  
-<html><p id="zotero-5-update-warning" style="color: red; font-weight: bold">This example has not been updated for Zotero 5 and should not currently be used.</p></html>+Note that this will change all instances of the tag in the library.
  
-<code javascript>var tags = ["foo", "bar", "baz"]; +Replace "Foo" in the first line with the tag to change: 
-var ids = []; + 
-var allTags = Zotero.Tags.search(); +<code javascript>var tag = "Foo"; 
-tags = tags.map(tag => tag.toLowerCase()); +var s = new Zotero.Search(); 
-for (var id in allTags) { +s.libraryID = ZoteroPane.getSelectedLibraryID(); 
-    if (tags.indexOf(allTags[id].name.toLowerCase()) != -1) { +s.addCondition('tag', 'is', tag); 
-      ids.push(id); +var ids = await s.search(); 
-    }+if (!ids.length) { 
 +    return "No items found";
 } }
-Zotero.Tags.erase(ids); +await Zotero.DB.executeTransaction(async function () { 
-</code>+    for (let id of ids) { 
 +        let item = Zotero.Items.get(id); 
 +        item.addTag(tag, 1); 
 +        await item.save({ 
 +            skipDateModifiedUpdate: true 
 +        }); 
 +    } 
 +}); 
 +return ids.length + " tag(s) updated";</code>
  
 ==== Example: Delete Tags By Part of Name ==== ==== Example: Delete Tags By Part of Name ====
dev/client_coding/javascript_api.1585542867.txt.gz · Last modified: 2020/03/30 00:34 by dstillman