README
¶
Textml / Template
This runtime provides a sub-language to define templates and layouts and combine them together. For example a basic layout file could be
./example-layouts.tml
#template{ base-layout }{
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>#{ title }</title>
<link rel="stylesheet" href="/assets/styles.css">
#{ head }
</head>
<body>
#{ body }
</body>
</html>
}
#template{ article-layout }{
#extends{ base-layout }{
#define{ title }{ Article - #{ article.title } }
#define{ body }{
<h1>#{ article.title }</h1>
#{ article.body }
}
}
}
Then we can add a concrete page that uses this layout file
./article-1.tml
#import{ ./example-layouts.tml }
#extends{ base-layout }{
#define{ head }{
<!-- maybe add KaTeX support just for this page -->
}
#define{ article.title }{ Article 1 }
#define{ article.body }{
<p>Some article</p>
}
}
Usage
textml template [-o OUTPUT] FILES... will evaluate each file in sequence starting from an empty context, the default LoaderFunc is FileLoader so #import{ FILE } will read and evaluate that file. The option --output or -o can be used to change the file to write to, by default its the - meaning stdout.
Reference
-
#template{ NAME }{ TEMPLATE }defines a new templateNAMEwith valueTEMPLATE. Templates can be expanded using the#extends{ NAME }{ ... }directive. -
#define{ NAME }{ VALUE }evaluates ast forVALUEwhen this define gets called and binds it to the variableNAME. -
#{ EXPR }evaluates the code inside or variable interpolation. -
#extends{ NAME }{ BLOCK }evaluates first the givenBLOCKand then the template bind toNAME. -
#import{ MODULE }is used to include a "module" using the givenLoaderFunc, for example the defaultFileLoaderreads a file and evaluates it in-place in the current engine context.
Expressions
-
#char{ CHAR_NAME }is a directive for printing some special characters likespace,newlineortab. -
#inline{ ... }recursively removes "newlines" (things matching[ ]*\n\s*) from all text nodes inside this inline block, mostly used for blocks that require more control on the generation of whitespace while keeping the code readable (works nice with the#chardirective). -
#foreach{ ITEM }{ ITEMS }{ BLOCK }takes a variable nameITEM, a listITEMS. For each item in the given list this will set theITEMvariable to the current item and then evaluateBLOCK. -
#intersperse{ ITEMS }{ SEPARATOR }takes a list and intersperses that list with the string given bySEPARATOR, useful for printing list inline. -
#if{ CONDITION }{ IF_TRUE }evaluates the chosen branch based on the value ofCONDITION. -
#if{ CONDITION }{ IF_TRUE }{ IF_FALSE }evaluates the chosen branch based on the value ofCONDITION. -
#unless{ CONDITION }{ UNLESS_FALSE }evaluates the chosen branch based on the value ofCONDITION. -
#unless{ CONDITION }{ UNLESS_FALSE }{ UNLESS_TRUE }evaluates the chosen branch based on the value ofCONDITION.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FileLoader ¶
Types ¶
type EngineEvaluateOption ¶
type EngineEvaluateOption func(e *Engine)
func WithContext ¶
func WithContext(vars map[string]any) EngineEvaluateOption
func WithTemplate ¶
func WithTemplate(name string, tmpl ast.Block) EngineEvaluateOption
func WithVariable ¶
func WithVariable(key string, value any) EngineEvaluateOption
Source Files