forked from hoyois/html5outliner
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bookmarklet.js
489 lines (435 loc) · 13.6 KB
/
bookmarklet.js
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
(function() {
/*____BEGIN_OPTIONS____*/
var numbering = 0001, linkColor = '', clickOutside = true, showDetails = false;
/*_____END_OPTIONS_____*/
/*_____BEGIN_CSS_____*/
var CSSRules = [
// CSS reset (except: text-rendering, link color)
// TODO: directional properties should not be reset
"#h5o-outside,#h5o-outside *{\
background:transparent;\
border:none;\
border-radius:0;\
bottom:auto;\
box-shadow:none;\
box-sizing:content-box;\
clear:none;\
" + (linkColor ? "color:" + linkColor + ";" : "") + "\
cursor:auto;\
direction:ltr;\
float:none;\
font-family:sans-serif;\
font-size:small;\
font-stretch:normal;\
font-style:normal;\
font-variant:normal;\
font-weight:normal;\
height:auto;\
left:auto;\
letter-spacing:normal;\
line-height:normal;\
margin:0;\
opacity:1;\
outline:none;\
overflow:visible;\
padding:0;\
position:static;\
right:auto;\
text-align:left;\
text-decoration:none;\
text-indent:0;\
text-overflow:clip;\
text-shadow:none;\
text-transform:none;\
top:auto;\
vertical-align:baseline;\
visibility:visible;\
white-space:normal;\
width:auto;\
word-break:normal;\
word-spacing:normal;\
word-wrap:normal;\
zoom:normal;\
}",
"#h5o-inside *:not([href]){\
color:black;\
}",
"#h5o-outside{\
background:transparent;\
box-sizing:border-box;\
display:block;\
height:100%;\
padding:10px;\
pointer-events:none;\
position:fixed;\
right:0px;\
top:0px;\
max-width:500px;\
z-index:2147483647;\
}",
"#h5o-inside{\
background:white;\
border:2px solid black;\
box-sizing:border-box;\
display:block;\
max-width:100%;\
max-height:100%;\
opacity:.9;\
overflow:auto;\
padding:10px;\
pointer-events:auto;\
}",
"#h5o-inside ol{\
counter-reset:li;\
display:block;\
margin:0;\
padding:0;\
}",
"#h5o-inside li{\
counter-increment:li;\
display:list-item;\
list-style-type:none;\
margin-left:" + (numbering === 2 ? "2em" : "1.5em") + ";\
position:relative;\
}",
"#h5o-inside a{\
display:inline;\
cursor:pointer;\
}",
"#h5o-inside a:hover{\
text-decoration:underline;\
}",
"#h5o-inside li.h5o-notitle>a{\
font-style:italic;\
}",
];
if(numbering > 0) CSSRules.push("#h5o-inside li::before{\
content:" + (numbering === 2 ? "counters(li,\".\")" : "counter(li)") + "\".\";\
display:block;\
left:-10.5em;\
position:absolute;\
text-align:right;\
width:10em;\
}");
else CSSRules.push("#h5o-inside>ol>li{margin-left:0;}");
/*_____END_CSS_____*/
// This must be global so that event listener can be removed when clicking on bookmarklet again
if(!window.h5o_sdWoNJpsAgQGAaf) window.h5o_sdWoNJpsAgQGAaf = function() {
document.removeEventListener("click", h5o_sdWoNJpsAgQGAaf, false);
document.body.removeChild(document.getElementById("h5o-outside"));
};
if(document.getElementById("h5o-outside")) {
h5o_sdWoNJpsAgQGAaf();
return;
}
var toc = document.createElement("div");
toc.id = "h5o-outside";
// Stylesheet
var style = document.createElement("style");
toc.appendChild(style);
document.body.appendChild(toc);
for(var i = 0; i < CSSRules.length; i++) {
try {
style.sheet.insertRule(CSSRules[i].replace(/;/g, " !important;"), i);
} catch(e) {}
}
var inside = document.createElement("div");
inside.id = "h5o-inside";
if(clickOutside) {
inside.addEventListener("click", function(event) {event.stopPropagation();}, false);
document.addEventListener("click", h5o_sdWoNJpsAgQGAaf, false);
}
// Create outline
HTMLOutline(document.body);
if(!document.body.sectionList) return; // HTML4 frameset documents
inside.appendChild(printOutline(document.body.sectionList));
toc.appendChild(inside);
function printOutline(outline) {
var ol = document.createElement("ol");
for(var i = 0; i < outline.length; i++) {
ol.appendChild(printSection(outline[i]));
}
return ol;
}
function printSection(section) {
var li = document.createElement("li");
var title = document.createElement("a");
li.appendChild(title);
var sectionHeading = (section.heading !== null ? getElementText(section.heading) : '');
if(/^[ \r\n\t]*$/.test(sectionHeading)) {
li.className = "h5o-notitle";
switch(section.associatedNodes[0].nodeName.toLowerCase()) {
case "body": title.textContent = "Document"; break;
case "article": title.textContent = "Article"; break;
case "aside": title.textContent = "Sidebar"; break;
case "nav": title.textContent = "Navigation"; break;
case "section": title.textContent = "Section"; break;
default: title.textContent = "Empty title";
}
} else title.textContent = sectionHeading;
var node = section.explicit ? section.associatedNodes[0] : section.heading;
title.href = "#" + node.id;
title.addEventListener("click", function(event) {
event.preventDefault();
node.scrollIntoView();
}, false);
if(showDetails) {
var details = "";
if(section.explicit) details += "<" + section.associatedNodes[0].nodeName.toLowerCase() + ">";
if(section.heading) details += "<h" + (-section.heading.rank) + ">";
details += ", " + section.associatedNodes.length + " nodes";
title.title = details;
}
li.appendChild(printOutline(section.childSections));
return li;
}
function getElementText(node) {
var text = '';
// Text node (3) or CDATA node (4) - return its text
if ((node.nodeType === 3) || (node.nodeType === 4)) {
text = node.nodeValue;
// If node is an element (1) and an img, input[type=image], or area element, return its alt text
} else if ((node.nodeType === 1) && (
(node.tagName.toLowerCase() == 'img') ||
(node.tagName.toLowerCase() == 'area') ||
((node.tagName.toLowerCase() == 'input') && node.getAttribute('type') && (node.getAttribute('type').toLowerCase() == 'image'))
)) {
text = node.getAttribute('alt') || '';
// Traverse children unless this is a script or style element
} else if ((node.nodeType === 1) && !node.tagName.match(/^(script|style)$/i)) {
var children = node.childNodes;
for (var i = 0, l = children.length; i < l; i++) {
text += getElementText(children[i]);
}
}
return text;
}
// Section class
function Section(explicit) {
this.parentSection = null;
this.childSections = [];
this.firstChild = null;
this.lastChild = null;
this.appendChild = function(section) {
section.parentSection = this;
this.childSections.push(section);
if(this.firstChild === null) this.firstChild = section;
this.lastChild = section;
};
this.explicit = explicit;
this.associatedNodes = []; // DOM nodes associated with the section
// this.heading is defined for all sections by the function HTMLOutline:
// It is either a heading content element or null for an implied heading
}
// Main function
function HTMLOutline(root) {
// BEGIN OUTLINE ALGORITHM
// STEP 1
var currentOutlinee = null; // element whose outline is being created
// STEP 2
var currentSection = null; // current section
// STEP 3
// Minimal stack object
var stack = {"lastIndex": -1};
stack.isEmpty = function() {
return stack.lastIndex === -1;
};
stack.push = function(e) {
stack[++stack.lastIndex] = e;
stack.top = e;
};
stack.pop = function() {
var e = stack.top;
delete stack[stack.lastIndex--];
stack.top = stack[stack.lastIndex];
return e;
};
// STEP 4
// Walk the DOM subtree of root
var node = root;
start: while(node) {
extend(node);
enter(node);
if(node.firstChild) {
node = node.firstChild;
continue start;
}
while(node) {
exit(node);
if(node === root) break start;
if(node.nextSibling) {
node = node.nextSibling;
continue start;
}
node = node.parentNode;
}
}
// When entering a node
function enter(node) {
if(isElement(node)) {
if(!stack.isEmpty() && (isHeadingContentElement(stack.top) || isHidden(stack.top))) {
// Do nothing
} else if(isHidden(node)) {
stack.push(node);
} else if(isSectioningContentElement(node)) {
if(currentOutlinee !== null) {
if(hasNoHeading(currentSection)) createImpliedHeading(currentSection);
stack.push(currentOutlinee);
}
currentOutlinee = node;
currentSection = new Section(true);
associateNodeWithSection(currentOutlinee, currentSection);
currentOutlinee.appendSection(currentSection);
} else if(isSectioningRootElement(node)) {
if(currentOutlinee !== null) stack.push(currentOutlinee);
currentOutlinee = node;
currentOutlinee.parentSection = currentSection;
currentSection = new Section(true);
associateNodeWithSection(currentOutlinee, currentSection);
currentOutlinee.appendSection(currentSection);
} else if(currentOutlinee === null) {
// Do nothing
// (this step is not in the algorithm but is needed here since root may not be a sectioning element)
} else if(isHeadingContentElement(node)) {
if(hasNoHeading(currentSection)) currentSection.heading = node;
else if(hasImpliedHeading(currentOutlinee.lastSection) || node.rank >= currentOutlinee.lastSection.heading.rank) {
currentSection = new Section(false);
currentSection.heading = node;
currentOutlinee.appendSection(currentSection);
} else {
var candidateSection = currentSection;
while(node.rank >= candidateSection.heading.rank) candidateSection = candidateSection.parentSection;
currentSection = new Section(false);
currentSection.heading = node;
candidateSection.appendChild(currentSection);
}
stack.push(node);
} // else {
// Do nothing
// }
}
}
// When exiting a node
function exit(node) {
if(isElement(node)) {
if(!stack.isEmpty() && node === stack.top) stack.pop();
else if(!stack.isEmpty() && (isHeadingContentElement(stack.top) || isHidden(stack.top))) {
// Do nothing
} else if(!stack.isEmpty() && isSectioningContentElement(node)) {
if(hasNoHeading(currentSection)) createImpliedHeading(currentSection);
currentOutlinee = stack.pop();
currentSection = currentOutlinee.lastSection;
for(var i = 0; i < node.sectionList.length; i++) {
currentSection.appendChild(node.sectionList[i]);
}
} else if(!stack.isEmpty() && isSectioningRootElement(node)) {
if(hasNoHeading(currentSection)) createImpliedHeading(currentSection);
currentSection = currentOutlinee.parentSection;
currentOutlinee = stack.pop();
} else if(isSectioningContentElement(node) || isSectioningRootElement(node)) {
if(hasNoHeading(currentSection)) createImpliedHeading(currentSection);
// If the root is a sectioning element, the walk ends here
// If not, we reset the algorithm for subsequent top-level sectioning elements
currentOutlinee = null;
currentSection = null;
} // else {
// Do nothing
// }
}
if(node.associatedSection === null && currentSection !== null) associateNodeWithSection(node, currentSection);
}
// STEP 5
// The heading associated to node is node.associatedSection.heading
// END OUTLINE ALGORITHM
// Now we must make the necessary definitions for the above to make sense...
function associateNodeWithSection(node, section) {
section.associatedNodes.push(node);
node.associatedSection = section;
}
function hasNoHeading(section) {
return section.heading === undefined;
}
function hasImpliedHeading(section) {
return section.heading === null;
}
function createImpliedHeading(section) {
section.heading = null;
}
// Types of nodes
function isElement(node) {
return node.nodeType === 1;
}
function isHidden(node) {
return node.hidden;
}
function isSectioningRootElement(node) {
return ["blockquote", "body", "details", "dialog", "fieldset", "figure", "td"].indexOf(node.nodeName.toLowerCase()) !== -1;
}
function isSectioningContentElement(node) {
return ["article", "aside", "nav", "section"].indexOf(node.nodeName.toLowerCase()) !== -1;
}
function isSectioningElement(node) {
return isSectioningRootElement(node) || isSectioningContentElement(node);
}
function isHeadingElement(node) {
return ["h1", "h2", "h3", "h4", "h5", "h6"].indexOf(node.nodeName.toLowerCase()) !== -1;
}
function isHeadingGroupElement(node) {
return "hgroup" === node.nodeName.toLowerCase();
}
function isHeadingContentElement(node) {
return isHeadingElement(node) || isHeadingGroupElement(node);
}
// Add properties to DOM nodes
function extend(node) {
if(isSectioningElement(node)) extendSectioningElement(node);
else if(isHeadingElement(node)) extendHeadingElement(node);
else if(isHeadingGroupElement(node)) extendHeadingGroupElement(node);
else extendNode(node);
}
function extendNode(node) {
node.associatedSection = null;
}
function extendSectioningElement(node) {
extendNode(node);
node.sectionList = [];
node.firstSection = null;
node.lastSection = null;
node.appendSection = function(section) {
this.sectionList.push(section);
if(this.firstSection === null) this.firstSection = section;
this.lastSection = section;
};
}
function extendHeadingContentElement(node) {
extendNode(node);
Object.defineProperty(node, "depth", {"get": function() {
var section = node.associatedSection;
if(section === null) return undefined;
var depth = 1;
while(section = section.parentSection) ++depth;
return depth;
}, "configurable": true, "enumerable": true});
}
function extendHeadingElement(node) {
extendHeadingContentElement(node);
node.rank = -parseInt(node.nodeName.charAt(1));
node.text = node.textContent;
}
function extendHeadingGroupElement(node) {
extendHeadingContentElement(node);
for(var i = 1; i <= 6; i++) {
var h = node.getElementsByTagName("h" + i);
if(h.length > 0) {
node.rank = -i;
node.text = h[0].textContent;
break;
}
}
if(node.rank === undefined) {
node.rank = -1;
node.text = "";
}
}
}
})();