nest

A simple, line-oriented data serialisation format
git clone https://git.torresjrjr.com/nest.git
Log | Files | Refs | README | LICENSE

commit c147adf5d85e447859b2f531e43730ff2f37936a
parent 7485b67a9f570d762b2081743a20110e40331264
Author: Byron Torres <b@torresjrjr.com>
Date:   Thu,  2 Dec 2021 16:38:26 +0000

fix tutorial

Diffstat:
Mtutorial.md | 36++++++++++++++++++------------------
1 file changed, 18 insertions(+), 18 deletions(-)

diff --git a/tutorial.md b/tutorial.md @@ -8,14 +8,14 @@ type. A document is organised into blocks, which are tab-indented (nested) to signify scope, and prefixed with a type signifier. A comment is a line prefixed with optional whitespace followed by an -octothorpe `#` (hash, pound). A comment can appear anywhere in a Nest +octothorpe (`#`) (hash, pound). A comment can appear anywhere in a Nest document without disrupting other sections. # Gemini computer #Stat reports A nest block contains lines of text, equivalently tab-indented. An -optional, equivalently tab-indented last line with a single period `.` +optional, equivalently tab-indented last line with a single period (`.`) to denote the end of a block is permitted. # ... @@ -26,7 +26,7 @@ to denote the end of a block is permitted. There are three block types: the map, sequence, and textwall. A textwall represents a multilined string scalar. Each line is prefixed -with a pipe `|`. The concatenation of each line, excluding the pipe +with a pipe (`|`). The concatenation of each line, excluding the pipe prefix and including the terminating newline character, form the scalar string. @@ -44,11 +44,11 @@ JSON equivalent: "Station:\n\nβ Hyi\tType circumpolar\tDistance 24.33ly\n" -A sequence holds elements, each either prefixed with a dash-space `- ` -for inline values, or a double-dash `--` for nested values. Inline -string values start from the first character after `- ` up to and -excluding the line's terminating newline character. Any element without -an inline or nested value is considered an empty string. +A sequence holds elements, each either prefixed with a dash-space (`- `) +for inline values, or a double-dash (`--`) for nested values. Inline +string values start from the first character after the dash-space up to +and excluding the line's terminating newline character. Any element +without an inline or nested value is considered an empty string. Example of a sequence, with a nested sequence: @@ -68,21 +68,21 @@ JSON equivalent: [ "Alice Nestler", - "194.22", + "2038-01-19 03:14:07", [ "QEC", "Hyperspeed" ], "", "", - " Barycentric Celestial ", + " Barycentric Celestial " ] -A map holds key-value pairs, each prefixed with a single period `.`. -Keys are terminated with a colon-space `: ` for inline values, or -double-colon `::` for nested values. Whitespace between these signifiers -and key strings is ignored. Inline string values exist similarly like in -sequences. +A map holds key-value pairs, each prefixed with a single period (`.`). +Keys are terminated with a colon-space (`: `) for inline values, or +double-colon (`::`) for nested values. Whitespace between these +signifiers and key strings is ignored. Inline string values are +represented similarly as in sequences. An example of a map, with one nested map: @@ -110,7 +110,7 @@ JSON equivalent: "reference system": "barycentric celestial", "alpha": "", "omega": "", - " equinox ": " J2000.0 SOL ", + "equinox": " J2000.0 SOL ", "": "Christopher Null" } @@ -124,11 +124,11 @@ A block with mixed content types is invalid. Maps and sequences can contain (nest) other blocks in various ways. .title: Nest Example - .maps:: + .map:: .alpha: red .bravo: green .charlie: blue - .sequences:: + .sequence:: - Alice Nestler -- - one