Script to read local file, rename the abbr field

[HuimingPan]

Description

In this script, I want to rename the item's field "Journal Abbr" based on the item's field Publication or Proceedings Title, and a local csv file recording the full names and the short names.

However, it doesn't work. I'm totally new to JavaScript and Zotero API. So, I'd like to know where to start fix it.

Event

None

Operation

Script

Data

/**
 * A description of this script.
 * @author Zotero Community
 * @usage 
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/
 */
const fs = require("fs");
const { Zotero, Zotero_Tabs, console, alert } = require('window');

function loadTable(path) {
    const tableData = fs.readFileSync(path, 'utf8').split('\n').map(line => line.split(','));
    const table = {};

    for (const row of tableData) {
        const [key, value] = row;
        table[key] = value;
    }

    return table;
}

function FindAbbr(journal, table) {
    return table[journal] || "Unknown";
}

if (item) {
    const path = "E:\\OneDrive - sjtu.edu.cn\\Others\\Zotero\\JournalAbbr.csv";
    const table = loadTable(path);
    const journal = item.getField("Publication");
    const abbr = FindAbbr(journal, table);
    item.setField("Journal Abbr", abbr);
    return item.getField('title');
} else {
    return `[Info] No item!`
}

Anything else

No response

[windingwind]

Zotero is not a Node environment and const fs = require("fs"); won't work. You'll need to use Zotero.File.getContentsAsync.

[HuimingPan]

Thanks, here is an updated script, which partially works. It successfully changed a single item's journal abbreviation. But when it comes to multiple items, the script stuck and broken down.

/**
 * The journal names imported automatically are not uniform in case. 
 * This script automatically retrieves standard journal names based on the CrossRef database.
 * update: 2024/01/03 11:29:34 GMT+8
 * @author Guanjie Wang
 * @usage Select an item in the library and press the assigned shortcut keys
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/374
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/374
 */
// Predefined table with known journal abbreviations
async function loadTable(path) {
    try {
        const fileContent = await Zotero.File.getContentsAsync(path);
        const table = new Map();
        const rows = fileContent.split('\n');
        
        for (const row of rows) {
            const [key, value] = row.split(',');
            if (key && value) {
                table.set(key.trim(), value.trim());
            }
        }
        
        return table;
    } catch (error) {
        Zotero.debug("Error reading file: " + error);
        return new Map();
    }
}

// Function to find the abbreviation for a given journal
function FindAbbr(journal, table) {
	return table.get(journal) || "Unknown"; // Return "Unknown" if the journal is not found
}

// Get the selected items in Zotero
var items = Zotero.getActiveZoteroPane().getSelectedItems();
const path = "E:\\OneDrive - sjtu.edu.cn\\Others\\Zotero\\JournalAbbr.csv";
const table = await loadTable(path);


for (let item of items) {
    // Ensure the item is a regular Zotero item (not a collection or note)
    if (item.isRegularItem() && !(item instanceof Zotero.Collection)) {
        var journal = item.getField("publicationTitle");

        // Find the abbreviation for the journal
        var abbr = FindAbbr(journal, table);

        // Set the abbreviation in the "Journal Abbr" field
        item.setField("journalAbbreviation", abbr);
		return abbr
    }
}

[windingwind]

No need to manually get items from ZoteroPane. Please read the instructions about variables in script in the readme.

[windingwind]

Also, as you return at the first execution of the for loop, only the first item will be processed

[HuimingPan]

Thank you for pointing it out. Now it works. However, I don't know "No need to manually get items from ZoteroPane". With this command, only the selected items will be processed.

/**
 * The journal names imported automatically are not uniform in case. 
 * This script automatically retrieves standard journal names based on the CrossRef database.
 * update: 2024/01/03 11:29:34 GMT+8
 * @author Huiming Pan
 * @usage Select items in the library and press the assigned shortcut keys
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/374
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/374
 */
// Predefined table with known journal abbreviations
async function loadTable(path) {
    try {
        const fileContent = await Zotero.File.getContentsAsync(path);
        const table = new Map();
        const rows = fileContent.split('\n');
        
        for (const row of rows) {
            const [key, value] = row.split(',');
            if (key && value) {
                table.set(key.trim(), value.trim());
            }
        }
        
        return table;
    } catch (error) {
        Zotero.debug("Error reading file: " + error);
        return new Map();
    }
}

// Function to find the abbreviation for a given journal
function FindAbbr(journal, table) {
	return table.get(journal) || "Unknown"; // Return "Unknown" if the journal is not found
}

// Get the selected items in Zotero
var items = Zotero.getActiveZoteroPane().getSelectedItems();
const path = "E:\\OneDrive - sjtu.edu.cn\\Others\\Zotero\\JournalAbbr.csv";
const table = await loadTable(path);


