Download the PHP package winter/wn-forum-plugin without Composer
On this page you can find all versions of the php package winter/wn-forum-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download winter/wn-forum-plugin
More information about winter/wn-forum-plugin
Files in winter/wn-forum-plugin
Package wn-forum-plugin
Short Description Forum plugin for Winter CMS
License MIT
Homepage https://github.com/wintercms/wn-forum-plugin
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package wn-forum-plugin
Forum Plugin
This plugin adds a simple embeddable forum to Winter CMS 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.
After installing the plugin you will need to run the migrations and (if you are using a public folder) republish your public directory.
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:
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"
==
<!-- This markup will never be displayed -->