GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — parsoid-jsapi/index.js at master · wikimedia/parsoid-jsapi

This repository was archived by the owner on Feb 1, 2023. It is now read-only.

Expand file tree

/

index.js

Copy path
More file actions
More file actions

Latest commit

 

History

History
History
135 lines (123 loc) · 3.82 KB
/

index.js

Copy path

File metadata and controls

135 lines (123 loc) · 3.82 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
'use strict';
require('parsoid/core-upgrade.js');
var parseJs = require('parsoid/lib/parse.js');
var json = require('./package.json');
var JsApi = require('./jsapi.js');
/**
* Main entry point for Parsoid's JavaScript API.
*
* Note that Parsoid's main interface is actually a web API, as
* defined by {@link ParsoidService}.
*
* But some users would like to use Parsoid as a NPM package using
* a native JavaScript API. This file provides that, more-or-less.
* It should be considered unstable. Patches welcome.
*
* See `./jsapi.js` for a useful wrapper API which works
* well with this interface.
*
* @namespace
*/
var Parsoid = module.exports = {
/** Name of the NPM package. */
name: json.name,
/** Version of the NPM package. */
version: json.version,
};
/**
* Parse wikitext (or html) to html (or wikitext).
*
* Sample usage:
*
* Parsoid.parse('hi there', { document: true }).then(function(res) {
* console.log(res.out.outerHTML);
* }).done();
*
* Advanced usage using the {@link PDoc} API:
*
* Parsoid.parse('{{echo|hi}}', { pdoc: true }).then(function(pdoc) {
* var templates = pdoc.filterTemplates();
* console.log(templates[0].name);
* }).done();
*
* @param {string} input
* The input wikitext or HTML (depending on conversion direction).
* @param {Object} options
* @param {boolean} [options.document=false]
* Return a DOM {@link Document} (instead of a string)
* @param {boolean} [options.pdoc=false]
* Return a {@link PDoc} object (instead of a string)
* @param {boolean} [options.wt2html=true]
* Convert wikitext to HTML.
* @param {boolean} [options.html2wt=false]
* Convert HTML to wikitext.
* @param {ParsoidConfig} [options.parsoidConfig]
* A {@link ParsoidConfig} object to use during parsing.
* If not provided one will be constructed using `options.config`.
* @return {Promise}
* Fulfilled with the result of the parse.
*/
Parsoid.parse = function(input, options, optCb) {
var argv = Object.assign({}, {
/* default options */
}, options || {});
if (argv.pdoc) {
argv.document = true;
}
if (argv.selser) {
argv.html2wt = true;
}
// Default conversion mode
if (!argv.html2wt && !argv.wt2wt && !argv.html2html) {
argv.wt2html = true;
}
return parseJs({
input: input || '',
mode: (
argv.wt2html ? 'wt2html' :
argv.html2wt ? 'html2wt' :
argv.html2html ? 'html2html' :
argv.wt2wt ? 'wt2wt' :
'<unknown mode>'
),
parsoidOptions: Object.assign({
useWorker: false,
addHTMLTemplateParameters: true,
loadWMF: true,
}, options.parsoidOptions || {}),
envOptions: Object.assign({
domain: argv.domain || 'en.wikipedia.org',
pageName: argv.pageName,
wrapSections: true,
}, options.envOptions || {}),
returnDocument: argv.pdoc || argv.document,
}).then(function(res) {
// The ability to return as an HTML Document used to be in core :(
return argv.pdoc ? new JsApi.PDoc(res.env, res.doc) : res;
}).nodify(optCb);
};
// Add a helper method to PNodeList, based on Parsoid.parse.
/**
* Create a {@link PNodeList} belonging to the given {@link PDoc}
* from a string containing wikitext.
* @param {PDoc} pdoc
* The {@link PDoc} which will own the result.
* @param {string} wikitext
* The wikitext to convert.
* @param {Object} options
* Options which are passed to {@link Parsoid#parse}.
* @return {Promise}
* Fulfilled by a {@link PNodeList} representing the given wikitext.
* @static
*/
JsApi.PNodeList.fromWikitext = function(pdoc, wikitext, options) {
options = Object.assign({}, options, { pdoc: true });
return Parsoid.parse(wikitext, options).then(function(pdoc2) {
var node = pdoc.document.adoptNode(pdoc2.document.body);
return new JsApi.PNodeList(pdoc, null, node);
});
};
// Expose other helpful objects.
Object.keys(JsApi).forEach(function(k) {
Parsoid[k] = JsApi[k];
});
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.