diff options
author | Thomas Lange <code@nerdmind.de> | 2021-07-10 22:35:37 +0200 |
---|---|---|
committer | Thomas Lange <code@nerdmind.de> | 2021-07-10 22:35:37 +0200 |
commit | ec8b209f8e078835029d90930d6c1305cd5b8743 (patch) | |
tree | aff0e49b89c7683c0eaf093dc0487e5450e5adf3 | |
parent | 4490330658ffa05f3709c078224c4607acf0b4bd (diff) | |
download | wiki-ec8b209f8e078835029d90930d6c1305cd5b8743.tar.gz wiki-ec8b209f8e078835029d90930d6c1305cd5b8743.tar.xz wiki-ec8b209f8e078835029d90930d6c1305cd5b8743.zip |
Update documentation
-rw-r--r-- | Configuration.md | 3 | ||||
-rw-r--r-- | Templates.md | 15 |
2 files changed, 3 insertions, 15 deletions
diff --git a/Configuration.md b/Configuration.md index bb10918..7f7a98d 100644 --- a/Configuration.md +++ b/Configuration.md @@ -79,7 +79,6 @@ Number of items to display per-site on overview sites. Number of items to display within the RSS feed. * `PAGE.FEED_SIZE`: [integer: `25`] -* `POST.FEED_SIZE`: [integer: `25`] ## Slug URLs Enable or disable the use of slug URLs for item permalinks. If disabled, the unique primary item ID is used instead. @@ -137,11 +136,9 @@ The `ORDER BY` clause for item sorting within the RSS feed. You can use each col **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'`] ## Feed `<guid>` hash Item attributes (database columns) to use to generate the `<guid>` value for the RSS feed items. -* `PAGE.FEED_GUID`: [array: `['id', 'time_insert']`] * `POST.FEED_GUID`: [array: `['id', 'time_insert']`]
\ No newline at end of file diff --git a/Templates.md b/Templates.md index 841287f..d27d5ac 100644 --- a/Templates.md +++ b/Templates.md @@ -8,8 +8,7 @@ │ │ ├── list.php │ │ └── main.php │ ├── feed - │ │ ├── item_page.php - │ │ ├── item_post.php + │ │ ├── item.php │ │ └── main.php │ ├── home.php │ ├── main.php @@ -212,17 +211,9 @@ Contains the site navigation for post, page and user list (and for the home temp ## Feed Template `html/feed/main.php` Basic framework of the RSS feed in XML which contains a list of page and post items: -* `$FEED['TYPE']`: Contains a string if a feed for a specific item group is requested (either `post` or `page`) -* `$FEED['LIST']['POSTS']`: Contains a list of post items (or is empty when the "pages-only" feed is requested) -* `$FEED['LIST']['PAGES']`: Contains a list of page items (or is empty when the "posts-only" feed is requested) - -## Feed Item Template [page] `html/feed/item_page.php` -Represents a single page to display within the feed template. - -* `$PAGE`: [See reference for `@PAGE`] -* `$USER`: [See reference for `@USER`] +* `$FEED['LIST']['POSTS']`: Contains a list of post items -## Feed Item Template [post] `html/feed/item_post.php` +## Feed Item Template `html/feed/item.php` Represents a single post to display within the feed template. * `$POST`: [See reference for `@POST`] |