Skip to content

v6.0.0

Latest

Choose a tag to compare

@aireilly aireilly released this 19 Aug 12:20

LwDITA 6.0.0

This release focuses on producing richer, better-structured DITA tasks and topics from Markdown, with sensible defaults so the common cases work without extra configuration.

Highlights

Shortdesc from a typed title

When a top-level heading is typed with a specialization class (# Title {.concept}, {.task}, or {.reference}), the first paragraph that follows is now emitted as <shortdesc> instead of an ordinary body paragraph. This gives concepts, tasks, and references a proper short description straight from the Markdown source, matching how authors naturally lead a topic with a one-line summary.

Implicit task sections on by default

The implicit-task-sections feature is now enabled by default for the md parser. Well-known section headings inside a {.task} topic are mapped to their DITA task-section elements automatically:

Heading (default) Task element
Prerequisites <prereq>
About this task <context>
Procedure / Steps <steps>
Verification <result>
Next steps <postreq>

The title-to-section mapping is configurable per section via SAX properties, e.g. setProperty("http://lwdita.org/sax/properties/implicit-task-sections/context", List.of("about this task")).

New "Procedure" / "Steps" marker heading

Previously a task could not combine heading-based prereq/context sections with real <steps>: the section heading opened a <section> that swallowed the following list, so the steps never materialized.

A heading whose title matches the steps section key (default titles Procedure and Steps) now acts as a marker. When implicit task sections are enabled and the heading sits inside a task, the heading itself is discarded and the ordered list that follows becomes <steps>. This means a single Markdown task can now carry heading-based prerequisites and context alongside genuine steps and a result:

# Install the software {.task}

This procedure installs the software from the command line.

## Prerequisites

You have administrator access.

## About this task

The installer applies the default configuration.

## Procedure

1.  Run the installer.
2.  Accept the license agreement.

## Verification

Confirm that the software is installed.

produces a valid task > taskbody > (prereq, context, steps, result).

The steps key is a first-class member of the configurable section-title map, so its trigger titles can be overridden like any other section, e.g. setProperty("http://lwdita.org/sax/properties/implicit-task-sections/steps", List.of("vorgehensweise")).

Richer task bodies: substeps, choices, and choicetable

Tasks now support both explicit and implicit substeps, explicit and implicit choices, and choicetable, giving generated <task> topics the full range of DITA step structures from plain Markdown.

MDX / Docusaurus output

Initial Docusaurus MDX output, including support for components, non-string props, nested maps in YAML headers, and a configurable TOC file extension. Prolog data elements now round-trip back out as YAML headers.

Also in this release

  • flexmark updated to 0.64.8.
  • HTML output support for choicetable, substeps, and implicit task features.
  • Fix for duplicate class attribute on the info element (jelovirt#240).
  • Tests migrated to useJUnitPlatform.

Installation

dita install org.lwdita-6.0.0.zip

Full Changelog: 5.9.1...v6.0.0