Package network.ike.plugin.adoc


package network.ike.plugin.adoc
The AsciiDoc package union behind ike:adoc-union (IKE-Network/ike-issues#1342; design topic dev-adoc-packages).

A topic library lays its AsciiDoc root out as packages: the first directory is the owning group as one dotted segment and the next is the domain, so one topic is network.ike.lab/dev/gitflow-overview.adoc in the source tree, in the zip the library ships, and in the union a build unpacks every library into. A library's own metadata is under META-INF/ike/<group>/<artifact>/, keyed by coordinates so it cannot collide. The classes here are the pure part of the goal: they take plain paths and records and never touch a Maven session, so the tests exercise them against real zips and a real reactor layout.

  • AdocUnion writes and verifies the union.
  • AdocManifest reads a library's manifest from its zip, or derives one from a reactor member's tree.
  • AdocLibrary is one library to put in the union: an external zip, or a module of the same reactor.
  • Class
    Description
    The Maven coordinates of a topic library: the artifact that ships a set of packages.
    One library to put in the union: either an external zip resolved from a repository, or a module of the same reactor whose AsciiDoc source root is on this machine.
    A library's manifest: its coordinates and the packages it ships, generated by the build from the pom and the tree and shipped at META-INF/ike/<group>/<artifact>/manifest.yaml (IKE-Network/ike-issues#1341).
    One package a library ships: a directory under the library's root, named by the owning group as one dotted segment and then the domain, such as network.ike.lab/dev.
    One union of AsciiDoc packages per repository, written and verified from any module of it.
    What one run did, by library.
    Finds a module of the reactor by its pom, under the reactor root.
    The one .asciidoctorconfig of a repository, at its root, so the IDE preview of every module resolves includes in the union (design topic dev-adoc-packages).