Allors.Documents 2.0.0

Allors Documents

Embed template tags inside open office documents.

Status

Usage

Write the template in LibreOffice Writer. Tags go into placeholder fields (Insert, Field, More Fields, Functions, Placeholder):

A picture frame named $path shows the image whose name is the value at path; pass the images to Render by name.

var template = new OpenDocumentTemplate<InvoiceModel>(templateBytes);
byte[] document = template.Render(model, new Dictionary<string, byte[]> { ["logo"] = logoPng });

With a dictionary as the model, name the arguments: new OpenDocumentTemplate(templateBytes, "Invoice,Logo").Render(dictionary, images).

Rendering rules

• The template renders as typed. Static text and attribute values pass unchanged, including &, <, >, ", backslashes and the characters ˂ and ˃ (U+02C2 and U+02C3) that the engine uses as its delimiters. The engine adds no white space of its own: a word split by formatting stays one word, and two adjacent tags render without a space between them.
• Bound values are escaped for XML and keep their white space: a tab becomes <text:tab/>, a line break <text:line-break/> and a run of spaces <text:s/>, as Writer saves them. Other characters below U+0020 are dropped. Booleans render as true or false; other values render through ToString() in the current culture.
• The paragraph or table row that holds a <@for>, <@if> or <@end> tag is removed with the rest of its text, so give each tag its own paragraph or row.
• The package starts with an uncompressed mimetype entry. PNG, JPEG, GIF and WebP pictures are stored; everything else is deflated.

Build

Prerequisites: .NET SDK 10.0 and Task.

• task or task ci — build, test and pack
• task test — build and run tests
• task pack — create the NuGet packages in artifacts/nuget
• task clean — clean build outputs

Versioning is handled by Nerdbank.GitVersioning (version.json).

Release

Pushing a tag vX.Y.Z or vX.Y.Z-rc.N runs release.yml: it builds, tests and packs, publishes the package to nuget.org through trusted publishing from the nuget-release environment, and creates a GitHub release. The package version comes from version.json, so set it to the tag's version before tagging.