# Release Notes 2019

# v1.3.0 (December 2019)

Changes in: @argdown/core, @argdown/node, @argdown/vscode, @argdown/sandbox, @argdown/codemirror-mode, @argdown/prism, docs

New package: ArgVu

This release fixes all currently open bugs, introduces ArgVu, a font for Argdown, and configurable shortcodes for special characters like logical symbols or emojis.

# ArgVu

ArgVu is a free font that adds Argdown-specific font ligatures and glyphs to DejaVu Sans Mono. You can configure VSCode so that it will only use ArgVu ligatures for Argdown files. For a feature list and installation instructions consult the font's README.

# Shortcodes for logical symbols and emojis 😍

You can now use shortcodes like .A. for ∀ or :happy: for 😀 instead of having to copy and paste special unicode characters. Please read more about this feature in our guide on creating argument maps.

If you install ArgVu and use its dlig ligatures the shortcodes for logical symbols will be automatically displayed as their unicode counterparts (so :A: will look like ∀ and :<->: will look like ↔). It is just like magic!

# Bug fixes

  • Multiple empty lines at end of file #132
  • First line empty, second line comment #130
  • Language server throws error messages in VS code #128
  • Windows line feed (\r) in argdown cli prevents it from running on linux #121
  • VS Code: language server does not work with unsaved files #89

# v1.2.0 (October 2019)

Changes in: @argdown/core, @argdown/node, @argdown/vscode, @argdown/sandbox, @argdown/language-server, docs

This is a small maintenance release that updates the packages dependencies, fixes the current bugs and improves the way linebreaks behave in statements and argument descriptions.

# Line breaks and empty spaces

Until now, line breaks were simply ignored by the parser. As @sbrugman pointed out in #117 the standard Markdown behaviour is that single line breaks in a paragraph are interpreted as empty spaces. Argdown will now behave in a similar way if

  • the line break is not already preceded by an empty space
  • the line break does not finish the statement text or argument description.

# Bug fixes

  • Windows line feed (\r) in argdown cli prevents it from running on linux #121
  • 3 *s cause problem #118
  • Add support for implicit relation direction of undercut (_ instead of <_) #112

# Documentation

  • error in installation instructions for @argdown/cli #120
  • link to first example broken #115
  • make docs more welcoming for users not familiar with argument maps #114
  • Documentation: Broken Link to @argdown/cli Readme and API docs #108

# Other

  • argdown-vscode: Update icons #122

# v1.1.0 (March 2019)

Changes in: @argdown/core, @argdown/node, @argdown/vscode, @argdown/sandbox, @argdown/language-server

This is a big release that extends the Argdown packages with a number of useful new features and configuration options like

However by far the most effort was put into bug fixes and improvements in code quality and stability. Nearly all bug issues on Github are now closed and all three Argdown apps should have gotten better in handling invalid Argdown code.

# GraphML Export

Maps can now be exported to GraphML. The exported maps can directly be used in the powerful and free yEd graph editor. This makes it now possible to completely customize the graph layout and design of the map.

The map in GraphML will not be layouted, all nodes have the same position. After the import in yEd you have to apply a graph layout (this only takes a few clicks).

# Closable Groups

A group can be closed now to hide all its children. This is useful to reduce complexity in huge maps.

# Usage with Data Flag:

[s1]

<a4>
    -> <a2>

# A Closed Group  {isClosed: true}

[s1]
    - <a2> {isInGroup: true}
    + <a3>
Argument Map s1 A Closed Group n0 s1 s1->n0 s1->n0 n1 a4 n1->s1

# Usage in Group Configuration:

The new group.sections setting allows to define which sections are closed and which are not groups:

===
group:
    sections: {"A Closed Group": {isClosed: true}, "Just a Heading": {isGroup: false}}
===

# A Closed Group

<s1>: I am hidden.
    -> [s2]

# Just a Heading

