Simplify.Templates 2.0.2

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.8 This package targets .NET Framework 4.8. The package is compatible with this framework or higher. 
dotnet add package Simplify.Templates --version 2.0.2                

                    
                

            
NuGet\Install-Package Simplify.Templates -Version 2.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Simplify.Templates" Version="2.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Simplify.Templates --version 2.0.2                

                    
                

            
#r "nuget: Simplify.Templates, 2.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Simplify.Templates as a Cake Addin
#addin nuget:?package=Simplify.Templates&version=2.0.2

// Install Simplify.Templates as a Cake Tool
#tool nuget:?package=Simplify.Templates&version=2.0.2

Simplify.Templates Documentation

Provides ITemplate interface, Template class and TemplateBuilder class for working with text templates.

With Simplify.Templates you can easily load text templates, localize them, insert data and get generated result.

Available at NuGet as binary package

Quick start

Load the template from a file located in the current assembly directory:

var tpl = TemplateBuilder
    .FromLocalFile("TestTemplate.tpl")
    .Build();

The TestTemplate.tpl file:

<html>
<body>
<div>{SomeVariable}</div>
<div>{Items}</div>
</body>

Setting a data into the template variables:

tpl.Set("SomeVariable", "footext");

tpl.Add("Items", "1")
    .Add("Items", "2")
    .Add("Items", "3");

Getting the template text:

var str = tpl.Get();

str will contain:

<html>
<body>
<div>footext</div>
<div>123</div>
</body>

Another ways of template loading

To choose how to load template use respective TemplateBuilder static methods:

  • Loading template from a string: FromString("some string")
  • Loading template from a file: FromFile("D:\SomeDir\SomeFile.txt")
  • Loading template from a file located in current assembly directory: FromLocalFile("SomeFile.txt")
  • Loading template from current assembly embedded resources by: FromCurrentAssembly("FilePath.Filename.tpl") or FromCurrentAssembly("FilePath/Filename.tpl")
  • Loading template from specified assembly embedded resources by: FromAssembly("FilePath.Filename.tpl", myAssembly)

Template localization

If you want a template to be localizable then you should create a xml file in the same directory as a template file.

Files should be named like FooTemplate.tpl.en.xml, if a template file name is FooTemplate.tpl. For embedded templates it should be named like FooTemplate.tpl-en.xml.

You can keep several files for each language, which you want to be localized, for example:

FooTemplate.tpl
FooTemplate.tpl.en.xml
FooTemplate.tpl.de.xml
FooTemplate.tpl.ru.xml

Localization file FooTemplate.tpl.de.xml example:

<?xml version="1.0" encoding="utf-8"?>`
<items>
    <item name="LocalizableVariable" value="Test" />
</items>

Localization file FooTemplate.tpl.en.xml example

<?xml version="1.0" encoding="utf-8"?>`
<items>
    <item name="LocalizableVariable" value="Test default" />
    <item name="LocalizableVariable2">
        <a href="#">localizable data default</a>
    </item>
</items>

Template file FooTemplate.tpl example:

<html>
<body>
<div>{LocalizableVariable}</div>
<div>{LocalizableVariable2}</div>
</body>

To perform localization use respective fluent methods: Localizable, LocalizableFromCurrentThreadLanguage

There are two language code parameters, first is the current language, and seconds is the default language.

At the time when a template builds, the current language localization file will be inserted into the template, after that the default localization file will be inserted. If some localizable values are not exist in the current localization file, then they will be inserted from the default localization file.

To use Thread.CurrentThread.CurrentCulture.TwoLetterISOLanguageName language code as the current language code use LocalizableFromCurrentThreadLanguage method.

Output example:

var tpl = TemplateBuilder
    .FromLocalFile("FooTemplate.tpl")
    .Localizable("de", "en")
    .Build();

var str = tpl.Get();

str will contain:

<html>
<body>
<div>Test</div>
<div><a href="#">localizable data default</a></div>
</body>

Building items list example

The MasterTemplate.tpl file:

<html>
<body>
{Links}
</body>

The FooLinkItem.tpl file:

<a href="http://foolink/{ItemID}">{MyLinkLabel} {ItemID}</a><br />

The FooLinkItem.tpl.en.xml file:

<?xml version="1.0" encoding="utf-8"?>`
<items>
    <item name="MyLinkLabel" value="My item" />
</items>

Building links list:

class MyItem
{
    public int ID { get; set; }
}

...

var items = new List<MyItem> { {ID = 1}, {ID = 2}, {ID = 3}};

var tpl = TemplateBuilder
    .FromFile("Templates/MasterTemplate.tpl")
    .Build();

var itemTpl = TemplateBuilder
    .FromFile("Templates/FooLinkItem.tpl")
    .Build();

foreach (var item in items)
{
    itemTpl.Set("ItemID", item.ID);

    // Adding our generated item data to the master template and rolling it back to initial, but localized state
    tpl.Add("Links", itemTpl.GetAndRoll());
}

var str = tpl.Get();

str will contain:

<html>
<body>
<a href="http://foolink/1">My item 1</a><br />
<a href="http://foolink/2">My item 2</a><br />
<a href="http://foolink/3">My item 3</a><br />
</body>

Model binding example

The MyTemplate.tpl file:

{Prop1}
{Prop2}
{Prop3}

The model:

public class MyClass
{
    public string Prop1 { get; set; }
    public int Prop2 { get; set; }
    public DateTime Prop3 { get; set; }
}

Setting model to template:

var obj = new MyClass {Prop1 = "Foo", Prop2 = 5, Prop3 = new DateTime(2014, 09, 13)};

var tpl = TemplateBuilder
    .FromFile("MyTemplate.tpl")
    .Build();

tpl.Model(obj).With(x => x.Prop3, x => x.ToString("dd.MM.yyyy")).Set();

var str = tpl.Get();

str will contain:

Foo
5
09.13.2014
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETFramework 4.8

    • No dependencies.

  • .NETStandard 2.0

    • No dependencies.

  • .NETStandard 2.1

    • No dependencies.

  • net6.0

    • No dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Simplify.Templates:

Package Downloads
Simplify.Web

Lightweight and fast .NET web-framework based on MVC and OWIN
AcspNet

ACSP.NET is a lightweight and fast .NET web-framework based on MVC and OWIN.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.2 1,374 5/25/2024
2.0.1 2,300 8/8/2023
2.0.0 20,791 12/8/2019
2.0.0-pre01 435 12/7/2019
1.5.2 2,960 9/28/2019
1.5.1 2,199 6/23/2019
1.5.0 1,848 12/16/2018
1.5.0-pre01 651 11/21/2018
1.4.1 1,224 10/1/2018
1.4.0 1,327 4/12/2018
1.3.0 2,275 8/18/2017
1.2.1 5,571 8/18/2016
1.2.0 1,929 6/1/2015
1.1.2 7,207 10/23/2014
1.1.1 2,090 9/21/2014
1.1.0 2,902 9/2/2014
1.0.5 1,795 8/8/2014
1.0.3 1,467 5/21/2014
1.0.2 1,137 4/23/2014
1.0.0 1,244 2/25/2014

See https://github.com/SimplifyNet/Simplify/tree/master/src/Simplify.Templates/CHANGELOG.md for details