-
Notifications
You must be signed in to change notification settings - Fork 503
/
APIRef.ejs
274 lines (229 loc) · 7.92 KB
/
APIRef.ejs
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<%
// API Sidebar
//
// Parameters:
// $0 A tag for the API group (searches for related APIs)
// Variables and data
var slug = env.slug;
var locale = env.locale;
var APIHref = '/' + locale + '/docs/Web/API';
var output = "";
// This is a hack. But to be able to use this macro in the /MDN/Kitchensink page
// we have to, unfortunately, pretend that our current slug is something
// that it's not. Otherwise you'll always get a `MacroPagesError` when using
// this macro on the kitchensink page.
if (slug.toLowerCase().startsWith('mdn/kitchensink')) {
// Sorry, but it's important to be able to run this macro for CI.
slug = 'Web/API/ServiceWorker';
}
// slug is not available in preview mode.
if (slug) {
var mainIF = slug.replace('Web/API/','').split('/')[0];
mainIF = mainIF.charAt(0).toUpperCase() + mainIF.slice(1);
var group = $0;
var hasTag = page.hasTag;
var htmlEscape = kuma.htmlEscape;
var rtlLocales = ['ar', 'he', 'fa'];
var webAPIData = JSON.parse(await template("InterfaceData"));
if (group) {
var webAPIGroups = JSON.parse(await template("GroupData"));
}
var commonl10n = JSON.parse(await template('L10n:Common'));
var text = {
'Methods': mdn.getLocalString(commonl10n, 'Methods'),
'Properties': mdn.getLocalString(commonl10n, 'Properties'),
'Constructor': mdn.getLocalString(commonl10n, 'Constructor'),
'Inheritance': mdn.getLocalString(commonl10n, 'Inheritance'),
'Implemented_by': mdn.getLocalString(commonl10n, 'Implemented_by'),
'Related': mdn.getLocalString(commonl10n, 'Related_pages').replace('$1', group),
'translate': mdn.getLocalString(commonl10n, '[Translate]'),
'title': mdn.getLocalString(commonl10n, 'TranslationCTA'),
'Events': mdn.getLocalString(commonl10n, 'Events'),
};
// Collect all the things
var mainIFPages = await page.subpagesExpand('/en-US/docs/Web/API/' + mainIF);
var impl = webAPIData[0][mainIF] != undefined ? webAPIData[0][mainIF].impl : [];
var inh = webAPIData[0][mainIF] != undefined ? webAPIData[0][mainIF].inh : '';
var related = [];
var events = []
if (group && webAPIGroups[0][group]) {
var rel_if = webAPIGroups[0][group].interfaces || [];
var rel_met = webAPIGroups[0][group].methods || [];
var rel_prop = webAPIGroups[0][group].properties || [];
related = rel_if.concat(rel_met, rel_prop);
var mainIfIndex = related.indexOf(mainIF);
if (mainIfIndex !== -1) {
related.splice(mainIfIndex, 1);
}
related.sort();
}
var properties = [];
var methods = [];
var ctors = [];
var events = [];
var inheritedIF = [];
var implementedBy = [];
function collect(pageList) {
for (var i in pageList) {
var aPage = pageList[i];
if (hasTag(aPage, "Property")) {
properties.push(aPage);
}
if (hasTag(aPage, "Method")) {
methods.push(aPage);
}
if (hasTag(aPage, "Constructor")) {
ctors.push(aPage);
}
if (hasTag(aPage, "Event")) {
events.push(aPage);
}
}
}
collect(mainIFPages);
if (impl.length > 0) {
for (var i = 0; i < impl.length; i++) {
var implementPages = await page.subpagesExpand('/en-US/docs/Web/API/' + impl[i]);
collect(implementPages);
}
}
function APISort(a, b) {
var aSplit = a.title.split('.');
var a = aSplit[aSplit.length - 1];
var bSplit = b.title.split('.');
var b = bSplit[bSplit.length - 1];
return a.toLowerCase().localeCompare(b.toLowerCase());
}
properties.sort(APISort);
methods.sort(APISort);
ctors.sort(APISort);
events.sort(APISort);
function getInheritance(inh) {
if (inh.length > 0) {
inheritedIF.push(inh);
if (Object.prototype.hasOwnProperty.call(webAPIData[0], inh)) {
var inh = webAPIData[0][inh].inh;
getInheritance(inh);
}
}
}
getInheritance(inh);
function getImplementedBy(data) {
for (var key in data) {
if (Object.prototype.hasOwnProperty.call(data, key)
&& data[key].impl
&& data[key].impl.indexOf(mainIF) != -1) {
implementedBy.push(key);
}
}
implementedBy.sort();
}
getImplementedBy(webAPIData[0]);
// output helpers
var badges = {
ExperimentalBadge : await template("ExperimentalBadge"),
NonStandardBadge : await template("NonStandardBadge"),
DeprecatedBadge : await template("DeprecatedBadge"),
ObsoleteBadge : await template("ObsoleteBadge"),
}
function buildSublist(pages, title) {
var result = '<li class="toggle"><details open><summary>' + title + '</summary><ol>';
for (var i in pages) {
var aPage = pages[i];
var url = aPage.url.replace('en-US', locale);
var titleSplit = htmlEscape(aPage.title).split('.'); // Two cases, as sometimes the interface name is forgotten in the title:
var title = titleSplit[titleSplit.length - 1]; // "WebGLRenderingContext.activeTexture()" and "activeTexture()" should both become "activeTexture()"
var translated = false;
if (locale != 'en-US') {
aPage.translations.forEach(function(translation){
if(translation.locale === locale) {
url = translation.url;
titleSplit = htmlEscape(translation.title).split('.');
title = titleSplit[titleSplit.length - 1];
translated = true;
}
});
}
// Event pages have a title like "Interface: eventname event" which looks silly
// in the sidebar. So for event pages we use the slug, which is supposed to be
// in the form "eventname_event", and split off "_event" to leave us (hopefully)
// with just "eventname" for the link text.
if (hasTag(aPage, 'Event')) {
title = aPage.slug.split('/').pop();
if (title.endsWith('_event')) {
title = title.slice(0,-6);
}
}
result += '<li>';
if (hasTag(aPage, 'Experimental')) {
result += badges.ExperimentalBadge;
}
if (hasTag(aPage, 'Non-standard') || hasTag(aPage, 'Non Standard')) {
result += badges.NonStandardBadge;
}
if (hasTag(aPage, 'Deprecated')) {
result += badges.DeprecatedBadge;
}
if (hasTag(aPage, 'Obsolete')) {
result += badges.ObsoleteBadge;
result += '<s class="obsoleteElement">';
}
if (rtlLocales.indexOf(locale) != -1) {
result += '<bdi>';
}
if (slug == aPage.slug) {
result += '<em><code>' + title + '</code></em>'
} else {
result += '<a href="' + url + '"><code>' + title + '</code></a>';
}
if (rtlLocales.indexOf(locale) != -1) {
result += '</bdi>';
}
if (hasTag(aPage, 'Obsolete')) {
result += '</s>';
}
result += '</li>';
}
result += '</ol></details></li>';
return result;
}
function buildIFList(interfaces, title) {
var result = '<li class="toggle"><details open><summary>' + title + '</summary><ol>';
for (var i = 0; i < interfaces.length; i++) {
var url = interfaces[i].replace('()', '').replace('.', '/');
result += '<li><a href="' + APIHref + '/' + url + '"><code>' + interfaces[i] + '</code></a></li>';
}
result += '</ol></details></li>';
return result;
}
// output
output = '<section class="Quick_links" id="Quick_Links"><ol>';
if (group && webAPIGroups[0][group] && webAPIGroups[0][group].overview) {
output += '<li><strong><a href="' + APIHref + '/' + webAPIGroups[0][group].overview[0].replace(/ /g, '_') + '">' + webAPIGroups[0][group].overview[0] + '</a></strong></li>';
}
output += '<li><strong><a href="' + APIHref + '/' + mainIF + '"><code>' + mainIF + '</code></a></strong></li>';
if (ctors.length > 0) {
output += buildSublist(ctors, text['Constructor']);
}
if (properties.length > 0) {
output += buildSublist(properties, text['Properties']);
}
if (methods.length > 0) {
output += buildSublist(methods, text['Methods']);
}
if (events.length > 0) {
output += buildSublist(events, text['Events']);
}
if (inh.length > 0) {
output += buildIFList(inheritedIF, text['Inheritance']);
}
if (implementedBy.length > 0) {
output += buildIFList(implementedBy, text['Implemented_by']);
}
if (related.length > 0) {
output += buildIFList(related, text['Related']);
}
output += '</ol></section>';
}
%>
<%-output%>