[s2]: I am free!
Argument Map s1 A Closed Group n0 s2 I am free! s1->n0

This allows to use headings as groups without "polluting" the Argdown document with data flags.

# Usage in Regroup Configuration:

===
group:
    regroup: [{
            title: "first group",
            statements: ["s1"], arguments: ["a1"],
            children: [
                {
                    title: "some other group",
                    isClosed: true,
                    arguments: ["a2"]
                }
            ]
            }]
===


[s1]: I am a proud member of the first group
    - <a1>: I am a proud member of the first group
        - <a2>: The other group is much more exclusive!

<a3>: Who needs groups?
    -> [s1]
Argument Map cluster_1 first group n0 s1 I am a proud member of the first group n1 a1 I am a proud member of the first group n1->n0 s1 some other group s1->n1 n3 a3 Who needs groups? n3->n0

# Ignoring Group Data flags

Group data flags can now be ignored by using group.ignoreIsGroup and group.ignoreIsClosed

# Dot Configuration: Rank Assignment

For the Dot export and VizJs map you can now use the sameRank option to declare that certain nodes should be at the same level in the layout (see this Stackoverflow question for an example).

# Usage of the sameRank Setting in Dot Configuration

===
dot:
    sameRank:
        - {arguments: ["a1", "a2"], statements: ["s1", "s2"]}
===

<a1>
    - <a2>
    + <a3>

[s1]
    - [s2]
    + [s3]
Argument Map n0 s1 n1 s2 n1->n0 n2 s3 n2->n0 n3 a1 n4 a2 n4->n3 n5 a3 n5->n3

# Usage of the rank Property in Element Data

<a1> {rank: "r1"}
    - <a2>  {rank: "r1"}
    + <a3>  {rank: "r2"}

[s1]  {rank: "r1"}
    - [s2]  {rank: "r1"}
    + [s3]  {rank: "r2"}
Argument Map n0 s1 n1 s2 n1->n0 n2 s3 n2->n0 n3 a1 n4 a2 n4->n3 n5 a3 n5->n3

If you want to put nodes of different groups (clusters) into the same rank, you might want to try the newrank graphviz setting:

===
dot:
    graphVizSettings:
        newrank: true
===

# New Rank Test

## Heading 1

<a1> {rank: "r1"}
    - <a2>  {rank: "r1"}
    + <a3>  {rank: "r2"}
    -> [s1]

## Heading 2

[s1]  {rank: "r1"}
    - [s2]  {rank: "r1"}
    + [s3]  {rank: "r2"}
Argument Map cluster_1 New Rank Test cluster_2 Heading 1 cluster_3 Heading 2 n0 s1 n3 a1 n3->n0 n4 a2 n4->n3 n5 a3 n5->n3 n1 s2 n1->n0 n2 s3 n2->n0

See this Stackoverflow question for more information.

# VizJs Configuration: Layout Engines

VizJs can now be configured to use any of its layout engines:

  • circo
  • dot (default)
  • fdp
  • neato
  • osage
  • twopi

At the moment this will not work on https:argdown.org/changes as the documentation still has to use an outdated VizJs version for technical reasons. If you want to try it out, copy the code below into the browser sandbox or into VSCode.

===
vizJs:
    engine: circo
===

<a1>
    - <a2>
    + <a3>
        - <a6>
        - <a7>
        - <a8>
    - <a4>
    + <a5>
        - <a9>
        - <a10>
        - <a11>
Argument Map n0 a1 n1 a2 n1->n0 n2 a3 n2->n0 n3 a6 n3->n2 n4 a7 n4->n2 n5 a8 n5->n2 n6 a4 n6->n0 n7 a5 n7->n0 n8 a9 n8->n7 n9 a10 n9->n7 n10 a11 n10->n7

# Dot/VizJs/Dagre Configuration: Changing the Node Width

The dot export/VizJs map and Dagre map now support two methods of changing the node width.

