diff --git a/_docs/editing/notes.md b/_docs/editing/notes.md index f69b35f8..69c8f35f 100644 --- a/_docs/editing/notes.md +++ b/_docs/editing/notes.md @@ -14,7 +14,7 @@ There are various options for notes. ## Endnotes -Endnotes appear at the end of a document (a web page or book chapter). In kramdown and on the web these are often called footnotes. To create them in markdown, follow the [kramdown syntax for footnotes](https://kramdown.gettalong.org/syntax.html#footnotes): +Endnotes appear at the end of a document (a web page or book chapter). In markdown these are usually called footnotes (because on the web they appear at the bottom of the web page). To create them in markdown, follow the [kramdown syntax for footnotes](https://kramdown.gettalong.org/syntax.html#footnotes): * put a `[^1]` where the footnote reference should appear (the `1` there can be any numbers or letters, and should be different for each footnote in a document); * anywhere in the document (we recommend after the paragraph containing the footnote reference), put `[^1]: Your footnote text here.`. @@ -48,6 +48,8 @@ To create true bottom-of-page footnotes, as opposed to endnotes, use the same sy {:.move-to-footnote} ``` +Note that converting endnotes to footnotes only affects PDF output. Web, epub and app outputs will still use endnotes. + > Technically, `footnotes.js` and `_print-notes.scss` convert endnotes completely from kramdown footnotes to [PrinceXML footnotes](https://www.princexml.com/doc-prince/#footnotes). They may look similar by default, but they are different elements and can be styled separately. {:.box} diff --git a/samples/01-07-notes.md b/samples/01-07-notes.md index 8d8784b3..61352f3a 100644 --- a/samples/01-07-notes.md +++ b/samples/01-07-notes.md @@ -4,20 +4,21 @@ title: "Notes" ## Notes -In Electric Book themes, we aim to support three kinds of notes: footnotes, sidenotes, and (what we call) footer notes. +In Electric Book themes, we aim to support four kinds of notes: endnotes, footnotes, sidenotes, and (what we call) footer notes. -- **Footnotes**, which appear at the end of a document (web page or book chapter). In book parlance, they are therefore actually endnotes, but we call them footnotes because that's what kramdown calls them. To create them in markdown, follow the [kramdown syntax for footnotes](https://kramdown.gettalong.org/syntax.html#footnotes): +- **Endnotes** appear at the end of a document (web page or book chapter). In technical markdown terms, these are called footnotes, because on the web they appear at the bottom of a web page. To create them in markdown, follow the [kramdown syntax for footnotes](https://kramdown.gettalong.org/syntax.html#footnotes): - put a `[^1]` where the footnote reference should appear (the `1` there can be any numbers or letters, and should be different for each footnote in a document); - anywhere in the document (we recommend after the paragraph containing the footnote reference), put `[^1]: Your footnote text here.`. -- **Sidenotes** appear in a box to the right of the text. On wide screens, they might float far right of the text. On narrower screens, the text might wrap around them. In print, the text might wrap around them, too, or they might appear in an otherwise empty sidebar space. To create a sidenote, give the paragraph a `{:.sidenote}` tag. If the sidenote includes more than one paragraph, put them in a `