rsyntaxtree 1.14.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 965fe8dae50ad6fe7907850239f395fda6a5186654a81d36b89400ebe52108f2
-  data.tar.gz: 4a183744f4d05b63efcbd1e9aedb6a4bf060654fde9dfc62abaeb20e6a38ac8a
+  metadata.gz: 231de78b2e34e37f4a5bbccd641839e8cf5ae1babc2d8d4362d86dcf782d28b4
+  data.tar.gz: a4d04e71e6587592540400aa9a7e23d9dadae0d19912078d5d6cc5ebd65c117d
 SHA512:
-  metadata.gz: ee4fca1e926ad6886aaca041468f61dc0a596eeffa107c4ee3a82576f2ac7ac53eddcdc0ee586fc5f4408fc809188dba1279eb0ff8083892ef1b598aea830ca1
-  data.tar.gz: 19173b80e3c2376a9f25d6ea72604bc5774194af7eccfc2b1158dfdf75939ed5d700f654b8122ecf3df99242036686666266ed829710fbe22d94bbea965ae91b
+  metadata.gz: f97797690b6d8e0ad8404c00a10c061c89d2213e582915a33fc9d739305d5fb10cdd0afde6bffe0b16f504b5d5854d7dcb0249f50a22b10599638fb22180aed3
+  data.tar.gz: 7f5814cc9bf0875b21982cf6c143397d467fb900a7973c8f6213934387ba4f80e0605ddccec63f02bc7bacc6d182a9da1bda3237f909414ba4c64f63a1da1d12

data/CHANGELOG.md

@@ -1,5 +1,136 @@
 # Changelog
 
