Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
dev:client_coding:javascript_api [2019/06/11 03:44] – [Running Ad Hoc JavaScript in Zotero] dstillman | dev:client_coding:javascript_api [2020/04/16 16:03] – [Running Ad Hoc JavaScript in Zotero] dstillman | ||
---|---|---|---|
Line 10: | Line 10: | ||
Zotero includes an option to run arbitrary privileged JavaScript: | Zotero includes an option to run arbitrary privileged JavaScript: | ||
- | | + | - In the Tools → Developer |
- | | + | - In the window that opens, enter some JavaScript in the Code textbox and click Run or press Cmd-R/ |
- | - In the window that opens, enter JavaScript in the Code textbox and click Run or press Cmd-R/ | + | |
- | To run asynchronous code, check the "Run as async function" | + | When running **asynchronous** code containing '' |
- | In synchronous mode, the value of the final line will appear in the right-hand pane. | + | <code javascript> |
+ | var items = Zotero.getActiveZoteroPane().getSelectedItems(); | ||
+ | return items; | ||
+ | </ | ||
+ | |||
+ | 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> | ||
+ | var items = Zotero.getActiveZoteroPane().getSelectedItems(); | ||
+ | items; | ||
+ | </ | ||
===== Zotero Code Architecture ===== | ===== Zotero Code Architecture ===== | ||
Line 233: | Line 242: | ||
<code javascript> | <code javascript> | ||
- | ===== Managing citations and bibliographies | + | ==== Managing citations and bibliographies ==== |
TODO: this is pretty sparse. | TODO: this is pretty sparse. | ||
- | ==== Getting a bibliography for an array of items: | + | === Getting a bibliography for an array of items: === |
Here we use Zotero' | Here we use Zotero' | ||
- | specified in Zotero' | + | specified in Zotero' |
+ | bibliography from all currently selected items. | ||
- | First we start with a list of as in the previous entry. | + | <code javascript> |
- | + | var qc = Zotero.QuickCopy; | |
- | <code javascript> | + | var format |
- | var biblio | + | if (format.split(" |
- | var biblio_html_format = cite.html; | + | |
- | var biblio_txt | + | } |
+ | var biblio = qc.getContentFromItems(items, | ||
+ | var biblio_html_format = biblio.html; | ||
+ | var biblio_txt = biblio.text; | ||
</ | </ | ||
- | ==== Get a list of available styles | + | If you instead want to have the citation string then simply replace the 7th |
+ | line with '' | ||
+ | |||
+ | |||
+ | === Get a list of available styles === | ||
<code javascript> | <code javascript> | ||
Line 262: | Line 279: | ||
</ | </ | ||
- | TODO: get citations. | + | TODO: change the style. |
especially RTF | especially RTF | ||
Line 336: | Line 353: | ||
===== Batch Editing ===== | ===== Batch Editing ===== | ||
- | The JavaScript API can provide | + | The JavaScript API provides |
Before proceeding, back up your [[: | Before proceeding, back up your [[: | ||
Line 369: | Line 386: | ||
https:// | https:// | ||
+ | |||
+ | ==== Example: Creator Name Changes ==== | ||
+ | |||
+ | Edit the first four lines as necessary: | ||
+ | |||
+ | <code javascript> | ||
+ | var newFirstName = " | ||
+ | var newLastName = " | ||
+ | var newFieldMode = 0; // 0: two-field, 1: one-field (with empty first name) | ||
+ | |||
+ | var s = new Zotero.Search(); | ||
+ | s.libraryID = Zotero.Libraries.userLibraryID; | ||
+ | s.addCondition(' | ||
+ | var ids = await s.search(); | ||
+ | if (!ids.length) { | ||
+ | return "No items found"; | ||
+ | } | ||
+ | await Zotero.DB.executeTransaction(async function () { | ||
+ | for (let id of ids) { | ||
+ | let item = await Zotero.Items.getAsync(id); | ||
+ | let creators = item.getCreators(); | ||
+ | let newCreators = []; | ||
+ | for (let creator of creators) { | ||
+ | if (`${creator.firstName} ${creator.lastName}`.trim() == oldName) { | ||
+ | creator.firstName = newFirstName; | ||
+ | creator.lastName = newLastName; | ||
+ | creator.fieldMode = newFieldMode; | ||
+ | } | ||
+ | newCreators.push(creator); | ||
+ | } | ||
+ | item.setCreators(newCreators); | ||
+ | await item.save(); | ||
+ | } | ||
+ | }); | ||
+ | return ids.length + " item(s) updated";</ | ||
==== Example: Delete Tags By Name ==== | ==== Example: Delete Tags By Name ==== |