abp/docs/en/Text-Templating.md

Text Templating

In ABP Framework, text template is a mixture of text blocks and control logic that can generate a string result. Scriban is used for the control logic and Abp.Localization is used to make content easily localizable. The generated string can be text of any kind, such as a web page, an e-mail content etc.

stored content

<ol>
{{~ for $i in 0..3 ~}}
 <li>{{ L "WelcomeMessage" }}</li>
{{~ endfor ~}}
</ol>

result (for en culture)

1. Welcome to the abp.io!
2. Welcome to the abp.io!
3. Welcome to the abp.io!
4. Welcome to the abp.io!

Installation

It is suggested to use the ABP CLI to install this package.

Using the ABP CLI

Open a command line window in the folder of the project (.csproj file) and type the following command:

abp add-package Volo.Abp.TextTemplating

Manual Installation

If you want to manually install;

1. Add the Volo.Abp.TextTemplating NuGet package to your project:

   Install-Package Volo.Abp.TextTemplating
   

2. Add the AbpTextTemplatingModule to the dependency list of your module:

[DependsOn(
    //...other dependencies
    typeof(AbpTextTemplatingModule) //Add the new module dependency
    )]
public class YourModule : AbpModule
{
}

Logic

A Text Template is a combination of two object.

• TemplateDefinition
• TemplateContent

Template Definition

Template Definition is an object that contains some information about your Text Templates. Template Definition object contains the following properties.

• Name (string)
• IsLayout (boolean)
• Layout (string) contains the name of layout template
• LocalizationResource (Type) Inline Localized
• IsInlineLocalized(boolean) describes that the template is inline localized or not
• DefaultCultureName (string) defines the default culture for the template

Template Content

This is a simple content for your templates. For default, template contents stored as Virtual File.

Example: ForgotPasswordEmail.tpl

<h3>{{L "PasswordReset"}}</h3>

<p>{{L "PasswordResetInfoInEmail"}}</p>

<div>
    <a href="{{model.link}}">{{L "ResetMyPassword"}}</a>
</div>

Localization

You can localize your Text Templates by choosing two different method.

• Inline Localization
• Multiple Content Localization

Inline Localization

Inline localized Text Templates is using only one content resource, and it is using the Abp.Localization to get content in different languages/cultures.

Example Inline Localized Text Template:

ForgotPasswordEmail.tpl

<h3>{{L "PasswordReset"}}</h3>

<p>{{L "PasswordResetInfoInEmail"}}</p>

<div>
    <a href="{{model.link}}">{{L "ResetMyPassword"}}</a>
</div>

Multiple Content Localization

You can store your Text Templates for any culture in different content resource.

Examples given by using Virtual File contents.

Example Multiple Content Localization

ForgotPasswordEmail / en.tpl

<h3>Reset Your Password</h3>

<p>Hello, this is a password changing email.</p>

<div>
    <a href="{{model.link}}">Click To Reset Your Password</a>
</div>

ForgotPasswordEmail / tr.tpl

<h3>Şifrenizi Değiştirin</h3>

<p>Merhaba, bu bir şifre yenileme e postasıdır.</p>

<div>
    <a href="{{model.link}}">Şifrenizi Yenilemek İçin Tıklayınız</a>
</div>

Definition a Text Template

Rendering

Getting Template Definitions

Template Definition Manager

Getting Template Contents

Template Content Contributor