Skip to content

Commit 5f0c19c

Browse files
authored
support and demonstrate the use of footnotes (#141)
1 parent 5a009cb commit 5f0c19c

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

guide.tcg

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,22 @@ The result looks like this:
452452
int i = 42;
453453
```
454454

455+
## Footnotes {#sec:footnotes}
456+
457+
```md
458+
You can use a footnote[^footnote-example] to provide additional details about something
459+
out of the way, at the bottom of the page.
460+
461+
[^footnote-example]: See @sec:footnotes for more information about footnotes.
462+
```
463+
464+
You can use a footnote[^footnote-example] to provide additional details about something
465+
out of the way, at the bottom of the page. The footnotes will be automatically numbered.[^footnote-numbering]
466+
467+
[^footnote-example]: See @sec:footnotes for more information about footnotes.
468+
469+
[^footnote-numbering]: Like this.
470+
455471
## Cross-References {#sec:cross-references}
456472

457473
In general, sections, tables, figures, and equations can be referenced using the `@` symbol. These cross-references do not show up in the GitHub markdown, but will appear in the final document.
@@ -1092,9 +1108,10 @@ documents in Markdown:
10921108
2. Release another release candidate marked rc.2, rc.3, etc.
10931109
6. When the document is approved for public review, send out the release candidate that got
10941110
approved.
1095-
7. When it comes time for final publication, release just 1.23.5. This will trigger a render
1096-
of a "Final" styled document. Note that according to the rules of semver, 1.23.5 is higher
1097-
than 1.23.5-rc.1.
1111+
7. When it comes time for final publication, release just 1.23.5.[^semver-ordering] This will trigger a render
1112+
of a "Final" styled document.
1113+
1114+
[^semver-ordering]: Note that according to the rules of semver, 1.23.5 is higher than 1.23.5-rc.1.
10981115

10991116
::: Note :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
11001117
If the spec is not rendered as part of a release, it will always be

template/tcg.tex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,10 @@
4545
%%
4646

4747
% Options for packages loaded elsewhere
48-
\PassOptionsToPackage{unicode$for(hyperrefoptions)$,$hyperrefoptions$$endfor$}{hyperref}
48+
\PassOptionsToPackage{unicode,hyperfootnotes=false}{hyperref}
4949
\PassOptionsToPackage{hyphens}{url}
5050
\PassOptionsToPackage{dvipsnames,svgnames*,x11names*,table}{xcolor}
51+
\PassOptionsToPackage{perpage}{footmisc}
5152

5253
\documentclass[
5354
paper=letter,
@@ -675,6 +676,8 @@
675676
\SetWatermarkText{\includegraphics[width=8.5in, height=11in]{/resources/img/draft.pdf}}
676677
}
677678

679+
\usepackage{footnotebackref}
680+
678681
\begin{document}
679682

680683
%%

0 commit comments

Comments
 (0)