Module Architecture

ike-doc-maven-plugin is the consumer-facing entry point — external doc projects declare it (or rather, declare it indirectly through ike-parent’s `<pluginManagement>) and invoke idoc:* goals. The other modules are infrastructure artifacts the plugin unpacks at build time, plus a standalone CLI tool.

The reactor itself is not consumed as an aggregator — ike-parent lives in ike-platform, not here, so external projects do not inherit from ike-docs/pom.xml. This reactor exists only to coordinate the build and release cadence of the ike-docs artifacts.

Rendering Pipelines

All renderers start from the same AsciiDoc source. The pipeline splits into three families based on how intermediate formats reach the final PDF.

Render selection is property-driven: every backend is gated by a -Dike.pdf.<name>=true toggle. Multiple backends activate concurrently; consumers compare output across renderers without rebuilding.

Quick Start

Build the entire reactor with HTML output (default):

mvn clean verify

Build with the Prawn PDF backend:

mvn clean verify -Dike.pdf.prawn

Build a single module:

mvn clean install -pl ike-doc-maven-plugin -am

For consumer-side authoring (a project inheriting ike-parent that uses these artifacts), see the Getting Started^[2] guide.

Module Inventory

Release Position

ike-tooling -> [ike-docs] -> ike-platform -> { doc-example, project-example, integration-tests-example } -> workspace-reactor-example
                                                                                                        -> ike-lab-documents

ike-docs releases after ike-tooling (which provides ike-maven-plugin for release orchestration) and before ike-platform (which declares ike-doc-maven-plugin and the other ike-docs artifacts in ike-parent’s `<pluginManagement>/<dependencyManagement>).

Key Design Decisions

Property-driven renderer toggles

Every PDF backend is a thin profile that flips an ike.skip.* property from true to false. Renderers compose: activate several at once with -Dike.pdf.prawn -Dike.pdf.prince. The configuration lives in ike-parent (in ike-platform), which inheriting projects pick up automatically.

Artifact-based resource sharing

The infrastructure modules (ike-doc-resources, minimal-fonts, docbook-xsl) are packaged as deployable Maven artifacts and unpacked into each consumer’s target/ at build time. No checked-in copies; everything is regenerated per build.

Classifier-canonical doc artifacts

Doc payloads ship as <classifier>adoc</classifier><type>zip</type> attachments on <packaging>pom</packaging> (doc-only) or <packaging>jar</packaging> (hybrid) primaries. This replaces the retired <packaging>ike-doc</packaging> custom type; see dev-classifier-canonical-doc-shape in ike-lab-documents/topics/ and IKE-Network/ike-issues#321 for the full design rationale.

Koncept markup

The k:ConceptName[] inline macro renders as an SVG badge linking to an auto-generated glossary section. Definitions are sourced from YAML files and include natural-language definitions, description-logic axioms, SNOMED CT identifiers, and OWL IRIs.

Semantic linebreaks

The semantic-linebreak tool reformats AsciiDoc prose to one-sentence-per-line. This produces cleaner git diff output and makes sentence-level review practical.

The IKE foundation

ike-docs is one of four foundation projects published to Maven Central. Together they form the parent-inheritance forest that every IKE project builds on:

• ike-base-parent^[4] — Tier 0 foundation parent POM; shared publishing metadata and signing config.
• ike-tooling^[5] — Maven plugins for release orchestration and workspace management.
• ike-docs^[6] — the AsciiDoc documentation pipeline and idoc:* plugin.
• ike-platform^[7] — the consumer-facing ike-parent, the BOM, and the ws:* plugin.

Resources

License

Copyright 2025 IKE Network. Licensed under the Apache License, Version 2.0.