[Share] After creating annotations, automatically remove spaces and garbled characters from the content

[yzy1228682367]

Is there an existing issue for this?

• I have searched the existing issues

Environment

• OS: macOS Sonoma 14.1.2
• Zotero Version: zotero 7 beta 60
• Plugin Version: 1.0.0-beta.34

Describe the feature request

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
感谢开发action＆tag！自动化省了很多功夫。请问可否利用action＆tag实现添加注释以后，自动去除注释内容中的空格以及乱码呢？

Why do you need this feature?
A clear and concise description of why you need this feature.
pdf中的中文文本有时空格很多，即使一行内没有空格，换行也会造成空格。目前可以利用快捷指令、quicker等工具选中文本以后去除空格，但是是否可以利用action＆tag的功能实现全自动去除空格呢？感谢开发者～

Describe the solution you'd like

The solution you'd like
A clear and concise description of what you want to happen.

Alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Anything else?

[wakewon]

介绍 Introduction

本脚本可用于去除注释中的多余空格、换行符，替换全角字母、数字，并规范标点符号。
This script can be used to remove extra spaces, line breaks, replace full-width letters and numbers, and standardize punctuation in comments.

用法 Usage

本脚本可用于自动触发（事件：新建注释）和手动触发（菜单项：注释菜单中）。
This script can be used for automatic triggering (Event: Create Annotation) and manual triggering (Menu Label: In Annotation Menu).

请将以下代码完整拷贝至“数据”中：
Please copy the following script into "Data":

/**
 * Format Chinese Annotations
 * @author wakewon
 * @usage Create Annotation & In Annotation Menu
 * @link https://github.com/windingwind/zotero-actions-tags/discussions/269
 * @see https://github.com/windingwind/zotero-actions-tags/discussions/269
*/

if (!item) {
  return;
}

let topItem = Zotero.Items.getTopLevel([item])[0]
const formatLang = ["", "zh", "zh-CN", "zh_CN"];
const lang = topItem.getField("language");

if (!formatLang.includes(lang)) {
  return "[Action: Format Chinese Annotations] Skip due to language";
}

return await EditAnnotation(item);

async function EditAnnotation(annotationItem) {
  if (!annotationItem.isAnnotation()) {
    return "[Action: Format Chinese Annotations] Not an annotation item";
  }
  if (annotationItem.annotationText == null) {
    return "[Action: Format Chinese Annotations] No text found in this annotation";
  }
  annotationItem.annotationText = await FormatText(annotationItem.annotationText);
  return "[Action: Format Chinese Annotations] Success";
}

