itsscb/askama
1
0
Fork 0
mirror of https://github.com/askama-rs/askama.git synced 2025-09-30 22:41:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #248 from GuillaumeGomez/missing-title

Browse Source 
Add missing "Escapers" title in the book
This commit is contained in:
René Kijewski 2024-11-18 15:23:56 +01:00 committed by GitHub
commit 7b91babbc7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
book/src/configuration.md
View File

@ -108,6 +108,8 @@ The following keys can currently be used to customize template syntax:
Values must be at least two characters long.
If a key is omitted, the value from the default syntax is used.
## Escapers
Here is an example of a custom escaper:
```toml
@ -118,10 +120,35 @@ extensions = ["tex"]
An escaper block consists of the attributes `path` and `extensions`. `path`
contains a Rust identifier that must be in scope for templates using this
escaper. `extensions` defines a list of file extensions that will trigger
escaper. This type must implement the [`Escaper`]
trait.
`extensions` defines a list of file extensions that will trigger
the use of that escaper. Extensions are matched in order, starting with the
first escaper configured and ending with the default escapers for HTML
(extensions `html`, `htm`, `xml`, `j2`, `jinja`, `jinja2`) and plain text
(no escaping; `md`, `yml`, `none`, `txt`, and the empty string). Note that
this means you can also define other escapers that match different extensions
to the same escaper.
You can then use templates with this extension or use the
[`escape`](https://docs.rs/rinja/latest/rinja/filters/fn.escape.html) filter with
the name of your extension in your template:
```jinja
{{ some_string|escape("tex") }}
```
As an example, we want `.js` files to be treated like "txt" files. To do so:
```toml
[[escaper]]
path = "rinja::filters::Text"
extensions = ["js"]
```
[`Text`](https://docs.rs/rinja/latest/rinja/filters/struct.Text.html) implements the
[`Escaper`] trait so since we don't need want any escaping on our `.js` files, we use
it.
[`Escaper`]: https://docs.rs/rinja/latest/rinja/filters/trait.Escaper.html