+## [2.1.0] - 2026-08-29
+
+### Changed
+- The JSON output's format name is `json`: `-f json`, writing `syntree.json`.
+  The old name `lsif` collided with an established code-intelligence format
+  of the same initials, and called itself an interchange format when only
+  one tool had ever written or read it. It remains an accepted alias — the
+  CLI says so on stderr — until 3.0. The document now identifies itself in a
+  top-level `format` object (`name: "rsyntaxtree-json"`, schema 0.4.0) in
+  place of the `lsif` key.
+
+### Added
+- A feature matrix in the JSON output carries its rows: cells split on the
+  tab stops, rules as rows of their own, and a matrix inside a cell
+  recursing. It used to arrive as an empty segment marked "matrix", its
+  attribute-value pairs recoverable only by re-parsing the raw label.
+
+## [2.0.0] - 2026-08-28
+
+The removals announced in 1.10.0 and 1.12.0, and the fixes that came out of
+looking at what was left. Every figure in the gallery draws exactly as it did.
+
+### Removed
+- JPG and GIF output. JPEG blurs line art and GIF has nothing to offer that
+  PNG does not do better, and they were the only reason for the RMagick
+  dependency. `-f jpg` and `-f gif` are now refused the way any unknown
+  format is. Use `-f png`.
+- The RMagick dependency, and with it ImageMagick. A machine that installs
+  this gem no longer needs ImageMagick's headers to build one, and the gem
+  now asks for four libraries instead of five.
+- The deprecated aliases, which a major release is the moment to drop:
+  `symmetrize` and its `-y` flag (say `tidy: symmetric`), `tidy_spacing`
+  (say `hspacing`), the undocumented `tidy_nest`, and `nothing`'s
+  undocumented spelling `none` in `leafstyle`. Each is refused by name and
+  told what replaced it. An unknown option is passed over in silence, since
+  a caller may hand its own parameters through, and a removed one read that
+  way would have handed back a different figure without a word.
+- `symmetrize` from the LSIF `meta.source.params` block. The layout scale it
+  duplicated, `tidy`, is written there already.
+
+### Fixed
+- A triangle drawn bottom to top pointed the wrong way. The shape spans the
+  child's text and points at the parent, and which way that is depends on
+  which of the two sits higher — the question the connectors ask and the
+  triangle did not. Bottom to top the figure folded through itself: the base
+  struck through the leaf and the apex through the node. No gallery figure
+  carries one, because every bottom-to-top example is a derivation, which
+  draws rules instead of connectors.
+- Every label now keeps the same air above it as below it. The connector
+  endpoints were measured from the layout box, whose edges sit unevenly
+  around the ink, so every figure carried a little more space under each
+  label than over it — visibly once a figure was tilted. The enclosures
+  were built with symmetric clearances all along; the plain labels now get
+  what the boxes always had. Nearly every gallery figure changes by a few
+  pixels of line length; no label, no position and no size moves.
+- A movement rail could reach past the right edge of a left-to-right
+  canvas and be cut off at it: the rail grows the canvas as it routes, and
+  the width it grew — unlike the height — was then recomputed from the
+  elements alone. Four pixels at the default spacing, twenty-four at
+  hspacing 0.5.
+- A rule written `---` (or `===` for a double rule) was refused inside a
+  `#( … #)` matrix, though it was drawn in every other kind of label. Two
+  hyphens and four were accepted there and three were not — a distinction
+  nothing could explain. The matrix grammar had no rule for it and the
+  matrix renderer dropped every row that was not text.
+- The bracket of a matrix that followed something in the same cell was drawn
+  on top of it: `AGR |1| [ … ]`, which is how a shared value is written, put
+  the right edge of the tag and the left edge of the bracket on the same
+  coordinate exactly. A block now keeps as much room in front of it as the
+  bracket keeps inside it.
+- In a left-to-right tree, `hspacing` and `vheight` both moved the width and
+  nothing moved the height. The layout replaces the gap that separates
+  sisters with one of its own and was not scaling it by `hspacing`, so a
+  left-to-right figure could be made wider but never shorter.
+- `storoke-width` in the style of every text element of every SVG. Renderers
+  ignored the misspelling, so nothing ever looked wrong.
+
+### Added
+- `shear`: the drawn figure tilts by the given angle (degrees, positive
+  leaning the top to the right) and lies on a plane drawn behind it, so the
+  lean reads as a surface seen at an angle rather than as a mistake. The
+  whole picture shears as one affine piece — layout untouched, region
+  shades coming out parallelograms on their own, and nothing able to newly
+  touch or cross. The plane is fill without an edge — a region shade is
+  bounded because it marks one part of a figure off from the rest, and a
+  line round the whole drawing would read as a frame. `shear_plane` turns
+  it off or gives it a colour, and a transparent background takes it away
+  for you: a clear background is asked for in order to lay the figure over
+  something else, and a sheet under it is what would defeat that.
+  TikZ refuses a sheared figure the way it refuses a derivation.
+- `vmargin`: the clearance between a label and its connectors, the same
+  above and below, measured from the ink its row actually contains — a row
+  of capitals pays nothing for descenders nobody wrote, and the ends of a
+  row's connectors stay level. From 0.1 to 1.0; at nothing at all a node's
+  box stops holding a label that draws its own shape.
+- Three gallery examples, in two new categories: the Indo-European family
+  tree (Historical Linguistics), where the region shade groups branches
+  rather than marking a c-command domain; type-driven semantic composition
+  (Formal Semantics); and a tree of typed feature structures with structure
+  sharing (Formal Grammar), which is the figure the matrix rule was missing.
+
+### Changed
+- The documents name every option. Four were missing from the one-page
+  reference and one from the README, because the test that reads the
+  documents built its roll-call from the tables of listed and numeric
+  values — and so never asked after the options that take on or off. It
+  reads the roll-call from the defaults now, and the README is one of the
+  documents it reads.
+- Three tests were added for the shapes of defect this release fixed: one
+  asks every feature in the index to read the same in a label, in a matrix
+  and in a matrix inside a matrix; one reads the drawn shapes back out of
+  the SVG and asks whether any two of them touch; and one asks a
+  left-to-right tree to answer to `hspacing` in its height.
+- The sweep draws two more figures — one with a triangle, one with a
+  movement rail — and moves the direction, `vmargin` and `shear` among its
+  settings, and asks of every triangle that it have an area. Each of the two
+  defects above lived in a figure the sweep did not draw, at a direction it
+  did not set: the settings alone could not have found either, and a
+  triangle folded flat passes every other check there is.
+- The manuals say what TikZ output does with what it cannot draw: it drops
+  it rather than refusing, so a label that is a matrix arrives with its
+  cells run together on one line.
+
+### Migration
+- `format: "jpg"` / `"gif"` → `"png"`.
+- `symmetrize: "on"` → `tidy: "symmetric"`; `tidy_spacing: n` → `hspacing: n`;
+  `leafstyle: "none"` → `"nothing"`. Each has been the documented spelling
+  since 1.12.0.
+- Everything else — every other option, and every piece of notation — is
+  unchanged.
+
 ## [1.14.0] - 2026-08-27
 
 ### Added
@@ -513,12 +644,40 @@ RMagick dependency.
 
 ## [1.3.1] - 2024-10-24
 
+- Square brackets can be escaped with `\[` and `\]`
 - Bug fixes and improvements
 
 ## [1.3.0] - 2024-08-27
 
 - TikZ/forest LaTeX output support
 
-## Previous versions
-
-See commit history for earlier changes.
+## Earlier releases (2018–2023)
+
+Before this file was kept, the web interface carried the release notes. Moved
+here so the history has one home.
+
+- 2023-09 — Cross-hatch rendering issue fixed
+- 2023-02 — PDF download; improved line edges; `Line width` option;
+  `Traditional` colour option; `Hide connectors` option; extra connectors
+  between nodes
+- 2023-01 — `Noto Sans Mono` font option
+- 2022-11 — `¥` accepted in place of the backslash for escapes; documentation
+  in Japanese
+- 2022-06 — RSyntaxTree on the Web: the UI as a source package, runnable
+  locally with Docker
+- 2022-02 — `Polyline connector` option
+- 2022-01 — comprehensive rewrite; path drawing (non-directional, directional,
+  bidirectional); more flexible text markup; new markup patterns (newlines,
+  brackets, horizontal lines, boxed text); triangles in every connector mode;
+  improved error display and image zoom in the UI
+- 2021-12 — subscript `_text_` and superscript `__text__`; `\n` inside
+  terminal nodes
+- 2021-11 — label-less terminal nodes (`[A [B] [C]]`); auto bracket close;
+  math symbol rendering; better image quality; some decoration symbols altered
+- 2019-11 — SVG download error fixed
+- 2019-04 — SVG colour on/off fixed
+- 2018-06 — whitespace in labels with `<>` (`Modal<>AUX`)
+- 2018-03 — `V spacing` option (then called Connector height); syntax
+  highlighting of the input; text styles (italic, bold) and decoration
+  (underline, overline, line-through); refined site design
+- 2018-02 — margins around the image; better editor (Ace)

