PaperForge.Compliance (PaperForge v1.3.0)

Copy Markdown View Source

Structural PDF/A and PDF/UA preparation with deterministic validation reports.

PaperForge validates the requirements it emits. Final archival certification should also be performed with VeraPDF because conformance includes rules that depend on the complete rendered document and the selected ICC profile.

Summary

Types

issue()

Functions

alternate_text(document, image_reference, text)

Associates alternate text with an image XObject for tagged-document tooling.

apply(document, options)

Applies one or more conformance profiles to a document.

validate(document, options)

Returns a machine-readable conformance report.

Types

issue()

@type issue() :: %{code: atom(), message: binary(), path: binary()}

Functions

alternate_text(document, image_reference, text)

@spec alternate_text(PaperForge.Document.t(), PaperForge.Reference.t(), binary()) ::
  PaperForge.Document.t()

Associates alternate text with an image XObject for tagged-document tooling.

apply(document, options)

@spec apply(
  PaperForge.Document.t(),
  keyword()
) :: PaperForge.Document.t()

Applies one or more conformance profiles to a document.

validate(document, options)

@spec validate(
  PaperForge.Document.t(),
  keyword()
) :: {:ok, map()} | {:error, [issue()]}

Returns a machine-readable conformance report.