17 |
37 | `,
38 | onRender: ({ body, item }) => {
39 | const tallies = fetchTalliesZotero7(item)
40 | if (!tallies) {
41 | body.textContent = "No tallies loaded"
42 | } else {
43 | const doi = getDOI(item.getField('DOI'), item.getField('extra'));
44 |
45 | const fields = ['supporting', 'contrasting', 'mentioning', 'citingPublications'];
46 | fields.forEach(field => {
47 | const spanElement = body.querySelector(`#scite-plugin-item-pane-${field}-key`);
48 | if (spanElement) {
49 | spanElement.textContent = tallies[field]?.toLocaleString() || '-';
50 | spanElement.dataset.itemid = item ? `${item.id}-${field}-${tallies[field]}` : '';
51 | }
52 | });
53 |
54 | // Handle the report link
55 | const linkContainer = body.querySelector('#scite-plugin-item-pane-report-link-container');
56 | const linkElement = body.querySelector('#scite-plugin-item-pane-report-link');
57 | if (doi && linkContainer && linkElement) {
58 | linkContainer.style.display = 'block';
59 | linkElement.onclick = (event) => {
60 | event.preventDefault();
61 | const url = `https://scite.ai/reports/${encodeURIComponent(doi)}?utm_source=zotero&utm_medium=scite-zotero-plugin&utm_campaign=scite`;
62 | Zotero.launchURL(url);
63 | };
64 | } else if (linkContainer) {
65 | linkContainer.style.display = 'none';
66 | }
67 | }
68 | }
69 | }
--------------------------------------------------------------------------------
/bootstrap.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable prefer-arrow/prefer-arrow-functions, no-var, @typescript-eslint/no-unused-vars, no-caller, @typescript-eslint/explicit-module-boundary-types */
2 | declare const ChromeUtils: any
3 | declare const Cc: any
4 | declare const Ci: any
5 |
6 | if (typeof Zotero == 'undefined') {
7 | var Zotero
8 | }
9 |
10 | function log(msg) {
11 | msg = `[Scite Zotero] bootstrap: ${msg}`
12 | Zotero.logError(msg)
13 | }
14 |
15 | export function onMainWindowLoad({ window }) {
16 | log('onMainWindowLoad')
17 | window.MozXULElement.insertFTLIfNeeded('scite-zotero-plugin.ftl')
18 | }
19 |
20 | async function waitForZotero() {
21 | if (typeof Zotero != 'undefined') {
22 | await Zotero.initializationPromise
23 | return
24 | }
25 |
26 | // eslint-disable-next-line @typescript-eslint/no-shadow
27 | var { Services } = ChromeUtils.import('resource://gre/modules/Services.jsm')
28 | var windows = Services.wm.getEnumerator('navigator:browser')
29 | var found = false
30 | while (windows.hasMoreElements()) {
31 | const win = windows.getNext()
32 | if (win.Zotero) {
33 | Zotero = win.Zotero
34 | found = true
35 | break
36 | }
37 | }
38 | if (!found) {
39 | await new Promise(resolve => {
40 | var listener = {
41 | onOpenWindow(aWindow) {
42 | // Wait for the window to finish loading
43 | const domWindow = aWindow.QueryInterface(Ci.nsIInterfaceRequestor)
44 | .getInterface(Ci.nsIDOMWindowInternal || Ci.nsIDOMWindow)
45 | domWindow.addEventListener('load', function() {
46 | domWindow.removeEventListener('load', arguments.callee, false)
47 | if (domWindow.Zotero) {
48 | Services.wm.removeListener(listener)
49 | Zotero = domWindow.Zotero
50 | resolve(undefined)
51 | }
52 | }, false)
53 | },
54 | }
55 | Services.wm.addListener(listener)
56 | })
57 | }
58 | await Zotero.initializationPromise
59 | }
60 |
61 | async function install() {
62 | await waitForZotero()
63 | log('Installed Scite Plugin')
64 | }
65 |
66 | let chromeHandle
67 | async function startup({ id, version, resourceURI, rootURI = resourceURI?.spec }) {
68 | try {
69 | await waitForZotero()
70 | if (typeof Services == 'undefined') {
71 | var { Services } = ChromeUtils.import('resource://gre/modules/Services.jsm')
72 | }
73 |
74 | var aomStartup = Cc['@mozilla.org/addons/addon-manager-startup;1'].getService(Ci.amIAddonManagerStartup)
75 | var manifestURI = Services.io.newURI(rootURI + 'client/manifest.json')
76 |
77 | // Register chrome resources
78 | chromeHandle = aomStartup.registerChrome(manifestURI, [
79 | [ 'content', 'scite-zotero-plugin', rootURI + 'content/' ],
80 | [ 'locale', 'scite-zotero-plugin', 'en-US', rootURI + 'locale/en-US/' ],
81 | ])
82 |
83 | Services.scriptloader.loadSubScript(`${rootURI}lib.js`)
84 | Zotero.Scite.start(rootURI).catch(err => Zotero.logError(err))
85 | log('Started Zotero Scite')
86 | const $window = Zotero.getMainWindow()
87 | onMainWindowLoad({ window: $window })
88 | }
89 | catch (err) {
90 | Zotero.logError('[Scite Zotero] Error during startup')
91 | Zotero.logError(err)
92 | }
93 | }
94 |
95 | function shutdown() {
96 | log('Shutting down')
97 |
98 | // Remove stylesheet
99 | var zp = Zotero.getActiveZoteroPane()
100 |
101 | Zotero.Scite.unload().catch(err => Zotero.logError(err))
102 |
103 | // Deregister chrome
104 | if (chromeHandle) {
105 | chromeHandle.destruct()
106 | chromeHandle = null
107 | }
108 |
109 | Zotero.Scite = undefined
110 | }
111 |
112 | function uninstall() {
113 | log('Uninstalled')
114 | }
115 |
116 | export { install, startup, shutdown, uninstall }
117 |
--------------------------------------------------------------------------------
/lib.ts:
--------------------------------------------------------------------------------
1 | import { IZotero } from './typings/global'
2 |
3 | Components.utils.import('resource://gre/modules/AddonManager.jsm')
4 |
5 | declare const Zotero: IZotero
6 | declare const Components: any
7 |
8 | import { debug } from './client/content/debug'
9 | import { htmlencode, plaintext, getField, getDOI, isShortDoi, isZotero7 } from './client/content/util'
10 | import { PLUGIN_ENABLED } from './client/content/config'
11 | import { sciteColumnsZotero7 } from './client/content/columns'
12 | import { sciteItemPaneZotero7 } from './client/content/itemPane'
13 |
14 | interface Tallies {
15 | doi: string
16 | contrasting: number // NOTE: The API returns contradicting, we map this manually
17 | mentioning: number
18 | supporting: number
19 | total: number
20 | unclassified: number
21 | citingPublications: number
22 | }
23 |
24 | const shortToLongDOIMap = {}
25 | const longToShortDOIMap = {}
26 | const MAX_DOI_BATCH_SIZE = 500 // tslint:disable-line:no-magic-numbers
27 |
28 | async function getLongDoi(shortDoi) {
29 | try {
30 | if (!shortDoi) {
31 | return ''
32 | }
33 | // If it starts with 10/, it is short
34 | // otherwise, treat it as long and just return
35 | shortDoi = shortDoi.toLowerCase().trim()
36 | if (!isShortDoi(shortDoi)) {
37 | // This is probably a long DOI then!
38 | return shortDoi
39 | }
40 | if (shortDoi in shortToLongDOIMap) {
41 | debug(`shortToLongDOIMap cache hit ${shortDoi}`)
42 | return shortToLongDOIMap[shortDoi]
43 | }
44 |
45 | const res = await Zotero.HTTP.request('GET', `https://doi.org/api/handles/${shortDoi}`)
46 | const doiRes = res?.response ? JSON.parse(res.response).values : []
47 | const longDoi = (doiRes && doiRes.length && doiRes.length > 1) ? doiRes[1].data.value.toLowerCase().trim() : ''
48 | if (!longDoi) {
49 | debug(`Unable to resolve shortDoi ${shortDoi} to longDoi`)
50 | // I guess just return the shortDoi for now...?
51 | return shortDoi
52 | }
53 |
54 | // Use these to minimize API calls and easily go back and forth
55 | shortToLongDOIMap[shortDoi] = longDoi
56 | longToShortDOIMap[longDoi] = shortDoi
57 |
58 | debug(`Converted shortDoi (${shortDoi}) to longDoi (${longDoi})`)
59 | return longDoi
60 | }
61 | catch (err) {
62 | Zotero.logError(`ERR_getLongDoi(${shortDoi}): ${err}`)
63 | return shortDoi
64 | }
65 | }
66 |
67 | const ready = Zotero.Promise.defer()
68 |
69 | export class CScite {
70 | public ready: any = ready.promise
71 | public tallies: { [DOI: string]: Tallies } = {}
72 | public uninstalled: boolean = false
73 |
74 | private bundle: any
75 | private started = false
76 |
77 | constructor() {
78 | this.bundle = Components.classes['@mozilla.org/intl/stringbundle;1'].getService(Components.interfaces.nsIStringBundleService).createBundle('chrome://zotero-scite/locale/zotero-scite.properties')
79 | }
80 |
81 | public async start(rootURI: string = '') {
82 | if (!PLUGIN_ENABLED) {
83 | Zotero.logError('Scite Zotero plugin is disabled. Aborting!')
84 | return
85 | }
86 |
87 | if (!isZotero7) {
88 | Zotero.logError('This version of the scite plugin only supports Zotero 7 and after, please upgrade or use an older XPI')
89 | return
90 | }
91 |
92 | if (this.started) return
93 | this.started = true
94 |
95 | const columns = sciteColumnsZotero7.map(column => {
96 | const iconPath = column.iconPath ? rootURI + column.iconPath : null
97 | return {
98 | ...column,
99 | iconPath,
100 | htmlLabel: iconPath
101 | ? `
18 | # Supporting
19 |
20 |
21 |
22 | # Contrasting
23 |
24 |
25 |
26 | # Mentioning
27 |
28 |
29 |
30 | # Citing Publications
31 |
32 |
33 |
36 | 
10 |
11 | It currently lets you do two main things:
12 | - See classification tallies for each paper based on our Smart Citation data
13 | - Easily go to the scite report page (see below)
14 |
15 | ### Smart Citation Classification Tallies
16 |
17 | Once you install the plugin (see below section for instructions), each row will have columns for `Supporting`, `Mentioning`, `Contrasting`, `Total Smart Citations`, and `Total Distinct Citing Publications`. The values in this cell tell you, for a given paper, how many citations there are in the scite database with the corresponding classification.
18 |
19 | You may need to right click and enable the columns to see them.
20 |
21 | 
22 |
23 | For example, here, the paper titled `Psychometric Properties of the Strengths and Difficulties Questionnaire` has received `207 supporting citations`, `26 contrasting citations`, `4,874 mentioning citations`, and `5,550 traditional citations` from other publications in our database. Note that a traditional citation is what you expect, i.e. a paper to paper level citation. A Smart Citation, like supporting, mentioning, contrasting, is unique to Scite because we index full-text articles from publishers and classify the intent of the citations based on our own deep learning models. You can [read about scite here](https://direct.mit.edu/qss/article/2/3/882/102990/scite-A-smart-citation-index-that-displays-the) or visit our [homepage to learn more](https://scite.ai).
24 |
25 | You can also sort on any of these 3 columns to see which papers are the most supported, contrasted, and so on.
26 |
27 | ### Viewing a scite report
28 |
29 | In order to explore the citation snippets around these classifications, you can view the scite report for the paper of interest through the item pane on the right, which shows the same metrics but in a panel. Simply select `View Scite Report`. It should open the URL directly in your browser.
30 |
31 | 
32 |
33 | ## Installation
34 |
35 | Get the XPI file from https://github.com/scitedotai/scite-zotero-plugin/releases and install it in Zotero following the normal plugin procedure.
36 |
37 | To install a plugin in Zotero, download its .xpi file to your computer. Then, in Zotero, click “Tools → Plugins”, then drag the .xpi for the plugin onto the Plugins Manager window that opens.
38 |
39 | ## Changelog
40 |
41 | NOTE: You only need to download once; it will auto update afterwards!
42 |
43 | ### [2.0.2](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v2.0.2)
44 |
45 | - Fixes bug in Z7 compatible plugin where column sorting broke because the numbers were being converted to strings.
46 |
47 | ### [2.0.1](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v2.0.1)
48 |
49 | - Adds support for Zotero 7 (not backwards compatible).
50 |
51 | ### [1.11.6](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.11.6)
52 |
53 | - Removes scite icon from each cell; moves it into the header. Fixes a bug where one of the cells had unnecessary padding to the left. Also adds React to support using icons in the column header via `iconLabel`.
54 |
55 | ### [1.11.5](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.11.5)
56 |
57 | - Re-enables scite plugin and fixes bug in patched `getField` function which was raising an exception for `int` fields being passed in, causing non-scite specific columns to go into the exception handler, which swallowed the exception and returned 0. This exception handler now only happens on scite specific columns as intended, and the handling of `field` is more robust to prevent the identified sources of exceptions.
58 |
59 | ### [1.11.4](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.11.4)
60 |
61 | - Disables the scite plugin from doing anything when it loads -- due to intermittent bug found in Zotero 6 upgrade.
62 |
63 | ### [1.11.3](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.11.3)
64 |
65 | - Fix bug where column sorting on scite specific columns did not work in Zotero 6.
66 |
67 | ### [1.11.2](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.11.2)
68 |
69 | - Upgrade `zotero-plugin` dependency with support for Zotero 6 (backwards compatible), and use eslint instead of tslint.
70 |
71 | ### [1.11.1](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.11.1)
72 |
73 | - Properly match scite column during `getField` call in XUL tree version.
74 |
75 | ### [1.11.0](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.11.0)
76 |
77 | - Fix bug in beta build where the tally information in each row was not refreshed after the initial load from the API.
78 |
79 | ### [1.10.0](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.10.0)
80 |
81 | - Add backwards-compatible support for upcoming Zotero release. This specifically makes the plugin work with the build `Zotero-5.0.97-beta.43+c5d89f6d0` but should generally support the new HTML based structure (in addition to the XUL version for any users who do not upgrade).
82 | ### [1.0.9](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.9)
83 |
84 | - Fix edge case in how DOI is retrieved from zotero library metadata (prevents a JavaScript exception).
85 |
86 | ### [1.0.8](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.8)
87 |
88 | - Add columns for Total Smart Citations and Total Distinct Citing Publications (for example: if `paper X` references `paper Y` a total of 4 times, then the count of Smart Citations for paper Y will be 4, and the count of citing publications will be 1. This is because Smart Citations count each individual in-text reference and are not grouped at the citing publication level.)
89 |
90 | ### [1.0.7](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.7)
91 |
92 | - Use DOMParser and XMLSerializer.
93 |
94 | ### [1.0.6](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.6)
95 |
96 | - Rename disputed to contrasted, and change the color of the icon from orange to blue.
97 |
98 | ### [1.0.5](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.5)
99 |
100 | - Fix auto-update bug.
101 |
102 | ### [1.0.4](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.4)
103 |
104 | - Add ability to resize `Supporting`, `Mentioning`, and `Disputing` columns.
105 | ### [1.0.3](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.3)
106 |
107 | - Minor logging changes, trim whitespace from DOIs, and properly supports automatic updates.
108 |
109 | ### [1.0.2](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.2)
110 |
111 | - Fixes bug where DOIs during bulk refresh were not properly being lower cased, and adds debug logging to triage issues in the future if it persists in other edge cases.
112 |
113 | ### [1.0.1](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.1)
114 |
115 | - Fixes bug where DOI wasn't being lowercased properly
116 |
117 | ### [1.0.0](https://github.com/scitedotai/scite-zotero-plugin/releases/tag/v1.0.0)
118 |
119 | Release initial version of plugin that allows you to:
120 | - See the # supporting cites (separate column, sortable)
121 | - See the # mentioning cites (separate column, sortable)
122 | - See the # disputing cites (separate column, sortable)
123 | - Directly view a scite report by right-clicking on a row and clicking 'View scite report')
124 | - Refreshing the tallies whenever you want (right-click row and click the refresh tallies option)
125 |
126 | ## Instructions for local development
127 |
128 | (These were originally from https://www.zotero.org/support/dev/client_coding/plugin_development but replicated here for convenience)
129 |
130 | - Clone the repo
131 | - `npm install` to get any dependencies
132 | - `npm run build` will generate a `build/` folder for you. You should see an `install.rdf` file in this directory. If you open it, find the `