summaryrefslogtreecommitdiffstats
path: root/Configuration.md
diff options
context:
space:
mode:
authorThomas Lange <code@nerdmind.de>2021-07-01 22:12:51 +0200
committerThomas Lange <code@nerdmind.de>2021-07-01 23:13:51 +0200
commit4490330658ffa05f3709c078224c4607acf0b4bd (patch)
treeac47987e08cab3e0d004ddd2f3f3bff65e59a7fb /Configuration.md
parent5f62e251b85c9e5b9c64423c829f25137970484a (diff)
downloadwiki-4490330658ffa05f3709c078224c4607acf0b4bd.tar.gz
wiki-4490330658ffa05f3709c078224c4607acf0b4bd.tar.xz
wiki-4490330658ffa05f3709c078224c4607acf0b4bd.zip
Add documentation for category system
Diffstat (limited to 'Configuration.md')
-rw-r--r--Configuration.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/Configuration.md b/Configuration.md
index 6928db9..bb10918 100644
--- a/Configuration.md
+++ b/Configuration.md
@@ -66,9 +66,11 @@ Protocol, hostname and base directory of your installation.
## List size
Number of items to display per-site on overview sites.
+* `CATEGORY.LIST_SIZE`: [integer: `10`]
* `PAGE.LIST_SIZE`: [integer: `10`]
* `POST.LIST_SIZE`: [integer: `10`]
* `USER.LIST_SIZE`: [integer: `10`]
+* `ADMIN.CATEGORY.LIST_SIZE`: [integer: `12`]
* `ADMIN.PAGE.LIST_SIZE`: [integer: `12`]
* `ADMIN.POST.LIST_SIZE`: [integer: `12`]
* `ADMIN.USER.LIST_SIZE`: [integer: `10`]
@@ -82,6 +84,7 @@ 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`]
@@ -89,6 +92,7 @@ Enable or disable the use of slug URLs for item permalinks. If disabled, the uni
## 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/` or `/user/id/`.
+* `CATEGORY.SINGLE_REDIRECT`: [bool: `TRUE`|`FALSE`]
* `PAGE.SINGLE_REDIRECT`: [bool: `TRUE`|`FALSE`]
* `POST.SINGLE_REDIRECT`: [bool: `TRUE`|`FALSE`]
* `USER.SINGLE_REDIRECT`: [bool: `TRUE`|`FALSE`]
@@ -96,6 +100,7 @@ Enable or disable the redirection from the overviews to the items main page if o
## Directories
Item base directories relative to your base directory where the application is installed.
+* `CATEGORY.DIRECTORY`: [string: `'category'`]
* `PAGE.DIRECTORY`: [string: `'page'`]
* `POST.DIRECTORY`: [string: `'post'`]
* `USER.DIRECTORY`: [string: `'user'`]
@@ -103,6 +108,7 @@ Item base directories relative to your base directory where the application is i
## Emoticons
Enable or disable parsing of emoticons for the body of the specific item type.
+* `CATEGORY.EMOTICONS`: [bool: `TRUE`|`FALSE`]
* `PAGE.EMOTICONS`: [bool: `TRUE`|`FALSE`]
* `POST.EMOTICONS`: [bool: `TRUE`|`FALSE`]
* `USER.EMOTICONS`: [bool: `TRUE`|`FALSE`]
@@ -110,6 +116,7 @@ Enable or disable parsing of emoticons for the body of the specific item type.
## `<meta>` description
Number of characters of the items content to display within the `<meta>` description.
+* `CATEGORY.DESCRIPTION_SIZE`: [integer: `200`]
* `PAGE.DESCRIPTION_SIZE`: [integer: `200`]
* `POST.DESCRIPTION_SIZE`: [integer: `200`]
* `USER.DESCRIPTION_SIZE`: [integer: `200`]
@@ -117,6 +124,7 @@ Number of characters of the items content to display within the `<meta>` descrip
## 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 instructions.
+* `CATEGORY.LIST_SORT`: [string: `'name ASC'`] This option is currently used only for the list sorting of child categories in a category!
* `PAGE.LIST_SORT`: [string: `'time_insert DESC'`]
* `POST.LIST_SORT`: [string: `'time_insert DESC'`]
* `USER.LIST_SORT`: [string: `'time_insert DESC'`]