archives/tweego
2
0
Fork 0
mirror of https://github.com/tmedwards/tweego.git synced 2025-07-04 13:47:03 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Docs] Improvements.

Browse source 
* 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.
This commit is contained in:
Thomas M. Edwards 2020-02-24 14:16:59 -06:00
parent 78cc697889
commit ecef9e14ea
2 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/core/faq-and-tips.md
View file

@ -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

6
docs/core/special-passages-and-tags.md
View file

@ -46,7 +46,7 @@ The core properties used with all story formats include:
The properties used only with Twine 2-style story formats include:
- <var>format</var>: (string) Optional. The name of the story format to compile against—e.g., `SugarCube`, `Harlowe`, `Chapbook`, `Snowman`.
- <var>format-version</var>: (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 <var>format</var>, Tweego will attempt to use the greatest version that matches the specified major version—i.e., if <var>format-version</var> 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`.
- <var>format-version</var>: (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 <var>major.minor.patch</var> form—e.g., `2.30.0`. From the installed story formats matching the name specified in <var>format</var>, Tweego will attempt to use the greatest version that matches the specified <var>major</var> version—i.e., if <var>format-version</var> 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`.
<p role="note"><b>Note:</b>
The above is <em>not</em> an exhaustive list of all Twine&nbsp;2-style story format properties. There are others available that are only useful when actually interoperating with Twine&nbsp;2—e.g, <var>tag-colors</var> and <var>zoom</var>. See the <a href="https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md" target="&#95;blank">twee-3-specification.md</a> for more information.
@ -57,7 +57,7 @@ To compile against a specific version of a story format, use the format command
</p>
<p class="warning" role="note"><b>Warning:</b>
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.
</p>
#### 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"
}
```