for (let item of items) {
    // Ensure the item is a regular Zotero item (not a collection or note)
    if (item.isRegularItem() && !(item instanceof Zotero.Collection)) {
        var journal = item.getField("publicationTitle");

        // Find the abbreviation for the journal
        var abbr = FindAbbr(journal, table);

        // Set the abbreviation in the "Journal Abbr" field
        item.setField("journalAbbreviation", abbr);
    }
}

[HuimingPan]

To anyone who wants to use this script, remember to change the variable path to your own one.

The JournalAbbr.csv looks like as below. The first column is the full name of the journal, and the second column is the corresponding abbreviation.

Science                                                            ,Science
Science Advances                                                   ,SA
Science Robotics                                                   ,SR
Scientific Reports                                                 ,SRE

[windingwind]

As I said, please read the relevant section in the readme. The plugin will pass items and item variables, depending on where you trigger the action. Don’t manually get item from ZoteroPane.

[windingwind]

items: The target items[] array. Only available in menu/shortcut-triggered actions, otherwise it's null.

When selecting multiple items in the library, the action will be triggered once for all items (items=[...], item=undefined) and then one by one for each item (items=[], item=...). You can use the items variable to get the selected items array and avoid duplicate executions.

For N selected items, your current script will execute N*(N+1) times on each item. If the action is triggered from the reader's menu, the reader's item will not be used as the target.

You should use the items variable provided by the plugin, instead of always getting it from the current ZoteroPane.

[HuimingPan]

Updated script, which can:

• Update the abbreviations of journal articles and conference papers.
• The abbreviations are in the archive column.

async function loadTable(path) {
  try {
    const fileContent = await Zotero.File.getContentsAsync(path);
    const journalTable = new Map();
    const conferenceTable = new Map();
    const rows = fileContent.split('\n');

    for (const row of rows) {
      // Use a regular expression to match the CSV format, including quoted strings
      const match = row.match(/^(journal|conference),[ "]*([^"]*)"?,(.+)/);
//       console.log(match)
      if (match) {
        const [_, type, key, value] = match;
        if (type && key && value) {
          if (type === 'journal') {
            journalTable.set(key.trim().toLowerCase(), value.trim());
          } else if (type === 'conference') {
            conferenceTable.set(key.trim().toLowerCase(), value.trim());
          }
        }
      }
    }

    return {
      journalTable,
      conferenceTable
    };
  } catch (error) {
    Zotero.debug("Error reading file: " + error);
    return {
      journalTable: new Map(),
      conferenceTable: new Map()
    };
  }
}

function FindJournalAbbr(journal, journalTable) {
  return journalTable.get(journal.trim().toLowerCase()) || "Unknown"; // Return "Unknown" if the journal is not found
}

function FindConferenceAbbr(conf, conferenceTable) {
  // Iterate through the conferenceTable to find an exact match
  for (let [fullTitle, abbreviation] of conferenceTable.entries()) {
    if (conf.trim().toLowerCase().includes(fullTitle)) {
      return abbreviation;
    }
  }
  return "Unknown"; // Return "Unknown" if the conference is not found
}


const path = "E:\\OneDrive - sjtu.edu.cn\\Others\\Zotero\\JournalAbbr.csv";
const {
  journalTable,
  conferenceTable
} = await loadTable(path);

var items = Zotero.getActiveZoteroPane().getSelectedItems();

for (let item of items) {
  if (item.isRegularItem() && !(item instanceof Zotero.Collection)) {
    if (item.itemType == 'journalArticle') {
      var journal = item.getField("publicationTitle");
      var abbr = FindJournalAbbr(journal, journalTable);
      if(abbr == "Unknown"){abbr = journal}
      item.setField("archive", abbr);
       
    } 
    
    else if (item.itemType == 'conferencePaper') {
      var proceedingsTitle = item.getField("proceedingsTitle");
      if (proceedingsTitle == "") {
        var proceedingsTitle = item.getField("conferenceName");
      }
      const yearPattern = /\b(19|20)\d{2}\b/g;
      var yearMatch = proceedingsTitle.match(yearPattern);
      var year = yearMatch ? yearMatch[0] : "000";

      var confAbbr = FindConferenceAbbr(proceedingsTitle, conferenceTable);
      var abbr = confAbbr + year;

      item.setField("archive", abbr);
    }
    
    else if (item.itemType == 'preprint'){
      abbr = item.getField("repository");
      item.setField("archive", abbr);
    }
    
    else{
      item.setField("archive", "Unknown");
    }
  }
  
}

[windingwind]

Please share any script under the Action Scripts category. Also, we strongly encourage you to always edit the original post with the latest version of the script, instead of posting in a new reply, which confuses users. Thanks

[HuimingPan]

Get it. No problem