Package network.ike.docs.koncept

package network.ike.docs.koncept

Koncept AsciiDoc Extension — inline markup for clinical knowledge concepts.

Overview

This package provides an AsciidoctorJ extension that introduces the k:ConceptName[] inline macro for referencing clinical and knowledge-engineering concepts in AsciiDoc documents. Each reference renders as a clickable SVG badge and is automatically collected into a "Referenced Koncepts" glossary appended to the document.

Extension Architecture

The extension consists of three cooperating components:

KonceptInlineMacro

Processes k:Name[] syntax during document conversion. Renders backend-appropriate markup (SVG for HTML, styled phrase for DocBook, bold text for Prawn PDF) and registers each reference in a document-scoped registry.

KonceptGlossaryProcessor

Postprocessor that consumes the registry after conversion, resolves definitions from a KonceptDefinitionSource, and appends a structured glossary and colophon to the output.

KonceptExtensionRegistry

SPI entry point that auto-registers the inline macro with AsciidoctorJ. The glossary postprocessor is registered separately per-execution to avoid Prawn PDF backend incompatibility.

Koncept Definitions

Definitions are sourced via the KonceptDefinitionSource strategy interface. The default implementation, YamlKonceptDefinitionSource, loads from YAML files. Each definition includes:

• Natural language definition text
• Description logic axiom using Unicode DL notation (≡, ⊓, ∃, ∀, ⊑, etc.)
• Optional SNOMED CT concept identifier (SCTID)
• Optional OWL IRI

Usage

In AsciiDoc source:

The patient presented with k:HeartFailure[] and k:AorticStenosis[].
A label override: k:HeartFailure[Congestive Heart Failure].

In a YAML definitions file (koncepts.yml):

HeartFailure:
  label: Heart Failure
  definition: >
    A clinical syndrome characterized by the heart's inability
    to pump sufficient blood to meet metabolic demands.
  axiom: "≡ ClinicalSyndrome ⊓ ∃hasPathology.(InsufficientCardiacOutput)"
  sctid: "84114007"

Backend Support

Rendering behavior by AsciiDoc backend

Backend	Inline Rendering	Glossary
html5	SVG badge with anchor link	HTML definition list
docbook5	DocBook link + phrase	DocBook glossary
pdf (Prawn)	Bold + code styled text	Not supported

Since:

1.0.0

See Also:

• KonceptInlineMacro
• KonceptGlossaryProcessor
• KonceptDefinitionSource

Class	Description
CompositeKonceptDefinitionSource	A definition source that chains multiple sources in priority order.
EmptyParagraphPostprocessor	AsciidoctorJ postprocessor that removes empty paragraph blocks from the generated HTML.
FrontBackMatterTreeprocessor	Tags level-1 special sections so the print stylesheets can route them to front- or back-matter page schemes instead of the chapter scheme.
IdenticonRenderer	Renders the Komet identicon for a koncept as a PNG.
KonceptBadgeAnatomyBlockMacro	AsciidoctorJ block macro that renders the anatomy of a Koncept Badge as a real, captioned figure: the referenced koncept's badge — kind sigil, identicon, name — drawn large, with a muted part label beneath each part.
KonceptDefinition	Immutable definition of a Koncept, including natural language definition, description logic axiom, and optional terminology identifiers.
KonceptDefinition.Builder	Builder for constructing KonceptDefinition instances from parsed YAML or programmatic sources.
KonceptDefinition.ModelFeature	One Model Feature of a kind: pattern koncept in presentation form: the referenced component first, then each declared field, labeled 1-indexed (Field 1 is the first declared field).
KonceptDefinition.PatternField	One field of a kind: pattern koncept: its own meaning, purpose, and data-type koncept identifiers, in the pattern's own declared field order.
KonceptDefinition.RetiredComment	A comment's text immediately before it was retired, and the time of that retirement.
KonceptDefinitionSource	Strategy interface for resolving Koncept definitions.
KonceptEntry	Tracks references to a single Koncept within a document.
KonceptExtensionRegistry	SPI entry point for automatic registration of Koncept extensions with AsciidoctorJ.
KonceptGlossaryProcessor	AsciidoctorJ postprocessor that generates a "Referenced Koncepts" glossary section and a colophon at the end of the document.
KonceptGlossaryTreeprocessor	Builds a real, TOC-visible AST section for the comprehensive (koncept-glossary-all) glossary mode (IKE-Network/ike-issues#877).
KonceptIdenticonFigureBlockMacro	AsciidoctorJ block macro that renders a koncept's identicon as a real, captioned figure — for prose that talks about identicons (a "How to Read This Guide" front matter) and needs to show one at figure size, not badge size.
KonceptInlineMacro	AsciidoctorJ inline macro processor that handles k:ConceptName[] syntax in AsciiDoc documents.
KonceptNarrativeBlockMacro	AsciidoctorJ block macro processor that splices a koncept's curated, long-form narrative field into the document as real AsciiDoc source.
KonceptPatternListBlockMacro	AsciidoctorJ block macro processor that renders a "List of Patterns": a flat, numbered index of every kind: pattern koncept in the definition source, alphabetical by label, each entry a plain link to that pattern's own entry in the Koncept Glossary — no columns, no icons, styled the same as the document's own table of contents (ul.sectlevel1) rather than as a data table.
KonceptPatternTableBlockMacro	AsciidoctorJ block macro processor that renders a kind: pattern koncept's shape as a real, captioned AsciiDoc table — one Model Feature (the referenced component, then each declared field in order) per three-row group (IKE-Network/ike-issues#883).
KonceptSigilInlineMacro	AsciidoctorJ inline macro that renders a component-kind sigil on its own — the mark a Koncept Badge carries for its kind, without any badge around it — so prose that talks about the sigil scheme (a "How to Read This Guide" front matter, a tutorial) can show the real marks instead of describing them.
KonceptSvgRenderer	Generates inline SVG badge markup for Koncept references.
KonceptTreeBlockProcessor	AsciidoctorJ block processor that renders a [koncept-tree] delimited block as an indented list of Koncept chips — the print/HTML/e-mail projection of the live tree Komet draws in the assistant surface (IKE-Network/ike-issues#827, the static counterpart of #805).
SnomedUuids	Derives the Tinkar PublicId UUID for a SNOMED CT concept from its SCTID.
YamlKonceptDefinitionSource	Loads Koncept definitions from a YAML file.