diff --git a/README.md b/README.md index ccade05..b42ea74 100644 --- a/README.md +++ b/README.md @@ -10,49 +10,49 @@ This project provides a collection of template renderers. ## Date/Time Renderers -| Renderer | Description | -|:----------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------| -| `rife.render.BeatTime` | Renders the current time in Swatch Internet (.beat) Time format | -| `rife.render.DateIso` | Renders the current date in ISO 8061 format | -| [rife.render.DateTimeIso](https://github.com/rife2/rife2-template-renderers/wiki/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.TimeIso` | Renders the current time in ISO 8061 format | -| `rife.render.Year` | Renders the current year | +| Renderer | Description | +|:------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------| +| [rife.render.BeatTime](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.BeatTime) | Renders the current time in Swatch Internet (.beat) Time format | +| [rife.render.DateIso](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateIso) | Renders the current date in ISO 8061 format | +| [rife.render.DateTimeIso](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateTimeIso) | Renders the current date and time in ISO 8061 format | +| [rife.render.DateTimeRfc2822](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateTimeRfc2822) | Renders the current date and time in RFC 2822 format | +| [rife.render.TimeIso](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.TimeIso) | Renders the current time in ISO 8061 format | +| [rife.render.Year](https://github.com/rife2/rife2-template-renderers/wiki/rife.rennder.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.EncodeJs` | Encodes a template value to JavaScript/ECMAScript | -| `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 | +| 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.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.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 | ## Format Renderers -| Renderer | Description | -|:------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------| -| `rife.render.formatCreditcard` | Formats a template credit card number value to the last 4 digits | -| `rife.render.ShorteUrl` | Shortens a template value using [is./gd](https://is.gd/) | -| [rife.render.Uptime](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Uptime) | Renders the server uptime in various customizable formats | +| Renderer | Description | +|:--------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------| +| `rife.render.formatCreditcard` | Formats a template credit card number value to the last 4 digits | +| [rife.render.ShortenUrl](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.ShortenUrl) | Shortens a template value using [is./gd](https://is.gd/) | +| [rife.render.Uptime](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Uptime) | Renders the server uptime in various customizable formats | ## 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 | +| Renderer | Description | +|:--------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------| +| [rife.render.Capitalize](https://github.com/rife2/rife2-template-renderers/wiki/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 diff --git a/lib/src/main/java/rife/render/BeatTime.java b/lib/src/main/java/rife/render/BeatTime.java index fc23f1d..e1eaf44 100644 --- a/lib/src/main/java/rife/render/BeatTime.java +++ b/lib/src/main/java/rife/render/BeatTime.java @@ -33,6 +33,7 @@ import java.time.ZonedDateTime; * * * @author Erik C. Thauvin + * @see rife.render.BeatTime * @since 1.0 */ public class BeatTime implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/Capitalize.java b/lib/src/main/java/rife/render/Capitalize.java index a1ae346..044693e 100644 --- a/lib/src/main/java/rife/render/Capitalize.java +++ b/lib/src/main/java/rife/render/Capitalize.java @@ -32,6 +32,7 @@ import rife.tools.Localization; * * * @author Erik C. Thauvin + * @see rife.render.Capitalize * @since 1.0 */ public class Capitalize implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/DateIso.java b/lib/src/main/java/rife/render/DateIso.java index 7ec50b2..d690782 100644 --- a/lib/src/main/java/rife/render/DateIso.java +++ b/lib/src/main/java/rife/render/DateIso.java @@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter; * * * @author Erik C. Thauvin + * @see rife.render.DateIso * @since 1.0 */ public class DateIso implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/DateTimeIso.java b/lib/src/main/java/rife/render/DateTimeIso.java index d24af3e..1312b20 100644 --- a/lib/src/main/java/rife/render/DateTimeIso.java +++ b/lib/src/main/java/rife/render/DateTimeIso.java @@ -39,6 +39,7 @@ import java.util.Properties; * * * @author Erik C. Thauvin + * @see rife.render.DateTimeIso * @since 1.0 */ public class DateTimeIso implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/DateTimeRfc2822.java b/lib/src/main/java/rife/render/DateTimeRfc2822.java index b2b98c4..cb2c860 100644 --- a/lib/src/main/java/rife/render/DateTimeRfc2822.java +++ b/lib/src/main/java/rife/render/DateTimeRfc2822.java @@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter; * * * @author Erik C. Thauvin + * @see rife.render.DateTimeRfc2822 * @since 1.0 */ public class DateTimeRfc2822 implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/EncodeBase64.java b/lib/src/main/java/rife/render/EncodeBase64.java index 2b2557f..c5bd854 100644 --- a/lib/src/main/java/rife/render/EncodeBase64.java +++ b/lib/src/main/java/rife/render/EncodeBase64.java @@ -34,6 +34,7 @@ import java.nio.charset.StandardCharsets; * * * @author Erik C. Thauvin + * @see rife.render.EncodeBase64 * @see StringUtils#encodeBase64(byte[]) * @since 1.0 */ diff --git a/lib/src/main/java/rife/render/RenderUtils.java b/lib/src/main/java/rife/render/RenderUtils.java index ade9e9b..33a3e0f 100644 --- a/lib/src/main/java/rife/render/RenderUtils.java +++ b/lib/src/main/java/rife/render/RenderUtils.java @@ -123,10 +123,10 @@ public final class RenderUtils { /** * Returns the plural form of a word, if count > 1. * - * @param count the count. - * @param word the singular word. - * @param plural the plural word. - * @return the singular or plural string. + * @param count the count + * @param word the singular word + * @param plural the plural word + * @return the singular or plural String */ public static String plural(final long count, final String word, final String plural) { if (count > 1) { @@ -307,8 +307,8 @@ public final class RenderUtils { /** * Returns the formatted server uptime. * - * @param uptime the uptime in milliseconds. - * @param properties the format properties. + * @param uptime the uptime in milliseconds + * @param properties the format properties * @return The formatted uptime. */ public static String uptime(long uptime, Properties properties) { diff --git a/lib/src/main/java/rife/render/ShortenUrl.java b/lib/src/main/java/rife/render/ShortenUrl.java index 7b259bf..b52c686 100644 --- a/lib/src/main/java/rife/render/ShortenUrl.java +++ b/lib/src/main/java/rife/render/ShortenUrl.java @@ -33,6 +33,7 @@ import rife.template.ValueRenderer; * * * @author Erik C. Thauvin + * @see rife.render.ShortenUrl * @since 1.0 */ public class ShortenUrl implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/TimeIso.java b/lib/src/main/java/rife/render/TimeIso.java index 72f2973..275799c 100644 --- a/lib/src/main/java/rife/render/TimeIso.java +++ b/lib/src/main/java/rife/render/TimeIso.java @@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter; * * * @author Erik C. Thauvin + * @see rife.render.TimeIso * @since 1.0 */ public class TimeIso implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/Uptime.java b/lib/src/main/java/rife/render/Uptime.java index ee4dabc..1e62a90 100644 --- a/lib/src/main/java/rife/render/Uptime.java +++ b/lib/src/main/java/rife/render/Uptime.java @@ -28,8 +28,15 @@ import java.util.Properties; /** * Renders the server uptime. * - * @see rife.render.Uptime + *

Usage:

+ * + * 
+ *   <!--v render:rife.render.Uptime/-->
+ *   {{v render:rife.render.Uptime/}}
+ *
+ * * @author Erik C. Thauvin + * @see rife.render.Uptime * @since 1.0 */ public class Uptime implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/Year.java b/lib/src/main/java/rife/render/Year.java index 08279ec..6e53fb3 100644 --- a/lib/src/main/java/rife/render/Year.java +++ b/lib/src/main/java/rife/render/Year.java @@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter; * * * @author Erik C. Thauvin + * @see rife.render.Year * @since 1.0 */ public class Year implements ValueRenderer { diff --git a/lib/src/test/resources/templates/dateTimeUtc.html b/lib/src/test/resources/templates/dateTimeUtc.html index 1efff41..0cf020c 100644 --- a/lib/src/test/resources/templates/dateTimeUtc.html +++ b/lib/src/test/resources/templates/dateTimeUtc.html @@ -1,3 +1,3 @@ tz=UTC - \ No newline at end of file + \ No newline at end of file