Skip to content

Commit b90b900

Browse files
authored
Merge pull request #428 from mgreminger/docs-update
docs: add quick reference guide
2 parents aa628a6 + 5763be4 commit b90b900

8 files changed

Lines changed: 17576 additions & 9 deletions

public/docs/accessible_reference.html

Lines changed: 2200 additions & 0 deletions
Large diffs are not rendered by default.

public/docs/ep_quick_reference.pdf

613 KB
Binary file not shown.

public/docs/ep_quick_reference.svg

Lines changed: 15332 additions & 0 deletions
Loading

src/App.svelte

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
9696
const apiUrl = window.location.origin;
9797
98-
const tutorialHash = "fPMFb3PZhRKpfJuBaJ2HDR";
98+
const tutorialHash = "hRLd9DHER22yb57AY82hmz";
9999
100100
let termsAccepted = $state(appState.termsVersion);
101101
@@ -2670,6 +2670,11 @@ Please include a link to this sheet in the email to assist in debugging the prob
26702670
on:close={() => window.dispatchEvent(new Event('resize'))}
26712671
>
26722672
<SideNavItems>
2673+
<SideNavLink
2674+
href={`${window.location.origin}/docs/ep_quick_reference.pdf`}
2675+
text="Quick Reference Guide"
2676+
target="_blank"
2677+
/>
26732678
<SideNavMenu text="Example Sheets">
26742679
{#each exampleSheets as {path, title} (path)}
26752680
<SideNavMenuItem

src/UnitsDocumentation.svelte

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
<script lang="ts">
2+
import { onMount } from "svelte";
3+
import { renderMathInElement } from "mathlive";
4+
5+
onMount(() => {
6+
const mathSpans = document.querySelectorAll(".math");
7+
for (const span of mathSpans) {
8+
renderMathInElement(span as HTMLElement);
9+
}
10+
});
11+
</script>
12+
113
<style>
214
table {
315
border-collapse: collapse;
@@ -17,11 +29,15 @@
1729

1830

1931
<p>
20-
The following unit definintions are supported by EngineeringPaper.xyz (from <a
21-
href="https://mathjs.org/docs/datatypes/units.html#reference">Math.js</a
22-
>
23-
documentation). Units may be used in their long or short forms (meter or m) and
24-
they may be used in their singular or plural forms (second or seconds).
32+
The following unit definintions are supported by EngineeringPaper.xyz (from
33+
<a
34+
href="https://mathjs.org/docs/datatypes/units.html#reference"
35+
target="_blank"
36+
>Math.js</a>
37+
documentation). Units can be used in their long and short forms. Most units support
38+
long prefixes in their long form and short prefixes in their short form (e.g., kilogram or kg). Long form units generally support their singular and plural forms (e.g., meter or meters).
39+
Units may be combined as needed using exponents, multiplication, and division, as in:
40+
<span class="math">{String.raw`\(\left\lbrack\frac{kg}{m^3}\right\rbrack\text{or}\left\lbrack kg\cdot m^{-3}\right\rbrack\)`}</span>
2541
</p>
2642

2743
<table>

src/Updates.svelte

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@
88
99
onMount(() => {
1010
const mathSpans = document.querySelectorAll(".math");
11-
// @ts-ignore
1211
for (const span of mathSpans) {
13-
renderMathInElement(span);
12+
renderMathInElement(span as HTMLElement);
1413
}
1514
});
1615
</script>
@@ -26,6 +25,20 @@
2625
}
2726
</style>
2827

28+
<em>July 27, 2026 (Permalink: <a href="https://20260717.engineeringpaper.xyz" target="_blank">20260727.engineeringpaper.xyz</a>)</em>
29+
<h4>Quick Reference Guide Added and Bug Fix</h4>
30+
<p>
31+
A 4 page PDF
32+
<a
33+
href="https://engineeringpaper.xyz/docs/ep_quick_reference.pdf"
34+
target="_blank"
35+
>quick reference guide</a> is now available in the left menu. The reference guide covers all
36+
of the cell types, all of the available functions, and all of the supported units.
37+
Additionally, a bug that prevented Python Code Cell functions from being plotted in
38+
certain situations has been fixed.
39+
</p>
40+
<br>
41+
2942
<em>June 12, 2026 (Permalink: <a href="https://20260612.engineeringpaper.xyz" target="_blank">20260612.engineeringpaper.xyz</a>)</em>
3043
<h4>Bug Fixes and Usability Improvements</h4>
3144
<p>

src/stores.svelte.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ type AppState = {
6464
}
6565

6666
const appState: AppState = $state<AppState>({
67-
currentVersion: 20260612,
67+
currentVersion: 20260727,
6868
termsVersion: 20240110,
6969

7070
unsavedChange: false,

vite.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ export default defineConfig(({ command, mode }) => {
6464
"mathlive/sounds/*",
6565
"logo_dark.svg",
6666
"print_logo.png",
67+
"docs/ep_quick_reference.pdf",
6768
"assets/IBMPlexSans-Light-Latin1*.woff2",
6869
"assets/IBMPlexSans-Regular-Latin1*.woff2",
6970
"assets/IBMPlexSans-Regular-Greek*.woff2",

0 commit comments

Comments
 (0)