In both cases the Argdown app has to add line breaks to the node labels to force a certain node width. The node width is changed by customizing the method by which the line breaks are added.

# The charactersInLine Setting

By default a line break is added after a certain maximum number of characters (respecting word boundaries). This behaviour is customized by using the charactersInLine setting. This simple method is fast and works surprisingly well in practice.

Here is an example of customizing the dot export with different charactersInLine settings for groups, arguments and nodes:

===
dot:
    group:
        charactersInLine: 1000
    argument:
        minWidth: 0
        title:
            charactersInLine: 12
        text:
            charactersInLine: 12
    statement:
        minWidth: 0
        title:
            charactersInLine: 30
        text:
            charactersInLine: 30
===

# A group with a very very very long title that does not contain a line break even though it is really long

[A statement with a long title]: This statement states that it is a long statement, longer than many many other claims commonly used in a debate.
    - <An argument with a long title>: A description that goes on for a while and does not stop too soon. Here is another sentence. And another one.
Argument Map cluster_1 A group with a very very very long title that does not contain a line break even though it is really long n0 A statement with a long title This statement states that it is a long statement, longer than many many other claims commonly used in a debate. n1 An argument with a long title A description that goes on for a while and does not stop too soon. Here is another sentence. And another one. n1->n0

Note that you have to define separate charactersInLine settings for the title labels and text labels of argument and statement nodes. This is necessary because you can also use different font sizes for them, so you might want to set charactersInLine lower if the font size is larger.

# The measureLineWidth Setting

Alternatively, you can try a more exact and slower method by turning on measureLineWidth. In this case the actual pixel width of each word is measured and a line break is added after a certain maximum number of pixels (once again respecting word boundaries).

This behaviour is customized by using the lineWidth setting. Here is an example of turning on and customizing measureLineWidth for the VizJs map:

===
dot:
    measureLineWidth: true
    group:
        lineWidth: 1000
    argument:
        lineWidth: 80
        minWidth: 0
    statement:
        lineWidth: 220
        minWidth: 0
===

# A group with a very very very long title that does not contain a line break even though it is really long

[A statement with a long title]: This statement states that it is a long statement, longer than many many other claims commonly used in a debate.
    - <An argument with a long title>: A description that goes on for a while and does not stop too soon. Here is another sentence. And another one.
Argument Map cluster_1 A group with a very very very long title that does not contain a line break even though it is really long n0 A statement with a long title This statement states that it is a long statement, longer than many many other claims commonly used in a debate. n1 An argument with a long title A description that goes on for a while and does not stop too soon. Here is another sentence. And another one. n1->n0

In this case there are no separate settings for title and text as the line width is measured by taking different font sizes into account.

For the text measurement we use the string-pixel-width library to be able to measure text outside of the browser. Please note that the library only supports measuring a limited number of fonts, so this option might not work with your font. Please consult the library's Readme for further information.

# Dot Configuration: Using minWidth to Set a Uniform Minimum Node Width

In the dot export (and the VizJs map by extension) the minWidth property will be used as a minimum node width. If minWidth = 0 the default GraphViz behaviour will be used, which means that the node width is set to maxLineWidthInLabel + horizontalMargin. This is how nodes widths were determined before in the Argdown VizJs map. This behaviour saves space, but it has the downside that nodes have different widths, depending on their label content. This lack of uniformity might make the map look messy.

In the new version, Argdown sets the minWidth for argument and statement nodes by default to 180 which means that the node width is now set to max(180, maxLineWidthInLabel) + horizontalMargin. If you want the old behaviour back, you have to set minWidth to 0.

Here is the new default behaviour:

<a1>
    - <A veeeeeeeery long title>
Argument Map n0 a1 n1 A veeeeeeeery long title n1->n0

Here is how you get the old default behaviour back:

===
dot:
    argument:
        minWidth: 0
===

<a1>
    - <A veeeeeeeery long title>
