Added more links to the wiki documentation
This commit is contained in:
parent
a3063eee07
commit
b27b0965af
13 changed files with 57 additions and 41 deletions
24
README.md
24
README.md
|
|
@ -11,19 +11,19 @@ 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.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` | 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 |
|
||||
| [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.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 |
|
||||
|
|
@ -36,17 +36,17 @@ This project provides a collection of template renderers.
|
|||
## 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.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.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 |
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ import java.time.ZonedDateTime;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.BeatTime">rife.render.BeatTime</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class BeatTime implements ValueRenderer {
|
||||
|
|
|
|||
|
|
@ -32,6 +32,7 @@ import rife.tools.Localization;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Capitalize">rife.render.Capitalize</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class Capitalize implements ValueRenderer {
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateIso">rife.render.DateIso</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class DateIso implements ValueRenderer {
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@ import java.util.Properties;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateTimeIso">rife.render.DateTimeIso</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class DateTimeIso implements ValueRenderer {
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateTimeRfc2822">rife.render.DateTimeRfc2822</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class DateTimeRfc2822 implements ValueRenderer {
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ import java.nio.charset.StandardCharsets;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeBase64">rife.render.EncodeBase64</a>
|
||||
* @see StringUtils#encodeBase64(byte[])
|
||||
* @since 1.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ import rife.template.ValueRenderer;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.ShortenUrl">rife.render.ShortenUrl</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class ShortenUrl implements ValueRenderer {
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.TimeIso">rife.render.TimeIso</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class TimeIso implements ValueRenderer {
|
||||
|
|
|
|||
|
|
@ -28,8 +28,15 @@ import java.util.Properties;
|
|||
/**
|
||||
* Renders the server uptime.
|
||||
*
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Uptime">rife.render.Uptime</a>
|
||||
* <p>Usage:</p>
|
||||
*
|
||||
* <pre>
|
||||
* <!--v render:rife.render.Uptime/-->
|
||||
* {{v render:rife.render.Uptime/}}
|
||||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Uptime">rife.render.Uptime</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class Uptime implements ValueRenderer {
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter;
|
|||
* </pre>
|
||||
*
|
||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.rennder.Year">rife.render.Year</a>
|
||||
* @since 1.0
|
||||
*/
|
||||
public class Year implements ValueRenderer {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue