Skip to content

main · 3.3 (unreleased)

Findings

Template authors and developers · Reference · CurrentMarkdownAgent index

Status: Current. Reference for template authors and developers.

This page is the reference for findings: what Validate and Render report, with the severity of each finding and what the render does about it. A finding prints as its severity, the tag as typed, the message and the location:

error: <$Invoice.Customer.Email>: Customer has no member Email (content.xml paragraph 3 "Customer: <$Invoice.Customer.Name>, <$Invoice.Customer.Email>")

A Finding says what is wrong in the author’s terms: the kind, the severity, the tag as typed, the path, a message and the Location. Validate reports everything it can tell from the template and the shape; Render reports what depends on the data; the constructor throws TemplateException with the findings a template cannot render with.

FindingSeverityMeaningFrom
MalformedTagerrorA tag, the description of a picture, or a map table that cannot be read; a tag renders as typed, a map row is skipped.Validate, Render
UnbalancedBlockerrorA block without an end, an end without a block, or an else that belongs to no condition: outside any, in a loop, or after the <@else>.Validate, constructor
BlockStructureerrorA block whose begin, elses and end are not in paragraphs of one container or in rows of one table.Validate, constructor
UnknownMembererrorA path segment the model does not have, on a binding, a loop, a condition, a sort key or a picture; it prints blank.Validate, Render
NotACollectionwarningA loop over a value that is not a collection; it runs once.Validate
UnknownAttributeerrorAn attribute a tag of that kind does not know.Validate
BadValueerrorA value an attribute does not take, such as empty="maybe".Validate
BadCultureerrorA culture name that is no culture, in a tag’s culture or in a document setting.Validate
BadPatternerrorA date, time or number pattern .NET rejects, in a tag or a document setting.Validate
MixedTextwarningText or tags in the paragraph or row that holds a block tag; they are removed with it.Validate
UnknownSettingwarningA document setting the library does not know.Validate
CannotSortwarningA loop whose sort keys cannot be ordered against each other; it keeps the collection’s order.Render
NotAPictureerrorA value bound to a picture frame that is no picture, or bytes in a format the library does not know; the frame leaves the document.Render
CannotFitwarningA picture that fills its frame instead of fitting it, because its bytes do not tell their size or the frame has no size.Render
UnknownMaperrorA map attribute that names no map of the template; the value prints as it is.Validate, Render
MissingKeywarningA value a map has no row for, in a map without a default row; the value prints as it is.Render
UnusedMapwarningA map no binding prints through.Validate
MapWithoutDefaultwarningA map without a default row.Validate
SeparatorIgnoredwarningA separator on a loop whose tags sit in paragraphs or rows of their own; nothing is written between its items.Validate