Argument Map n0 a1 n1 A veeeeeeeery long title n1->n0

# Dot Configuration: Setting Margins for Nodes and Groups

You can now use the margin dot setting to customize the sizing of statements, arguments and groups in dot (and the VizJs map):

===
map:
    argumentLabelMode: title
dot:
    argument:
        minWidth: 0
        margin: "0.8, 0"
    statement:
        minWidth: 0
        margin: "0, 0.8"
    group:
        margin: "80"
===

# A group

[s1]: A statement
    - <argument>: An argument
Argument Map cluster_1 A group n0 s1 A statement n1 argument n1->n0

# GraphML Configuration: Node Size

Because the GraphML export is not used in a live preview, performance is not as important so it always uses the line measurement method.

In contrast to the Dot export and the Dagre map, node width can be set directly. Together with the horizontalPadding setting it determines the node's line width.

Here are the node size configuration options for GraphML:

===
graphml:
    argument:
        width: 100
        horizontalPadding: 20
        verticalPadding: 10
    statement:
        width: 150
        horizontalPadding: 20
        verticalPadding: 10
    group:
        horizontalPadding: 20
        verticalPadding: 20
===

...
Argument Map

# Dot/GraphML/Dagre Configuration: Font Style

Font size, font and boldness of text in the Dot/GraphML exports and VizJs/Dagre maps can now be customized for groups, arguments and statements:

===
dot:
    group:
        fontSize: 25
        font: impact
        bold: true
    statement:
        title:
            fontSize: 14
            bold: true
            font: impact
        text:
            font: times new roman
            fontSize: 12
    argument:
        title:
            fontSize: 16
            bold: true
            font: impact
        text:
            font: times new roman
            fontSize: 12
===

[Statement]: Some text
    - <Argument>: Some text
Argument Map n0 Statement Some text n1 Argument Some text n1->n0

Please note that VizJs only supports a small number of fonts and the same is true for the library that is used for text width measurement.

# Color configuration: Custom Relation & Edge Colors

Relation colors can now be customized. Here is how you can turn all attack edges in your map pink:

===
color:
    relationColors:
        attack: "#FFC0CB"
===

<a1>
    - <a2>
    - <a3>
Argument Map n0 a1 n1 a2 n1->n0 n2 a3 n2->n0

# HTML Export: Creating a Header From Document Metadata

The HTML export now uses frontmatter metadata to create a document header with a title and optionally a subtitle, authors, date and abstract:

===
title: A Document with a Header
subTitle: Having Fun With HTML
author: Christian Voigt
# if there are several authors you can use an array:
# author: ["Christian Voigt", "Gregor Betz"]
date: 14/3/2019
abstract: >
    Demonstrating the use
    of document meta data
    in the HTML export
===

...
Argument Map
A Document with a Header — Having Fun With HTML: Demonstrating the use of document meta data in the HTML export

If you want to define metadata, but not generate a HTML header section, you can deactivate this feature in the html settings:

===
title: A Document Without a Header
author: Christian Voigt
html:
    createHeaderFromMetadata: false
===

...
Argument Map
A Document Without a Header

# PDF Export Configuration

The PDF export for the VizJs map is now fixed. The size and padding of the pdf can now be changed. The map will be scaled accordingly.

===
svgToPdf:
    width: 800
    height: 600
    padding: 20
===

...
Argument Map

For VSCode users: please note that only the currently visible part of the map will be visible in the pdf file. If you have zoomed in, some parts of the map will be cut off. Reload the map to make all nodes visible again and then export to pdf without zooming.

# Dot Configuration: mapBgColor Setting

To support VSCode dark themes the VizJs map's background color is now set to transparent. You can change the background color with the mapBgColor setting.

Here is how you turn your VizJs map background pink:

===
dot:
    mapBgColor: "#FFC0CB"
===

[s1]
    + <a1>
        - <a2>
        - <a3>
