Compare commits

...

23 Commits

Author SHA1 Message Date
Ludwig Schubert 7fcd24a07b 2.5.0 2019-12-16 10:21:47 -08:00
Ludwig Schubert f569b07151 Add bibtex-key to d-cite for framework compatability 2019-12-16 10:21:38 -08:00
Ludwig Schubert 042da68b9a 2.4.3 2019-02-18 11:43:56 -08:00
Ludwig Schubert 4adbf9dcd2 Scope footer styles to avoid leaking them in pre-rendered mode 2019-02-18 11:43:45 -08:00
Ludwig Schubert f933920421 2.4.2 2019-02-15 17:35:55 -08:00
Ludwig Schubert cdfa045a36 Header prerendering now adds markup directly and adds distill-prerendered tag which TEMPLATE webcomponents now respect 2019-02-15 17:35:48 -08:00
Ludwig Schubert 5d83dbfd61 Add updated package-lock with hopefully some of the securoty warnings fixed 2019-02-06 21:09:46 -08:00
Ludwig Schubert 94510ee10b Switch debugging http server from python's http server to a http-server. 2019-02-06 21:07:06 -08:00
Ludwig Schubert 7b3038bbd3 2.4.1 2019-02-06 20:37:19 -08:00
Ludwig Schubert e9df166db9 Fix #101 by special casing bibtex author name strings without spaces or commas 2019-02-06 20:37:07 -08:00
Ludwig Schubert e6dd2fbfd9 2.4.0 2019-01-31 17:21:49 -08:00
Ludwig Schubert 37cc1f3157 Fix d-cite tags that are dynamically added (such as in footnotes) + eliminate inline-block extra whitespace 2019-01-31 17:20:56 -08:00
Ludwig Schubert 9ead1f6f01 Remove stray console.log(frontmatter) call 2019-01-31 17:20:56 -08:00
Ludwig Schubert ebe56d2329 Render d-math in all body (not just article) and remove contain: content optimizations in favor of contain: style 2019-01-31 17:20:56 -08:00
Ludwig Schubert c3ff605777 Move Runlevel reporting to console.debug calls, fix logic flaw when to complain about Controller initialization 2019-01-31 17:20:42 -08:00
Ludwig Schubert 0300b98cb6 2.3.0 2019-01-06 20:51:37 -08:00
Ludwig Schubert ecfd28bdf9 Allow any tag type in parseFrontMatter. <script> is still recommended where possible. 2019-01-06 20:33:19 -08:00
Ludwig Schubert 86ca6f72f4 Merge branch 'master' of github.com:distillpub/template 2019-01-03 14:42:54 -08:00
Ludwig Schubert d0f5824e0c Support specifying DOI in frontMatter (meant to be used for self-publishing; not for pre-rendered distill publishing) 2019-01-03 14:42:45 -08:00
Ludwig Schubert 8bd32bdf0b Merge pull request #100 from distillpub/d-cite-keys-whitespace
Trim whitespace
2018-12-28 19:59:06 +00:00
Shan Carter f2ae6d7aa3 Merge pull request #81 from lbertge/master
Update readme
2018-12-27 11:49:00 -08:00
Shan Carter 37c7483cb0 Trim whitespace
Trimming whitespace on keys.
2018-12-20 14:01:30 -08:00
Albert Ge 975c3e8256 Update readme 2018-07-06 14:47:18 -07:00
26 changed files with 2295 additions and 1855 deletions
+1 -44
View File
@@ -1,44 +1 @@
# Logs
logs
*.log
npm-debug.log*
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# node-waf configuration
.lock-wscript
# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules
bower_components
jspm_packages
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# Copied fonts
examples/fonts
dist
article-rendered.html
# dependency graph
rollup-grapher.html
.DS_Store
+1 -1
View File
@@ -11,7 +11,7 @@ To contribute a change, [check out the contributing guide](CONTRIBUTING.md).
### Local Development
Run `npm run start` to start a watching build rollup server. To view the sample pages in the repo, you can run `npm run serve` as a separate process which starts a static server. `npm run build` will run a one-time build.
First, run `npm install` to install all node modules required. Then, run `npm run dev` to start a watching build rollup server. To view the sample pages in the repo, you can run `npm run serve` as a separate process which starts a static server. `npm run build` will run a one-time build.
## Disclaimer & License
+1
View File
@@ -37,6 +37,7 @@ const options = { runScripts: 'outside-only', QuerySelector: true, virtualConsol
JSDOM.fromFile(program.inputPath, options).then(dom => {
const window = dom.window;
const document = window.document;
const HTMLElement = window.HTMLElement;
const data = new transforms.FrontMatter;
data.inputHTMLPath = program.inputPath; // may be needed to resolve relative links!
+119 -86
View File
@@ -17,14 +17,14 @@
<head>
<script src="../dist/template.v2.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" >
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf8">
</head>
<body>
<distill-header></distill-header>
<d-front-matter>
<script id='distill-front-matter' type="text/json">{
<d-front-matter>
<script id='distill-front-matter' type="text/json">{
"title": "Why Momentum Really Works",
"description": "Although \" extremely useful for visualizing high-dimensional data, t-SNE plots can sometimes be mysterious or misleading.",
"published": "Jan 10, 2017",
@@ -54,96 +54,129 @@
]
}
}</script>
</d-front-matter>
<d-title>
<figure style="grid-column: page; margin: 1rem 0;"><img src="momentum.png" style="width:100%; border: 1px solid rgba(0, 0, 0, 0.2);"/></figure>
<p>We often think of Momentum<d-cite key="mercier2011humans"></d-cite> as a means of dampening oscillations and speeding up the iterations, leading to faster convergence. But it has other interesting behavior. It allows a larger range of step-sizes to be used, and creates its own oscillations. What is going on?</p>
</d-title>
<d-byline></d-byline>
<d-article>
<a class="marker" href="#section-1" id="section-1"><span>1</span></a>
<h2>A Brief Survey of Techniques</h2>
<p>Before diving in: if you havent encountered t-SNE before, heres what you need to know about the math behind it. The goal is to take a set of points in a high-dimensional space and find a faithful representation of those points in a lower-dimensional space, typically the 2D plane. The algorithm is non-linear and adapts to the underlying data, performing different transformations on different regions. Those differences can be a major source of confusion.</p>
<p>This is the first paragraph of the article. Test a long&thinsp;&mdash;&thinsp;dash -- here it is.</p>
<p>Test for owner's possessive. Test for "quoting a passage." And another sentence. Or two. Some flopping fins; for diving.</p>
<aside>Some text in an aside, margin notes, etc...</aside>
<p>Here's a test of an inline equation <d-math>c = a^2 + b^2</d-math>. Also with configurable katex standards just using inline '$' signs: $$x^2$$ And then there's a block equation:</p>
<d-math block>
c = \pm \sqrt{ \sum_{i=0}^{n}{a^{222} + b^2}}
</d-math>
<p>Math can also be quite involved:</p>
<d-math block>
\frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }
</d-math>
<a class="marker" href="#section-1.1" id="section-1.1"><span>1.1</span></a>
<h3>Citations</h3>
<p><d-slider style="width: 200px;"></d-slider></p>
<p>We can<d-cite key="mercier2011humans"></d-cite> also cite <d-cite key="gregor2015draw,mercier2011humans"></d-cite> external publications. <d-cite key="dong2014image,dumoulin2016guide,mordvintsev2015inceptionism"></d-cite>. We should also be testing footnotes<d-footnote>This will become a hoverable footnote. This will become a hoverable footnote. This will become a hoverable footnote. This will become a hoverable footnote. This will become a hoverable footnote. This will become a hoverable footnote. This will become a hoverable footnote. This will become a hoverable footnote.</d-footnote>. There are multiple footnotes, and they appear in the appendix<d-footnote>Given I have coded them right. Also, here's math in a footnote: <d-math>c = \sum_0^i{x}</d-math>. Also, a citation. Box-ception<d-cite key='gregor2015draw'></d-cite>!</d-footnote> as well.</p>
<a class="marker" href="#section-2" id="section-2"><span>2</span></a>
<h2>Displaying code snippets</h2>
<p>Some inline javascript:<d-code language="javascript">var x = 25;</d-code>. And here's a javascript code block.</p>
<d-code block language="javascript">
</d-front-matter>
<d-title>
<figure style="grid-column: page; margin: 1rem 0;"><img src="momentum.png"
style="width:100%; border: 1px solid rgba(0, 0, 0, 0.2);" /></figure>
<p>We often think of Momentum<d-cite key="mercier2011humans"></d-cite> as a means of dampening oscillations and
speeding up the iterations, leading to faster convergence. But it has other interesting behavior. It allows a
larger range of step-sizes to be used, and creates its own oscillations. What is going on?</p>
</d-title>
<d-byline></d-byline>
<d-article>
<a class="marker" href="#section-1" id="section-1"><span>1</span></a>
<h2>A Brief Survey of Techniques</h2>
<p>Before diving in: if you havent encountered t-SNE before, heres what you need to know about the math behind it.
The goal is to take a set of points in a high-dimensional space and find a faithful representation of those points
in a lower-dimensional space, typically the 2D plane. The algorithm is non-linear and adapts to the underlying
data, performing different transformations on different regions. Those differences can be a major source of
confusion.</p>
<p>This is the first paragraph of the article. Test a long&thinsp;&mdash;&thinsp;dash -- here it is.</p>
<p>Test for owner's possessive. Test for "quoting a passage." And another sentence. Or two. Some flopping fins; for
diving.</p>
<aside>Some text in an aside, margin notes, etc...</aside>
<p>Here's a test of an inline equation <d-math>c = a^2 + b^2</d-math>. Also with configurable katex standards just
using inline '$' signs: $$x^2$$ And then there's a block equation:</p>
<d-math block>
c = \pm \sqrt{ \sum_{i=0}^{n}{a^{222} + b^2}}
</d-math>
<p>Math can also be quite involved:</p>
<d-math block>
\frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}}
{1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }
</d-math>
<a class="marker" href="#section-1.1" id="section-1.1"><span>1.1</span></a>
<h3>Citations</h3>
<p>
<d-slider style="width: 200px;"></d-slider>
</p>
<p>We can<d-cite bibtex-key="mercier2011humans"></d-cite> also cite <d-cite
key="gregor2015draw,mercier2011humans,openai2018charter"></d-cite> external publications. <d-cite
key="dong2014image,dumoulin2016guide,mordvintsev2015inceptionism"></d-cite>. We should also be testing footnotes
<d-footnote>This will become a hoverable footnote. This will become a hoverable footnote. This will become a
hoverable footnote. This will become a hoverable footnote. This will become a hoverable footnote. This will
become a hoverable footnote. This will become a hoverable footnote. This will become a hoverable footnote.
</d-footnote>. There are multiple footnotes, and they appear in the appendix<d-footnote>Given I have coded them
right. Also, here's math in a footnote: <d-math>c = \sum_0^i{x}</d-math>. Also, a citation. Box-ception<d-cite
key='gregor2015draw'></d-cite>!</d-footnote> as well.</p>
<a class="marker" href="#section-2" id="section-2"><span>2</span></a>
<h2>Displaying code snippets</h2>
<p>Some inline javascript:<d-code language="javascript">var x = 25;</d-code>. And here's a javascript code block.
</p>
<d-code block language="javascript">
var x = 25;
function(x){
return x * x;
return x * x;
}
</d-code>
<p>We also support python.</p>
<d-code block language="python">
# Python 3: Fibonacci series up to n
def fib(n):
</d-code>
<p>We also support python.</p>
<d-code block language="python">
# Python 3: Fibonacci series up to n
def fib(n):
a, b = 0, 1
while a < n:
print(a, end=' ')
a, b = b, a+b
</d-code>
<p>And a table</p>
<table>
<thead>
<tr><th>First</th><th>Second</th><th>Third</th></tr>
</thead>
<tbody>
<tr><td>23</td><td>654</td><td>23</td></tr>
<tr><td>14</td><td>54</td><td>34</td></tr>
<tr><td>234</td><td>54</td><td>23</td></tr>
</tbody>
</table>
<d-figure id="last-figure"></d-figure>
<script>
const figure = document.querySelector("d-figure#last-figure");
const initTag = document.createElement("span");
initTag.textContent = "initialized!"
figure.appendChild(initTag);
figure.addEventListener("ready", function() {
const initTag = figure.querySelector("span");
initTag.textContent = "ready"
console.log('ready')
});
figure.addEventListener("onscreen", function() {
const initTag = figure.querySelector("span");
initTag.textContent = "onscreen"
console.log('onscreen')
});
figure.addEventListener("offscreen", function() {
const initTag = figure.querySelector("span");
initTag.textContent = "offscreen!"
console.log('offscreen')
});
</script>
<p>That's it for the example article!</p>
while a < n: print(a, end=' ' ) a, b=b, a+b </d-code> <p>And a table</p>
<table>
<thead>
<tr>
<th>First</th>
<th>Second</th>
<th>Third</th>
</tr>
</thead>
<tbody>
<tr>
<td>23</td>
<td>654</td>
<td>23</td>
</tr>
<tr>
<td>14</td>
<td>54</td>
<td>34</td>
</tr>
<tr>
<td>234</td>
<td>54</td>
<td>23</td>
</tr>
</tbody>
</table>
<d-figure id="last-figure"></d-figure>
<script>
const figure = document.querySelector("d-figure#last-figure");
const initTag = document.createElement("span");
initTag.textContent = "initialized!"
figure.appendChild(initTag);
figure.addEventListener("ready", function () {
const initTag = figure.querySelector("span");
initTag.textContent = "ready"
console.log('ready')
});
figure.addEventListener("onscreen", function () {
const initTag = figure.querySelector("span");
initTag.textContent = "onscreen"
console.log('onscreen')
});
figure.addEventListener("offscreen", function () {
const initTag = figure.querySelector("span");
initTag.textContent = "offscreen!"
console.log('offscreen')
});
</script>
<p>That's it for the example article!</p>
</d-article>
</d-article>
<d-appendix>
<d-appendix>
<h3>Contributions</h3>
<p>Some text describing who did what.</p>
<h3>Reviewers</h3>
<p>Some text with links describing who reviewed the article.</p>
<h3>Contributions</h3>
<p>Some text describing who did what.</p>
<h3>Reviewers</h3>
<p>Some text with links describing who reviewed the article.</p>
<d-bibliography src="bibliography.bib"></d-bibliography>
</d-appendix>
<d-bibliography src="bibliography.bib"></d-bibliography>
</d-appendix>
<distill-footer></distill-footer>
<distill-footer></distill-footer>
</body>
</body>
+9
View File
@@ -97,3 +97,12 @@
year={2016},
url={https://arxiv.org/pdf/1609.07009.pdf}
}
@misc{openai2018charter,
author={OpenAI},
title={OpenAI Charter},
type={Blog},
number={April 9},
year={2018},
url={https://blog.openai.com/charter},
}
+1780 -1413
View File
File diff suppressed because it is too large Load Diff
+5 -4
View File
@@ -1,6 +1,6 @@
{
"name": "distill-template",
"version": "2.2.26",
"version": "2.5.0",
"description": "Template for creating Distill articles.",
"main": "dist/template.v2.js",
"bin": {
@@ -13,7 +13,7 @@
},
"scripts": {
"dev": "rollup -c rollup.config.dev.js -w",
"serve": "python3 -m http.server --bind 127.0.0.1 8888",
"serve": "http-server",
"test": "mocha",
"lint": "eslint",
"build": "rollup -c rollup.config.js",
@@ -28,11 +28,12 @@
"chai": "^3.5.0",
"eslint": "^4.3.0",
"eslint-config-google": "^0.9.1",
"http-server": "^0.11.1",
"js-yaml": "^3.7.0",
"jsdom": "11.3.0",
"jsdom-global": "3.0.2",
"marked": "^0.3.6",
"mocha": "^3.5.3",
"marked": "^0.6.0",
"mocha": "^5.2.0",
"prismjs": "^1.6.0",
"rollup": "^0.50.0",
"rollup-plugin-babili": "^3.1.0",
+16 -13
View File
@@ -13,6 +13,7 @@
// limitations under the License.
import { Controller } from './controller';
import { domContentLoaded } from './helpers/domContentLoaded.js';
/* Transforms */
import { makeStyleTag } from './styles/styles';
@@ -55,13 +56,13 @@ const distillMain = function() {
throw new Error('Runlevel 1: Distill Template is getting loaded more than once, aborting!');
} else {
window.distillTemplateIsLoading = true;
console.info('Runlevel 1: Distill Template has started loading.');
console.debug('Runlevel 1: Distill Template has started loading.');
}
/* 2. Add styles if they weren't added during prerendering */
makeStyleTag(document);
console.info('Runlevel 1: Static Distill styles have been added.');
console.info('Runlevel 1->2.');
console.debug('Runlevel 1: Static Distill styles have been added.');
console.debug('Runlevel 1->2.');
window.distillRunlevel += 1;
/* 3. Register Controller listener functions */
@@ -73,8 +74,8 @@ const distillMain = function() {
console.error('Runlevel 2: Controller listeners need to be functions!');
}
}
console.info('Runlevel 2: We can now listen to controller events.');
console.info('Runlevel 2->3.');
console.debug('Runlevel 2: We can now listen to controller events.');
console.debug('Runlevel 2->3.');
window.distillRunlevel += 1;
/* 4. Register components */
@@ -93,29 +94,31 @@ const distillMain = function() {
}
const allComponents = components.concat(distillComponents);
for (const component of allComponents) {
console.info('Runlevel 2: Registering custom element: ' + component.is);
console.debug('Runlevel 2: Registering custom element: ' + component.is);
customElements.define(component.is, component);
}
console.info('Runlevel 3: Distill Template finished registering custom elements.');
console.info('Runlevel 3->4.');
console.debug('Runlevel 3: Distill Template finished registering custom elements.');
console.debug('Runlevel 3->4.');
window.distillRunlevel += 1;
// If template was added after DOMContentLoaded we may have missed that event.
// Controller will check for that case, so trigger the event explicitly:
Controller.listeners.DOMContentLoaded();
if (domContentLoaded()) {
Controller.listeners.DOMContentLoaded();
}
console.info('Runlevel 4: Distill Template initialisation complete.');
console.debug('Runlevel 4: Distill Template initialisation complete.');
};
window.distillRunlevel = 0;
/* 0. Check browser feature support; synchronously polyfill if needed */
if (Polyfills.browserSupportsAllFeatures()) {
console.info('Runlevel 0: No need for polyfills.');
console.info('Runlevel 0->1.');
console.debug('Runlevel 0: No need for polyfills.');
console.debug('Runlevel 0->1.');
window.distillRunlevel += 1;
distillMain();
} else {
console.info('Runlevel 0: Distill Template is loading polyfills.');
console.debug('Runlevel 0: Distill Template is loading polyfills.');
Polyfills.load(distillMain);
}
+1 -1
View File
@@ -16,7 +16,7 @@ import { bibliography_cite } from '../helpers/citation';
const styles = `
d-citation-list {
contain: layout style;
contain: style;
}
d-citation-list .references {
+62 -32
View File
@@ -12,18 +12,19 @@
// See the License for the specific language governing permissions and
// limitations under the License.
import { Template } from '../mixins/template';
import { hover_cite, bibliography_cite } from '../helpers/citation';
import { Template } from "../mixins/template";
import { hover_cite, bibliography_cite } from "../helpers/citation";
const T = Template('d-cite', `
const T = Template(
"d-cite",
`
<style>
:host {
display: inline-block;
}
.citation {
display: inline-block;
color: hsla(206, 90%, 20%, 0.7);
}
@@ -68,76 +69,105 @@ ul li:last-of-type {
<d-hover-box id="hover-box"></d-hover-box>
<div id="citation-" class="citation">
<slot></slot>
<span class="citation-number"></span>
</div>
`);
`
);
export class Cite extends T(HTMLElement) {
/* Lifecycle */
constructor() {
super();
this._numbers = [];
this._entries = [];
}
connectedCallback() {
this.outerSpan = this.root.querySelector('#citation-');
this.innerSpan = this.root.querySelector('.citation-number');
this.hoverBox = this.root.querySelector('d-hover-box');
window.customElements.whenDefined('d-hover-box').then(() => {
this.outerSpan = this.root.querySelector("#citation-");
this.innerSpan = this.root.querySelector(".citation-number");
this.hoverBox = this.root.querySelector("d-hover-box");
window.customElements.whenDefined("d-hover-box").then(() => {
this.hoverBox.listen(this);
});
// in case this component got connected after values were set
if (this.numbers) {
this.displayNumbers(this.numbers);
}
if (this.entries) {
this.displayEntries(this.entries);
}
}
//TODO This causes an infinite loop on firefox with polyfills.
// This is only needed for interactive editing so no priority.
// disconnectedCallback() {
// const options = { detail: [this, this.keys], bubbles: true };
// const event = new CustomEvent('onCiteKeyRemoved', options);
// document.dispatchEvent(event);
// const options = { detail: [this, this.keys], bubbles: true };
// const event = new CustomEvent('onCiteKeyRemoved', options);
// document.dispatchEvent(event);
// }
/* observe 'key' attribute */
static get observedAttributes() {
return ['key'];
return ["key", "bibtex-key"];
}
attributeChangedCallback(name, oldValue, newValue) {
const eventName = oldValue ? 'onCiteKeyChanged' : 'onCiteKeyCreated';
const keys = newValue.split(',');
const eventName = oldValue ? "onCiteKeyChanged" : "onCiteKeyCreated";
const keys = newValue.split(",").map(k => k.trim());
const options = { detail: [this, keys], bubbles: true };
const event = new CustomEvent(eventName, options);
document.dispatchEvent(event);
}
set key(value) {
this.setAttribute('key', value);
this.setAttribute("key", value);
}
get key() {
return this.getAttribute('key');
return this.getAttribute("key") || this.getAttribute("bibtex-key");
}
get keys() {
return this.getAttribute('key').split(',');
return this.key.split(",");
}
/* Setters & Rendering */
set numbers(numbers) {
const numberStrings = numbers.map( index => {
return index == -1 ? '?' : index + 1 + '';
this._numbers = numbers;
this.displayNumbers(numbers);
}
get numbers() {
return this._numbers;
}
displayNumbers(numbers) {
if (!this.innerSpan) return;
const numberStrings = numbers.map(index => {
return index == -1 ? "?" : index + 1 + "";
});
const textContent = '[' + numberStrings.join(', ') + ']';
if (this.innerSpan) {
this.innerSpan.textContent = textContent;
}
const textContent = "[" + numberStrings.join(", ") + "]";
this.innerSpan.textContent = textContent;
}
set entries(entries) {
if (this.hoverBox) {
this.hoverBox.innerHTML = `<ul>
${entries.map(hover_cite).map(html => `<li>${html}</li>`).join('\n')}
</ul>`;
}
this._entries = entries;
this.displayEntries(entries);
}
get entries() {
return this._entries;
}
displayEntries(entries) {
if (!this.hoverBox) return;
this.hoverBox.innerHTML = `<ul>
${entries
.map(hover_cite)
.map(html => `<li>${html}</li>`)
.join("\n")}
</ul>`;
}
}
+1 -2
View File
@@ -30,12 +30,11 @@ export function _moveLegacyAffiliationFormatIntoArray(frontMatter) {
author.affiliations = [newAffiliation];
}
}
console.log(frontMatter)
return frontMatter
}
export function parseFrontmatter(element) {
const scriptTag = element.querySelector('script');
const scriptTag = element.firstElementChild;
if (scriptTag) {
const type = scriptTag.getAttribute('type');
if (type.split('/')[1] == 'json') {
+2 -3
View File
@@ -30,7 +30,7 @@ ${katexCSSTag}
:host {
display: inline-block;
contain: content;
contain: style;
}
:host([block]) {
@@ -73,8 +73,7 @@ export class DMath extends Mutating(T(HTMLElement)) {
}
// transform inline delimited math to d-math tags
if (DMath.katexOptions.delimiters) {
const article = document.querySelector('d-article');
renderMathInElement(article, DMath.katexOptions);
renderMathInElement(document.body, DMath.katexOptions);
}
}
+8 -8
View File
@@ -15,14 +15,12 @@
import { FrontMatter, mergeFromYMLFrontmatter } from './front-matter';
import { DMath } from './components/d-math';
import { collect_citations } from './helpers/citation.js';
import { domContentLoaded } from './helpers/domContentLoaded.js';
import { parseFrontmatter } from './components/d-front-matter';
import optionalComponents from './transforms/optional-components';
const frontMatter = new FrontMatter();
function domContentLoaded() {
return ['interactive', 'complete'].indexOf(document.readyState) !== -1;
}
export const Controller = {
@@ -109,7 +107,7 @@ export const Controller = {
if (citationListTag.hasAttribute('distill-prerendered')) {
console.info('Citation list was prerendered; not updating it.');
console.debug('Citation list was prerendered; not updating it.');
} else {
const entries = new Map(frontMatter.citations.map( citationKey => {
return [citationKey, frontMatter.bibliography.get(citationKey)];
@@ -167,16 +165,18 @@ export const Controller = {
console.warn('Controller received DOMContentLoaded but was already loaded!');
return;
} else if (!domContentLoaded()) {
console.warn('Controller received DOMContentLoaded before appropriate document.readyState!');
console.warn('Controller received DOMContentLoaded at document.readyState: ' + document.readyState + '!');
return;
} else {
Controller.loaded = true;
console.log('Runlevel 4: Controller running DOMContentLoaded');
console.debug('Runlevel 4: Controller running DOMContentLoaded');
}
const frontMatterTag = document.querySelector('d-front-matter');
const data = parseFrontmatter(frontMatterTag);
Controller.listeners.onFrontMatterChanged({detail: data});
if (frontMatterTag) {
const data = parseFrontmatter(frontMatterTag);
Controller.listeners.onFrontMatterChanged({detail: data});
}
// Resolving "citations" dependency due to initial DOM load
frontMatter.citations = collect_citations();
@@ -0,0 +1,74 @@
import logo from '../assets/distill-logo.svg';
export const footerTemplate = `
<style>
:host {
color: rgba(255, 255, 255, 0.5);
font-weight: 300;
padding: 2rem 0;
border-top: 1px solid rgba(0, 0, 0, 0.1);
background-color: hsl(180, 5%, 15%); /*hsl(200, 60%, 15%);*/
text-align: left;
contain: content;
}
.footer-container .logo svg {
width: 24px;
position: relative;
top: 4px;
margin-right: 2px;
}
.footer-container .logo svg path {
fill: none;
stroke: rgba(255, 255, 255, 0.8);
stroke-width: 3px;
}
.footer-container .logo {
font-size: 17px;
font-weight: 200;
color: rgba(255, 255, 255, 0.8);
text-decoration: none;
margin-right: 6px;
}
.footer-container {
grid-column: text;
}
.footer-container .nav {
font-size: 0.9em;
margin-top: 1.5em;
}
.footer-container .nav a {
color: rgba(255, 255, 255, 0.8);
margin-right: 6px;
text-decoration: none;
}
</style>
<div class='footer-container'>
<a href="/" class="logo">
${logo}
Distill
</a> is dedicated to clear explanations of machine learning
<div class="nav">
<a href="https://distill.pub/about/">About</a>
<a href="https://distill.pub/journal/">Submit</a>
<a href="https://distill.pub/prize/">Prize</a>
<a href="https://distill.pub/archive/">Archive</a>
<a href="https://distill.pub/rss.xml">RSS</a>
<a href="https://github.com/distillpub">GitHub</a>
<a href="https://twitter.com/distillpub">Twitter</a>
&nbsp;&nbsp;&nbsp;&nbsp; ISSN 2476-0757
</div>
</div>
`;
+2 -72
View File
@@ -13,80 +13,10 @@
// limitations under the License.
import { Template } from '../mixins/template';
import logo from '../assets/distill-logo.svg';
const T = Template('distill-footer', `
<style>
import {footerTemplate} from './distill-footer-template';
:host {
color: rgba(255, 255, 255, 0.5);
font-weight: 300;
padding: 2rem 0;
border-top: 1px solid rgba(0, 0, 0, 0.1);
background-color: hsl(180, 5%, 15%); /*hsl(200, 60%, 15%);*/
text-align: left;
contain: content;
}
.logo svg {
width: 24px;
position: relative;
top: 4px;
margin-right: 2px;
}
.logo svg path {
fill: none;
stroke: rgba(255, 255, 255, 0.8);
stroke-width: 3px;
}
.logo {
font-size: 17px;
font-weight: 200;
color: rgba(255, 255, 255, 0.8);
text-decoration: none;
margin-right: 6px;
}
.container {
grid-column: text;
}
.nav {
font-size: 0.9em;
margin-top: 1.5em;
}
.nav a {
color: rgba(255, 255, 255, 0.8);
margin-right: 6px;
text-decoration: none;
}
</style>
<div class='container'>
<a href="/" class="logo">
${logo}
Distill
</a> is dedicated to clear explanations of machine learning
<div class="nav">
<a href="https://distill.pub/about/">About</a>
<a href="https://distill.pub/journal/">Submit</a>
<a href="https://distill.pub/prize/">Prize</a>
<a href="https://distill.pub/archive/">Archive</a>
<a href="https://distill.pub/rss.xml">RSS</a>
<a href="https://github.com/distillpub">GitHub</a>
<a href="https://twitter.com/distillpub">Twitter</a>
&nbsp;&nbsp;&nbsp;&nbsp; ISSN 2476-0757
</div>
</div>
`);
const T = Template('distill-footer', footerTemplate);
export class DistillFooter extends T(HTMLElement) {
@@ -0,0 +1,79 @@
import logo from '../assets/distill-logo.svg';
export const headerTemplate = `
<style>
distill-header {
position: relative;
height: 60px;
background-color: hsl(200, 60%, 15%);
width: 100%;
box-sizing: border-box;
z-index: 2;
color: rgba(0, 0, 0, 0.8);
border-bottom: 1px solid rgba(0, 0, 0, 0.08);
box-shadow: 0 1px 6px rgba(0, 0, 0, 0.05);
}
distill-header .content {
height: 70px;
grid-column: page;
}
distill-header a {
font-size: 16px;
height: 60px;
line-height: 60px;
text-decoration: none;
color: rgba(255, 255, 255, 0.8);
padding: 22px 0;
}
distill-header a:hover {
color: rgba(255, 255, 255, 1);
}
distill-header svg {
width: 24px;
position: relative;
top: 4px;
margin-right: 2px;
}
@media(min-width: 1080px) {
distill-header {
height: 70px;
}
distill-header a {
height: 70px;
line-height: 70px;
padding: 28px 0;
}
distill-header .logo {
}
}
distill-header svg path {
fill: none;
stroke: rgba(255, 255, 255, 0.8);
stroke-width: 3px;
}
distill-header .logo {
font-size: 17px;
font-weight: 200;
}
distill-header .nav {
float: right;
font-weight: 300;
}
distill-header .nav a {
font-size: 12px;
margin-left: 24px;
text-transform: uppercase;
}
</style>
<div class="content">
<a href="/" class="logo">
${logo}
Distill
</a>
<nav class="nav">
<a href="/about/">About</a>
<a href="/prize/">Prize</a>
<a href="/journal/">Submit</a>
</nav>
</div>
`;
+2 -79
View File
@@ -14,86 +14,9 @@
import { Template } from '../mixins/template';
import logo from '../assets/distill-logo.svg';
const T = Template('distill-header', `
<style>
distill-header {
position: relative;
height: 60px;
background-color: hsl(200, 60%, 15%);
width: 100%;
box-sizing: border-box;
z-index: 2;
color: rgba(0, 0, 0, 0.8);
border-bottom: 1px solid rgba(0, 0, 0, 0.08);
box-shadow: 0 1px 6px rgba(0, 0, 0, 0.05);
}
distill-header .content {
height: 70px;
grid-column: page;
}
distill-header a {
font-size: 16px;
height: 60px;
line-height: 60px;
text-decoration: none;
color: rgba(255, 255, 255, 0.8);
padding: 22px 0;
}
distill-header a:hover {
color: rgba(255, 255, 255, 1);
}
distill-header svg {
width: 24px;
position: relative;
top: 4px;
margin-right: 2px;
}
@media(min-width: 1080px) {
distill-header {
height: 70px;
}
distill-header a {
height: 70px;
line-height: 70px;
padding: 28px 0;
}
distill-header .logo {
}
}
distill-header svg path {
fill: none;
stroke: rgba(255, 255, 255, 0.8);
stroke-width: 3px;
}
distill-header .logo {
font-size: 17px;
font-weight: 200;
}
distill-header .nav {
float: right;
font-weight: 300;
}
distill-header .nav a {
font-size: 12px;
margin-left: 24px;
text-transform: uppercase;
}
</style>
<div class="content">
<a href="/" class="logo">
${logo}
Distill
</a>
<nav class="nav">
<a href="/about/">About</a>
<a href="/prize/">Prize</a>
<a href="/journal/">Submit</a>
</nav>
</div>
`, false);
import {headerTemplate} from './distill-header-template';
const T = Template('distill-header', headerTemplate, false);
export class DistillHeader extends T(HTMLElement) {
+3
View File
@@ -12,10 +12,13 @@
// See the License for the specific language governing permissions and
// limitations under the License.
import { footerTemplate } from '../distill-components/distill-footer-template';
export default function(dom) {
const footerTag = dom.querySelector('distill-footer');
if(!footerTag) {
const footer = dom.createElement('distill-footer');
footer.innerHTML = footerTemplate;
const body = dom.querySelector('body');
body.appendChild(footer);
}
+6 -1
View File
@@ -12,10 +12,15 @@
// See the License for the specific language governing permissions and
// limitations under the License.
export default function(dom) {
import { headerTemplate } from '../distill-components/distill-header-template';
export default function(dom, data) {
const headerTag = dom.querySelector('distill-header');
if (!headerTag) {
const header = dom.createElement('distill-header');
header.innerHTML = headerTemplate;
header.setAttribute('distill-prerendered', "");
const body = dom.querySelector('body');
body.insertBefore(header, body.firstChild);
}
+5
View File
@@ -96,6 +96,9 @@ export function mergeFromYMLFrontmatter(target, source) {
target.authors = source.authors.map( (authorObject) => new Author(authorObject));
target.katex = source.katex;
target.password = source.password;
if (source.doi) {
target.doi = source.doi;
}
}
export class FrontMatter {
@@ -160,6 +163,7 @@ export class FrontMatter {
// githubCompareUpdatesUrl: 'https://github.com/distillpub/post--augmented-rnns/compare/1596e094d8943d2dc0ea445d92071129c6419c59...3bd9209e0c24d020f87cf6152dcecc6017cbc193',
// updatedDate: 2017-03-21T07:13:16.000Z,
// doi: '10.23915/distill.00001',
this.doi = undefined;
this.publishedDate = undefined;
}
@@ -318,6 +322,7 @@ export class FrontMatter {
Object.assign(target, this);
target.bibliography = objectFromMap(this.bibliographyEntries);
target.url = this.url;
target.doi = this.doi;
target.githubUrl = this.githubUrl;
target.previewURL = this.previewURL;
if (this.publishedDate) {
+105 -89
View File
@@ -12,71 +12,85 @@
// See the License for the specific language governing permissions and
// limitations under the License.
export function collect_citations(dom=document) {
export function collect_citations(dom = document) {
const citations = new Set();
const citeTags = dom.querySelectorAll('d-cite');
const citeTags = dom.querySelectorAll("d-cite");
for (const tag of citeTags) {
const keys = tag.getAttribute('key').split(',');
for (const key of keys) {
for (const key of tag.keys) {
citations.add(key);
}
}
return [...citations];
}
export function inline_cite_short(keys){
function cite_string(key){
if (key in data.bibliography){
var n = data.citations.indexOf(key)+1;
return ''+n;
export function inline_cite_short(keys) {
function cite_string(key) {
if (key in data.bibliography) {
var n = data.citations.indexOf(key) + 1;
return "" + n;
} else {
return '?';
return "?";
}
}
return '['+keys.map(cite_string).join(', ')+']';
return "[" + keys.map(cite_string).join(", ") + "]";
}
export function inline_cite_long(keys){
function cite_string(key){
if (key in data.bibliography){
export function inline_cite_long(keys) {
function cite_string(key) {
if (key in data.bibliography) {
var ent = data.bibliography[key];
var names = ent.author.split(' and ');
names = names.map(name => name.split(',')[0].trim());
var names = ent.author.split(" and ");
names = names.map(name => name.split(",")[0].trim());
var year = ent.year;
if (names.length == 1) return names[0] + ', ' + year;
if (names.length == 2) return names[0] + ' & ' + names[1] + ', ' + year;
if (names.length > 2) return names[0] + ', et al., ' + year;
if (names.length == 1) return names[0] + ", " + year;
if (names.length == 2) return names[0] + " & " + names[1] + ", " + year;
if (names.length > 2) return names[0] + ", et al., " + year;
} else {
return '?';
return "?";
}
}
return keys.map(cite_string).join(', ');
return keys.map(cite_string).join(", ");
}
function author_string(ent, template, sep, finalSep){
if (ent.author == null) { return ''; }
var names = ent.author.split(' and ');
function author_string(ent, template, sep, finalSep) {
if (ent.author == null) {
return "";
}
var names = ent.author.split(" and ");
let name_strings = names.map(name => {
name = name.trim();
if (name.indexOf(',') != -1){
var last = name.split(',')[0].trim();
var firsts = name.split(',')[1];
if (name.indexOf(",") != -1) {
var last = name.split(",")[0].trim();
var firsts = name.split(",")[1];
} else if (name.indexOf(" ") != -1) {
var last = name
.split(" ")
.slice(-1)[0]
.trim();
var firsts = name
.split(" ")
.slice(0, -1)
.join(" ");
} else {
var last = name.split(' ').slice(-1)[0].trim();
var firsts = name.split(' ').slice(0,-1).join(' ');
var last = name.trim();
}
var initials = '';
var initials = "";
if (firsts != undefined) {
initials = firsts.trim().split(' ').map(s => s.trim()[0]);
initials = initials.join('.')+'.';
initials = firsts
.trim()
.split(" ")
.map(s => s.trim()[0]);
initials = initials.join(".") + ".";
}
return template.replace('${F}', firsts)
.replace('${L}', last)
.replace('${I}', initials);
return template
.replace("${F}", firsts)
.replace("${L}", last)
.replace("${I}", initials)
.trim(); // in case one of first or last was empty
});
if (names.length > 1) {
var str = name_strings.slice(0, names.length-1).join(sep);
str += (finalSep || sep) + name_strings[names.length-1];
var str = name_strings.slice(0, names.length - 1).join(sep);
str += (finalSep || sep) + name_strings[names.length - 1];
return str;
} else {
return name_strings[0];
@@ -84,69 +98,71 @@ function author_string(ent, template, sep, finalSep){
}
function venue_string(ent) {
var cite = (ent.journal || ent.booktitle || '');
if ('volume' in ent){
var cite = ent.journal || ent.booktitle || "";
if ("volume" in ent) {
var issue = ent.issue || ent.number;
issue = (issue != undefined)? '('+issue+')' : '';
cite += ', Vol ' + ent.volume + issue;
issue = issue != undefined ? "(" + issue + ")" : "";
cite += ", Vol " + ent.volume + issue;
}
if ('pages' in ent){
cite += ', pp. ' + ent.pages;
if ("pages" in ent) {
cite += ", pp. " + ent.pages;
}
if (cite != '') cite += '. ';
if ('publisher' in ent){
if (cite != "") cite += ". ";
if ("publisher" in ent) {
cite += ent.publisher;
if (cite[cite.length-1] != '.') cite += '.';
if (cite[cite.length - 1] != ".") cite += ".";
}
return cite;
}
function link_string(ent){
if ('url' in ent){
function link_string(ent) {
if ("url" in ent) {
var url = ent.url;
var arxiv_match = (/arxiv\.org\/abs\/([0-9\.]*)/).exec(url);
if (arxiv_match != null){
var arxiv_match = /arxiv\.org\/abs\/([0-9\.]*)/.exec(url);
if (arxiv_match != null) {
url = `http://arxiv.org/pdf/${arxiv_match[1]}.pdf`;
}
if (url.slice(-4) == '.pdf'){
var label = 'PDF';
} else if (url.slice(-5) == '.html') {
var label = 'HTML';
if (url.slice(-4) == ".pdf") {
var label = "PDF";
} else if (url.slice(-5) == ".html") {
var label = "HTML";
}
return ` &ensp;<a href="${url}">[${label||'link'}]</a>`;
}/* else if ("doi" in ent){
return ` &ensp;<a href="${url}">[${label || "link"}]</a>`;
} /* else if ("doi" in ent){
return ` &ensp;<a href="https://doi.org/${ent.doi}" >[DOI]</a>`;
}*/ else {
return '';
return "";
}
}
function doi_string(ent, new_line){
if ('doi' in ent) {
return `${new_line?'<br>':''} <a href="https://doi.org/${ent.doi}" style="text-decoration:inherit;">DOI: ${ent.doi}</a>`;
function doi_string(ent, new_line) {
if ("doi" in ent) {
return `${new_line ? "<br>" : ""} <a href="https://doi.org/${
ent.doi
}" style="text-decoration:inherit;">DOI: ${ent.doi}</a>`;
} else {
return '';
return "";
}
}
function title_string(ent) {
return '<span class="title">' + ent.title + '</span> ';
return '<span class="title">' + ent.title + "</span> ";
}
export function bibliography_cite(ent, fancy){
if (ent){
export function bibliography_cite(ent, fancy) {
if (ent) {
var cite = title_string(ent);
cite += link_string(ent) + '<br>';
cite += link_string(ent) + "<br>";
if (ent.author) {
cite += author_string(ent, '${L}, ${I}', ', ', ' and ');
cite += author_string(ent, "${L}, ${I}", ", ", " and ");
if (ent.year || ent.date) {
cite += ', ';
cite += ", ";
}
}
if (ent.year || ent.date) {
cite += (ent.year || ent.date) + '. ';
cite += (ent.year || ent.date) + ". ";
} else {
cite += '. ';
cite += ". ";
}
cite += venue_string(ent);
cite += doi_string(ent);
@@ -163,39 +179,39 @@ export function bibliography_cite(ent, fancy){
cite += link_string(ent);
return cite*/
} else {
return '?';
return "?";
}
}
export function hover_cite(ent){
if (ent){
var cite = '';
cite += '<strong>' + ent.title + '</strong>';
export function hover_cite(ent) {
if (ent) {
var cite = "";
cite += "<strong>" + ent.title + "</strong>";
cite += link_string(ent);
cite += '<br>';
cite += "<br>";
var a_str = author_string(ent, '${I} ${L}', ', ') + '.';
var v_str = venue_string(ent).trim() + ' ' + ent.year + '. ' + doi_string(ent, true);
var a_str = author_string(ent, "${I} ${L}", ", ") + ".";
var v_str =
venue_string(ent).trim() + " " + ent.year + ". " + doi_string(ent, true);
if ((a_str+v_str).length < Math.min(40, ent.title.length)) {
cite += a_str + ' ' + v_str;
if ((a_str + v_str).length < Math.min(40, ent.title.length)) {
cite += a_str + " " + v_str;
} else {
cite += a_str + '<br>' + v_str;
cite += a_str + "<br>" + v_str;
}
return cite;
} else {
return '?';
return "?";
}
}
//https://scholar.google.com/scholar?q=allintitle%3ADocument+author%3Aolah
function get_GS_URL(ent){
if (ent){
var names = ent.author.split(' and ');
names = names.map(name => name.split(',')[0].trim());
var title = ent.title.split(' ');//.replace(/[,:]/, "")
var url = 'http://search.labs.crossref.org/dois?';//""https://scholar.google.com/scholar?"
url += uris({q: names.join(' ') + ' ' + title.join(' ')});
function get_GS_URL(ent) {
if (ent) {
var names = ent.author.split(" and ");
names = names.map(name => name.split(",")[0].trim());
var title = ent.title.split(" "); //.replace(/[,:]/, "")
var url = "http://search.labs.crossref.org/dois?"; //""https://scholar.google.com/scholar?"
url += uris({ q: names.join(" ") + " " + title.join(" ") });
}
}
+3
View File
@@ -0,0 +1,3 @@
export function domContentLoaded() {
return ['interactive', 'complete'].indexOf(document.readyState) !== -1;
}
+5 -5
View File
@@ -13,7 +13,7 @@
// limitations under the License.
export function addPolyfill(polyfill, polyfillLoadedCallback) {
console.info('Runlevel 0: Polyfill required: ' + polyfill.name);
console.debug('Runlevel 0: Polyfill required: ' + polyfill.name);
const script = document.createElement('script');
script.src = polyfill.url;
script.async = false;
@@ -58,11 +58,11 @@ export class Polyfills {
// Define an intermediate callback that checks if all is loaded.
const polyfillLoaded = function(polyfill) {
polyfill.loaded = true;
console.info('Runlevel 0: Polyfill has finished loading: ' + polyfill.name);
// console.info(window[polyfill.name]);
console.debug('Runlevel 0: Polyfill has finished loading: ' + polyfill.name);
// console.debug(window[polyfill.name]);
if (Polyfills.neededPolyfills.every((poly) => poly.loaded)) {
console.info('Runlevel 0: All required polyfills have finished loading.');
console.info('Runlevel 0->1.');
console.debug('Runlevel 0: All required polyfills have finished loading.');
console.debug('Runlevel 0->1.');
window.distillRunlevel = 1;
callback();
}
+3
View File
@@ -40,6 +40,9 @@ export const Template = (name, templateString, useShadow = true) => {
}
connectedCallback() {
if (this.hasAttribute('distill-prerendered')) {
return;
}
if (useShadow) {
if ('ShadyCSS' in window) {
ShadyCSS.styleElement(this);
+1 -1
View File
@@ -15,7 +15,7 @@
*/
d-byline {
contain: content;
contain: style;
overflow: hidden;
border-top: 1px solid rgba(0, 0, 0, 0.1);
font-size: 0.8rem;
+1 -1
View File
@@ -67,7 +67,7 @@ export default function render(dom) {
if (templateTag) {
templateTag.parentNode.removeChild(templateTag);
} else {
console.info('FYI: Did not find template tag when trying to remove it. You may not have added it. Be aware that our polyfills will add it.')
console.debug('FYI: Did not find template tag when trying to remove it. You may not have added it. Be aware that our polyfills will add it.')
}
// add loader