PdfElixide.Compliance.Issue (pdf_elixide v0.23.0)

Copy Markdown View Source

One finding in a PdfElixide.Compliance.Report, an error or a warning.

  • :code — the finding's identifier, such as "FONT-001", "UA-FIG-001" or "XMETA-001". The prefix names the area checked; codes are strings to match on.
  • :message — a human-readable description.
  • :clause — the clause of the standard the finding refers to, such as "6.1.4", or nil when none is given. PDF/A and PDF/UA warnings never carry one.
  • :location — where in the document the finding applies, as free text, or nil. Given for PDF/A and PDF/UA only.
  • :page — the zero-based index of the page the finding applies to, or nil. Given for PDF/X only.
  • :object — the number of the PDF object the finding applies to, or nil. Given for PDF/X only.
  • :wcag — the WCAG success criterion a PDF/UA finding maps to, or nil.

Summary

Types

t()

Types

t()

@type t() :: %PdfElixide.Compliance.Issue{
  clause: String.t() | nil,
  code: String.t(),
  location: String.t() | nil,
  message: String.t(),
  object: non_neg_integer() | nil,
  page: non_neg_integer() | nil,
  wcag: String.t() | nil
}