From cea371ed31af8cbbb344c6da995c02066e3b1df3 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sat, 18 Mar 2023 14:56:19 -0700 Subject: [PATCH] Added links to wiki for EncodeHtml, EncodeJs, EncodeJson and EncodeXml --- README.md | 38 ++++--------------- lib/src/main/java/rife/render/EncodeHtml.java | 1 + lib/src/main/java/rife/render/EncodeJs.java | 1 + lib/src/main/java/rife/render/EncodeJson.java | 1 + lib/src/main/java/rife/render/EncodeXml.java | 1 + .../main/java/rife/render/RenderUtils.java | 6 +-- lib/src/test/java/rife/render/TestEncode.java | 4 +- 7 files changed, 16 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 9d29669..d6d2317 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # [RIFE2](https://rife2.com/) Template Renderers -This project provides a collection of template renderers. +This project provides a collection of useful template renderers. ## Date/Time Renderers @@ -24,14 +24,14 @@ This project provides a collection of template renderers. | Renderer | Description | |:------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------| | [rife.render.EncodeBase64](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeBase64) | Encodes a template value to Base64 | -| `rife.render.EncodeHtml` | Encodes a template value to HTML | +| [rife.render.EncodeHtml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtml) | Encodes a template value to HTML | | `rife.render.EncodeHtmlEntities` | Encodes a template value to HTML decimal entities | -| `rife.render.EncodeJs` | Encodes a template value to JavaScript/ECMAScript | -| `rife.render.EncodeJson` | Encodes a template value to JSON | +| [rife.render.EncodeJs](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJs) | Encodes a template value to JavaScript/ECMAScript | +| [rife.render.EncodeJson](https://github.com/rife2/rife2-template-renderers/wiki/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.EncodeXml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeXml) | Encodes a template value to XML | ## Format Renderers @@ -54,30 +54,6 @@ This project provides a collection of template renderers. | `rife.render.Uncapitalize` | Un-capitalizes a template value | | `rife.render.Uppercase` | Converts a template value to uppercase | -## Usage in Templates +## Documentation -In RIFE2, template renders are used as follows: - -```plain - -``` - -or - -```plain -{{v render:rife.render.RendererName/}} -``` - -To specify the value ID when applicable, use: - -```plain - -{{v render:rife.render.RendererName:valueId/}} -``` - -For example, to capitalize a template `foo` value: - -```plain - -{{v render.rife.render.Capitalize:foo/}} -``` +Read more in the [full documenation](https://github.com/rife2/rife2/wiki). \ No newline at end of file diff --git a/lib/src/main/java/rife/render/EncodeHtml.java b/lib/src/main/java/rife/render/EncodeHtml.java index 5943075..858b6dd 100644 --- a/lib/src/main/java/rife/render/EncodeHtml.java +++ b/lib/src/main/java/rife/render/EncodeHtml.java @@ -32,6 +32,7 @@ import rife.tools.StringUtils; * * * @author Erik C. Thauvin + * @see rife.render.EncodeHtml * @see StringUtils#encodeHtml(String) * @since 1.0 */ diff --git a/lib/src/main/java/rife/render/EncodeJs.java b/lib/src/main/java/rife/render/EncodeJs.java index 2d6e37a..ae441fa 100644 --- a/lib/src/main/java/rife/render/EncodeJs.java +++ b/lib/src/main/java/rife/render/EncodeJs.java @@ -32,6 +32,7 @@ import rife.tools.StringUtils; * * * @author Erik C. Thauvin + * @see rife.render.EncodeJs * @see StringUtils#encodeJson(String) * @since 1.0 */ diff --git a/lib/src/main/java/rife/render/EncodeJson.java b/lib/src/main/java/rife/render/EncodeJson.java index cd10f83..60916f6 100644 --- a/lib/src/main/java/rife/render/EncodeJson.java +++ b/lib/src/main/java/rife/render/EncodeJson.java @@ -32,6 +32,7 @@ import rife.tools.StringUtils; * * * @author Erik C. Thauvin + * @see rife.render.EncodeJson * @see StringUtils#encodeJson(String) * @since 1.0 */ diff --git a/lib/src/main/java/rife/render/EncodeXml.java b/lib/src/main/java/rife/render/EncodeXml.java index 0b2bae4..743e084 100644 --- a/lib/src/main/java/rife/render/EncodeXml.java +++ b/lib/src/main/java/rife/render/EncodeXml.java @@ -32,6 +32,7 @@ import rife.tools.StringUtils; * * * @author Erik C. Thauvin + * @see rife.render.EncodeXml * @see StringUtils#encodeXml(String) * @since 1.0 */ diff --git a/lib/src/main/java/rife/render/RenderUtils.java b/lib/src/main/java/rife/render/RenderUtils.java index 1b24a52..138bbb1 100644 --- a/lib/src/main/java/rife/render/RenderUtils.java +++ b/lib/src/main/java/rife/render/RenderUtils.java @@ -51,10 +51,10 @@ public final class RenderUtils { } /** - * Encodes a string to JavaScript/ECMAScript. + * Encodes a String to JavaScript/ECMAScript. * - * @param src the source string - * @return the enocded string + * @param src the source String + * @return the encoded String */ public static String encodeJS(String src) { if (src == null || src.isBlank()) { diff --git a/lib/src/test/java/rife/render/TestEncode.java b/lib/src/test/java/rife/render/TestEncode.java index f6f4144..99369c6 100644 --- a/lib/src/test/java/rife/render/TestEncode.java +++ b/lib/src/test/java/rife/render/TestEncode.java @@ -54,8 +54,8 @@ class TestEncode { @Test void testEncodeJson() { var t = TemplateFactory.JSON.get("encodeJson"); - t.setAttribute(TestCase.FOO, "fde\fde\rjk\tos\\u218Foi"); - assertThat(t.getContent()).isEqualTo("{\n \"foo\": \"fde\\fde\\rjk\\tos\\\\u218Foi\"\n}"); + t.setAttribute(TestCase.FOO, "This is a \"•test\""); + assertThat(t.getContent()).isEqualTo("{\n \"foo\": \"This is a \\\"\\u2022test\\\"\"\n}"); } @Test