wikiparse

目录

• 简介
• Properties
  • codejar
• Methods
  • setI18N
  • setConfig
  • getConfig
  • lint
  • highlight
  • edit
• Constructors
  • Linter

Other Languages

• English

简介

这是浏览器端的插件添加的全局变量，可以执行高亮静态代码或文本框、报告潜在的语法错误等多种操作。

Properties

codejar

展开

需要加载 CodeJar 插件。

type: Promise<(textbox: HTMLTextAreaElement, include?: boolean, linenums?: boolean) => CodeJar>
高亮文本框。

(await wikiparse.codejar)(document.getElementsByTagName('textarea')[0]);

Methods

setI18N

展开

param: Record<string, string>
设置语言。默认语言为英文，其他预设的语言包含简体中文和繁体中文。

const i18n = await (await fetch('https://bhsd-harry.github.io/wikiparser-node/i18n/zh-hans.json')).json();
wikiparse.setI18N(i18n);

setConfig

展开

param: Config
添加解析设置。预设的解析设置包含英文维基百科（enwiki）、中文维基百科（zhwiki）、萌娘百科（moegirl）和 LLWiki（llwiki）。如需定制一个 MediaWiki 站点的解析设置，请参考 .schema.json 填入相关内容。

const config = await (await fetch('https://bhsd-harry.github.io/wikiparser-node/config/zhwiki.json')).json();
wikiparse.setConfig(config);

getConfig

展开

returns: Promise<Config>
获取解析设置。

const config = await wikiparse.getConfig();

lint

展开

param: string 维基文本
param: boolean 是否嵌入，默认为 false
returns: Promise<LintError[]>
报告潜在语法错误。

const errors = await wikiparse.lint('[[a]');

highlight

展开

需要加载 Highlight 插件。

param: HTMLElement 静态代码所在的网页元素
param: boolean 是否嵌入，默认为 false
param: boolean 是否加注行号，默认为 false
param: number 行号起始值，可选
returns: Promise<void>
高亮静态代码。

wikiparse.highlight(document.getElementsByTagName('pre')[0], false, true);

edit

展开

需要加载 Editor 插件。

param: HTMLTextAreaElement 文本框
param: boolean 是否嵌入，默认为 false
高亮文本框。

wikiparse.edit(document.getElementsByTagName('textarea')[0]);

Constructors

Linter

参见 Linter。