Skip to content
Permalink
Browse files

finish admin panel

  • Loading branch information...
devnewton committed Sep 13, 2018
1 parent 7daf00f commit d3ea542b499375fae5d444cb5f649c9b59d5f3c5
Showing with 30 additions and 6 deletions.
  1. +13 −6 README.md
  2. +13 −0 blueprints.yaml
  3. +4 −0 languages.yaml
@@ -1,8 +1,6 @@
# Tribune Plugin

**This README.md file should be modified to describe the features, installation, configuration, and general usage of this plugin.**

The **Tribune** Plugin is for [Grav CMS](http://github.com/getgrav/grav). Tribune/shoutbox/webchat plugin
The **Tribune** Plugin add simple tribune/shoutbox/webchat feature to [Grav CMS](http://github.com/getgrav/grav).

## Installation

@@ -38,19 +36,28 @@ Here is the default configuration and an explanation of available options:

```yaml
enabled: true
page: /tribune # Page where tribune will be visible
style: true # Use default CSS to style the tribune
timezone: Europe/Paris # Timezone for message timestamps (aka norloges)
maxPosts: 200 # History size
maxMessageLength: 1024 # Message size limit
maxLoginLength: 32 # Message's login size limit
maxInfoLength: 64 # Message's additionnal info size limit
maxLineLength: 2048 # Internal parameter that MUST be greater than sum of *Length options
```

Note that if you use the admin plugin, a file with your configuration, and named tribune.yaml will be saved in the `user/config/plugins/` folder once the configuration is saved in the admin.

## Usage

**Describe how to use the plugin.**
1. Create a page to show the tribune (default /tribune).
2. Enjoy !

## Credits

**Did you incorporate third-party code? Want to thank somebody?**
This plugin use [PEG.js](https://pegjs.org/) to parse and format message.

## To Do

- [ ] Future plans, if any
- [ ] Handle user login

@@ -37,3 +37,16 @@ form:
0: PLUGIN_TRIBUNE.STYLE_DISABLED
label: PLUGIN_TRIBUNE.STYLE_VARIABLE
help: PLUGIN_TRIBUNE.STYLE_VARIABLE_HELP
timezone:
type: text
default: "Europe/Paris"
label: PLUGIN_TRIBUNE.TIMEZONE_VARIABLE
help: PLUGIN_TRIBUNE.TIMEZONE_VARIABLE_HELP
maxPosts:
type: text
default: 200
validate:
type: number
min: 1
label: PLUGIN_TRIBUNE.MAXPOSTS_VARIABLE
help: PLUGIN_TRIBUNE.MAXPOSTS_VARIABLE_HELP
@@ -6,3 +6,7 @@ en:
STYLE_VARIABLE_HELP: Style tribune with default embedded CSS or not
STYLE_ENABLED: Default
STYLE_DISABLED: None
TIMEZONE_VARIABLE: Timezone
TIMEZONE_VARIABLE_HELP: Timezone for norloges
MAXPOSTS_VARIABLE: Max posts
MAXPOSTS_VARIABLE_HELP: Tribune history size

0 comments on commit d3ea542

Please sign in to comment.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.