Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wintercms/wn-forum-plugin
Forum plugin for Winter CMS
https://github.com/wintercms/wn-forum-plugin
hacktoberfest
Last synced: about 1 month ago
JSON representation
Forum plugin for Winter CMS
- Host: GitHub
- URL: https://github.com/wintercms/wn-forum-plugin
- Owner: wintercms
- License: mit
- Created: 2021-03-06T05:16:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T17:35:12.000Z (9 months ago)
- Last Synced: 2024-04-14T04:55:43.955Z (8 months ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 463 KB
- Stars: 5
- Watchers: 5
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wintercms - Winter.Forum - Robust forum platform. (Uncategorized / Uncategorized)
README
# Forum Plugin
[](https://github.com/wintercms/wn-forum-plugin/blob/main/LICENSE)
This plugin adds a simple embeddable forum to [Winter CMS](https://wintercms.com) websites.
A video demonstration of this plugin can be seen here:
https://vimeo.com/97088926
Supports:
- Topics
- Channels
- Members
- Posts
- RSS Feeds
## Installation
This plugin is available for installation via [Composer](http://getcomposer.org/).
```bash
composer require winter/wn-forum-plugin
```
After installing the plugin you will need to run the migrations and (if you are using a [public folder](https://wintercms.com/docs/develop/docs/setup/configuration#using-a-public-folder)) [republish your public directory](https://wintercms.com/docs/develop/docs/console/setup-maintenance#mirror-public-files).
```bash
php artisan migrate
```
## Configuration
The forum does not require immediate configuration to operate. However the following options are available.
* Forum categories (Channels) can be managed via the System > Channels menu.
* Forum members can be managed via the User menu.
## Displaying a list of channels
The plugin includes a component forumChannels that should be used as the main page for your forum. Add the component to your page and render it with the component tag:
```php
{% component 'forumChannels' %}
```
You should tell this component about the other forum pages.
* **channelPage** - the page used for viewing an individual channel's topics.
* **topicPage** - the page used for viewing a discussion topic and posts.
* **memberPage** - the page used for viewing a forum user.
### RSS feed
Use the `forumRssFeed` component to display an RSS feed containing the latest blog posts. The following properties are supported:
* **channelFilter** - a channel slug to filter the topics by. If left blank, all topics are displayed.
* **topicsPerPage** - how many topics to display on the feed. The default value is 20.
* **forumPage** - path to the main forum page.
* **topicPage** - path to the topic details page.
The component can be used on any page, it will hijack the entire page cycle to display the feed in RSS format. The next example shows how to use it:
title = "RSS Feed"
url = "/forum/rss.xml"
[forumRssFeed]
forumPage = "forum"
topicPage = "forum/topic"
==
## Example page structure
#### forum/home.htm
```
title = "Forum"
url = "/forum"
layout = "default"
[forumChannels]
memberPage = "forum/member"
channelPage = "forum/channel"
topicPage = "forum/topic"
==
Forum
{% component 'forumChannels' %}
```
#### forum/channel.htm
```
title = "Forum"
url = "/forum/channel/:slug"
layout = "default"
[forumChannel]
memberPage = "forum/member"
topicPage = "forum/topic"
==
{{ channel.title }}
{% component 'forumChannel' %}
```
#### forum/topic.htm
```
title = "Forum"
url = "/forum/topic/:slug"
layout = "default"
[forumTopic]
memberPage = "forum/member"
channelPage = "forum/channel"
==
{{ topic.subject }}
{% component 'forumTopic' %}
```
#### forum/member.htm
```
title = "Forum"
url = "/forum/member/:slug"
layout = "default"
[forumMember]
channelPage = "forum/channel"
topicPage = "forum/topic"
==
{{ member.username }}
{% component 'forumMember' %}
```