[Share] copy zotero markdown link with citation info/复制作者-年份引用markdown条目链接

[littleironx]

Description

modify based on Copy Zotero link

this script can generate a markdown link with citation infomation such as A&B(2024)[zotero://select]

Event

None

Operation

None

Data

// @author littleiron
// @usage Select an item in the library and press the assigned shortcut keys

// EDIT THESE SETTINGS

/** @type {string} Name of the field to use as the link text. To use the citation key, set this to "citationKey". */
let linkTextField = "title";

/** @type {'html' | 'md' | 'plain'} What type of link to create. */
let linkType = "md";

/** @type {boolean} If true, make the link specific to the currently selected collection. */
let useColl = false;

/** @type {boolean} If true, use Better Notes zotero://note link when the selected item is a note. */
let useNoteLink = false;

/** @type {'select' | 'open-pdf' | 'auto'} Action of link*/
let linkAction = "auto"; // auto = open-pdf for PDFs and annotations, select for everything else

// 添加新的设置选项
/** @type {boolean} 是否使用作者-年份格式 */
let useAuthorYearFormat = true;

// END OF EDITABLE SETTINGS

// For efficiency, only execute once for all selected items
if (item) return;
item = items[0];
if (!item && !collection) return "[Copy Zotero Link] item is empty";

if (collection) {
  linkAction = "select";
  useColl = true;
}

if (linkAction === "auto") {
  if (item.isPDFAttachment() || item.isAnnotation()) {
    linkAction = "open-pdf";
  } else {
    linkAction = "select";
  }
}

const uriParts = [];
let uriParams = "";

let targetItem = item;
if (linkAction === "open-pdf") {
  uriParts.push("zotero://open-pdf");
  if (item.isRegularItem()) {
    targetItem = (await item.getBestAttachments()).find((att) =>
      att.isPDFAttachment()
    );
  } else if (item.isAnnotation()) {
    targetItem = item.parentItem;
    // If the item is an annotation, we want to open the PDF at the page of the annotation
    let pageIndex = 1;
    try {
      pageIndex = JSON.parse(item.annotationPosition).pageIndex + 1;
    } catch (e) {
      Zotero.warn(e);
    }
    uriParams = `?page=${pageIndex}&annotation=${item.key}`;
  }
} else {
  uriParts.push("zotero://select");
  if (item?.isAnnotation()) {
    targetItem = item.parentItem;
  }
}

if (!targetItem && !collection) return "[Copy Zotero Link] item is invalid";

// 在生成linkText的部分添加新的逻辑
let linkText;
if (useAuthorYearFormat && !collection) {
  let creators = item.getCreators();
  let year = item.getField('year');
  
  if (creators.length > 0) {
    let authorName;
    if (creators.length === 1) {
      authorName = creators[0].lastName || creators[0].name;
    } else if (creators.length === 2) {
      authorName = `${creators[0].lastName || creators[0].name} & ${creators[1].lastName || creators[1].name}`;
    } else {
      authorName = `${creators[0].lastName || creators[0].name} et al.`;
    }
    linkText = `${authorName}(${year})`;
  } else {
    linkText = year ? `(${year})` : item.getField(linkTextField);
  }
} else if (collection) {
  // 使用现有的collection逻辑
  linkText = collection.name;
} else {
  // 使用现有的item逻辑
  linkText = item.getField(linkTextField);
}

// Add the library or group URI part (collection must go first)
let libraryType = (collection || item).library.libraryType;
if (libraryType === "user") {
  uriParts.push("library");
} else {
  uriParts.push(
    `groups/${Zotero.Libraries.get((collection || item).libraryID).groupID}`
  );
}

// If useColl, make the link collection specific
if (useColl) {
  // see https://forums.zotero.org/discussion/73893/zotero-select-for-collections
  let coll = collection || Zotero.getActiveZoteroPane().getSelectedCollection();

  // It's possible that a collection isn't selected. When that's the case,
  // this will fall back to the typical library behavior.

  // If a collection is selected, add the collections URI part
  if (!!coll) uriParts.push(`collections/${coll.key}`);
}

if (!collection) {
  // Add the item URI part
  uriParts.push(`items/${targetItem.key}`);
}

// Join the parts together
let uri = uriParts.join("/");

// Add the URI parameters
if (uriParams) {
  uri += uriParams;
}

if (useNoteLink && item?.isNote() && Zotero.BetterNotes) {
  uri = Zotero.BetterNotes.api.convert.note2link(item);
}

// Format the link and copy it to the clipboard
const clipboard = new Zotero.ActionsTags.api.utils.ClipboardHelper();
if (linkType == "html") {
  clipboard.addText(`<a href="${uri}">${linkText}</a>`, "text/unicode");
} else if (linkType == "md") {
  clipboard.addText(`[${linkText}](${uri})`, "text/unicode");
} else {
  clipboard.addText(uri, "text/unicode");
}

clipboard.addText(`<a href="${uri}">${linkText}</a>`, "text/html");

clipboard.copy();

return `[Copy Zotero Link] link ${uri} copied.`;

Anything else

No response

[Ghiclgi]

There could be another solution with Better Bibtex:

/**
 * Create a Markdown link with Citation Key (Better BibTeX)
 * Example: `[Author (year)](zotero://select/items/@citationKey)`
 * Use the item pane header (in Zotero 7) as the text for the hyperlink.
*/

if (items?.length > 0) {
	// Do something with all selected items
	return "Please select one item instead.";
}

let citationKey = item.getField('citationKey'); // Replace 'citationKey'
// use item pane header as the text
let doc = Zotero.getActiveZoteroPane().document;
let creatorYearText = doc.querySelector('item-pane-header .creator-year').textContent
// Combine the strings
let result = `[` + creatorYearText + `](zotero://select/items/@` + citationKey + `)`

Zotero.Utilities.Internal.copyTextToClipboard(result)
return "Markdown link copied.";

[like1river2east]

if anyone prefer the form ""LastNameoftheFirstAuthor"-2024-"NameoftheItem"", please try the following code I modified.
eg."[Simos-2020-Thermally induced cracking on the massive concrete structure of the NSLS II synchrotron and its engineering remediationNSLS II](zotero://select/library/items/XXXXXXXX)"

// @author littleiron
// @usage Select an item in the library and press the assigned shortcut keys

// EDIT THESE SETTINGS

/** @type {string} Name of the field to use as the link text. To use the citation key, set this to "citationKey". */
let linkTextField = "title";

/** @type {'html' | 'md' | 'plain'} What type of link to create. */
let linkType = "md";

/** @type {boolean} If true, make the link specific to the currently selected collection. */
let useColl = false;

/** @type {boolean} If true, use Better Notes zotero://note link when the selected item is a note. */
let useNoteLink = false;

/** @type {'select' | 'open-pdf' | 'auto'} Action of link*/
let linkAction = "auto"; // auto = open-pdf for PDFs and annotations, select for everything else

// 添加新的设置选项
/** @type {boolean} 是否使用作者-年份格式 */
let useAuthorYearFormat = true;

// END OF EDITABLE SETTINGS

// For efficiency, only execute once for all selected items
if (item) return;
item = items[0];
if (!item && !collection) return "[Copy Zotero Link] item is empty";

if (collection) {
  linkAction = "select";
  useColl = true;
}

if (linkAction === "auto") {
  if (item.isPDFAttachment() || item.isAnnotation()) {
    linkAction = "open-pdf";
  } else {
    linkAction = "select";
  }
}

const uriParts = [];
let uriParams = "";

let targetItem = item;
if (linkAction === "open-pdf") {
  uriParts.push("zotero://open-pdf");
  if (item.isRegularItem()) {
    targetItem = (await item.getBestAttachments()).find((att) =>
      att.isPDFAttachment()
    );
  } else if (item.isAnnotation()) {
    targetItem = item.parentItem;
    // If the item is an annotation, we want to open the PDF at the page of the annotation
    let pageIndex = 1;
    try {
      pageIndex = JSON.parse(item.annotationPosition).pageIndex + 1;
    } catch (e) {
      Zotero.warn(e);
    }
    uriParams = `?page=${pageIndex}&annotation=${item.key}`;
  }
} else {
  uriParts.push("zotero://select");
  if (item?.isAnnotation()) {
    targetItem = item.parentItem;
  }
}

if (!targetItem && !collection) return "[Copy Zotero Link] item is invalid";

// 在生成linkText的部分添加新的逻辑
let linkText;
if (useAuthorYearFormat && !collection) {
  let creators = item.getCreators();
  let year = item.getField('year');
  
  if (creators.length > 0) {
    let authorName = creators[0].lastName; // 仅使用第一作者的姓
    let title = item.getField('title'); // 获取文献条目的名称
    linkText = `${authorName}-${year}-${title}`;
  } else {
    linkText = year ? `(${year})` : item.getField(linkTextField);
  }
} else if (collection) {
  // 使用现有的collection逻辑
  linkText = collection.name;
} else {
  // 使用现有的item逻辑
  linkText = item.getField(linkTextField);
}

// Add the library or group URI part (collection must go first)
let libraryType = (collection || item).library.libraryType;
if (libraryType === "user") {
  uriParts.push("library");
} else {
  uriParts.push(
    `groups/${Zotero.Libraries.get((collection || item).libraryID).groupID}`
  );
}

// If useColl, make the link collection specific
if (useColl) {
  // see https://forums.zotero.org/discussion/73893/zotero-select-for-collections 
  let coll = collection || Zotero.getActiveZoteroPane().getSelectedCollection();

  // It's possible that a collection isn't selected. When that's the case,
  // this will fall back to the typical library behavior.

  // If a collection is selected, add the collections URI part
  if (!!coll) uriParts.push(`collections/${coll.key}`);
}

if (!collection) {
  // Add the item URI part
  uriParts.push(`items/${targetItem.key}`);
}

// Join the parts together
let uri = uriParts.join("/");

// Add the URI parameters
if (uriParams) {
  uri += uriParams;
}

if (useNoteLink && item?.isNote() && Zotero.BetterNotes) {
  uri = Zotero.BetterNotes.api.convert.note2link(item);
}

// Format the link and copy it to the clipboard
const clipboard = new Zotero.ActionsTags.api.utils.ClipboardHelper();
if (linkType == "html") {
  clipboard.addText(`<a href="${uri}">${linkText}</a>`, "text/unicode");
} else if (linkType == "md") {
  clipboard.addText(`[${linkText}](${uri})`, "text/unicode");
} else {
  clipboard.addText(uri, "text/unicode");
}

clipboard.addText(`<a href="${uri}">${linkText}</a>`, "text/html");

clipboard.copy();

return `[Copy Zotero Link] link ${uri} copied.`;