Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discourse/discourse-calendar
Adds the ability to create a dynamic calendar in the first post of a topic.
https://github.com/discourse/discourse-calendar
discourse discourse-plugin
Last synced: 18 days ago
JSON representation
Adds the ability to create a dynamic calendar in the first post of a topic.
- Host: GitHub
- URL: https://github.com/discourse/discourse-calendar
- Owner: discourse
- License: mit
- Created: 2018-09-17T14:48:07.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T14:31:30.000Z (about 1 month ago)
- Last Synced: 2024-10-29T17:48:47.352Z (about 1 month ago)
- Topics: discourse, discourse-plugin
- Language: Ruby
- Homepage:
- Size: 3.12 MB
- Stars: 62
- Watchers: 19
- Forks: 52
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - discourse/discourse-calendar - Adds the ability to create a dynamic calendar in the first post of a topic. (Ruby)
README
# Discourse Calendar
Adds the ability to create a dynamic calendar in the first post of a topic.
Topic discussing the plugin itself can be found here: [https://meta.discourse.org/t/discourse-calendar/97376](https://meta.discourse.org/t/discourse-calendar/97376)
## Customization
### Events
- `discourse_post_event_event_will_start` this DiscourseEvent will be triggered one hour before an event starts
- `discourse_post_event_event_started` this DiscourseEvent will be triggered when an event starts
- `discourse_post_event_event_ended` this DiscourseEvent will be triggered when an event ends
### Custom Fields
Custom fields can be set in plugin settings. Once added a new form will appear on event UI.
These custom fields are available when a plugin event is triggered.
### Holidays
See an incorrect or missing holiday? Familiarize yourself with the [holiday definition Syntax](vendor/holidays/definitions/doc/SYNTAX.md). Then make your updates in the `vendor/holiday/definitions` directory.
Generate updated holidays as follows.
```sh
cd vendor/holidays
# Generate holiday definitions
rake generate:definitions
```
Install the plugin and switch to the discourse root(not the plugin directory).
```sh
# Collect all holiday regions into assets/javascripts/lib/regions.js
bin/rails javascript:update_constants
```
### Interactions with Other Plugins
You can use an element of this plugin with the [Right Sidebar Blocks](https://github.com/discourse/discourse-right-sidebar-blocks) component. You'll want to ensure the desired route is enabled via the `events calendar categories` setting. In Right Sidebar Block's settings, the block name will be `upcoming-events-list`, and the params use this [syntax](https://momentjs.com/docs/#/displaying/format/), for example `MMMM D, YYYY`.