All Classes and Interfaces
Class
Description
Marks the differences between two versions of an AsciiDoc fragment as
inline
[.diff-ins]#…# / [.diff-del]#…# roles, producing
a renderable "marked copy" for a doc-diff review packet
(ike-issues#648, #649).The result of marking one fragment: the marked lines, word-level
insertion/deletion counts, and the notes describing changes to
protected constructs.
Source of STAMP endnote refs for marked regions (ike-issues#656).
How a library lays out its AsciiDoc root, chosen by the POM property
ike.adoc.layout (dev-adoc-packages,
IKE-Network/ike-issues#1341).The packages layout of an AsciiDoc root (
dev-adoc-packages,
IKE-Network/ike-issues#1341): the first directory under the root is the
owning group written as one dotted segment, network.ike.lab, and
the directory under that is the topic domain, so a topic is
network.ike.lab/dev/gitflow-overview.adoc and its package is
network.ike.lab/dev.One package of a root.
Generate Adoc Studio sidecar projects for assembly modules.
Generate documentation from AsciiDoc sources using AsciidoctorJ.
AsciiDoc output backends supported by the
AsciidocMojo.Every
.adoc file under a registry root with the git blob id of its
content: the key the incremental registry decides staleness by
(dev-adoc-packages, IKE-Network/ike-issues#1341).Where a
BlobIndex took its blob ids from.The change-entity manifest behind a review packet (ike-issues#648).
One named change.
Per-file status of a compared AsciiDoc source between the two sides
of a doc-diff comparison (ike-issues#649).
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.Read a
BlobIndex from git without opening a file
(dev-adoc-packages, IKE-Network/ike-issues#1341).Read-only access to both sides of a doc-diff comparison
(ike-issues#649): any two commits, or a commit and the working tree.
One changed file between the two sides.
Metadata of one commit in a compared range, for change-entity
derivation from trailers (ike-issues#652) and stamp endnotes
(ike-issues#656).
Compile-time identity for every
idoc:* goal in this plugin.The blob-keyed incremental registry (
dev-adoc-packages,
IKE-Network/ike-issues#1341).What one update did.
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.What a package holds, as the manifest records it under
kind
(dev-adoc-packages, IKE-Network/ike-issues#1341).The ownership lint of the packages layout (
dev-adoc-packages,
IKE-Network/ike-issues#1341), the check that makes the layout a
guarantee and not a habit.What the lint found.
The manifest a library ships beside its registry,
META-INF/ike/<groupId>/<artifactId>/manifest.yaml
(dev-adoc-packages, IKE-Network/ike-issues#1341): generated by
the build from the POM and the tree, never kept by hand.Composes the review packet's generated AsciiDoc (ike-issues#648):
the master document with cover sheet, change summary, Record of
Changes, per-topic includes, Change Glossary, and Change Index, plus
the unified-diff listings for assembly scaffolding files.
A staged fragment with its relative includes re-pointed at their
staged copies (ike-issues#1096).
One scaffolding (non-fragment) AsciiDoc change shown as a
unified-diff listing.
One marked topic destined for the packet.
Patch stock DocBook XSL stylesheets to suppress Saxon warnings.
Create output directories for external PDF renderers.
Entry-keyed delta of the IKE topic registry between the two sides of
a doc-diff comparison, rendered as an AsciiDoc partial
(ike-issues#650).
One side's topic registry, generated from the files as they stand on
that side of a doc-diff comparison: topics grouped by domain (each entry
in the shape
idoc:topic-registry writes, built from the
:topic-*: header), and each assembly's topic membership read
from its include:: lines.Render PDF from intermediate files using an external renderer.
Scan renderer log files for error patterns and print a summary.
The packet's stamp set (ike-issues#656): one STAMP per (range commit,
status) pair, plus the uncommitted pair for working-tree marks.
One stamp as used somewhere in the packet.
Marked-region status, stated redundantly in each endnote.
The term index
IKE-INDEX.md and IKE-TOPIC-REGISTRY.md
describe, term-index.yaml: the reverse mapping from the index
terms a topic marks (indexterm:[primary, secondary],
indexterm2:[term], ((term)), (((primary, secondary))))
to the topics that mark them.The parsed header of one AsciiDoc file: the
:topic-*: attribute
block, the anchor and the level-1 heading, read line by line without
AsciidoctorJ.The generated topic registry: every AsciiDoc file under a scan root, parsed
by
TopicHeader, in the shape IKE-TOPIC-REGISTRY.md gives
topic-registry.yaml: topics grouped into domains by the prefix of
their id, each with the registry's field names (id, file,
title, type, keywords, status,
char-count, related, summary), then what a build can
add on top: assemblies and plain files with their document attributes, the
findings the headers raise, and a generation stamp.One scan root's result.
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.