From 2297011febc0b32ff5e4cb8581cf27836007d0c8 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sat, 18 Mar 2023 21:39:41 -0700 Subject: [PATCH] Added links to wiki for EncodeHtmlEntities, EncodeUnicode and EncodeUrl --- README.md | 23 +++++++++---------- .../java/rife/render/EncodeHtmlEntities.java | 5 +--- .../main/java/rife/render/EncodeUnicode.java | 1 + lib/src/main/java/rife/render/EncodeUrl.java | 1 + lib/src/test/java/rife/render/TestEncode.java | 7 ------ 5 files changed, 14 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index d6d2317..b0613b2 100644 --- a/README.md +++ b/README.md @@ -21,17 +21,16 @@ This project provides a collection of useful template renderers. ## Encoding 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](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](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](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeXml) | Encodes a template value to XML | +| 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](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtml) | Encodes a template value to HTML | +| [rife.render.EncodeHtmlEntities](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtmlEntities0) | Encodes a template value to HTML decimal entities | +| [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.EncodeUnicode](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUnicode) | Encodes a template value to Unicode escape codes | +| [rife.render.EncodeUrl](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUrl) | URL-encodes a template value | +| [rife.render.EncodeXml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeXml) | Encodes a template value to XML | ## Format Renderers @@ -56,4 +55,4 @@ This project provides a collection of useful template renderers. ## Documentation -Read more in the [full documenation](https://github.com/rife2/rife2/wiki). \ No newline at end of file +Read more in the [full documenation](https://github.com/rife2/rife2-template-renderers/wiki). \ No newline at end of file diff --git a/lib/src/main/java/rife/render/EncodeHtmlEntities.java b/lib/src/main/java/rife/render/EncodeHtmlEntities.java index f6e3fac..22b498a 100644 --- a/lib/src/main/java/rife/render/EncodeHtmlEntities.java +++ b/lib/src/main/java/rife/render/EncodeHtmlEntities.java @@ -30,11 +30,8 @@ import rife.template.ValueRenderer; * {{v render:rife.render.EncodeHtmlEntities:valueId/}} * * - *

For example {@code john@doe.com} would be encoded to:

- * - * 
john@doe.com
- * * @author Erik C. Thauvin + * @see rife.render.EncodeHtmlEntities * @since 1.0 */ public class EncodeHtmlEntities implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/EncodeUnicode.java b/lib/src/main/java/rife/render/EncodeUnicode.java index 44233d2..1d67bf1 100644 --- a/lib/src/main/java/rife/render/EncodeUnicode.java +++ b/lib/src/main/java/rife/render/EncodeUnicode.java @@ -32,6 +32,7 @@ import rife.tools.StringUtils; * * * @author Erik C. Thauvin + * @see rife.render.EncodeUnicode * @see StringUtils#encodeUnicode(String) * @since 1.0 */ diff --git a/lib/src/main/java/rife/render/EncodeUrl.java b/lib/src/main/java/rife/render/EncodeUrl.java index 0d87a51..f6201d5 100644 --- a/lib/src/main/java/rife/render/EncodeUrl.java +++ b/lib/src/main/java/rife/render/EncodeUrl.java @@ -32,6 +32,7 @@ import rife.tools.StringUtils; * * * @author Erik C. Thauvin + * @see rife.render.EncodeUrl * @see StringUtils#encodeUrl(String) * @since 1.0 */ diff --git a/lib/src/test/java/rife/render/TestEncode.java b/lib/src/test/java/rife/render/TestEncode.java index 99369c6..0ccf03e 100644 --- a/lib/src/test/java/rife/render/TestEncode.java +++ b/lib/src/test/java/rife/render/TestEncode.java @@ -58,13 +58,6 @@ class TestEncode { assertThat(t.getContent()).isEqualTo("{\n \"foo\": \"This is a \\\"\\u2022test\\\"\"\n}"); } - @Test - void testEncodeQp() { - var t = TemplateFactory.TXT.get("encodeQp"); - t.setAttribute(TestCase.FOO, TestCase.SAMPLE_TEXT + "\nAnd one more test for =A0."); - assertThat(t.getContent()).isEqualTo("This=20is=20a=20test=2E=0AAnd=20one=20more=20test=20for=20=3DA0=2E"); - } - @Test void testEncodeRot13() { var t = TemplateFactory.TXT.get("rot13");