Argument Map n0 s1 n1 a1 n1->n0 n2 a2 n2->n1 n3 a3 n3->n1

# Changes in Section Assignment

The behaviour of the section assignment has slightly changed: If an equivalence class has no definition and an argument has no definition and no premise-conclusion-structure the section of their first reference is assigned to them:

# A section

[A statement without definition]

# Another section

[A statement without definition]
    - <An argument without definition>
Argument Map cluster_1 A section cluster_2 Another section n0 A statement without definition n1 An argument without definition n1->n0

Previoulsy no section was assigned in these cases.

# VSCode: New Themes

The VSCode Argdown extension now comes with two themes:

  • Argdown Light, based on the default light theme
  • Argdown Dark, based on the default dark theme

Additionally the extension's README now contains instructions how to use any VSCode theme with Argdown by adding custom token colors to your VSCode configuration.

The Argdown preview will now also use your current theme's colors for its styles, so that the extension will be seamlessly integrated into VSCode.

# VSCode: Hover Quick Info

Hovering with the mouse over statement and argument titles will show an improved quick info view that will show explicit and now also implicit relations that can be derived from equivalence classes and premise-conclusion-structures.

# VSCode: Persistent Preview

The Argdown preview will now serialize its state and recreate it on VSCode restarts, allowing you to continue work where you left off. This also applies to its zoom state.

# Minor changes

  • @argdown/vscode: added argdown.preview.minUpdateDelay setting so that the user can increase the delay between preview updates if performance is an issue
  • @argdown/core: simple configuration data sanitization system for better stability in previews if configuration is invalid
  • @argdown/core: checkResponseInputFields helper for easier response validation in plugins
  • @argdown/core: added error code to plugin exceptions for easier testing of exceptions handling
  • @argdown/language-server: increased general stability (exception handling)
  • @argdown/sandbox: increased general stability of preview (catching exceptions), VizJs is now automatically reinstantiated if rendering fails
  • @argdown/vscode: now uses Viz.Js inside the webview, hopefully improving performance
  • @argdown/sandbox: now uses a web worker for the VizJsMap that should improve performance
  • @argdown/map-views: refactoring of map views, changed Dagre labels from foreign-objects to pure svg to avoid browser bugs
  • @argdown/vscode: using @argdown/map-views now, sharing code with @argdown/sandbox
  • @argdown/sandbox: using @argdown/map-views now, sharing code with @argdown/vscode
  • @argdown/core now exports deriveImplicitRelations helper for getting inferences derivable from pcs (used in hover provider of language server).
  • @argdown/core now exports jsonReplacer and stringifyArgdownData for stringifying Argdown data.
  • @argdown/sandbox removed settings view (as all configuration should be done via frontmatter)
  • updated all dependencies
  • @argdown/core (and others): replaced dependency on lodash with dependencies on single lodash functions

# Breaking changes

  • Process order: Map colorization now happens in the ColorPlugin, so it needs to be run after the MapPlugin
  • renamed dotToSvg to vizJs settings
  • removed some cli options in favor of configuration through config file or frontmatter section (see cli help for remaining options)
  • VizJsMap now uses the external full.render.js that can be used as a web worker. This file should not be processed by a bundler and has to be made accessible to the map view.
  • DotToSvgPlugin runs now asynchronous (using app.run instead of app.runAsync will not run it)

# Bug fixes

  • #106 vizjs map can not handle untitled arguments
  • #104 Extension host stops in VSCODE
  • #103 @argdown/sandbox: dagre nodes twice too large in Chrome
  • #99 @argdown/codemirror-mode: highlighting of indented inferences
  • #97 Language Server should not send parser errors to log
  • #90 argdown-vscode: improve quick info on hover
  • #87 Incorrect arrows with: isInMap: false and mode:strict bug
  • #82 html export: improve anchor link behavior
  • #57 redundant edges in map
  • #51 pdf export: map is cut off

# Older releases

For the release notes of 2018 visit this page.