data/README.md

@@ -69,7 +69,7 @@ Connect nodes with lines or arrows:
 
 ### Multiple Output Formats
 
-Generate trees in PNG, SVG, PDF, or LSIF (JSON) format. (JPG and GIF are deprecated and will be removed in 2.0.)
+Generate trees in PNG, SVG, PDF, TikZ, or JSON format — the last carrying the laid-out tree as structured data.
 
 ## Web Interface
 
@@ -170,18 +170,25 @@ Usage:
 | Option | Description | Default |
 |--------|-------------|---------|
 | `-o, --outdir` | Output directory | `./` |
-| `-f, --format` | Output format: png, svg, pdf, lsif, tikz (jpg and gif are deprecated) | `png` |
+| `-f, --format` | Output format: png, svg, pdf, json, tikz | `png` |
 | `-l, --leafstyle` | Leaf style: auto, triangle, bar, nothing | `auto` |
 | `-n, --fontstyle` | Font style: sans, serif, cjk, mono | `sans` |
 | `-s, --fontsize` | Font size: 6-26 | `16` |
 | `-i, --linewidth` | Line width relative to the font size: 0.5-3.0 (`1` = 5% of the font size) | `1.0` |
 | `-c, --color` | Color mode: modern, traditional, gray (black text, grey lines), off | `modern` |
 | `-p, --polyline` | Polyline connectors: on, off | `off` |
-| `-d, --direction` | Tree layout direction: ttb, ltr | `ttb` |
+| `--hide-default-connectors` | Draw no parent-to-child lines, leaving only the ones written with `+-n`: on, off | `off` |
+| `-d, --direction` | Tree layout direction: ttb, ltr, btt | `ttb` |
 | `--tidy` | Layout scale: off, symmetric, low, medium, high | `off` |
-| `--hspacing` | Horizontal spacing factor, all layout modes (0.5-3.0) | `1.0` |
+| `--hspacing` | How far apart sisters sit, all layout modes (0.5-3.0) | `1.0` |
+| `-v, --vheight` | How far apart levels sit (0.5-5.0) | `2.0` |
+| `--derivation` | Join each node to its daughters with one rule drawn across them: on, off | `off` |
 | `--hyphen` | How a hyphen reads: markup (`-underline-`) or literal | `markup` |
 | `-m, --mirror` | Flip the tree horizontally (RTL convention): on, off | `off` |
+| `--shear` | Tilt the drawn figure, in degrees (-45 to 45, positive leans the top right) | `0` |
+| `--shear-plane` | The plane behind a sheared figure: on, off, or a colour | `on` |
+| `--vmargin` | Clearance between a label and its connectors (0.1-1.0, same above and below) | `0.4` |
+| `-r, --transparent` | Leave the background clear instead of painting it white: on, off | `off` |
 | `--validate` | Check the input without drawing: a JSON diagnosis on stdout, the verdict in the exit code | |
 | `--notation` | Print a short reference for the notation | |
 
