Index

A B C D E F G H I K L M N O P Q R S T U V W Y 
All Classes and Interfaces|All Packages|Constant Field Values

A

ACTIVE - Enum constant in enum class network.ike.docs.plugin.diff.StampRegistry.Status
A new or replacing version of the text.
activeRef(int) - Method in interface network.ike.docs.plugin.diff.AdocDiffMarker.StampSource
The footnote macro for an Active region (insertion or replacement) whose last new-side line has the given index.
add(Map, Path, List, Instant) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
Add files to an existing registry, or refresh their entries, without rescanning the roots: each file is parsed alone, placed in its domain in id order, counted, and checked for a duplicate id against the ids the registry already holds.
ADDED - Enum constant in enum class network.ike.docs.plugin.diff.ChangeStatus
Absent on the from side, present on the to side.
AdocDiffMarker - Class in network.ike.docs.plugin.diff
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).
AdocDiffMarker.MarkResult - Record Class in network.ike.docs.plugin.diff
The result of marking one fragment: the marked lines, word-level insertion/deletion counts, and the notes describing changes to protected constructs.
AdocDiffMarker.StampSource - Interface in network.ike.docs.plugin.diff
Source of STAMP endnote refs for marked regions (ike-issues#656).
AdocLayout - Enum Class in network.ike.docs.plugin.packages
How a library lays out its AsciiDoc root, chosen by the POM property ike.adoc.layout (dev-adoc-packages, IKE-Network/ike-issues#1341).
AdocPackages - Class in network.ike.docs.plugin.packages
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.
AdocPackages.Package - Record Class in network.ike.docs.plugin.packages
One package of a root.
ADOCSTUDIO - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:adocstudio — generate Adoc Studio sidecar projects.
AdocStudioMojo - Class in network.ike.docs.plugin
Generate Adoc Studio sidecar projects for assembly modules.
AdocStudioMojo() - Constructor for class network.ike.docs.plugin.AdocStudioMojo
Creates this goal instance.
ALIAS - Static variable in class network.ike.docs.plugin.packages.PackageLint
The migration alias the lint reports.
anchor() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the anchor record component.
anchorOf(List) - Static method in class network.ike.docs.plugin.diff.PacketAssembler
Find a fragment's anchor id ([[id]]).
ASCIIDOC - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:asciidoc — render AsciiDoc to HTML, DocBook, and Prawn PDF.
AsciidocMojo - Class in network.ike.docs.plugin
Generate documentation from AsciiDoc sources using AsciidoctorJ.
AsciidocMojo() - Constructor for class network.ike.docs.plugin.AsciidocMojo
Creates this goal instance.
asciidoctorName() - Method in enum class network.ike.docs.plugin.Backend
The backend name as AsciidoctorJ expects it.
assemblyRefs(String) - Method in class network.ike.docs.plugin.diff.RegistryIndex
An assembly's topic membership, in include order.
ATTRIBUTE - Static variable in class network.ike.docs.plugin.packages.PackageLint
The include attribute of the packages layout.
attributes() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the attributes record component.
author() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Returns the value of the author record component.
author() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns the value of the author record component.

B

Backend - Enum Class in network.ike.docs.plugin
AsciiDoc output backends supported by the AsciidocMojo.
blameInRange(String, String, Set) - Method in class network.ike.docs.plugin.diff.GitSource
Attribute each line of a file's to-side text to the range commit that introduced it (ike-issues#656).
blobId(byte[]) - Static method in record class network.ike.docs.plugin.registry.BlobIndex
The git blob id of content: the SHA-1 of "blob <length>\0" followed by the bytes, as git hash-object computes it for a file with no clean filter.
BlobIndex - Record Class in network.ike.docs.plugin.registry
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).
BlobIndex(Map, List, BlobIndex.Source) - Constructor for record class network.ike.docs.plugin.registry.BlobIndex
Creates an instance of a BlobIndex record class.
BlobIndex.Source - Enum Class in network.ike.docs.plugin.registry
Where a BlobIndex took its blob ids from.
blobs() - Method in record class network.ike.docs.plugin.registry.BlobIndex
Returns the value of the blobs record component.
branch() - Method in class network.ike.docs.plugin.diff.GitSource
The current branch name — the git-era analogue of the STAMP path coordinate.
branch() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns the value of the branch record component.
byName(String) - Static method in enum class network.ike.docs.plugin.IdocGoal
Look up a goal by its bare name (e.g.

C

change() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry
Returns the value of the change record component.
Change(ChangeStatus, String, String) - Constructor for record class network.ike.docs.plugin.diff.GitSource.Change
Creates an instance of a Change record class.
ChangeEntity(String, String, String, List, List) - Constructor for record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Creates an instance of a ChangeEntity record class.
ChangeManifest - Class in network.ike.docs.plugin.diff
The change-entity manifest behind a review packet (ike-issues#648).
ChangeManifest.ChangeEntity - Record Class in network.ike.docs.plugin.diff
One named change.
changes() - Method in class network.ike.docs.plugin.diff.ChangeManifest
The manifest's change entities, in authored or derived order.
changes(String, String, String, String) - Method in class network.ike.docs.plugin.diff.GitSource
List the files that differ between the two sides, with rename detection, filtered to a path prefix and suffix.
ChangeStatus - Enum Class in network.ike.docs.plugin.diff
Per-file status of a compared AsciiDoc source between the two sides of a doc-diff comparison (ike-issues#649).
charCount() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the charCount record component.
children(Path) - Static method in class network.ike.docs.plugin.packages.AdocPackages
The immediate entries of a directory in name order.
clean() - Method in record class network.ike.docs.plugin.packages.PackageLint.Report
Whether the build passes.
close() - Method in class network.ike.docs.plugin.diff.GitSource
 
commitId() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns the value of the commitId record component.
CommitMeta(String, String, String, String, String, List) - Constructor for record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Creates an instance of a CommitMeta record class.
commitsBetween(String, String) - Method in class network.ike.docs.plugin.diff.GitSource
Walk the commits reachable from toRef and not from fromRef (i.e.
COPY_DEFAULT_PDF - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:copy-default-pdf — copy the default-renderer PDF to the site.
COPY_DOCS - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:copy-docs — copy rendered docs into the site.
COPY_EXTENSIONS - Static variable in class network.ike.docs.plugin.CopyDocsToSiteMojo
File extensions to copy from generated-docs to the site.
CopyDefaultPdfMojo - Class in network.ike.docs.plugin
Copy the selected renderer's PDF to the default pdf/ directory.
CopyDefaultPdfMojo() - Constructor for class network.ike.docs.plugin.CopyDefaultPdfMojo
Creates this goal instance.
CopyDocsToSiteMojo - Class in network.ike.docs.plugin
Copy rendered HTML docs and assets into the Maven site output directory.
CopyDocsToSiteMojo() - Constructor for class network.ike.docs.plugin.CopyDocsToSiteMojo
Creates this goal instance.
countBareRects(String) - Static method in class network.ike.docs.plugin.FixSvgMojo
Count occurrences of bare <rect/> elements in HTML content.
countErrors(String) - Static method in class network.ike.docs.plugin.ScanRendererLogsMojo
Count lines containing error patterns in log content.

D

date() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Returns the value of the date record component.
DELETED - Enum constant in enum class network.ike.docs.plugin.diff.ChangeStatus
Present on the from side, absent on the to side.
delWords() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult
Returns the value of the delWords record component.
derive(List) - Static method in class network.ike.docs.plugin.diff.ChangeManifest
Derive a manifest from a commit range by grouping commits on their first Refs:/Fixes: trailer.
description() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Returns the value of the description record component.
description() - Method in enum class network.ike.docs.plugin.IdocGoal
One-line human description of what this goal does.
DIFF - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:diff — generate and render a doc-diff review packet (#648).
directory() - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
Returns the value of the directory record component.
displayPath() - Method in record class network.ike.docs.plugin.diff.GitSource.Change
The path a reader should know this file by — the to side when present, otherwise the from side.
DOCBOOK - Enum constant in enum class network.ike.docs.plugin.Backend
DocBook 5 — intermediate XML for XEP/FOP XSL-FO pipelines.
DocDiffMojo - Class in network.ike.docs.plugin
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).
DocDiffMojo() - Constructor for class network.ike.docs.plugin.DocDiffMojo
 
documentAttributes() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the documentAttributes record component.
domain() - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
Returns the value of the domain record component.
domainOf(String) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
The domain a topic belongs to: the part of its id before the first hyphen, the {domain-prefix}-{slug} rule of IKE-TOPIC-REGISTRY.md.
dropped() - Method in record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Returns the value of the dropped record component.

E

equals(Object) - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.GitSource.Change
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.PacketAssembler.IncludeRewrite
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.OutputValidator.Issue
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.packages.PackageLint.Report
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.registry.BlobIndex
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.registry.TopicHeader
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.registry.TopicRegistry.Scan
Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class network.ike.docs.plugin.OutputValidator.Severity
Fatal issue when strict mode is enabled (e.g., unresolved attribute).
errors() - Method in record class network.ike.docs.plugin.packages.PackageLint.Report
Returns the value of the errors record component.
execute() - Method in class network.ike.docs.plugin.AdocStudioMojo
 
execute() - Method in class network.ike.docs.plugin.AsciidocMojo
 
execute() - Method in class network.ike.docs.plugin.CopyDefaultPdfMojo
 
execute() - Method in class network.ike.docs.plugin.CopyDocsToSiteMojo
 
execute() - Method in class network.ike.docs.plugin.DocDiffMojo
 
execute() - Method in class network.ike.docs.plugin.FixSvgMojo
 
execute() - Method in class network.ike.docs.plugin.InjectBreadcrumbMojo
 
execute() - Method in class network.ike.docs.plugin.LintPackagesMojo
 
execute() - Method in class network.ike.docs.plugin.LintSiteMojo
 
execute() - Method in class network.ike.docs.plugin.ManifestMojo
 
execute() - Method in class network.ike.docs.plugin.PackageDocMojo
 
execute() - Method in class network.ike.docs.plugin.PatchDocbookMojo
 
execute() - Method in class network.ike.docs.plugin.PrepareRendererOutputMojo
 
execute() - Method in class network.ike.docs.plugin.RenderPdfMojo
 
execute() - Method in class network.ike.docs.plugin.ScanRendererLogsMojo
 
execute() - Method in class network.ike.docs.plugin.TopicRegistryMojo
 
expectedBodyClassFor(String) - Static method in class network.ike.docs.plugin.LintSiteMojo
Return the expected <bodyClass> for a deployment target.
extractRendererName(String) - Static method in class network.ike.docs.plugin.ScanRendererLogsMojo
Extract the renderer name from a log filename.

F

file() - Method in record class network.ike.docs.plugin.OutputValidator.Issue
Returns the value of the file record component.
file() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the file record component.
FILE_NAME - Static variable in class network.ike.docs.plugin.packages.PackageManifest
The manifest's file name.
files() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Returns the value of the files record component.
files() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Returns the value of the files record component.
files() - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
Returns the value of the files record component.
findings() - Method in record class network.ike.docs.plugin.registry.BlobIndex
Returns the value of the findings record component.
findings() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the findings record component.
findings() - Method in record class network.ike.docs.plugin.registry.TopicRegistry.Scan
Returns the value of the findings record component.
findRoot(GitSource, String) - Static method in class network.ike.docs.plugin.diff.RegistryIndex
Find the topic library's source root on a side: the …/src/docs/asciidoc directory whose topics/ holds .adoc files.
FIX_SVG - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:fix-svg — post-process SVGs for PDF renderer compatibility.
FixSvgMojo - Class in network.ike.docs.plugin
Remove bare <rect/> elements from generated HTML files.
FixSvgMojo() - Constructor for class network.ike.docs.plugin.FixSvgMojo
Creates this goal instance.
footnote(String, StampRegistry.Status, String) - Method in class network.ike.docs.plugin.diff.StampRegistry
The reusable footnote macro for one attribution + status.
footnoteId() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns the value of the footnoteId record component.
formatSummary(String, int, int) - Static method in class network.ike.docs.plugin.ScanRendererLogsMojo
Format a one-line summary for a renderer log.
fullMessage() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Returns the value of the fullMessage record component.

G

generateThemeCss() - Static method in class network.ike.docs.plugin.InjectBreadcrumbMojo
Generate the IKE theme override CSS for JaCoCo reports.
getLog() - Method in class network.ike.docs.plugin.AdocStudioMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.AsciidocMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.CopyDefaultPdfMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.CopyDocsToSiteMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.DocDiffMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.FixSvgMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.InjectBreadcrumbMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.LintPackagesMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.LintSiteMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.ManifestMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.PackageDocMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.PatchDocbookMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.PrepareRendererOutputMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.RenderPdfMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.ScanRendererLogsMojo
Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.TopicRegistryMojo
Access the Maven logger.
GIT - Enum constant in enum class network.ike.docs.plugin.registry.BlobIndex.Source
From git ls-files, git status and git hash-object.
GitBlobIndex - Class in network.ike.docs.plugin.registry
Read a BlobIndex from git without opening a file (dev-adoc-packages, IKE-Network/ike-issues#1341).
GitSource - Class in network.ike.docs.plugin.diff
Read-only access to both sides of a doc-diff comparison (ike-issues#649): any two commits, or a commit and the working tree.
GitSource.Change - Record Class in network.ike.docs.plugin.diff
One changed file between the two sides.
GitSource.CommitMeta - Record Class in network.ike.docs.plugin.diff
Metadata of one commit in a compared range, for change-entity derivation from trailers (ike-issues#652) and stamp endnotes (ike-issues#656).
goalName() - Method in enum class network.ike.docs.plugin.IdocGoal
The bare goal name as it appears in @Mojo(name = ...).
GROUP - Static variable in class network.ike.docs.plugin.packages.AdocPackages
A group directory's name: a reverse-DNS group as one dotted segment, at least two labels of lowercase letters, digits, hyphens and underscores, as a Maven group id is written.
groupDirectories(Path) - Static method in class network.ike.docs.plugin.packages.AdocPackages
The group directories of a root: its immediate subdirectories whose name is a dotted group.

H

hashCode() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.GitSource.Change
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.IncludeRewrite
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.OutputValidator.Issue
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.packages.PackageLint.Report
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.registry.BlobIndex
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.registry.TopicRegistry.Scan
Returns a hash code value for this object.
hashed(Path) - Static method in record class network.ike.docs.plugin.registry.BlobIndex
Index a root by reading every .adoc file under it and hashing the content as git hashes a blob ("blob " + length + NUL + content, SHA-1).
HASHED - Enum constant in enum class network.ike.docs.plugin.registry.BlobIndex.Source
Computed in Java by reading every file: the tree has no git.
headers(Path, Path) - Static method in class network.ike.docs.plugin.packages.AdocPackages
Parse the header of every .adoc file under a directory, in path order, paths relative to the root; symbolic links and the directories TopicRegistry.SKIPPED_DIRS are left out.
HTML - Enum constant in enum class network.ike.docs.plugin.Backend
HTML5 — website and CSS-to-PDF renderer input.

I

id() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Returns the value of the id record component.
id() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Returns the value of the id record component.
id() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the id record component.
IdocGoal - Enum Class in network.ike.docs.plugin
Compile-time identity for every idoc:* goal in this plugin.
IMAGES - Static variable in class network.ike.docs.plugin.packages.AdocPackages
The directory inside a package that holds its images.
INACTIVE - Enum constant in enum class network.ike.docs.plugin.diff.StampRegistry.Status
An unpaired deletion — an inactivation.
inactiveRef() - Method in interface network.ike.docs.plugin.diff.AdocDiffMarker.StampSource
The footnote macro for an Inactive region (unpaired deletion).
IncludeRewrite(List, Map) - Constructor for record class network.ike.docs.plugin.diff.PacketAssembler.IncludeRewrite
Creates an instance of a IncludeRewrite record class.
includes() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the includes record component.
IncrementalRegistry - Class in network.ike.docs.plugin.registry
The blob-keyed incremental registry (dev-adoc-packages, IKE-Network/ike-issues#1341).
IncrementalRegistry.Outcome - Record Class in network.ike.docs.plugin.registry
What one update did.
INJECT_BREADCRUMB - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:inject-breadcrumb — inject breadcrumbs into rendered HTML.
injectBreadcrumb(String, String, String) - Static method in class network.ike.docs.plugin.InjectBreadcrumbMojo
Inject a breadcrumb navigation link into JaCoCo's breadcrumb div.
InjectBreadcrumbMojo - Class in network.ike.docs.plugin
Inject navigation breadcrumbs and theme overrides into JaCoCo HTML reports.
InjectBreadcrumbMojo() - Constructor for class network.ike.docs.plugin.InjectBreadcrumbMojo
Creates this goal instance.
injectChangeTerms(List, List) - Static method in class network.ike.docs.plugin.diff.PacketAssembler
Inject one silent change-index term per owning change after a fragment's level-1 title, so the ordinary [index] section collects a change → pages mapping.
injectThemeCssLink(String) - Static method in class network.ike.docs.plugin.InjectBreadcrumbMojo
Inject a CSS link to the IKE theme override after the existing report.css link.
insWords() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult
Returns the value of the insWords record component.
isDomainPackage(Path) - Static method in class network.ike.docs.plugin.packages.AdocPackages
Whether a group directory is itself the domain package: it holds an .adoc file directly, as the ANF library's group directory does.
Issue(Path, int, OutputValidator.Severity, String) - Constructor for record class network.ike.docs.plugin.OutputValidator.Issue
Creates an instance of a Issue record class.

K

kept() - Method in record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Returns the value of the kept record component.
keywords() - Method in record class network.ike.docs.plugin.registry.TopicHeader
The :topic-keywords: value split on commas and trimmed.
kind() - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
Returns the value of the kind record component.

L

label() - Method in enum class network.ike.docs.plugin.diff.StampRegistry.Status
The label as printed in endnotes and the register.
label() - Method in enum class network.ike.docs.plugin.packages.PackageKind
The kind as the manifest writes it.
LEGACY - Enum constant in enum class network.ike.docs.plugin.packages.AdocLayout
The layout before packages: a topics/<domain>/ tree under the root with the preview index and shared images beside it, the registry written to target/topic-registry.yaml.
level() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the level record component.
LEVEL_SEPARATOR - Static variable in class network.ike.docs.plugin.registry.TermIndex
The separator between the levels of a term as the registry records it.
LIBRARY - Enum constant in enum class network.ike.docs.plugin.packages.PackageKind
The library's own package: the preview index and shared images, rendered content that is not metadata and so not under META-INF.
line() - Method in record class network.ike.docs.plugin.OutputValidator.Issue
Returns the value of the line record component.
lines() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult
Returns the value of the lines record component.
lines() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.IncludeRewrite
Returns the value of the lines record component.
lint(String, String, String, String) - Static method in class network.ike.docs.plugin.LintSiteMojo
Apply all site.xml lint rules to the given content.
lint(Path, String, List) - Static method in class network.ike.docs.plugin.packages.PackageLint
Lint a root.
LINT_PACKAGES - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:lint-packages — lint the packages layout of a topic library (#1341).
LINT_SITE - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:lint-site — lint src/site/site.xml for IKE theme/breadcrumb drift (#319).
LintPackagesMojo - Class in network.ike.docs.plugin
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.
LintPackagesMojo() - Constructor for class network.ike.docs.plugin.LintPackagesMojo
Creates this goal instance.
LintSiteMojo - Class in network.ike.docs.plugin
Lint src/site/site.xml for IKE Network theme + breadcrumb conventions (ike-issues#319).
LintSiteMojo() - Constructor for class network.ike.docs.plugin.LintSiteMojo
Creates this goal instance.
listFiles(String, String, String) - Method in class network.ike.docs.plugin.diff.GitSource
List every file under a directory on a side whose name ends with a suffix, recursively — used to read all topic headers and assembly include lines as they stand on each side of the comparison, so the topic registry can be generated for that side.
load(Path) - Static method in class network.ike.docs.plugin.diff.ChangeManifest
Load an authored manifest.
load(Path) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
Read a registry written by TopicRegistry.yaml(Map) back into its model.
load(GitSource, String, String) - Static method in class network.ike.docs.plugin.diff.RegistryIndex
Generate the registry as it stands on one side of a comparison.

M

MANIFEST - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:manifest — generate the package manifest of a topic library (#1341).
ManifestMojo - Class in network.ike.docs.plugin
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.
ManifestMojo() - Constructor for class network.ike.docs.plugin.ManifestMojo
Creates this goal instance.
mark(List, List) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker
Produce a marked copy of a changed fragment, without stamps.
mark(List, List, AdocDiffMarker.StampSource) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker
Produce a marked copy of a changed fragment, with optional STAMP endnote refs per change boundary.
markAdded(List, String) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker
Produce a full-text copy of an added fragment with a banner note instead of inline marks.
markAdded(List, String, String) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker
Produce a full-text copy of an added fragment with a banner note, optionally stamped — an added topic is one Active stamp, carried on the banner rather than in the flow.
MarkResult(List, int, int, List) - Constructor for record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult
Creates an instance of a MarkResult record class.
masterDoc(String, String, String, List, List, ChangeManifest, List, boolean, List, String, List) - Static method in class network.ike.docs.plugin.diff.PacketAssembler
Compose the packet master document.
membershipDelta(RegistryIndex, RegistryIndex, String, String, String) - Static method in class network.ike.docs.plugin.diff.RegistryIndex
Render one assembly's membership delta (topics added to and removed from its includes between two sides) as a small registry-delta partial for an assembly-projection packet.
message() - Method in record class network.ike.docs.plugin.OutputValidator.Issue
Returns the value of the message record component.
META_INF - Static variable in class network.ike.docs.plugin.packages.AdocPackages
The reserved directory for artifact metadata, never a package.
metaDirectory(String, String) - Static method in class network.ike.docs.plugin.packages.AdocPackages
The metadata directory of an artifact inside the zip and the union, keyed by its coordinates so that it cannot collide: META-INF/ike/<groupId>/<artifactId>.
missingRequired() - Method in record class network.ike.docs.plugin.registry.TopicHeader
The required attributes this header lacks, in the order of TopicHeader.REQUIRED.
model() - Method in record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Returns the value of the model record component.
model(Path, String, String, String) - Static method in class network.ike.docs.plugin.packages.PackageManifest
The manifest as an ordered map, ready for YAML.
model(List, String, String) - Static method in class network.ike.docs.plugin.packages.PackageManifest
The manifest as an ordered map from packages already enumerated.
model(List, Path, Instant) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
The registry as an ordered map, ready for YAML: the schema's keys first (registry-version, generated, topic-count, domains with their topics), then assemblies, other-files and findings.
model(Map, Instant) - Static method in class network.ike.docs.plugin.registry.TermIndex
The term index as an ordered map, ready for YAML, from a registry model whose topic entries carry index-terms: generated, term-count, then terms, a tree of levels in alphabetical order, each level with its _topics in id order and its sub-levels after.
MODIFIED - Enum constant in enum class network.ike.docs.plugin.diff.ChangeStatus
Present on both sides with differing content.
module() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns the value of the module record component.
mojoClass() - Method in enum class network.ike.docs.plugin.IdocGoal
The mojo class that implements this goal.
multipleStampsPossible(boolean) - Method in class network.ike.docs.plugin.diff.StampRegistry
Whether the packet can carry more than one distinct stamp; when not, in-flow refs are suppressed and the cover states the single stamp once.

N

name() - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
Returns the value of the name record component.
network.ike.docs.plugin - package network.ike.docs.plugin
 
network.ike.docs.plugin.diff - package network.ike.docs.plugin.diff
 
network.ike.docs.plugin.packages - package network.ike.docs.plugin.packages
 
network.ike.docs.plugin.registry - package network.ike.docs.plugin.registry
 
newPath() - Method in record class network.ike.docs.plugin.diff.GitSource.Change
Returns the value of the newPath record component.
notes() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult
Returns the value of the notes record component.

O

of(String) - Static method in enum class network.ike.docs.plugin.packages.AdocLayout
Read the layout from the property's value.
of(List) - Static method in class network.ike.docs.plugin.diff.ChangeManifest
Build a manifest from already-constructed entities — used to merge trailer-derived entities for a committed range with a synthetic uncommitted entity when the to side is the working tree.
oldPath() - Method in record class network.ike.docs.plugin.diff.GitSource.Change
Returns the value of the oldPath record component.
open(Path) - Static method in class network.ike.docs.plugin.diff.GitSource
Open the repository that contains the given directory, walking upward to find the git dir (a module's basedir is typically below the repository root).
otherEntry(TopicHeader, String) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
An assembly or plain file: its path, title, document attributes and include count.
others() - Method in record class network.ike.docs.plugin.registry.TopicRegistry.Scan
Returns the value of the others record component.
Outcome(Map, int, int, int, int) - Constructor for record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Creates an instance of a Outcome record class.
outName() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry
Returns the value of the outName record component.
outputSubdir() - Method in enum class network.ike.docs.plugin.Backend
Default output subdirectory under the goal's output root.
OutputValidator - Class in network.ike.docs.plugin
Scans generated AsciiDoc output for common conversion problems.
OutputValidator() - Constructor for class network.ike.docs.plugin.OutputValidator
Creates a new output validator.
OutputValidator.Issue - Record Class in network.ike.docs.plugin
A single validation issue found in a generated file.
OutputValidator.Severity - Enum Class in network.ike.docs.plugin
Severity levels for validation issues.
owned(String, String, List) - Static method in class network.ike.docs.plugin.packages.PackageLint
Whether a package passes the ownership rule.

P

Package(String, String, Path, PackageKind, List) - Constructor for record class network.ike.docs.plugin.packages.AdocPackages.Package
Creates an instance of a Package record class.
PACKAGE_DOC - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:package-doc — package rendered docs as an ike-doc artifact.
PackageDocMojo - Class in network.ike.docs.plugin
Package AsciiDoc sources as the primary artifact for ike-doc packaging.
PackageDocMojo() - Constructor for class network.ike.docs.plugin.PackageDocMojo
Creates this goal instance.
PackageKind - Enum Class in network.ike.docs.plugin.packages
What a package holds, as the manifest records it under kind (dev-adoc-packages, IKE-Network/ike-issues#1341).
PackageLint - Class in network.ike.docs.plugin.packages
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.
PackageLint.Report - Record Class in network.ike.docs.plugin.packages
What the lint found.
PackageManifest - Class in network.ike.docs.plugin.packages
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.
packages(Path, String) - Static method in class network.ike.docs.plugin.packages.AdocPackages
Enumerate the packages of a root: for each group directory, the group itself when it holds topics directly, otherwise each subdirectory of it as <group>/<domain>, hidden directories left out.
PACKAGES - Enum constant in enum class network.ike.docs.plugin.packages.AdocLayout
The packages layout: the root holds one directory per owning group, written as one dotted segment, with the topic domain as the directory under it; artifact metadata goes under META-INF/ike/<group>/<artifact>/.
PacketAssembler - Class in network.ike.docs.plugin.diff
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.
PacketAssembler.IncludeRewrite - Record Class in network.ike.docs.plugin.diff
A staged fragment with its relative includes re-pointed at their staged copies (ike-issues#1096).
PacketAssembler.ScaffoldEntry - Record Class in network.ike.docs.plugin.diff
One scaffolding (non-fragment) AsciiDoc change shown as a unified-diff listing.
PacketAssembler.TopicEntry - Record Class in network.ike.docs.plugin.diff
One marked topic destined for the packet.
parse(String) - Static method in enum class network.ike.docs.plugin.Backend
Parse a backend name (case-insensitive).
parse(String, String) - Static method in record class network.ike.docs.plugin.registry.TopicHeader
Parse file content already in memory.
parse(Path, Path) - Static method in record class network.ike.docs.plugin.registry.TopicHeader
Parse one file.
parsed() - Method in record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Returns the value of the parsed record component.
PATCH_DOCBOOK - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:patch-docbook — apply local patches to DocBook XSL output.
PatchDocbookMojo - Class in network.ike.docs.plugin
Patch stock DocBook XSL stylesheets to suppress Saxon warnings.
PatchDocbookMojo() - Constructor for class network.ike.docs.plugin.PatchDocbookMojo
Creates this goal instance.
path() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry
Returns the value of the path record component.
PDF - Enum constant in enum class network.ike.docs.plugin.Backend
Prawn PDF — direct AsciiDoc-to-PDF via JRuby.
PLUGIN_PREFIX - Static variable in enum class network.ike.docs.plugin.IdocGoal
Shared idoc: prefix for all goals in this plugin.
pluginPrefix() - Method in enum class network.ike.docs.plugin.IdocGoal
The idoc plugin prefix — shared by every goal in this enum.
PREPARE_RENDERER_OUTPUT - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:prepare-renderer-output — prepare per-renderer output dirs.
PrepareRendererOutputMojo - Class in network.ike.docs.plugin
Create output directories for external PDF renderers.
PrepareRendererOutputMojo() - Constructor for class network.ike.docs.plugin.PrepareRendererOutputMojo
Creates this goal instance.
PROPERTY - Static variable in enum class network.ike.docs.plugin.packages.AdocLayout
The property that selects the layout.

Q

qualified() - Method in enum class network.ike.docs.plugin.IdocGoal
The fully-qualified goal invocation, e.g.

R

read(String, String) - Method in class network.ike.docs.plugin.diff.GitSource
Read one file's text from a side.
read(Path) - Static method in class network.ike.docs.plugin.registry.GitBlobIndex
Index the .adoc files under a root from git.
refs() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Returns the value of the refs record component.
refs() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns the value of the refs record component.
RegistryDelta - Class in network.ike.docs.plugin.diff
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).
RegistryDelta(String, String) - Constructor for class network.ike.docs.plugin.diff.RegistryDelta
Create a delta generator over one comparison.
RegistryIndex - Class in network.ike.docs.plugin.diff
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.
rekeyed() - Method in record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Returns the value of the rekeyed record component.
removeBareRects(String) - Static method in class network.ike.docs.plugin.FixSvgMojo
Remove all bare <rect/> elements from HTML content.
removeDeadVariable(String) - Static method in class network.ike.docs.plugin.PatchDocbookMojo
Remove the dead <xsl:variable name="output.delims"> block from DocBook's fo/math.xsl.
removeUtilityInclude(String) - Static method in class network.ike.docs.plugin.PatchDocbookMojo
Remove the <xsl:include href="../common/utility.xsl"/> line from DocBook's fo/docbook.xsl.
RENAMED - Enum constant in enum class network.ike.docs.plugin.diff.ChangeStatus
Moved between paths (content compared across the rename).
render(RegistryIndex, RegistryIndex) - Method in class network.ike.docs.plugin.diff.RegistryDelta
Render the delta as an AsciiDoc partial with a level-1 title.
RENDER_PDF - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:render-pdf — render AsciiDoc to PDF via a configured renderer.
RenderPdfMojo - Class in network.ike.docs.plugin
Render PDF from intermediate files using an external renderer.
RenderPdfMojo() - Constructor for class network.ike.docs.plugin.RenderPdfMojo
Creates this goal instance.
Report(List, List) - Constructor for record class network.ike.docs.plugin.packages.PackageLint.Report
Creates an instance of a Report record class.
REQUIRED - Static variable in record class network.ike.docs.plugin.registry.TopicHeader
Attributes every topic must declare, without the topic- prefix.
resolveInclude(String, String) - Static method in class network.ike.docs.plugin.diff.PacketAssembler
Resolve an include:: target the way the AsciiDoc preprocessor does — relative to the directory of the including file — into a repository-relative path.
result() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry
Returns the value of the result record component.
rewriteIncludes(List, String, Function) - Static method in class network.ike.docs.plugin.diff.PacketAssembler
Re-point every statically resolvable include:: line of a fragment staged under _diff/ at the flat staged name of its target, so the include resolves from the staging directory exactly as it did from the source tree (ike-issues#1096).
root() - Method in record class network.ike.docs.plugin.registry.TopicRegistry.Scan
Returns the value of the root record component.

S

ScaffoldEntry(String, String) - Constructor for record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry
Creates an instance of a ScaffoldEntry record class.
scan(Path, int) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
Scan one root.
Scan(Path, List, List, List) - Constructor for record class network.ike.docs.plugin.registry.TopicRegistry.Scan
Creates an instance of a Scan record class.
SCAN_LOGS - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:scan-logs — scan renderer logs for warnings and errors.
scanFrom(Path, Path) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
Scan from one root file: the file and every .adoc file it reaches through include:: lines, followed recursively and resolved relative to the including file as the AsciiDoc preprocessor does.
ScanRendererLogsMojo - Class in network.ike.docs.plugin
Scan renderer log files for error patterns and print a summary.
ScanRendererLogsMojo() - Constructor for class network.ike.docs.plugin.ScanRendererLogsMojo
Creates this goal instance.
severity() - Method in record class network.ike.docs.plugin.OutputValidator.Issue
Returns the value of the severity record component.
shouldCopy(String) - Static method in class network.ike.docs.plugin.CopyDocsToSiteMojo
Check whether a filename has an extension in the copy list.
singleStampLine(String) - Method in class network.ike.docs.plugin.diff.StampRegistry
Render the single stamp's coordinate line for the cover when in-flow refs are suppressed.
SKIPPED_DIRS - Static variable in class network.ike.docs.plugin.registry.TopicRegistry
Directory names never entered by the scan.
source() - Method in record class network.ike.docs.plugin.registry.BlobIndex
Returns the value of the source record component.
Stamp(String, StampRegistry.Status, String, String, String, String, String, String) - Constructor for record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Creates an instance of a Stamp record class.
StampRegistry - Class in network.ike.docs.plugin.diff
The packet's stamp set (ike-issues#656): one STAMP per (range commit, status) pair, plus the uncommitted pair for working-tree marks.
StampRegistry(List, String, String, String, String) - Constructor for class network.ike.docs.plugin.diff.StampRegistry
Create the registry for one packet.
StampRegistry.Stamp - Record Class in network.ike.docs.plugin.diff
One stamp as used somewhere in the packet.
StampRegistry.Status - Enum Class in network.ike.docs.plugin.diff
Marked-region status, stated redundantly in each endnote.
status() - Method in record class network.ike.docs.plugin.diff.GitSource.Change
Returns the value of the status record component.
status() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns the value of the status record component.
STATUSES - Static variable in record class network.ike.docs.plugin.registry.TopicHeader
The topic statuses IKE-TOPIC-REGISTRY.md allows.
subject() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Returns the value of the subject record component.
supportsPostprocessor() - Method in enum class network.ike.docs.plugin.Backend
Whether this backend supports AsciidoctorJ Postprocessor extensions.

T

targets() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.IncludeRewrite
Returns the value of the targets record component.
TermIndex - Class in network.ike.docs.plugin.registry
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.
termsOf(String) - Static method in class network.ike.docs.plugin.registry.TermIndex
The index terms one file marks, in order of appearance, each as its levels joined with TermIndex.LEVEL_SEPARATOR; a term marked twice is listed once.
time() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns the value of the time record component.
title() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Returns the value of the title record component.
title() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the title record component.
topic() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns the value of the topic record component.
TOPIC_REGISTRY - Enum constant in enum class network.ike.docs.plugin.IdocGoal
idoc:topic-registry — generate the topic registry from the files.
topicEntry(TopicHeader, String) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
One topic in the registry's field order (id, file, title, type, keywords, status, char-count, dependencies, related, summary, supersedes, notes), then what the header adds: provenance, scope note, citation, license, the anchor and header verdicts, unknown :topic-*: attributes under extra, document attributes, and the include count.
TopicEntry(GitSource.Change, String, AdocDiffMarker.MarkResult) - Constructor for record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry
Creates an instance of a TopicEntry record class.
topicFile(String) - Method in class network.ike.docs.plugin.diff.RegistryIndex
Resolve a topic id to its source file, relative to the registry root (e.g.
TopicHeader - Record Class in network.ike.docs.plugin.registry
The parsed header of one AsciiDoc file: the :topic-*: attribute block, the anchor and the level-1 heading, read line by line without AsciidoctorJ.
TopicHeader(String, boolean, String, String, int, Map, Map, String, long, int, List) - Constructor for record class network.ike.docs.plugin.registry.TopicHeader
Creates an instance of a TopicHeader record class.
TopicRegistry - Class in network.ike.docs.plugin.registry
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.
TopicRegistry.Scan - Record Class in network.ike.docs.plugin.registry
One scan root's result.
TopicRegistryMojo - Class in network.ike.docs.plugin
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.
TopicRegistryMojo() - Constructor for class network.ike.docs.plugin.TopicRegistryMojo
Creates this goal instance.
topics() - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
The files that declare a :topic-id:.
topics() - Method in record class network.ike.docs.plugin.registry.TopicRegistry.Scan
Returns the value of the topics record component.
TOPICS - Enum constant in enum class network.ike.docs.plugin.packages.PackageKind
Topics: files that declare a :topic-id:, with their images.
TOPICS_KEY - Static variable in class network.ike.docs.plugin.registry.TermIndex
The key under which a level lists the topics indexed at it.
toString() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.GitSource.Change
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.IncludeRewrite
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.OutputValidator.Issue
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.packages.AdocPackages.Package
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.packages.PackageLint.Report
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.registry.BlobIndex
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.registry.IncrementalRegistry.Outcome
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.registry.TopicHeader
Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.registry.TopicRegistry.Scan
Returns a string representation of this record class.
tree(TopicRegistry.Scan, Path) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
The scan as an indented tree for the build log: directories, then each file with its id, type and status, and the files that are not topics with their include counts.
TYPES - Static variable in record class network.ike.docs.plugin.registry.TopicHeader
The topic types IKE-TOPIC-REGISTRY.md allows, plus procedure, which ike-doc-ingest writes for task topics.
TYPST - Enum constant in enum class network.ike.docs.plugin.Backend
Typst — .typ source for the Typst print target, compiled by typst compile (RenderPdfMojo.RendererType.TYPST).

U

UNCOMMITTED - Static variable in class network.ike.docs.plugin.diff.GitSource
Attribution value for working-tree lines not yet committed.
unifiedDiff() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry
Returns the value of the unifiedDiff record component.
unifiedDiff(String, List, List) - Static method in class network.ike.docs.plugin.diff.PacketAssembler
Produce a unified diff for a scaffolding file.
update(Map, Path, BlobIndex, Path, Instant) - Static method in class network.ike.docs.plugin.registry.IncrementalRegistry
Update a registry against the files a blob index lists.
usedStamps() - Method in class network.ike.docs.plugin.diff.StampRegistry
The stamps actually used in this packet, in first-use order.
userName() - Method in class network.ike.docs.plugin.diff.GitSource
The configured user name, used as the author of uncommitted (working-tree) stamps.

V

validate(Path, Backend) - Method in class network.ike.docs.plugin.OutputValidator
Validate all files in the given output directory.
valueOf(String) - Static method in enum class network.ike.docs.plugin.Backend
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.diff.ChangeStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.diff.StampRegistry.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.IdocGoal
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.OutputValidator.Severity
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.packages.AdocLayout
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.packages.PackageKind
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.registry.BlobIndex.Source
Returns the enum constant of this class with the specified name.
values() - Static method in enum class network.ike.docs.plugin.Backend
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.diff.ChangeStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.diff.StampRegistry.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.IdocGoal
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.OutputValidator.Severity
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.packages.AdocLayout
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.packages.PackageKind
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.registry.BlobIndex.Source
Returns an array containing the constants of this enum class, in the order they are declared.
VERSION - Static variable in class network.ike.docs.plugin.registry.IncrementalRegistry
The registry-version of a registry whose entries carry blobs.

W

WARNING - Enum constant in enum class network.ike.docs.plugin.OutputValidator.Severity
Non-fatal issue (e.g., missing image).
warnings() - Method in record class network.ike.docs.plugin.packages.PackageLint.Report
Returns the value of the warnings record component.
withDiagramHistory(List, List) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker
Append, after every diagram block whose body meaningfully changed between the two sides, the compact source delta followed by the rendered previous version — so the reader sees the new drawing, what changed in the spec, and the old drawing, in that order.
workTree() - Method in class network.ike.docs.plugin.diff.GitSource
The repository's working-tree root.
WORKTREE - Static variable in class network.ike.docs.plugin.diff.GitSource
Pseudo-ref naming the uncommitted working tree as a side.

Y

yaml(Map) - Static method in class network.ike.docs.plugin.packages.PackageManifest
Render the manifest as YAML.
yaml(Map) - Static method in class network.ike.docs.plugin.registry.TermIndex
Render the term index as YAML, in the registry's block style.
yaml(Map) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
Render the registry model as YAML in the registry's block style: two-space indent, sequences indented under their key, one scalar per line.
yaml(Map, String) - Static method in class network.ike.docs.plugin.registry.TopicRegistry
Render a model as YAML in the registry's block style under a given header comment, the shape shared by the registry, the term index and the package manifest.
A B C D E F G H I K L M N O P Q R S T U V W Y 
All Classes and Interfaces|All Packages|Constant Field Values