Skip to content

Latest commit

 

History

History
148 lines (105 loc) · 4 KB

CHANGE.md

File metadata and controls

148 lines (105 loc) · 4 KB
Raw

v4.0.3

  • Regenerated package-lock.json, dropping references to unpm from these packages:
    • asap
    • camelcase
    • pop-iterate
    • q
    • rezult
    • shon
    • system
    • weak-map
  • necessarily upgraded all dependencies, due to reinstalling sans version lock

v4.0.2

  • Upgrades the xorshift random number generator. This does invalidate any tests that dependend upon consistent sequences, which is a breaking change but one that fallows so quickly on the release of version 4.0, there are no production scripts affected and this merely increases the scope of change in upgrading to version 4.

v4.0.1

  • Publishes missing modules.

v4.0.0

  • This version adds support for compiling stories that span multiple files.

    Pass all of these files to the kni command and it will weave them into a single story. Each file will begin with a label that is the name of the file, like @archery for path/to/archery.kni. The story can start anywhere you put your @start label, or in a file called start.kni.

  • This version also merges support for hyperlinks, which was introduced in minor version 2.3.0 and first appears in the version 3 train here. The language allows hyperlinks to be expressed and passes them through as unaltered text to the rendering engine. This comes with the recommendation that hyperlinks be expressed in stand-alone blocks like {Example https://example.com} and for the rendering engine to appreciate the entire block as a hyperlink instead of a span of text if it can.

  • This version adds support for string input.

    To read a string, add a variable name to a prompt line.

    What is your name?
> Name

We are very pleased to meet you, {(Name)}.

    The terminal implementation is ready. The web implementation is not ready.

v3.0.2

Fixes the HTML generator by including the necessary missing files in the published package.

v3.0.1

Attempts to fix a bug in the HTML generator, but fails. See version v3.0.2 or newer.

v3.0.0

This version allows options to be declared in subroutines.

- @common()
  X is currently {(x)}.
  + [Increment x. ] {+x}
  + [Decrement x. ] {-x}

- @menu()
  Choose an option.
  + [This is a good option. ]
  ->common()
  + [Quit. ] <-
  >

  # loop back to the menu, even for common options.
  ->menu

->menu()
You have exited the menu.

This major version breaks compatibility with previous JSON state machines. The new state machine has reserved "RET" and "ESC" labels, instead of using null to mean "return". The "escape" label is new, and causes a function to return through a call "branch" when it returns, instead of following to the "next" of the call site.

This major version also breaks compatibility with previous JSON interactive story state objects. These have a new format that is almost fully desymbolicated, which makes them more brittle to story changes but makes the URL anchor for HTML stories more compact.

The command line mode now supports "back" and diagnostic commands "capture" and "replay".

v2.3.0 - 2018-01-01

  • Alter the language so hyperlinks to be expressed in scripts. Paragraphs and line breaks must be padded with white space.

v2.2.2

  • Fix command line usage by upgrading the command line argument parser, SHON.

v2.2.1

  • Fix missing file in package.json

v2.2.0

  • Adds HTML command line flags for color, background color, and title for single interactive HTML page generation.

v2.1.0

  • Adds a --html flag that writes the script as a single interactive page.

v2.0.0

  • This version changes the behavior of keyword options so that the first option to introduce a keyword has precedence over all subsequent options.
  • The engine now emits a choice event to handlers, so the handler can observe which choice was made and particularly what its keywords are.

v1.1.0

This version adds support for option keywords.

+ <apple> [You chose[Choose] apple. ]
+ <orange> <lemon> [You chose[Choose] orange or lemon. ]
+ <grape> [] You chose a grape, which wasn'}t even on the menu.
>

v1.0.0