@@ -215,10 +222,11 @@ a model writing it does better with the reference in front of it than without.
 [web interface](https://yohasebe.com/rsyntaxtree) or on your own machine —
 nothing needs installing. Give the model one of these to read:
 
-- [The brief reference](https://yohasebe.github.io/rsyntaxtree/llms.txt), about
-  a page, leading with the characters that already mean something.
+- [The reference, on one page](https://yohasebe.github.io/rsyntaxtree/notation.txt):
+  the characters that already mean something, then every feature at a line
+  each, then the options. About 6 KB.
 - [Everything in one file](https://yohasebe.github.io/rsyntaxtree/llms-full.txt):
-  the reference, the manual and all the gallery examples, 78 KB.
+  the reference, the manual and all the gallery examples, about 85 KB.
 
 **If the model can run a shell**, it can draw and then look at what it drew,
 which is the part that lets it correct itself:

data/bin/rsyntaxtree

@@ -9,7 +9,7 @@ require_relative '../lib/rsyntaxtree'
 require_relative '../lib/rsyntaxtree/utils'
 require_relative '../lib/rsyntaxtree/format_converter'
 
-# "png, jpg, gif, pdf, svg, lsif, or tikz" — built once from the library's
+# "png, pdf, svg, json, or tikz" — built once from the library's
 # own list so the three places that name the formats cannot drift apart.
 FORMAT_LIST_MESSAGE = FORMATS.join(", ").sub(/, ([^,]+)\z/, ', or \1')
 
@@ -17,21 +17,22 @@ FORMAT_LIST_MESSAGE = FORMATS.join(", ").sub(/, ([^,]+)\z/, ', or \1')
 CONFIG_VALIDATORS = {
   outdir: ->(v) { FileTest.directory?(v) ? nil : "must be an existing directory path" },
   outfilename: ->(v) { v.is_a?(String) ? nil : "must be a string" },
-  format: ->(v) { FORMATS.include?(v.to_s) ? nil : "must be #{FORMAT_LIST_MESSAGE}" },
+  format: ->(v) { FORMATS.include?(v.to_s) || v.to_s == "lsif" ? nil : "must be #{FORMAT_LIST_MESSAGE}" },
   leafstyle: ->(v) { OPTION_VALUES[:leafstyle].include?(v.to_s) ? nil : "must be auto, triangle, bar, or nothing" },
   fontstyle: ->(v) { OPTION_VALUES[:fontstyle].include?(v.to_s) ? nil : "must be sans, serif, cjk, or mono" },
   fontsize: ->(v) { v.is_a?(Integer) && v >= 6 && v <= 26 ? nil : "must be in the range of 6-26" },
   linewidth: ->(v) { v.is_a?(Numeric) && v >= 0.5 && v <= 3.0 ? nil : "must be in the range of 0.5-3.0" },
   vheight: ->(v) { v.is_a?(Numeric) && v >= 0.5 && v <= 5.0 ? nil : "must be in the range of 0.5-5.0" },
   color: ->(v) { OPTION_VALUES[:color].include?(v.to_s) ? nil : "must be modern, traditional, gray, or off" },
-  symmetrize: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
   transparent: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
   polyline: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
   hide_default_connectors: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
   mirror: ->(v) { /\A(on|off|true|false)\z/ =~ v.to_s ? nil : "must be on or off" },
+  shear: ->(v) { v.is_a?(Numeric) && v >= -45 && v <= 45 ? nil : "must be in the range of -45-45" },
+  vmargin: ->(v) { v.is_a?(Numeric) && v >= 0.1 && v <= 1.0 ? nil : "must be in the range of 0.1-1.0" },
+  shear_plane: ->(v) { v.to_s =~ /\A(on|off)\z/ || RSyntaxTree::COLOR_NAMES.include?(v.to_s.downcase) || v.to_s =~ /\A#(\h{3}|\h{6})\z/ ? nil : "must be on, off, or a colour" },
   tidy: ->(v) { OPTION_VALUES[:tidy].include?(v.to_s) ? nil : "must be off, symmetric, low, medium, or high" },
   hspacing: ->(v) { v.is_a?(Numeric) && v >= 0.5 && v <= 3.0 ? nil : "must be in the range of 0.5-3.0" },
-  tidy_spacing: ->(v) { v.is_a?(Numeric) && v >= 0.5 && v <= 3.0 ? nil : "must be in the range of 0.5-3.0" },
   direction: ->(v) { OPTION_VALUES[:direction].include?(v.to_s) ? nil : "must be one of: #{OPTION_VALUES[:direction].join(', ')}" },
   hyphen: ->(v) { OPTION_VALUES[:hyphen].include?(v.to_s) ? nil : "must be markup or literal" }
 }.freeze
@@ -114,14 +115,15 @@ opts = Optimist.options do
   opt :linewidth, "Size: 0.5-3.0", default: 1.0, short: :i
   opt :vheight, "Connector Height: 0.5-5.0", default: 2.0, short: :v
   opt :color, "Color text and bars: modern, traditional, gray, or off", default: "modern", short: :c
-  opt :symmetrize, "DEPRECATED alias of --tidy symmetric: on or off", default: "off", short: :y
   opt :transparent, "Make background transparent: on or off", default: "off", short: :r
   opt :polyline, "draw polyline connectors: on or off", default: "off", short: :p
   opt :hide_default_connectors, "make default connectors transparent: on or off", default: "off", short: :none
   opt :mirror, "flip the tree horizontally (RTL linguistics convention: first word at the right edge): on or off", default: "off"
+  opt :shear, "Tilt the drawn figure, in degrees: -45 to 45, positive leaning the top to the right", default: 0.0, short: :none
+  opt :shear_plane, "The plane behind a sheared figure: on, off, a colour name, or a hex colour", default: "on", short: :none
+  opt :vmargin, "Clearance between a label and its connectors, 0.1-1.0", default: 0.4, short: :none
   opt :tidy, "tidy tree layout: off, symmetric (radical symmetrization), low (packed, strict leaf positions), medium (packed; leaves may overlap but never swap order), or high (packed; leaf order kept per row only)", default: "off", short: :none
   opt :hspacing, "Horizontal spacing factor (counterpart of vheight): 0.5-3.0", default: 1.0, short: :none
-  opt :tidy_spacing, "DEPRECATED alias of --hspacing: 0.5-3.0", default: 1.0, short: :none
   opt :direction, "Tree layout direction: ttb (top-to-bottom), ltr (left-to-right) or btt (bottom-to-top, the root last)", default: "ttb", short: :d
   opt :derivation, "Join each node to its daughters with one rule drawn across them, as a derivation is written, rather than with a line to each: on, off", default: "off", short: :none
   opt :hyphen, "How a hyphen in a label reads: markup (-underline-) or literal (a hyphen; \-underline\- then underlines)", default: "markup", short: :none
@@ -131,6 +133,13 @@ opts = Optimist.options do
   opt :help, "This is a custom help message", short: :h
 end
 
+# The name the JSON format wore from 1.11.0 to 2.0.0. Accepted until 3.0,
+# and said out loud, the way JPG and GIF were seen out.
+if opts[:format] == "lsif"
+  warn "Warning: the format name 'lsif' is now 'json'. The old name will be removed in RSyntaxTree 3.0."
+  opts[:format] = "json"
+end
+
 Optimist.die :outdir, "must be an exsting directory path" unless FileTest.directory?(opts[:outdir])
 Optimist.die :direction, "must be one of: #{OPTION_VALUES[:direction].join(', ')}" unless OPTION_VALUES[:direction].include?(opts[:direction])
 Optimist.die :derivation, "must be one of: #{OPTION_VALUES[:derivation].join(', ')}" unless OPTION_VALUES[:derivation].include?(opts[:derivation])
@@ -140,8 +149,10 @@ Optimist.die :leafstyle, "must be auto, triangle, bar, or nothing" unless OPTION
 Optimist.die :fontstyle, "must be sans, serif, cjk, or mono" unless OPTION_VALUES[:fontstyle].include?(opts[:fontstyle])
 Optimist.die :fontsize, "must be in the range of 6-26" unless opts[:fontsize] >= 6 && opts[:fontsize] <= 26
 Optimist.die :linewidth, "must be in the range of 0.5-3.0" unless opts[:linewidth] >= 0.5 && opts[:linewidth] <= 3.0
+Optimist.die :shear, "must be in the range of -45-45" unless opts[:shear] >= -45 && opts[:shear] <= 45
+Optimist.die :vmargin, "must be in the range of 0.1-1.0" unless opts[:vmargin] >= 0.1 && opts[:vmargin] <= 1.0
+Optimist.die :shear_plane, "must be on, off, or a colour" unless /\A(on|off)\z/ =~ opts[:shear_plane] || RSyntaxTree::COLOR_NAMES.include?(opts[:shear_plane].downcase) || /\A#(\h{3}|\h{6})\z/ =~ opts[:shear_plane]
 Optimist.die :color, "must be either modern, traditional, gray, or off" unless OPTION_VALUES[:color].include?(opts[:color])
-Optimist.die :symmetrize, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:symmetrize]
 Optimist.die :vheight, "must be in the range of 0.5-5.0" if opts[:vheight] < 0.5 || opts[:vheight] > 5.0
 Optimist.die :transparent, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:transparent]
 Optimist.die :polyline, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:polyline]
@@ -149,7 +160,6 @@ Optimist.die :hide_default_connectors, "must be either on or off" unless /\A(on|
 Optimist.die :mirror, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:mirror]
 Optimist.die :tidy, "must be off, symmetric, low, medium, or high" unless OPTION_VALUES[:tidy].include?(opts[:tidy])
 Optimist.die :hspacing, "must be in the range of 0.5-3.0" if opts[:hspacing] < 0.5 || opts[:hspacing] > 3.0
-Optimist.die :tidy_spacing, "must be in the range of 0.5-3.0" if opts[:tidy_spacing] < 0.5 || opts[:tidy_spacing] > 3.0
 
 # Merge config file options with CLI options (CLI takes precedence)
 string_opts = {}
@@ -170,10 +180,6 @@ opts.each do |key, value|
   end
 end
 
-if %w[jpg gif].include?(string_opts[:format])
-  warn "Warning: #{string_opts[:format].upcase} output is deprecated and will be removed in RSyntaxTree 2.0. Use PNG instead."
-end
-
 # These print and exit, so they answer before the input is read. Reading
 # first meant waiting on a pipe that never closes when stdin is not a
 # terminal, which is how they are reached from a script.

data/lib/rsyntaxtree/base_graph.rb

@@ -14,7 +14,6 @@ module RSyntaxTree
     def initialize(element_list, params, global)
       @global = global
       @element_list = element_list
-      @symmetrize = params[:symmetrize] == true
       @direction = params[:direction] || "ttb"
 
       case params[:color]
@@ -72,13 +71,10 @@ module RSyntaxTree
       # "off" | "low" (packing, strict leaf positions) | "medium" (packing
       # with cross-row tucking as long as no two leaves swap left-right
       # order) | "high" (free tucking; leaf order kept per row only).
-      # Legacy inputs upgrade into the scale: tidy_nest: on lifts "low" to
-      # "high", and the old standalone symmetrize: on lifts "off" to
-      # "symmetric". When tidy packing is active the symmetric layout is
-      # meaningless, so packing wins over a legacy symmetrize flag.
+      # One scale, and nothing beside it: the standalone symmetrize and
+      # tidy_nest flags that used to lift a mode into another were removed
+      # in 2.0, so what is asked for is what is drawn.
       tidy_mode = params[:tidy].to_s
-      tidy_mode = "high" if tidy_mode == "low" && params[:tidy_nest] == true
-      tidy_mode = "symmetric" if tidy_mode == "off" && @symmetrize
       @tidy = %w[low medium high].include?(tidy_mode)
       # :none — leaf spans may not overlap at all (strict positions)
       # :ordered — spans may overlap, but leaf centers keep their order
@@ -966,7 +962,13 @@ module RSyntaxTree
       # is disproportionately large relative to the swapped content dimensions.
       # Use height_connector_to_text / 2 (= font_height / 4) for tight
       # vertical packing proportional to the font size.
-      @global[:h_gap_between_nodes] = @global[:height_connector_to_text] / 2
+      #
+      # Scaled by hspacing, like the gap it replaces. Without it the two
+      # spacing options both pushed the width in this direction — hspacing
+      # only through the margins it is left in — and nothing at all decided
+      # how far apart siblings sat, so a left-to-right tree could be made
+      # wider but never shorter.
+      @global[:h_gap_between_nodes] = @global[:height_connector_to_text] / 2 * @global[:hspacing]
 
       # In LTR, height_connector becomes horizontal depth between levels.
       # After content swap, content_height = original content_width (small),
@@ -1090,7 +1092,14 @@ module RSyntaxTree
       max_x = @rule_name_edge if @rule_name_edge.to_f > max_x
       width = max_x + @global[:h_gap_between_nodes]
       height = max_y
+      # A movement path routes outside the tree — below it top-to-bottom,
+      # beyond it to the right left-to-right — and grows @height or @width as
+      # it goes. The height has always been read back here; the width was
+      # computed from the elements alone and then overwrote what the path had
+      # grown, so a left-to-right path could reach past the canvas and be cut
+      # off at its edge.
       height = @height if @height > height
+      width = @width if @width > width
       { height: height, width: width }
     end
   end

data/lib/rsyntaxtree/element.rb

@@ -13,7 +13,7 @@ require_relative "color_names"
 
 module RSyntaxTree
   class Element
-    attr_accessor :rule_name, :label_with_rule_name, :id, :parent, :type, :level, :width, :height, :content, :content_width, :text_width, :content_height, :horizontal_indent, :vertical_indent, :triangle, :enclosure, :children, :font, :fontsize, :contains_phrase, :path, :color, :raw_content, :region, :region_color
+    attr_accessor :ink_top, :ink_bottom, :rule_name, :label_with_rule_name, :id, :parent, :type, :level, :width, :height, :content, :content_width, :text_width, :content_height, :horizontal_indent, :vertical_indent, :triangle, :enclosure, :children, :font, :fontsize, :contains_phrase, :path, :color, :raw_content, :region, :region_color
 
     # names_a_rule says the content is a mother's label rather than a leaf's
     # text. Only a mother has a step under it for a name to sit beside, and a
@@ -309,6 +309,10 @@ module RSyntaxTree
           row_holds_text = content[:elements].any? do |e|
             (e[:decoration] & [:box, :circle, :bar]).empty? && !e[:text].to_s.strip.empty?
           end
+          # True until something is drawn in the current column. A tabstop
+          # opens the next one, so a block that starts a column is at the
+          # start of a cell however many columns came before it.
+          cell_start = true
           content[:elements].each do |e|
             # A nested matrix is measured by the same code one level down, and
             # reports the size of the block it will occupy in this row: its own
@@ -317,7 +321,18 @@ module RSyntaxTree
               inner = measure_lines(e[:matrix], nested: true)
               e[:matrix_width] = inner[:width]
               e[:matrix_height] = inner[:height]
-              e[:width] = inner[:width] + matrix_bracket_room * 2
+              # A block that opens a cell needs nothing in front of it: the
+              # column it starts is already held clear. One that follows
+              # something in the same cell — the tag on a shared value, as in
+              # AGR |1| [ ... ] — was drawn with its bracket on the ink before
+              # it, because a run is spaced for the glyph that comes next and
+              # a bracket is not a glyph.
+              # As much room in front of the bracket as the bracket keeps
+              # inside it, so the two sides of it look alike. Half as much
+              # left it looking crowded from the outside.
+              e[:matrix_lead] = cell_start ? 0 : matrix_bracket_room
+              cell_start = false
+              e[:width] = inner[:width] + matrix_bracket_room * 2 + e[:matrix_lead]
               # Two separate allowances. The block is padded inside its own
               # brackets, above and below, and that padding is part of the row.
               # The gap that keeps the block clear of the rows either side is
@@ -335,6 +350,14 @@ module RSyntaxTree
               next
             end
 
+            # A tabstop opens the next column; anything else puts ink in the
+            # one being filled.
+            if e[:decoration].to_a.include?(:tabstop)
+              cell_start = true
+            elsif !e[:text].to_s.empty?
+              cell_start = false
+            end
+
             text = e[:text]
             # Handle escaped square brackets
             text = text.gsub('\\[', '[')

data/lib/rsyntaxtree/{lsif_graph.rb → json_graph.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #==========================
-# lsif_graph.rb
+# json_graph.rb
 #==========================
 #
 # Generates LSIF (Linguistic Structure Interchange Format) JSON output.
@@ -12,7 +12,7 @@ require_relative 'base_graph'
 require_relative 'utils'
 
 module RSyntaxTree
-  class LsifGraph < BaseGraph
+  class JSONGraph < BaseGraph
     attr_accessor :width, :height
 
     def initialize(element_list, params, global)
@@ -30,7 +30,7 @@ module RSyntaxTree
       @global = global
     end
 
-    def lsif_data
+    def json_data
       metrics = parse_list
       @width = metrics[:width] + @global[:h_gap_between_nodes] * 2
       @height = metrics[:height] + @global[:height_connector_to_text] / 2
@@ -241,14 +241,7 @@ module RSyntaxTree
       element.content.each do |l|
         next unless l[:type] == :text
 
-        segments = l[:elements].map do |e|
-          next if e[:decoration].include?(:whitespace) && e[:text].strip.empty?
-
-          {
-            text: e[:text].gsub(WHITESPACE_BLOCK, " ").gsub('&#62;', '>').gsub('&#60;', '<'),
-            decorations: e[:decoration].map(&:to_s).reject { |d| d == "whitespace" }
-          }
-        end.compact
+        segments = l[:elements].map { |e| build_segment(e) }.compact
         lines << { segments: segments } unless segments.empty?
       end
 
@@ -258,6 +251,43 @@ module RSyntaxTree
       }
     end
 
+    def build_segment(run)
+      return nil if run[:decoration].include?(:whitespace) && run[:text].strip.empty?
+
+      segment = {
+        text: run[:text].gsub(WHITESPACE_BLOCK, " ").gsub('&#62;', '>').gsub('&#60;', '<'),
+        decorations: run[:decoration].map(&:to_s).reject { |d| d == "whitespace" }
+      }
+      # A feature matrix used to reach this document as an empty segment
+      # marked "matrix", its attribute-value pairs recoverable only by
+      # re-parsing the raw label — which is no way to score whether a model
+      # wrote CASE nom where CASE nom was wanted. The rows come through now:
+      # cells split on the tab stops, rules kept as rows of their own, a
+      # matrix inside a cell recursing.
+      segment[:matrix] = { rows: build_matrix_rows(run[:matrix]) } if run[:decoration].include?(:matrix) && run[:matrix]
+      segment
+    end
+
+    def build_matrix_rows(matrix_lines)
+      matrix_lines.filter_map do |line|
+        case line[:type]
+        when :border then { rule: "single" }
+        when :bborder then { rule: "double" }
+        when :text
+          cells = [[]]
+          line[:elements].each do |run|
+            if run[:decoration].include?(:tabstop)
+              cells << []
+            else
+              segment = build_segment(run)
+              cells.last << segment if segment
+            end
+          end
+          { cells: cells }
+        end
+      end
+    end
+
     def map_enclosure(enclosure)
       case enclosure
       when :brackets then "brackets"
@@ -273,8 +303,14 @@ module RSyntaxTree
 
     def build_json
       data = {
-        lsif: {
-          version: "0.3.0",
+        # What this document is, said by a field rather than by the key, so a
+        # reader checks ["format"]["name"] and the key never has to change
+        # again. Documents up to schema 0.3.0 said it with a top-level "lsif"
+        # key instead — a name that collided with the code-intelligence
+        # format of the same initials.
+        format: {
+          name: "rsyntaxtree-json",
+          version: "0.4.0",
           generator: "rsyntaxtree #{RSyntaxTree::VERSION}",
           level: "rendered"
         },
@@ -291,12 +327,18 @@ module RSyntaxTree
               connector_height: @params[:vheight],
               horizontal_spacing: @params[:hspacing] || 1.0,
               line_width: @params[:linewidth],
-              # The layout scale the figure was drawn on. symmetrize is kept
-              # for readers of older files; tidy: "symmetric" supersedes it.
+              # The layout scale the figure was drawn on. Files written
+              # before 2.0 carry a separate symmetrize flag beside it; the
+              # scale is what it meant, and it is all that is written now.
               tidy: @params[:tidy] || "off",
-              symmetrize: @params[:symmetrize],
               mirror: @params[:mirror] == true,
               direction: @params[:direction] || "ttb",
+              # Degrees, positive leaning the top right. The geometry below
+              # is the unsheared layout — the shear is applied at render — so
+              # a reader who wants the drawn look applies it, and one who
+              # wants the layout ignores it.
+              shear: (@params[:shear] || 0).to_f,
+              vmargin: (@params[:vmargin] || 0.4).to_f,
               # Which of the two readings of a hyphen the input was parsed
               # under. The input is recorded verbatim above, and the same
               # string means different things under the two, so a reader

data/lib/rsyntaxtree/markup_parser.rb

@@ -5,8 +5,13 @@ require 'parslet'
 class MarkupParser < Parslet::Parser
   rule(:cr) { str('\\n') }
   rule(:eof) { any.absent? }
-  rule(:border) { match('[^\-]').absent? >> str('-').repeat(3).as(:border) >> (eof | cr) }
-  rule(:bborder) { match('[^=]').absent? >> str('=').repeat(3).as(:bborder) >> (eof | cr) }
+  rule(:border) { rule_line >> (eof | cr) }
+  rule(:bborder) { double_rule_line >> (eof | cr) }
+  # The rule itself, without what ends the line. A matrix ends its rows on
+  # its own closing delimiter as well as on a line break, so it supplies its
+  # own terminator; folding one in here would have the two consume it twice.
+  rule(:rule_line) { match('[^\-]').absent? >> str('-').repeat(3).as(:border) }
+  rule(:double_rule_line) { match('[^=]').absent? >> str('=').repeat(3).as(:bborder) }
 
   rule(:brectangle) { str('###') }
   rule(:rectangle) { str('##') }
@@ -79,7 +84,7 @@ class MarkupParser < Parslet::Parser
   # bare brackets would be read as tree structure and bare parentheses appear
   # in labels too often to claim.
   rule(:matrix) { str('#(') >> matrix_line.repeat(1).as(:matrix) >> str('#)') }
-  rule(:matrix_line) { matrix_markup.repeat(1).as(:line) >> (cr | str('#)').present?) }
+  rule(:matrix_line) { (rule_line | double_rule_line | matrix_markup.repeat(1).as(:line)) >> (cr | str('#)').present?) }
   rule(:matrix_markup) { (matrix | tabstop | matrix_text | decoration | shape | bstroke) }
   # Text inside a matrix stops at the closing delimiter as well.
   rule(:matrix_text) { (escaped | (str('#)').absent? >> non_escaped)).repeat(1).as(:text) }

data/lib/rsyntaxtree/notation_core.md

@@ -13,7 +13,10 @@ figure that was meant.
 - `<>` is one space and `<3>` is three, everywhere — never angle brackets.
   Where linguistics wants the brackets themselves, write ⟨ and ⟩ (U+27E8/9):
   SPR\t⟨<>NP<>⟩, 'hand⟨SUBJ,OBJ⟩'. A label written <NP> is refused with this
-  advice; a stray <3> simply draws three spaces.
+  advice; a stray <3> simply draws three spaces. No text face carries these
+  two characters, so whatever the machine falls back to draws them — they
+  will not quite match the letters beside them, and how far off they look
+  depends on the fonts installed.
 - A pair of hyphens underlines what stands between them: well-made-word draws
   "made" underlined. (A lone hyphen is refused with a hint.) Write `\-` for a
   hyphen — V\-bar, HEAD\-DTR — or set the hyphen option to literal.
@@ -84,7 +87,7 @@ Options (the command line spells them --like-this):
 
 | option     | what it decides |
 |------------|-----------------|
-| format     | png, svg, pdf, gif, jpg, tikz, lsif |
+| format     | png, svg, pdf, tikz, json (the tree as structured data) |
 | fontstyle  | sans, serif, mono, cjk |
 | fontsize   | 6–26 |
 | color      | modern, traditional, off, gray |
@@ -93,10 +96,20 @@ Options (the command line spells them --like-this):
 | direction  | ttb, ltr, btt |
 | mirror     | flip the finished layout, for RTL scripts |
 | tidy       | off, symmetric, low, medium, high — how tightly subtrees pack |
-| hspacing   | horizontal spacing factor, 0.5–3.0 (tidy_spacing is its old name) |
-| vheight    | vertical spacing factor, 0.5–5.0 |
+| hspacing   | how far apart sisters sit, 0.5–3.0 |
+| vheight    | how far apart levels sit, 0.5–5.0 |
+| polyline   | draw each connector as two right angles rather than a slanted line |
+| hide_default_connectors | draw no parent-to-child lines, leaving only the ones written with +-n — how a lattice or a network is drawn |
+| transparent | leave the background clear instead of painting it white |
 | derivation | one rule across the daughters, categorial-grammar style |
 | hyphen     | markup (hyphens underline) or literal (hyphens are hyphens) |
+| shear      | tilt the drawn figure: degrees, −45 to 45, positive leans the top right |
+| shear_plane | the plane behind a sheared figure: on (grey), off, or a colour; never drawn on a transparent background |
+| vmargin    | clearance between a label and its connectors, 0.1–1.0, the same above and below |
+
+hspacing and vheight are named for the top-to-bottom layout, and follow the
+tree rather than the page: with direction ltr, sisters stack downwards and
+hspacing is what separates them, while vheight runs across.
 
 The full manual explains each of these with figures, and every example in the
 gallery is written out beside the figure it draws: