Package network.ike.docs.plugin


package network.ike.docs.plugin
  • Class
    Description
    Generate Adoc Studio sidecar projects for assembly modules.
    Generate documentation from AsciiDoc sources using AsciidoctorJ.
    AsciiDoc output backends supported by the AsciidocMojo.
    Copy the selected renderer's PDF to the default pdf/ directory.
    Copy rendered HTML docs and assets into the Maven site output directory.
    Generate and render a doc-diff review packet: every changed AsciiDoc fragment between two refs (or a ref and the working tree), marked inline with [.diff-ins]/[.diff-del] roles and composed into a book with a cover summary, Record of Changes, Change Glossary, Change Index, registry delta, and assembly scaffolding diffs (ike-issues#648, #649, #650; design note dev-doc-diff-pipeline in ike-lab-documents).
    Remove bare <rect/> elements from generated HTML files.
    Compile-time identity for every idoc:* goal in this plugin.
    Inject navigation breadcrumbs and theme overrides into JaCoCo HTML reports.
    Lint a topic library laid out as packages (dev-adoc-packages, IKE-Network/ike-issues#1341) and fail the build with every finding listed: the root holds only dotted-group directories and META-INF; every package begins with the module's own group unless the POM property ike.adoc.packages declares another prefix on purpose; a topic's directory equals the domain prefix of its :topic-id:; images are inside packages, not at the root.
    Lint src/site/site.xml for IKE Network theme + breadcrumb conventions (ike-issues#319).
    Generate the package manifest of a topic library laid out as packages (dev-adoc-packages, IKE-Network/ike-issues#1341): target/adoc-meta/META-INF/ike/<groupId>/<artifactId>/manifest.yaml, from the POM and the tree, never kept by hand.
    Scans generated AsciiDoc output for common conversion problems.
    A single validation issue found in a generated file.
    Severity levels for validation issues.
    Package AsciiDoc sources as the primary artifact for ike-doc packaging.
    Patch stock DocBook XSL stylesheets to suppress Saxon warnings.
    Create output directories for external PDF renderers.
    Render PDF from intermediate files using an external renderer.
    Scan renderer log files for error patterns and print a summary.
    Generate the topic registry: every AsciiDoc file under the module's source root, with its storage location and header metadata (the :topic-*: block of a topic fragment; the title, document attributes and include count of any file), written to target/topic-registry.yaml in the shape IKE-TOPIC-REGISTRY.md gives the registry: topics grouped into domains by the prefix of their id.