diff options
| -rw-r--r-- | Arguments.md | 6 | ||||
| -rw-r--r-- | Configuration.md | 26 |
2 files changed, 16 insertions, 16 deletions
diff --git a/Arguments.md b/Arguments.md index 801adba..47bb93a 100644 --- a/Arguments.md +++ b/Arguments.md @@ -1,6 +1,6 @@ This document explains how to use the optional field for arguments in the content editor. This field can contain a list of arguments as key or key/value pairs formatted as follows: -`FOO=value|BAR=value` (or `FOO=value|BAR`; `BAR` will be automatically set to `TRUE`). +`FOO=value|BAR=value` (or `FOO=value|BAR`; `BAR` will be automatically set to `true`). ## How to access arguments in a template Lets assume that your argument string for a specific post is something like this: @@ -23,7 +23,7 @@ You can now access the entire (unparsed) argument string in templates with `$POS } ## How this arguments can be used to do something special -If you are a template developer, you can check within your templates if the argument `HIGHLIGHT` is present (arguments with no explicit value will be automatically set to boolean `TRUE`). If set, you can highlight this post differently. Just check if this value is set and add an extra CSS class to your HTML markup which then will highlight your post. +If you are a template developer, you can check within your templates if the argument `HIGHLIGHT` is present (arguments with no explicit value will be automatically set to boolean `true`). If set, you can highlight this post differently. Just check if this value is set and add an extra CSS class to your HTML markup which then will highlight your post. You can even add a preview image functionality. Lets assume you want to show a preview image for each post in the list? There is no core functionality to do this, but with the argument functionality you can do this very simple: @@ -35,4 +35,4 @@ You can even add a preview image functionality. Lets assume you want to show a p Each argument key (the part before the `=`) must only contain letters from `A-Z`, `a-z`, `0-9` and underscores (`_`)! ## Conclusion -The use cases of these arguments are practically unlimited. Please note that the templates of the `default` theme are not using any arguments provided in the argument field. It is up **to you** whether you implement this in your own template to do something special or not!
\ No newline at end of file +The use cases of these arguments are practically unlimited. Please note that the templates of the `default` theme are not using any arguments provided in the argument field. It is up **to you** whether you implement this in your own template to do something special or not! diff --git a/Configuration.md b/Configuration.md index b019041..088d20f 100644 --- a/Configuration.md +++ b/Configuration.md @@ -6,7 +6,7 @@ This is the core language which will be used. A corresponding language file **mu * `CORE.LANGUAGE`: [string: `'en'`] ## ETag configuration -If `CORE.SEND_304` is set to `TRUE`, the application generates an `ETag` response header on each request which consists of a hash value based on the timestamps of the last created/edited items. The client will cache this information and sends it with the next request (inside the request header `If-None-Match`) back to the application. +If `CORE.SEND_304` is `true`, the application generates an `ETag` response header on each request which consists of a hash value based on the timestamps of the last created/edited items. The client will cache this information and sends it with the next request (inside the request header `If-None-Match`) back to the application. **Application sends `ETag` header:** ~~~ @@ -20,7 +20,7 @@ If-None-Match: "241d9ec9cb7526853698590929f06ae9-gzip" The application now calculates again a hash value of the last created/edited items and compares it to the hash of the `If-None-Match` request header which was sent by the client. If these two hash values are **the same**, then obviously no new items have been created/edited since the last request by the client. Therefore, the application immediately exits and returns the `304 Not Modified` HTTP response status. -* `CORE.SEND_304`: [bool: `TRUE`|`FALSE`] +* `CORE.SEND_304`: [bool: `true`|`false`] ## Blog informations Meta informations about your custom blog installation. Please note that `BLOGMETA.LANG` is not the system language! It is the language in which **your content** is written and is useful for the `lang` attribute on the `<html>` tag within the template. It depends on the template whether this variable is used or not. @@ -42,7 +42,7 @@ Database and hostname with login credentials to authenticate to the MariaDB/MySQ ## Migrator Enable or disable the Migrator which checks for outstanding database schema migrations. -* `MIGRATOR.ENABLED`: [bool: `TRUE`|`FALSE`] +* `MIGRATOR.ENABLED`: [bool: `true`|`false`] ## Backend Settings for the administration area. A corresponding language file **must exists** within the template directory of the template defined by `ADMIN.TEMPLATE`! @@ -83,18 +83,18 @@ Number of items to display within the RSS feed. ## Slug URLs Enable or disable the use of slug URLs for item permalinks. If disabled, the unique primary item ID is used instead. -* `CATEGORY.SLUG_URLS`: [bool: `TRUE`|`FALSE`] -* `PAGE.SLUG_URLS`: [bool: `TRUE`|`FALSE`] -* `POST.SLUG_URLS`: [bool: `TRUE`|`FALSE`] -* `USER.SLUG_URLS`: [bool: `TRUE`|`FALSE`] +* `CATEGORY.SLUG_URLS`: [bool: `true`|`false`] +* `PAGE.SLUG_URLS`: [bool: `true`|`false`] +* `POST.SLUG_URLS`: [bool: `true`|`false`] +* `USER.SLUG_URLS`: [bool: `true`|`false`] ## Redirect single items -Enable or disable the redirection from the overviews to the items primary page if only one item of the specific type exists. For example, if you only have one user and `USER.REDIRECT_SINGLE` is set to `TRUE`, requests to `/user/` will be automatically `302`-redirected to `/user/username/` (or `/user/id/`). +Enable or disable the redirection from the overviews to the items primary page if only one item of the specific type exists. For example, if you only have one user and `USER.REDIRECT_SINGLE` is `true`, requests to `/user/` will be automatically `302`-redirected to `/user/username/` (or `/user/id/`). -* `CATEGORY.REDIRECT_SINGLE`: [bool: `TRUE`|`FALSE`] -* `PAGE.REDIRECT_SINGLE`: [bool: `TRUE`|`FALSE`] -* `POST.REDIRECT_SINGLE`: [bool: `TRUE`|`FALSE`] -* `USER.REDIRECT_SINGLE`: [bool: `TRUE`|`FALSE`] +* `CATEGORY.REDIRECT_SINGLE`: [bool: `true`|`false`] +* `PAGE.REDIRECT_SINGLE`: [bool: `true`|`false`] +* `POST.REDIRECT_SINGLE`: [bool: `true`|`false`] +* `USER.REDIRECT_SINGLE`: [bool: `true`|`false`] ## Directories Item base directories relative to your base directory where the application is installed. @@ -107,7 +107,7 @@ Item base directories relative to your base directory where the application is i ## Emoticon descriptions Enable or disable the wrapping of emoticons found in the content of an item into a `<span>` element which contains a further description of the emoticon within the `title` attribute. -* `WRAP_EMOTICONS`: [bool: `TRUE`|`FALSE`] +* `WRAP_EMOTICONS`: [bool: `true`|`false`] ## `<meta>` description Number of characters of the items content to display within the `<meta>` description. |