Index (IKE Doc Maven Plugin 43 API)

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

A

ADOCSTUDIO - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:adocstudio — edit the project in AsciiDocFX.
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.
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.

B

Backend - Enum Class in network.ike.docs.plugin: AsciiDoc output backends supported by the AsciidocMojo.
byName(String) - Static method in enum class network.ike.docs.plugin.IdocGoal: Look up a goal by its bare name (e.g.

C

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

description() - Method in enum class network.ike.docs.plugin.IdocGoal: One-line human description of what this goal does.
DOCBOOK - Enum constant in enum class network.ike.docs.plugin.Backend: DocBook 5 — intermediate XML for XEP/FOP XSL-FO pipelines.

E

equals(Object) - Method in record class network.ike.docs.plugin.OutputValidator.Issue: 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).
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.FixSvgMojo
execute() - Method in class network.ike.docs.plugin.InjectBreadcrumbMojo
execute() - Method in class network.ike.docs.plugin.LintSiteMojo
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
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.
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.
formatSummary(String, int, int) - Static method in class network.ike.docs.plugin.ScanRendererLogsMojo: Format a one-line summary for a renderer log.

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.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.LintSiteMojo: 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.
goalName() - Method in enum class network.ike.docs.plugin.IdocGoal: The bare goal name as it appears in @Mojo(name = ...).

H

hashCode() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns a hash code value for this object.
HTML - Enum constant in enum class network.ike.docs.plugin.Backend: HTML5 — website and CSS-to-PDF renderer input.

I

IdocGoal - Enum Class in network.ike.docs.plugin: Compile-time identity for every idoc:* goal in this plugin.
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.
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.
Issue(Path, int, OutputValidator.Severity, String) - Constructor for record class network.ike.docs.plugin.OutputValidator.Issue: Creates an instance of a Issue record class.

L

line() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns the value of the line 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_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).
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.

M

message() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns the value of the message record component.
mojoClass() - Method in enum class network.ike.docs.plugin.IdocGoal: The mojo class that implements this goal.

N

network.ike.docs.plugin - package network.ike.docs.plugin

O

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.

P

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.
parse(String) - Static method in enum class network.ike.docs.plugin.Backend: Parse a backend name (case-insensitive).
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.
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.

Q

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

R

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.
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.

S

SCAN_LOGS - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:scan-logs — scan renderer logs for warnings and errors.
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.
supportsPostprocessor() - Method in enum class network.ike.docs.plugin.Backend: Whether this backend supports AsciidoctorJ Postprocessor extensions.

T

toString() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns a string representation of this record class.

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.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.
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.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.

W

WARNING - Enum constant in enum class network.ike.docs.plugin.OutputValidator.Severity: Non-fatal issue (e.g., missing image).

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