rife2/rife2-template-renderers
rife2/rife2-template-renderers
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added category tables

Browse source
This commit is contained in:
Erik C. Thauvin 2023-03-15 15:56:08 -07:00
parent d7659f4052
commit 4b96a64c3c
1 changed files with 47 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

99
README.md
View file

@ -3,62 +3,62 @@
# [RIFE2](https://rife2.com/) Template Renderers
This project provides a set of template renderers.
This project provides a collection of template renderers.
- **rife.render.Capitalize**
- Capitalizes a template value.
- **rife.render.DateIso**
- Renders the current date in ISO 8061 format.
- **rife.render.DateTimeIso**
- Renders the current date and time in ISO 8061 format.
- **rife.render.DateTimeRfc2822**
- Renders the current date and time in RFC 2822 format.
- **rife.render.DateTimeUtc**
- Renders the current UTC date and time in ISO 8061 format.
- **rife.render.EncodeBase64**
- Encodes a template value to Base64.
- **rife.render.EncodeHtml**
- Encodes a template value to HTML.
- **rife.render.EncodeHtmlEntities**
- Encodes a template value to HTML decimal entities.
- **rife.render.EncodeJson**
- Encodes a template value to JSON.
- **rife.render.EncodeQp**
- Converts a template value to a quoted-printable string.
- **rife.render.EncodeUnicode**
- Encodes a template value to Unicode escape codes.
- **rife.render.EncodeUrl**
- URL-encodes a template value.
- **rife.render.EncodeXml**
- Encodes a template value to XML.
- **rife.render.Lowercase**
- Converts a template value to lowercase.
- **rife.render.Rot13**
- Translates a template value to/from ROT13.
- **rife.render.SwapCase**
- Swap case of a template value.
- **rife.render.TimeIso**
- Renders the current time in ISO 8061 format.
- **rife.render.Trim**
- Removes leading and trailing whitespace from a template value.
- **rife.render.Uncapitalize**
- Un-capitalizes a template value.
- **rife.render.Uppercase**
- Converts a template value to uppercase.
- **rife.render.Year**
- Renders the current year.
## Date/Time Renderers
| Renderer | Description |
|:---------------------------------|:----------------------------------------------------------|
| `rife.render.DateIso` | Renders the current date in ISO 8061 format. |
| `rife.render.DateTimeIso` | Renders the current date and time in ISO 8061 format. |
| `rife.render.DateTimeRfc2822` | Renders the current date and time in RFC 2822 format. |
| `rife.render.DateTimeUtc` | Renders the current UTC date and time in ISO 8061 format. |
| `rife.render.TimeIso` | Renders the current time in ISO 8061 format. |
| `rife.render.Year` | Renders the current year. |
## Encoding Renderers
| Renderer | Description |
|:-----------------------------------|:--------------------------------------------------------|
| `rife.render.EncodeBase64` | Encodes a template value to Base64. |
| `rife.render.EncodeHtml` | Encodes a template value to HTML. |
| `rife.render.EncodeHtmlEntities` | Encodes a template value to HTML decimal entities. |
| `rife.render.EncodeJson` | Encodes a template value to JSON. |
| `rife.render.EncodeQp` | Converts a template value to a quoted-printable string. |
| `rife.render.EncodeUnicode` | Encodes a template value to Unicode escape codes. |
| `rife.render.EncodeUrl` | URL-encodes a template value. |
| `rife.render.EncodeXml` | Encodes a template value to XML. |
## Text Renderers
| Renderer | Description |
|:----------------------------|:---------------------------------------------------------------|
| `rife.render.Capitalize` | Capitalizes a template value. |
| `rife.render.Lowercase` | Converts a template value to lowercase. |
| `rife.render.Rot13` | Translates a template value to/from ROT13. |
| `rife.render.SwapCase` | Swap case of a template value. |
| `rife.render.Trim` | Removes leading and trailing whitespace from a template value. |
| `rife.render.Uncapitalize` | Un-capitalizes a template value. |
| `rife.render.Uppercase` | Converts a template value to uppercase. |
## Usage in Templates
All rendered can be used at follows:
In RIFE2, template renders are used as follows:
```
<!--v render:rife.render.RendererName:valueId/-->
<!--v render:rife.render.RendererName/-->
```
or
```
{{v render:rife.render.RendererName/}}
```
To specify the value ID when applicable, use:
```
<!--v render:rife.render.RendererName:valueId/-->
{{v render:rife.render.RendererName:valueId/}}
```
@ -66,10 +66,5 @@ For example, to capitalize a template `foo` value:
```
<!--v render:rife.render.Capitalize:foo/-->
```
or
```
{{v render:rife.render.Capitalize:foo}}
```
{{v render.rife.render.Capitalize:foo/}}
```