async function FormatText(text) {

  // Remove all line breaks.
  text = text.replace(/[\r\n]/g, '');

  // Remove special characters.
  text = text.replace(/[\uE5D2\uE5CF\uE5CE\uE5E5]/g, '');

  // Replace all full-width characters with half-width.
  text = text.replace(/[Ａ-Ｚａ-ｚ０-９！＂＇（）［］｛｝＜＞，．：；－]/g, function (s) {
    return String.fromCharCode(s.charCodeAt(0) - 0xFEE0);
  });

  // Replace consecutive spaces with a single space.
  text = text.replace(/\s+/g, ' ');

  // Replace spaces around digits with an empty string.
  text = text.replace(/(?<=\d)\s+|\s+(?=\d)/g, '');

  // Replace spaces around punctuation with an empty string.
  text = text.replace(/\s*(?=[.,:;!?"()\[\]。？！，、；：“”‘’（）《》【】])|(?<=[.,:;!?"()\[\]。？！，、；：“”‘’（）《》【】])\s*/g, '');

  // Remove spaces between Chinese characters, but keep spaces between English letters and digits.
  text = text.replace(/(\S)\s+(?=[\u4e00-\u9fa5])|(?<=[\u4e00-\u9fa5])\s+(\S)/g, '\$1\$2');

  // Replace English punctuation marks adjacent to Chinese characters with Chinese punctuation marks.
  text = text.replace(/([\u4e00-\u9fa5]+)([,.!?:;]+)/g, function (match, chinese, punctuation) {
    const punctuationMap = {
      '.': '。',
      ',': '，',
      '!': '！',
      '?': '？',
      ':': '：',
      ';': '；'
    };
    return chinese + punctuation.split('').map(p => punctuationMap[p]).join('');
  });
  text = text.replace(/([,.!?:;]+)([\u4e00-\u9fa5]+)/g, function (match, punctuation, chinese) {
    const punctuationMap = {
      '.': '。',
      ',': '，',
      '!': '！',
      '?': '？',
      ':': '：',
      ';': '；'
    };
    return punctuation.split('').map(p => punctuationMap[p]).join('') + chinese;
  });
  text = text.replace(/\(([^()]*[\u4e00-\u9fa5][^()]*)\)|\[([^\[\]]*[\u4e00-\u9fa5][^\[\]]*)\]/g, function (match, content1, content2) {
    if (content1) {
      return '（' + content1 + '）';
    } else if (content2) {
      return '【' + content2 + '】';
    }
  });

  // Replace full-width parentheses around digits and letters with half-width parentheses.
  text = text.replace(/([0-9a-zA-Z])（/g, "\$1" + String.fromCharCode(0xFF08));
  text = text.replace(/）([0-9a-zA-Z])/g, String.fromCharCode(0xFF09) + "\$1");

  // Add a space for English punctuations.
  text = text.replace(/([a-zA-Z]+)([,.!?:;]+)([a-zA-Z]+)/g, function (match, word1, punctuation, word2) {
    return word1 + punctuation + ' ' + word2;
  });
  text = text.replace(/([a-zA-Z]+)([,.!?:;]+)([a-zA-Z]+)/g, function (match, word1, punctuation, word2) {
    return word1 + punctuation + ' ' + word2;
  });
  text = text.replace(/(\S)\(/g, '\$1 (');
  text = text.replace(/\)([\u4e00-\u9fa5])/g, ') \$1');

  return text;
}

定制化用法 Customized Usage

跳过特定语言的文献 Skip the documentation of a specific language

本脚本只处理语言字段为zh、zh-CN、zh_CN以及没有语言信息条目下的PDF文档。

• 如果需要处理更多语言的文献，请在 const formatLang = ["", "zh", "zh-CN", "zh_CN"]; 中自行添加；
• 如果希望处理任意语言的文献，请在 return "[Action: Format Chinese Annotations] Skip due to language" 前添加两个斜线 //。

This script only handles PDF documents with language fields zh, zh-CN, zh_CN and no language information entries.

• If you need to process documents in more languages, please add them yourself in const formatLang = ["", "zh", "zh-CN", "zh_CN"];;
• If you want to handle documents in any language, please add two slashes // before return "[Action: Format Chinese Annotations] Skip due to language".

关闭提醒弹窗 Turn off alert pop-ups

如果希望关闭某一个弹窗提醒，你可以将代码中 return 后双引号及双引号内的内容删除。
例如：如果你希望关闭因语言跳过的提醒，你只需要将 return "[Action: Format Chinese Annotations] Skip due to language"; 改为 return; 即可。

If you wish to turn off a particular pop-up alert, you can remove the double quotes and the content inside the double quotes after the return in the code.
For example, if you want to turn off alerts that skip due to language, you just need to change return "[Action: Format Chinese Annotations] Skip due to language"; to return;.

[yzy1228682367]

感谢大佬！太牛了！

[yslemmo]

谢谢，太好了。终于能便捷地解决这个空格的问题了

[pengxy0]

你好老哥，这个具体怎么操作呢，我这咋没有变化？能帮我看下嘛？这是我的一个设置和操作。

[wakewon]

这个脚本是用来（自动）处理在PDF阅读中选中文字后创建高亮标记（新建注释）时，高亮标记记录下的文本里会有多余空格的问题的（详见我前面回答里的两张图），不会在选中文本后直接添加到条目笔记（通过已有的注释添加条目笔记）时被触发。你可以尝试修改代码看看能不能适用于你这样的工作流程。

从截图不太好看出这个漏掉的“空格”具体是什么，或许你可以上传下案例PDF方便测试？

[pengxy0]

我明白这个脚本的作用了。这个应该是每篇PDF做的条目笔记，都会存在这样的空格。我不知道怎么回事hh