-
Notifications
You must be signed in to change notification settings - Fork 62
/
Copy pathextracts-content.js
1171 lines (991 loc) · 44.7 KB
/
extracts-content.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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************/
/* The target-testing and pop-frame-filling functions in this section
come in sets, which define and implement classes of pop-frames
(whether those be popups, or popins, etc.). (These classes are things
like “a link that has a statically generated extract provided for it”,
“a link to a locally archived web page”, “an anchorlink to a section of
the current page”, and so on.)
Each set contains a testing function, which is called by
testTarget() to determine if the target (link, etc.) is eligible for
processing, and is also called by fillPopFrame() to find the
appropriate filling function for a pop-frame spawned by a given
target. The testing function takes a target element and examines its
href or other properties, and returns true if the target is a member of
that class of targets, false otherwise.
NOTE: These testing (a.k.a. “type predicate”) functions SHOULD NOT be used
directly, but only via Extracts.targetTypeInfo()!
Each set also contains the corresponding filling function, which
is called by fillPopFrame() (chosen on the basis of the return values
of the testing functions, and the specified order in which they’re
called). The filling function takes a target element and returns a
DocumentFragment whose contents should be injected into the pop-frame
spawned by the given target.
*/
Extracts.targetTypeDefinitions.insertBefore([
"LOCAL_PAGE", // Type name
"isLocalPageLink", // Type predicate function
"has-content", // Target classes to add
"localPageForTarget", // Pop-frame fill function
"local-page" // Pop-frame classes
], (def => def[0] == "ANNOTATION_PARTIAL"));
/*=-------------=*/
/*= LOCAL PAGES =*/
/*=-------------=*/
Extracts = { ...Extracts,
/* Local links (to sections of the current page, or other site pages).
*/
// Called by: Extracts.targetTypeInfo (as `predicateFunctionName`)
isLocalPageLink: (target) => {
return ( Content.contentTypes.localPage.matches(target)
&& ( isAnchorLink(target)
|| target.pathname != location.pathname));
},
/* TOC links.
*/
// Called by: Extracts.testTarget_LOCAL_PAGE
// Called by: Extracts.preparePopup_LOCAL_PAGE
isTOCLink: (target) => {
return (target.closest("#TOC") != null);
},
/* Links in the sidebar.
*/
// Called by: Extracts.testTarget_LOCAL_PAGE
isSidebarLink: (target) => {
return (target.closest("#sidebar") != null);
},
/* “Full context” links in backlinks lists.
*/
isFullBacklinkContextLink: (target) => {
return ( target.closest(".backlink-source") != null
&& target.classList.contains("link-page")
&& Annotations.isAnnotatedLink(target) == false);
},
/* Annotation title-links on mobile.
*/
isMobileAnnotationTitleLink: (target) => {
return ( GW.isMobile()
&& target.matches(".data-field.title a.title-link"));
},
/* This “special testing function” is used to exclude certain targets which
have already been categorized as (in this case) `LOCAL_PAGE` targets. It
returns false if the target is to be excluded, true otherwise. Excluded
targets will not spawn pop-frames.
*/
// Called by: Extracts.targets.testTarget (as `testTarget_${targetTypeInfo.typeName}`)
testTarget_LOCAL_PAGE: (target) => {
return (!( Extracts.popFrameProvider == Popins
&& ( Extracts.isTOCLink(target)
|| Extracts.isSidebarLink(target)
|| Extracts.isMobileAnnotationTitleLink(target))));
},
// Called by: Extracts.fillPopFrame (as `popFrameFillFunctionName`)
// Called by: Extracts.citationForTarget (extracts-content.js)
// Called by: Extracts.citationBackLinkForTarget (extracts-content.js)
localPageForTarget: (target) => {
GWLog("Extracts.localPageForTarget", "extracts-content.js", 2);
/* If the target is an anchor-link, check to see if the target location
matches an already-displayed page (which can be the root page of the
window).
If the entire linked page is already displayed, and if the
target points to an anchor in that page, display the linked
section or element.
Also display just the linked block if we’re spawning this
pop-frame from a table of contents.
Otherwise, display the entire linked page.
*/
let fullPage = !( isAnchorLink(target)
&& ( target.closest(".TOC")
|| Extracts.targetDocument(target)));
// Synthesize include-link (with or without hash, as appropriate).
let includeLink = synthesizeIncludeLink(target, {
class: "include-strict include-block-context-expanded include-spinner-not"
});
// Mark full-page embed pop-frames.
if (fullPage)
Extracts.addPopFrameClassesToLink(includeLink, "full-page");
// Designate “full context” pop-frames for backlinks.
if (Extracts.isFullBacklinkContextLink(target))
Extracts.addPopFrameClassesToLink(includeLink, "full-backlink-context");
if (fullPage) {
stripAnchorsFromLink(includeLink);
} else if ( Extracts.isFullBacklinkContextLink(target)
&& target.pathname == location.pathname) {
/* Since “full” context is just the base page, which we don’t want
to pop up/in, we instead show the containing section or
footnote.
*/
let targetElement = targetElementInDocument(target, Extracts.rootDocument);
let nearestSection = targetElement.closest("section, li.footnote");
if (nearestSection)
includeLink.hash = "#" + nearestSection.id;
}
return newDocument(includeLink);
},
// Called by: Extracts.titleForPopFrame (as `titleForPopFrame_${targetTypeName}`)
titleForPopFrame_LOCAL_PAGE: (popFrame) => {
GWLog("Extracts.titleForPopFrame_LOCAL_PAGE", "extracts-content.js", 2);
let target = popFrame.spawningTarget;
let referenceData = Content.referenceDataForLink(target);
let popFrameTitleHTML;
if (referenceData == null) {
let popFrameTitleText = "";
if (target.pathname != location.pathname)
popFrameTitleText += target.pathname;
if (popFrame.classList.contains("full-page") == false)
popFrameTitleText += target.hash;
popFrameTitleHTML = `<code>${popFrameTitleText}</code>`;
} else {
let popFrameTitleTextParts = [ ];
if (target.pathname != location.pathname)
popFrameTitleTextParts.push(referenceData.pageTitle);
if (popFrame.classList.contains("full-page") == false) {
// Find the target element and/or containing block, if any.
let element = targetElementInDocument(target, referenceData.content);
// Section title or block id.
if (element) {
let nearestSection = element.closest("section");
let nearestFootnote = element.closest("li.footnote");
if (nearestFootnote) {
popFrameTitleTextParts.push("Footnote", Notes.noteNumber(nearestFootnote));
let identifyingSpan = nearestFootnote.querySelector("span[id]:empty");
if (identifyingSpan)
popFrameTitleTextParts.push(`(#${(identifyingSpan.id)})`);
} else if (nearestSection) {
// Section mark (§) for sections.
popFrameTitleTextParts.push("§");
if (nearestSection.id == "footnotes") {
popFrameTitleTextParts.push("Footnotes");
} else {
popFrameTitleTextParts.push(nearestSection.firstElementChild.textContent);
}
} else {
popFrameTitleTextParts.push(link.hash);
}
}
}
popFrameTitleHTML = popFrameTitleTextParts.join(" ");
}
/* This is for section backlinks popups for the base page, and any
(section or full) backlinks popups for a different page.
*/
if ( popFrame.classList.contains("backlinks")
&& ( target.pathname == location.pathname
&& [ "#backlinks", "#backlinks-section" ].includes(target.hash)) == false)
popFrameTitleHTML += " (Backlinks)";
return Transclude.fillTemplateNamed("pop-frame-title-standard", {
popFrameTitleLinkHref: target.href,
popFrameTitle: popFrameTitleHTML
});
},
// Called by: Extracts.preparePopup_LOCAL_PAGE
preparePopFrame_LOCAL_PAGE: (popFrame) => {
GWLog("Extracts.preparePopFrame_LOCAL_PAGE", "extracts-content.js", 2);
let target = popFrame.spawningTarget;
/* For local content embed pop-frames, add handler to trigger
transcludes in source content when they trigger in the pop-frame.
*/
if (Content.cachedDataExists(target)) {
GW.notificationCenter.addHandlerForEvent("GW.contentDidInject", popFrame.updateSourceContentOnTranscludeTriggerHandler = (info) => {
Content.updateCachedContent(target, (content) => {
Transclude.allIncludeLinksInContainer(content).filter(includeLink =>
includeLink.href == info.includeLink.href
).forEach(includeLink => {
Transclude.transclude(includeLink, true);
});
});
}, { condition: (info) => ( info.source == "transclude"
&& info.document == popFrame.document) });
// Add handler to remove the above handler when pop-frame despawns.
let suffix = Extracts.popFrameTypeSuffix();
GW.notificationCenter.addHandlerForEvent(`Pop${suffix}s.pop${suffix}WillDespawn`, (info) => {
GW.notificationCenter.removeHandlerForEvent("GW.contentDidInject", popFrame.updateSourceContentOnTranscludeTriggerHandler);
}, {
once: true,
condition: (info) => (info[`pop${suffix}`] == popFrame)
});
}
return popFrame;
},
// Called by: Extracts.preparePopFrame (as `preparePop${suffix}_${targetTypeName}`)
preparePopup_LOCAL_PAGE: (popup) => {
GWLog("Extracts.preparePopup_LOCAL_PAGE", "extracts-content.js", 2);
let target = popup.spawningTarget;
// Do not spawn “full context” popup if the link is visible.
if ( Extracts.isFullBacklinkContextLink(target)
&& popup.classList.contains("full-page") == false
&& Popups.isVisible(targetElementInDocument(target, Extracts.rootDocument)))
return null;
/* Designate popups spawned from section links in the the TOC (for
special styling).
*/
if (Extracts.isTOCLink(target))
Extracts.popFrameProvider.addClassesToPopFrame(popup, "toc-section");
return Extracts.preparePopFrame_LOCAL_PAGE(popup);
},
// Called by: Extracts.rewritePopFrameContent (as `updatePopFrame_${targetTypeName}`)
updatePopFrame_LOCAL_PAGE: (popFrame) => {
GWLog("Extracts.updatePopFrame_LOCAL_PAGE", "extracts-content.js", 2);
// Add page body classes.
let referenceData = Content.referenceDataForLink(popFrame.spawningTarget);
Extracts.popFrameProvider.addClassesToPopFrame(popFrame, ...(referenceData.pageBodyClasses.filter(c => c.startsWith("dropcaps-") == false)));
// Update pop-frame title.
Extracts.updatePopFrameTitle(popFrame);
},
// Called by: Extracts.rewritePopinContent_LOCAL_PAGE
// Called by: Extracts.rewritePopupContent_LOCAL_PAGE
rewritePopFrameContent_LOCAL_PAGE: (popFrame, contentContainer) => {
GWLog("Extracts.rewritePopFrameContent_LOCAL_PAGE", "extracts-content.js", 2);
// Something failed somehow (probably a transclude error).
if (isNodeEmpty(contentContainer)) {
Extracts.postRefreshUpdatePopFrame(popFrame, false);
return;
}
// Remove empty page-metadata section.
let pageMetadata = contentContainer.querySelector("#page-metadata");
if (isNodeEmpty(pageMetadata))
pageMetadata.remove();
// Make first image load eagerly.
let firstImage = ( contentContainer.querySelector(".page-thumbnail")
?? contentContainer.querySelector("figure img"))
if (firstImage) {
firstImage.loading = "eager";
firstImage.decoding = "sync";
}
// Expand a single collapse block encompassing the top level content.
if ( isOnlyChild(contentContainer.firstElementChild)
&& contentContainer.firstElementChild.classList.contains("collapse"))
expandLockCollapseBlock(contentContainer.firstElementChild);
/* In the case where the spawning link points to a specific element
within the transcluded content, but we’re transcluding the full
page and not just the block context of the targeted element,
transclude.js has not marked the targeted element for us already.
So we must do it here.
*/
let target = popFrame.spawningTarget;
if ( isAnchorLink(target)
&& popFrame.classList.containsAnyOf([ "full-page", "full-backlink-context" ]))
highlightTargetElementInDocument(target, popFrame.document);
// Scroll to the target.
Extracts.scrollToTargetedElementInPopFrame(popFrame);
},
// Called by: Extracts.rewritePopFrameContent (as `rewritePop${suffix}Content_${targetTypeName}`)
rewritePopupContent_LOCAL_PAGE: (popup, contentContainer) => {
GWLog("Extracts.rewritePopupContent_LOCAL_PAGE", "extracts-content.js", 2);
// Make anchorlinks scroll popup instead of opening normally.
Extracts.constrainLinkClickBehaviorInPopFrame(popup);
// Non-provider-specific rewrites.
Extracts.rewritePopFrameContent_LOCAL_PAGE(popup, contentContainer);
},
// Called by: Extracts.rewritePopFrameContent (as `rewritePop${suffix}Content_${targetTypeName}`)
rewritePopinContent_LOCAL_PAGE: (popin, contentContainer) => {
GWLog("Extracts.rewritePopinContent_LOCAL_PAGE", "extracts-content.js", 2);
/* Make anchorlinks scroll popin instead of opening normally
(but only for non-popin-spawning anchorlinks).
*/
Extracts.constrainLinkClickBehaviorInPopFrame(popin, (link => link.classList.contains("spawns-popin") == false));
// Non-provider-specific rewrites.
Extracts.rewritePopFrameContent_LOCAL_PAGE(popin, contentContainer);
}
};
/*=-----------------=*/
/*= AUXILIARY LINKS =*/
/*=-----------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"AUX_LINKS", // Type name
"isAuxLinksLink", // Type predicate function
"has-content", // Target classes to add
"auxLinksForTarget", // Pop-frame fill function
"aux-links" // Pop-frame classes
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isAuxLinksLink: (target) => {
let auxLinksLinkType = AuxLinks.auxLinksLinkType(target);
return ( auxLinksLinkType != null
&& target.classList.contains(auxLinksLinkType));
},
/* This “special testing function” is used to exclude certain targets which
have already been categorized as (in this case) `AUX_LINKS` targets.
It returns false if the target is to be excluded, true otherwise.
Excluded targets will not spawn pop-frames.
*/
// Called by: Extracts.targets.testTarget (as `testTarget_${targetTypeInfo.typeName}`)
testTarget_AUX_LINKS: (target) => {
let exclude = false;
let auxLinksType = AuxLinks.auxLinksLinkType(target);
let containingAnnotation = target.closest(".annotation");
if (containingAnnotation) {
let includedAuxLinksBlock = containingAnnotation.querySelector(`.${auxLinksType}-append`);
if (includedAuxLinksBlock)
exclude = true;
}
return (!( Extracts.popFrameProvider == Popins
&& exclude == true));
},
/* Backlinks, similar-links, etc.
*/
// Called by: extracts.js (as `popFrameFillFunctionName`)
auxLinksForTarget: (target) => {
GWLog("Extracts.auxLinksForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
class: "include-strict include-spinner-not " + AuxLinks.auxLinksLinkType(target)
}));
},
// Called by: extracts.js (as `titleForPopFrame_${targetTypeName}`)
titleForPopFrame_AUX_LINKS: (popFrame) => {
let target = popFrame.spawningTarget;
let targetPage = AuxLinks.targetOfAuxLinksLink(target);
let auxLinksLinkType = AuxLinks.auxLinksLinkType(target);
switch (auxLinksLinkType) {
case "backlinks":
return newDocument(`<code>${targetPage}</code><span> (Backlinks)</span>`);
case "similars":
return newDocument(`<code>${targetPage}</code><span> (Similar links)</span>`);
case "link-bibliography":
return newDocument(`<code>${targetPage}</code><span> (Bibliography)</span>`);
default:
return newDocument(`<code>${targetPage}</code>`);
}
},
// Called by: Extracts.preparePopFrame (as `preparePopFrame_${targetTypeName}`)
preparePopFrame_AUX_LINKS: (popFrame) => {
GWLog("Extracts.preparePopFrame_AUX_LINKS", "extracts-content.js", 2);
let auxLinksLinkType = AuxLinks.auxLinksLinkType(popFrame.spawningTarget);
if (auxLinksLinkType > "")
Extracts.popFrameProvider.addClassesToPopFrame(popFrame, auxLinksLinkType);
return popFrame;
},
// Called by: extracts.js (as `rewritePopFrameContent_${targetTypeName}`)
rewritePopFrameContent_AUX_LINKS: (popFrame, contentContainer) => {
GWLog("Extracts.rewritePopFrameContent_AUX_LINKS", "extracts-content.js", 2);
if (Extracts.popFrameProvider == Popups) {
popFrame.document.querySelectorAll(".backlink-source a:nth-of-type(2)").forEach(fullContextLink => {
let targetDocument = Extracts.targetDocument(fullContextLink);
if (targetDocument) {
let targetElement = targetElementInDocument(fullContextLink, targetDocument);
fullContextLink.addEventListener("mouseenter", (event) => {
targetElement.classList.toggle("block-context-highlighted-temp", true);
});
fullContextLink.addEventListener("mouseleave", (event) => {
targetElement.classList.toggle("block-context-highlighted-temp", false);
});
GW.notificationCenter.addHandlerForEvent("Popups.popupWillDespawn", (info) => {
targetElement.classList.toggle("block-context-highlighted-temp", false);
}, {
once: true,
condition: (info) => (info.popup == popFrame)
});
}
});
}
}
};
/*=--------------------=*/
/*= DROPCAP INFO LINKS =*/
/*=--------------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"DROPCAP_INFO", // Type name
"isDropcapInfoLink", // Type predicate function
null, // Target classes to add
"dropcapInfoForTarget", // Pop-frame fill function
(popFrame) => [ // Pop-frame classes
"dropcap-info",
(Extracts.popFrameProvider == Popups
? "mini-title-bar"
: "no-footer-bar")
].join(" ")
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isDropcapInfoLink: (target) => {
return Content.contentTypes.dropcapInfo.matches(target);
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
dropcapInfoForTarget: (target) => {
GWLog("Extracts.dropcapInfoForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
"class": "include-strict",
"data-letter": target.dataset.letter,
"data-dropcap-type": target.dataset.dropcapType
}));
},
// Called by: extracts.js (as `preparePopFrame_${targetTypeName}`)
preparePopFrame_DROPCAP_INFO: (popFrame) => {
// Base location is base location of spawning link’s document.
popFrame.document.baseLocation = baseLocationForDocument(popFrame.spawningTarget.getRootNode());
return popFrame;
},
};
/*=-----------=*/
/*= FOOTNOTES =*/
/*=-----------=*/
Extracts.targetTypeDefinitions.insertBefore([
"FOOTNOTE", // Type name
"isFootnoteLink", // Type predicate function
null, // Target classes to add
"footnoteForTarget", // Pop-frame fill function
(popFrame) => [ // Pop-frame classes
"footnote",
(Extracts.popFrameProvider == Popups
? "mini-title-bar"
: "no-footer-bar")
].join(" ")
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isFootnoteLink: (target) => {
return target.classList.contains("footnote-ref");
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
footnoteForTarget: (target) => {
GWLog("Extracts.footnoteForTarget", "extracts-content.js", 2);
let includeLink = synthesizeIncludeLink(target, {
"class": "include-strict include-spinner-not",
"data-include-selector-not": ".footnote-self-link, .footnote-back"
})
includeLink.hash = "#" + Notes.footnoteIdForNumber(Notes.noteNumber(target));
return newDocument(includeLink);
},
// Called by: extracts.js (as `titleForPopFrame_${targetTypeName}`)
titleForPopFrame_FOOTNOTE: (popFrame) => {
let target = popFrame.spawningTarget;
let footnoteNumber = target.querySelector("sup").textContent;
let popFrameTitleHTML = `Footnote #${footnoteNumber}`;
return Extracts.standardPopFrameTitleElementForTarget(target, popFrameTitleHTML);
},
// Called by: extracts.js (as `preparePopup_${targetTypeName}`)
preparePopup_FOOTNOTE: (popup) => {
let target = popup.spawningTarget;
/* Do not spawn footnote popup if the {side|foot}note it points to is
visible.
*/
if (Array.from(Notes.allNotesForCitation(target)).findIndex(note => Popups.isVisible(note)) !== -1)
return null;
/* Add event listeners to highlight citation when its footnote
popup is hovered over.
*/
popup.addEventListener("mouseenter", (event) => {
target.classList.toggle("highlighted", true);
});
popup.addEventListener("mouseleave", (event) => {
target.classList.toggle("highlighted", false);
});
GW.notificationCenter.addHandlerForEvent("Popups.popupWillDespawn", (info) => {
target.classList.toggle("highlighted", false);
}, {
once: true,
condition: (info) => (info.popup == popup)
});
return popup;
}
};
/*=-------------------------=*/
/*= CITATIONS CONTEXT LINKS =*/
/*=-------------------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"CITATION_CONTEXT", // Type name
"isCitationContextLink", // Type predicate function
null, // Target classes to add
"citationContextForTarget", // Pop-frame fill function
(popFrame) => [ // Pop-frame classes
"citation-context",
(Extracts.popFrameProvider == Popups
? "mini-title-bar"
: "no-footer-bar")
].join(" ")
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isCitationContextLink: (target) => {
return target.classList.contains("footnote-back");
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
citationContextForTarget: (target) => {
GWLog("Extracts.citationContextForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
class: "include-block-context-expanded include-strict include-spinner-not"
}));
},
/* This “special testing function” is used to exclude certain targets which
have already been categorized as (in this case) `CITATION_CONTEXT`
targets. It returns false if the target is to be excluded, true
otherwise. Excluded targets will not spawn pop-frames.
*/
// Called by: extracts.js (as `testTarget_${targetTypeInfo.typeName}`)
testTarget_CITATION_CONTEXT: (target) => {
return (Extracts.popFrameProvider != Popins);
},
// Called by: extracts.js (as `preparePopup_${targetTypeName}`)
preparePopup_CITATION_CONTEXT: (popup) => {
let target = popup.spawningTarget;
// Do not spawn citation context popup if citation is visible.
let targetDocument = Extracts.targetDocument(target);
if (targetDocument) {
let targetElement = targetElementInDocument(target, targetDocument);
if ( targetElement
&& Popups.isVisible(targetElement))
return null;
}
return popup;
},
// Called by: extracts.js (as `rewritePopupContent_${targetTypeName}`)
rewritePopupContent_CITATION_CONTEXT: (popup, contentContainer) => {
GWLog("Extracts.rewritePopupContent_CITATION_CONTEXT", "extracts-content.js", 2);
// Highlight citation in popup.
/* Remove the .targeted class from a targeted citation (if any)
inside the popup (to prevent confusion with the citation that
the spawning link points to, which will be highlighted).
*/
popup.document.querySelectorAll(".footnote-ref.targeted").forEach(targetedCitation => {
targetedCitation.classList.remove("targeted");
});
// In the popup, the citation for which context is being shown.
let citationInPopup = targetElementInDocument(popup.spawningTarget, popup.document);
// Highlight the citation.
citationInPopup.classList.add("targeted");
// Remove class that would interfere with styling.
citationInPopup.classList.remove("block-context-highlighted");
// Scroll to the citation.
Extracts.scrollToTargetedElementInPopFrame(popup);
}
};
/*=---------------=*/
/*= REMOTE IMAGES =*/
/*=---------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"REMOTE_IMAGE", // Type name
"isRemoteImageLink", // Type predicate function
"has-content", // Target classes to add
"remoteImageForTarget", // Pop-frame fill function
"image object" // Pop-frame classes
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isRemoteImageLink: (target) => {
return Content.contentTypes.remoteImage.matches(target);
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
remoteImageForTarget: (target) => {
GWLog("Extracts.remoteImageForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
"class": "include-caption-not include-strict include-spinner-not"
}));
},
// Called by: Extracts.rewritePopFrameContent (as `rewritePop${suffix}Content_${targetTypeName}`)
rewritePopupContent_REMOTE_IMAGE: (popup, contentContainer) => {
GWLog("Extracts.rewritePopFrameContent_REMOTE_IMAGE", "extracts-content.js", 2);
contentContainer.querySelector("img").addEventListener("load", (event) => {
requestAnimationFrame(() => {
Extracts.resizeObjectInObjectPopup(popup, "img");
});
}, { once: true });
}
};
/*=---------------=*/
/*= REMOTE VIDEOS =*/
/*=---------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"REMOTE_VIDEO", // Type name
"isRemoteVideoLink", // Type predicate function
"has-content", // Target classes to add
"remoteVideoForTarget", // Pop-frame fill function
"video object" // Pop-frame classes
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isRemoteVideoLink: (target) => {
return Content.contentTypes.remoteVideo.matches(target);
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
remoteVideoForTarget: (target) => {
GWLog("Extracts.remoteVideoForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
class: "include-strict include-spinner-not"
}));
},
// Called by: extracts.js (as `preparePopup_${targetTypeName}`)
preparePopup_REMOTE_VIDEO: (popup) => {
let target = popup.spawningTarget;
if (Content.contentTypes.remoteVideo.isYoutubeLink(target)) {
Extracts.popFrameProvider.addClassesToPopFrame(popup, "youtube");
} else if (Content.contentTypes.remoteVideo.isVimeoLink(target)) {
Extracts.popFrameProvider.addClassesToPopFrame(popup, "vimeo");
}
return popup;
}
};
/*=--------------------=*/
/*= CONTENT TRANSFORMS =*/
/*=--------------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"CONTENT_TRANSFORM", // Type name
"isContentTransformLink", // Type predicate function
/* NOTE: At some point, `content-transform` (or some analogous class) will
be added by the back-end code (or content.js for links in popups), so
will be removed from the line below.
—SA 2024-04-15
*/
"has-annotation content-transform", // Target classes to add
"contentTransformForTarget", // Pop-frame fill function
"content-transform" // Pop-frame classes
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isContentTransformLink: (target) => {
return ( target.classList.contains("content-transform-not") == false
&& [ "tweet",
"wikipediaEntry",
"githubIssue"
].findIndex(x => Content.contentTypes[x].matches(target)) !== -1);
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
contentTransformForTarget: (target) => {
GWLog("Extracts.contenTransformForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
"class": "include-strict include-spinner-not",
"data-include-template": "$popFrameTemplate"
}));
},
// Called by: extracts.js (as `preparePopup_${targetTypeName}`)
preparePopup_CONTENT_TRANSFORM: (popup) => {
/* Do not spawn popup if the transformed content is already visible
on screen. (This may occur if the target is in a popup that was
spawned from a backlinks popup for this same content as viewed on
a tag index page, for example.)
*/
let escapedLinkURL = CSS.escape(decodeURIComponent(popup.spawningTarget.href));
let targetAnalogueInLinkBibliography = document.querySelector(`a[id^='link-bibliography'][href='${escapedLinkURL}']`);
if (targetAnalogueInLinkBibliography) {
let containingSection = targetAnalogueInLinkBibliography.closest("section");
if ( containingSection
&& containingSection.querySelector("blockquote")
&& Popups.isVisible(containingSection)) {
return null;
}
}
return popup;
},
// Called by: Extracts.rewritePopFrameContent (as `updatePopFrame_${targetTypeName}`)
updatePopFrame_CONTENT_TRANSFORM: (popFrame) => {
GWLog("Extracts.updatePopFrame_CONTENT_TRANSFORM", "extracts-content.js", 2);
let referenceData = Content.referenceDataForLink(popFrame.spawningTarget);
// Mark pop-frame with content type class.
Extracts.popFrameProvider.addClassesToPopFrame(popFrame, ...(referenceData.contentTypeClass.split(" ")));
// Make anchor-links in Wikipedia content transforms un-clickable.
if (referenceData.contentTypeClass == "wikipedia-entry")
Extracts.constrainLinkClickBehaviorInPopFrame(popFrame);
// Update pop-frame title.
Extracts.updatePopFrameTitle(popFrame, referenceData.popFrameTitle);
}
};
/*=-----------------------=*/
/*= LOCALLY HOSTED VIDEOS =*/
/*=-----------------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"LOCAL_VIDEO", // Type name
"isLocalVideoLink", // Type predicate function
"has-content", // Target classes to add
"localVideoForTarget", // Pop-frame fill function
(popFrame) => [ // Pop-frame classes
"video object",
(Extracts.popFrameProvider == Popups
? "mini-title-bar"
: "no-footer-bar")
].join(" ")
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isLocalVideoLink: (target) => {
return Content.contentTypes.localVideo.matches(target);
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
localVideoForTarget: (target) => {
GWLog("Extracts.localVideoForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
"class": "include-caption-not include-strict include-spinner-not"
}));
},
// Called by: Extracts.rewritePopFrameContent (as `rewritePop${suffix}Content_${targetTypeName}`)
rewritePopupContent_LOCAL_VIDEO: (popup, contentContainer) => {
GWLog("Extracts.rewritePopFrameContent_LOCAL_VIDEO", "extracts-content.js", 2);
Extracts.resizeObjectInObjectPopup(popup, "video", { loosenSizeConstraints: true });
}
};
/*=----------------------------=*/
/*= LOCALLY HOSTED AUDIO FILES =*/
/*=----------------------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"LOCAL_AUDIO", // Type name
"isLocalAudioLink", // Type predicate function
"has-content", // Target classes to add
"localAudioForTarget", // Pop-frame fill function
(popFrame) => [ // Pop-frame classes
"audio object",
(Extracts.popFrameProvider == Popups
? "mini-title-bar no-resize-height"
: "no-footer-bar")
].join(" ")
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isLocalAudioLink: (target) => {
return Content.contentTypes.localAudio.matches(target);
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
localAudioForTarget: (target) => {
GWLog("Extracts.localAudioForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
"class": "include-caption-not include-strict include-spinner-not"
}));
}
};
/*=-----------------------=*/
/*= LOCALLY HOSTED IMAGES =*/
/*=-----------------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"LOCAL_IMAGE", // Type name
"isLocalImageLink", // Type predicate function
"has-content", // Target classes to add
"localImageForTarget", // Pop-frame fill function
(popFrame) => [ // Pop-frame classes
"image object",
(Extracts.popFrameProvider == Popups
? "mini-title-bar"
: "no-footer-bar")
].join(" ")
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isLocalImageLink: (target) => {
return Content.contentTypes.localImage.matches(target);
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
localImageForTarget: (target) => {
GWLog("Extracts.localImageForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
"class": "include-caption-not include-strict include-spinner-not"
}));
},
// Called by: extracts.js (as `rewritePopFrameContent_${targetTypeName}`)
rewritePopFrameContent_LOCAL_IMAGE: (popFrame, contentContainer) => {
GWLog("Extracts.rewritePopFrameContent_LOCAL_IMAGE", "extracts-content.js", 2);
// Mark sized image pop-frame.
if (popFrame.document.querySelector("img[width][height]"))
Extracts.popFrameProvider.addClassesToPopFrame(popFrame, "dimensions-specified");
},
// Called by: Extracts.rewritePopFrameContent (as `rewritePop${suffix}Content_${targetTypeName}`)
rewritePopupContent_LOCAL_IMAGE: (popup, contentContainer) => {
GWLog("Extracts.rewritePopFrameContent_LOCAL_IMAGE", "extracts-content.js", 2);
Extracts.resizeObjectInObjectPopup(popup, "img", { loosenSizeConstraints: true });
// Non-provider-specific rewrites.
Extracts.rewritePopFrameContent_LOCAL_IMAGE(popup, contentContainer);
}
};
/*=--------------------------=*/
/*= LOCALLY HOSTED DOCUMENTS =*/
/*=--------------------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"LOCAL_DOCUMENT", // Type name
"isLocalDocumentLink", // Type predicate function
"has-content", // Target classes to add
"localDocumentForTarget", // Pop-frame fill function
"local-document object" // Pop-frame classes
], (def => def[0] == "LOCAL_PAGE"));
Extracts = { ...Extracts,
// Called by: extracts.js (as `predicateFunctionName`)
isLocalDocumentLink: (target) => {
return Content.contentTypes.localDocument.matches(target);
},
// Called by: extracts.js (as `popFrameFillFunctionName`)
localDocumentForTarget: (target) => {
GWLog("Extracts.localDocumentForTarget", "extracts-content.js", 2);
return newDocument(synthesizeIncludeLink(target, {
class: "include-strict include-spinner-not"
}));
},
/* This “special testing function” is used to exclude certain targets which
have already been categorized as (in this case) `LOCAL_DOCUMENT`
targets. It returns false if the target is to be excluded, true
otherwise. Excluded targets will not spawn pop-frames.
*/
// Called by: extracts.js (as `testTarget_${targetTypeInfo.typeName}`)
testTarget_LOCAL_DOCUMENT: (target) => {
/* Mobile browsers have no in-browser PDF viewer, so a popin would be
pointless, since the file will download anyway.
*/
if ( Extracts.popFrameProvider == Popins
&& target.pathname.endsWith(".pdf"))
return false;
return true;
},
// Called by: extracts.js (as `rewritePopFrameContent_${targetTypeName}`)
rewritePopFrameContent_LOCAL_DOCUMENT: (popFrame, contentContainer) => {
GWLog("Extracts.rewritePopFrameContent_LOCAL_DOCUMENT", "extracts-content.js", 2);
let iframe = popFrame.document.querySelector("iframe");
if (iframe) {
iframe.addEventListener("load", (event) => {
// Set title of popup from page title, if any.
let title = iframe.contentDocument.title?.trim();
if (title > "")
Extracts.updatePopFrameTitle(popFrame, title);
}, { once: true });
}
}
};
/*=---------------------------=*/
/*= LOCALLY HOSTED CODE FILES =*/
/*=---------------------------=*/
Extracts.targetTypeDefinitions.insertBefore([
"LOCAL_CODE_FILE", // Type name
"isLocalCodeFileLink", // Type predicate function
"has-content", // Target classes to add
"localCodeFileForTarget", // Pop-frame fill function
"local-code-file" // Pop-frame classes
], (def => def[0] == "LOCAL_PAGE"));