diff options
| author | Thomas Lange <code@nerdmind.de> | 2021-05-21 15:49:05 +0200 |
|---|---|---|
| committer | Thomas Lange <code@nerdmind.de> | 2021-05-21 15:49:05 +0200 |
| commit | 923a14c764a7f5939f74bd284b7d1f92df781ca2 (patch) | |
| tree | b19373dc89f9e1e20cb184cfabf5c770d41c42c9 /Configuration.md | |
| parent | d7fa3b949171785c8efb130cd2e90daf33f02c1a (diff) | |
| download | wiki-923a14c764a7f5939f74bd284b7d1f92df781ca2.tar.gz wiki-923a14c764a7f5939f74bd284b7d1f92df781ca2.tar.xz wiki-923a14c764a7f5939f74bd284b7d1f92df781ca2.zip | |
Optimize text
Diffstat (limited to 'Configuration.md')
| -rw-r--r-- | Configuration.md | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/Configuration.md b/Configuration.md index d2f1996..e964745 100644 --- a/Configuration.md +++ b/Configuration.md @@ -1,17 +1,29 @@ -This document describes the available configuration settings from the `configuration.php` file in more detail. +This document describes the available configuration settings of the `configuration.php` file in more detail. ## Language configuration -This is the core language which will be used. A corresponding language file **must exists** within `core/language/`. Currently are only `en` and `de` supported. If you are a translator, please only use the original `en` language file for your translation and open a pull request on GitHub or send your language file via email to `code@nerdmind.de`! +This is the core language which will be used. A corresponding language file **must exists** within `core/language/`. Currently only `en` and `de` are supported. If you are a translator, please only use the original `en` language file for your translation and open a pull request on GitHub or send your language file via email to `code@nerdmind.de`! * `CORE.LANGUAGE`: [string: `'en'`] ## ETag configuration -If this parameter is set to `TRUE`, the system will generate an `ETag` response header which includes a hash of the timestamps from the last created / edited items and sends him to the client. The client will cache this header and sends him with each further request in the request header back to the application. If the hash, which the appplication now creates again, is not the same as the one from the request header (which means that no new items have been published and no existing item have been edited), the application exit and returns the `304 Not Modified` response header to reduce server load and traffic. +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. + +**Application sends `ETag` header:** +~~~ +ETag: "241d9ec9cb7526853698590929f06ae9-gzip" +~~~ + +**Client sends `If-None-Match` header on next request:** +~~~ +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`: [boolean: `TRUE`|`FALSE`] ## Blog informations -Meta informations about your custom blog installation. 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. +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. * `BLOGMETA.NAME`: [string: `'My Techblog'`] * `BLOGMETA.DESC`: [string: `'[a creative description]'`] @@ -20,7 +32,7 @@ Meta informations about your custom blog installation. Note that `BLOGMETA.LANG` * `BLOGMETA.LANG`: [string: `'en'`] ## Database -Database and hostname with login credentials to authenticate to the MariaDB or MySQL server. +Database and hostname with login credentials to authenticate to the MariaDB/MySQL server. * `DATABASE.HOSTNAME`: [string: `'localhost'`] * `DATABASE.BASENAME`: [string: `'niceblog'`] @@ -67,7 +79,7 @@ Enable or disable the use of slug URLs for item permalinks. If disabled, the uni * `USER.SLUG_URLS`: [boolean: `TRUE`|`FALSE`] ## Single redirects -Enable or disable the redirection from the overviews to the items main page if only one item of the specific type exists. For example, if you only have one user and `USER.SINGLE_REDIRECT` is set to `TRUE`, then requests to `/user/` will be automatically redirected to `/user/username/`. +Enable or disable the redirection from the overviews to the items main page if only one item of the specific type exists. For example, if you only have one user and `USER.SINGLE_REDIRECT` is set to `TRUE`, then requests to `/user/` will be automatically redirected to `/user/username/` or `/user/id/`. * `PAGE.SINGLE_REDIRECT`: [boolean: `TRUE`|`FALSE`] * `POST.SINGLE_REDIRECT`: [boolean: `TRUE`|`FALSE`] @@ -81,30 +93,30 @@ Item base directories relative to your base directory where the application is i * `USER.DIRECTORY`: [string: `'user'`] ## Emoticons -Enable or disable parsing of emoticons for the body of the item. +Enable or disable parsing of emoticons for the body of the specific item type. * `PAGE.EMOTICONS`: [boolean: `TRUE`|`FALSE`] * `POST.EMOTICONS`: [boolean: `TRUE`|`FALSE`] * `USER.EMOTICONS`: [boolean: `TRUE`|`FALSE`] ## `<meta>` description -Number of characters from the items content to display within the `<meta>` description. +Number of characters of the items content to display within the `<meta>` description. * `PAGE.DESCRIPTION_SIZE`: [integer: `200`] * `POST.DESCRIPTION_SIZE`: [integer: `200`] * `USER.DESCRIPTION_SIZE`: [integer: `200`] ## Item overview sorting -The `ORDER BY` clause for item sorting on item overview sites. You can use each column from the database table to sort and you also can combine multiple columns together. See the [MySQL documentation for `ORDER BY`](https://dev.mysql.com/doc/refman/5.6/en/sorting-rows.html) for more information. +The `ORDER BY` clause for item sorting on item overview sites. You can use each column from the database table to sort and you also can combine multiple columns together. See the [MySQL documentation for `ORDER BY`](https://dev.mysql.com/doc/refman/5.6/en/sorting-rows.html) for more instructions. * `PAGE.LIST_SORT`: [string: `'time_insert DESC'`] * `POST.LIST_SORT`: [string: `'time_insert DESC'`] * `USER.LIST_SORT`: [string: `'time_insert DESC'`] ## Feed sorting -The `ORDER BY` clause for item sorting within the RSS feed. You can use each column from the database table to sort and you also can combine multiple columns together. See the [MySQL documentation for `ORDER BY`](https://dev.mysql.com/doc/refman/5.6/en/sorting-rows.html) for more information. +The `ORDER BY` clause for item sorting within the RSS feed. You can use each column from the database table to sort and you also can combine multiple columns together. See the [MySQL documentation for `ORDER BY`](https://dev.mysql.com/doc/refman/5.6/en/sorting-rows.html) for more instructions. -**Note:** It depends on the RSS reader how the content is sorted. The settings here are only for the sorting of the content in the raw XML source code, but it is nevertheless a good idea to sort them as they shall appear in the RSS reader. +**Note:** It depends on the RSS reader how the content is sorted. The settings here are only for the sorting of the content **in the raw XML** source code, but it is nevertheless a good idea to sort them in the order as they shall appear in the RSS reader. * `PAGE.FEED_SORT`: [string: `'time_insert DESC'`] * `POST.FEED_SORT`: [string: `'time_insert DESC'`] |