-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
196 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
JavaScript-enhanced footnotes for HTML | ||
====================================== | ||
|
||
Challenges: | ||
|
||
- On screen, show footnote content close to where the footnote is referenced. | ||
- Support touch devices. | ||
- In print, show footnotes as usual. | ||
- Degrade gracefully if JavaScript is switched off. | ||
|
||
Further reading: | ||
|
||
- Blog post: http://www.2ality.com/2011/12/footnotes.html | ||
- Try it out: http://dl.2ality.com/dl/2011/12/footnotes/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
a.footptr { | ||
vertical-align: super; | ||
font-size: .83em; | ||
text-decoration: none; | ||
} | ||
a.refptr { | ||
text-decoration: none; | ||
} | ||
.foot-tooltip { | ||
background-color: #FCF6CF; | ||
padding-top: 0.5em; | ||
padding-bottom: 0.5em; | ||
padding-left: 1em; | ||
opacity: 0; | ||
-webkit-transition: opacity 0.3s linear; | ||
-moz-transition: opacity 0.3s linear; | ||
-o-transition: opacity 0.3s linear; | ||
-ms-transition: opacity 0.3s linear; | ||
transition: opacity 0.3s linear; | ||
} | ||
|
||
li:target { | ||
background-color: #BFEFFF; | ||
} | ||
|
||
ol#references { | ||
list-style:none; | ||
margin-left: 0; | ||
padding-left: 1.8em; | ||
text-indent: -1.8em; | ||
|
||
counter-reset: refcounter; | ||
} | ||
ol#references > li:before { | ||
content: "[" counter(refcounter) "] "; | ||
counter-increment: refcounter; | ||
} | ||
|
||
ol#footnotes { | ||
list-style:none; | ||
margin-left: 0; | ||
padding-left: 1.8em; | ||
text-indent: -1.8em; | ||
|
||
counter-reset: footcounter; | ||
} | ||
ol#footnotes > li:before { | ||
content: "(" counter(footcounter) ") "; | ||
counter-increment: footcounter; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
<!doctype html> | ||
<html> | ||
<head> | ||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
<title>HTML footnotes and references</title> | ||
<link rel="stylesheet" href="footnotes.css" type="text/css"> | ||
<script src="footnotes.js"></script> | ||
</head> | ||
<body> | ||
<h1>HTML footnotes and references</h1> | ||
|
||
You can use an IIFE<a class="ptr">(1)</a> to avoid the global namespace<a class="ptr">(2)</a> being polluted. JavaScript has many functional language constructs <a class="ptr">[1]</a>. For example: consult <a class="ptr">[2]</a> for an introduction to closures. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
<p> | ||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
|
||
<h2>Footnotes</h2> | ||
|
||
<ol id="footnotes"> | ||
<li>IIFE is an acronym for Immediately-Invoked Function Expression. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
</li> | ||
<li>The global scope is reified as an object in JavaScript. A <a href="http://www.example.com">link</a> to somewhere else. | ||
One more line. | ||
</li> | ||
</ol> | ||
|
||
<h2>References</h2> | ||
|
||
<ol id="references"> | ||
<li><a href="http://en.wikipedia.org/wiki/Functional_programming"><i>Functional programming</i></a>. In <i>Wikipedia</i>. Retrieved 2011-12-03. | ||
</li> | ||
<li>Douglas Crockford, <i>JavaScript: The Good Parts</i>. O’Reilly. 2008-05-16.</li> | ||
</ol> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
(function () { | ||
var FOOTNOTE_REGEX = /^\([0-9]+\)$/; | ||
var REFERENCE_REGEX = /^\[[0-9]+\]$/; | ||
|
||
var oldOnLoad = window.onload; | ||
window.onload = function (event) { | ||
if (document.getElementsByClassName) { | ||
var elems = document.getElementsByClassName("ptr"); | ||
for (var i = 0; i<elems.length; i++) { | ||
var elem = elems[i]; | ||
var ptrText = elem.innerHTML; | ||
if (FOOTNOTE_REGEX.test(ptrText)) { | ||
elem.className = "ptr footptr"; | ||
elem.onclick = toggle; | ||
} else if (REFERENCE_REGEX.test(ptrText)) { | ||
elem.className = "ptr refptr"; | ||
} | ||
elem.setAttribute("href", "#"+ptrText); | ||
} | ||
addListItemIds("references", "[", "]"); | ||
addListItemIds("footnotes", "(", ")"); | ||
} | ||
|
||
if (typeof oldOnLoad === "function") { | ||
oldOnLoad(event); | ||
} | ||
}; | ||
|
||
function addListItemIds(parentId, before, after) { | ||
var refs = document.getElementById(parentId); | ||
if (refs && refs.getElementsByTagName) { | ||
var elems = refs.getElementsByTagName("li"); | ||
for (var i = 0; i<elems.length; i++) { | ||
var elem = elems[i]; | ||
elem.setAttribute("id", before+(i+1)+after); | ||
} | ||
} | ||
} | ||
|
||
var currentDiv = null; | ||
var currentId = null; | ||
function toggle(event) { | ||
var parent = this.parentNode; | ||
if (currentDiv) { | ||
parent.removeChild(currentDiv); | ||
currentDiv = null; | ||
} | ||
var footnoteId = this.innerHTML; | ||
if (currentId === footnoteId) { | ||
currentId = null; | ||
} else { | ||
currentId = footnoteId; | ||
currentDiv = document.createElement("div"); | ||
var footHtml = document.getElementById(footnoteId).innerHTML; | ||
currentDiv.innerHTML = footHtml; | ||
currentDiv.className = "foot-tooltip"; | ||
parent.insertBefore(currentDiv, this.nextSibling); | ||
setTimeout(function () { | ||
currentDiv.style.opacity = "1"; | ||
}, 0); | ||
} | ||
event.preventDefault(); | ||
} | ||
}()); |