From 975fc05d8fd6739c6f8608e4dc1e19bf2d5f3960 Mon Sep 17 00:00:00 2001 From: Tony Garnock-Jones Date: Tue, 17 Oct 2023 10:55:11 +0200 Subject: [PATCH] Link QuickRef in nav --- README.md | 2 +- _layouts/page.html | 1 + cheatsheet.md | 7 ++++++- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c2441da..0d1d26b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ automatic, perfect-fidelity conversion between syntaxes. - [Preserves textual syntax](preserves-text.html), and - [Preserves machine-oriented binary syntax](preserves-binary.html) - [Preserves tutorial](TUTORIAL.html) + - [Quick Reference for Preserves syntax](cheatsheet.html) - [Canonical Form for Binary Syntax](canonical-binary.html) - [Syrup](https://github.com/ocapn/syrup#pseudo-specification), a hybrid binary/human-readable syntax for the Preserves data model @@ -65,7 +66,6 @@ Implementations of the data model, plus Syrup transfer syntax: ## Additional resources - - [Cheat sheet(s) for Preserves syntax](cheatsheet.html) - Some [conventions for common data types](conventions.html) - [Open questions](questions.html); see also the [issues list]({{page.projectpages}}/issues) diff --git a/_layouts/page.html b/_layouts/page.html index 8e9050a..3988761 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -17,6 +17,7 @@ extra_html_headers: >
diff --git a/cheatsheet.md b/cheatsheet.md index 20717fa..b25212d 100644 --- a/cheatsheet.md +++ b/cheatsheet.md @@ -1,11 +1,16 @@ --- no_site_title: true -title: "Preserves Cheatsheets" +title: "Preserves Quick Reference" --- Tony Garnock-Jones {{ site.version_date }}. Version {{ site.version }}. +These are non-normative "reference card" definitions. See also the normative [semantics]({{ +site.baseurl }}/preserves.html), [text syntax specification]({{ site.baseurl +}}/preserves-text.html) and [machine-oriented syntax specification]({{ site.baseurl +}}/preserves-binary.html). + ## Machine-Oriented Binary Syntax {% include cheatsheet-binary.md %}