npm 包 nodebb-plugin-composer-default-qc 使用教程

阅读时长 5 分钟读完

介绍

nodebb-plugin-composer-default-qc 是一个基于 NodeBB 的插件,旨在提供一个独特的文本质量控制工具,让您的帖子清晰、准确、有效。插件支持深入文本质量分析和自定义缩写和规则等方面的强大特性。

在本篇文章中,我们将会详细介绍如何安装、配置和使用这个插件,包括如何加载、捕获和改变该插件的配置选项,以及示例代码展示。

安装

你可以通过一下命令安装本插件:

配置

加载配置

该插件的配置简单易用,可以轻松地通过 nodebb 的配置文件加载。只需要在文件中添加以下代码即可:

-- -------------------- ---- -------
------------------------------------ -
---------- -----
--------- -----------
---------------------------- ------
----------- -
----------- ---
------------ -----
---
----------------- -
--- ------- ---- ------- ----- --
--- ------- ---- ------- ----- -
---
--------------- -
---
----------- ------------------------------------
-------------- ----------
-------------- --------
----------------- ----
----------------------- -
---
--
-

这段配置代码可以实现基本的文本质量分析,并基于各项指标给出建议。

配置选项

active (Boolean)

控制默认的文本质量控制策略是否激活。默认为 true

level (String)

控制文本质量的粒度。可以是 "strict", "moderate", 或 "lenient"。默认为 "moderate"。

abortOnModerationFailure (Boolean)

控制文本质量分析中出现违反规则的文本块是否停止继续分析,即跳过此文本块。默认为 false

penalty (Object)

该对象允许你配置罚则策略。主要包括以下属性:

  • weight (Integer): 扣分的权值,默认为 1。
  • banUser (Boolean): 是否将违反规则的用户拉入黑名单。默认为 false

substitutions (Array)

自定义的替换规则,允许您定义一组惯用词汇的替代方案。例如,"u" 可以替换成 "you",以保证文本质量。该选项的值应该是一个包含以下属性的对象的数组:

  • orig (String): 原始词汇
  • repl (String): 替代成的新词汇

customRules (Array)

进阶的文本质量规则。允许您定义针对特定文本块的正则表达式和惩罚策略。主要包括以下属性:

  • regex (String): 用于匹配文本块的正则表达式。
  • category (String): 该规则代表的文本质量问题的类别。例如,可以是 "grammar", "spelling" 或 "style"。
  • severity (String): 问题的严重程度。可以是 "minor", "moderate" 或 "major"。
  • replacement (String): 如果执行替换操作,则应该用来替换匹配的文本块。
  • penaltyMultiplier (Number): 表示该规则匹配时增加的惩罚权重。默认为 1。

使用

为了将 nodebb-plugin-composer-default-qc 应用到所有的发帖和回复中,只需要在社区总体设置中激活该插件即可。

为了更具体地控制文本质量,你可以在每个帖子和回复中配置。将 parseAndComplain 选项设置为 false 将会阻止针对此条信息的文本质量分析。

下面是一个例子:

这段 HTML 代码展示了如何在发帖过程中使用 option 参数。data-parseAndComplain 属性控制是否激活基本的文本质量分析。

结束语

nodebb-plugin-composer-default-qc 是一个非常实用而又简单可 直接用的插件。其提供的丰富的选项可以让您轻松地配置自己的文本质量分析策略,控制文本质量,提高帖子的质量。希望这篇文章对您有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600562bc81e8991b448dffd4

纠错
反馈