From ecef9e14eab578887b2fdabfa1e039c47202e6b3 Mon Sep 17 00:00:00 2001 From: "Thomas M. Edwards" Date: Mon, 24 Feb 2020 14:16:59 -0600 Subject: [PATCH] [Docs] Improvements. * Add enough of a description of story format versions that the later mention of "major version" makes sense. * Change a "should" to the correct "must" in the JSON chunk warning. * Add a reminder to the Twee2->Twee v3 tip about the standard Twee file extensions. --- docs/core/faq-and-tips.md | 2 +- docs/core/special-passages-and-tags.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/core/faq-and-tips.md b/docs/core/faq-and-tips.md index 31758f0..7b8770d 100644 --- a/docs/core/faq-and-tips.md +++ b/docs/core/faq-and-tips.md @@ -45,7 +45,7 @@ You may convert a Twee2 notation file to a Twee v3 notation file like so: tweego -d -o twee_v3_file.twee twee2_file.tw2 ``` -Or, if the Twee2 notation file has a standard Twee file extension, like so: +Or, if the Twee2 notation file has a standard Twee file extension (`.tw`, `.twee`), like so: ``` tweego --twee2-compat -d -o twee_v3_file.twee twee2_file.twee diff --git a/docs/core/special-passages-and-tags.md b/docs/core/special-passages-and-tags.md index 74918d6..1b8ae51 100644 --- a/docs/core/special-passages-and-tags.md +++ b/docs/core/special-passages-and-tags.md @@ -46,7 +46,7 @@ The core properties used with all story formats include: The properties used only with Twine 2-style story formats include: - format: (string) Optional. The name of the story format to compile against—e.g., `SugarCube`, `Harlowe`, `Chapbook`, `Snowman`. -- format-version: (string) Optional. The version of the story format to compile against—e.g., `2.29.0`. From the installed story formats matching the name specified in format, Tweego will attempt to use the greatest version that matches the specified major version—i.e., if format-version is `2.0.0` and you have the versions `1.0.0`, `2.0.0`, `2.5.0`, and `3.0.0` installed, Tweego will choose `2.5.0`. +- format-version: (string) Optional. The version of the story format to compile against. Story format versions follow the [Semantic Versioning specification](https://semver.org/), though generally use only the major.minor.patch form—e.g., `2.30.0`. From the installed story formats matching the name specified in format, Tweego will attempt to use the greatest version that matches the specified major version—i.e., if format-version is `2.0.0` and you have the versions `1.0.0`, `2.0.0`, `2.5.0`, and `3.0.0` installed, then Tweego will choose `2.5.0`.

Note: The above is not an exhaustive list of all Twine 2-style story format properties. There are others available that are only useful when actually interoperating with Twine 2—e.g, tag-colors and zoom. See the twee-3-specification.md for more information. @@ -57,7 +57,7 @@ To compile against a specific version of a story format, use the format command

Warning: -JSON chunks are not JavaScript object literals, though they look much alike. Property names must always be double quoted and you should not include a trailing comma after the last property. +JSON chunks are not JavaScript object literals, though they look much alike. Property names must always be double quoted and you must not include a trailing comma after the last property.

#### Example @@ -67,7 +67,7 @@ JSON chunks are not JavaScript object literals, though they look much alike. Pr { "ifid": "D674C58C-DEFA-4F70-B7A2-27742230C0FC", "format": "SugarCube", - "format-version": "2.29.0", + "format-version": "2.30.0", "start": "My Starting Passage" } ```