Added category tables

This commit is contained in:
Erik C. Thauvin 2023-03-15 15:56:08 -07:00
parent d7659f4052
commit 4b96a64c3c

View file

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