Adds the ability to create a dynamic calendar in the first post of a topic.
Go to file
benj 57fa918858
Adds plugin outlet to events list (#601)
2024-08-22 15:39:34 -05:00
.github/workflows DEV: Update CI workflows (#376) 2023-01-10 18:03:55 +00:00
app FEATURE: closed events (#564) 2024-05-14 10:12:47 +02:00
assets Adds plugin outlet to events list (#601) 2024-08-22 15:39:34 -05:00
config Update translations (#595) 2024-08-13 16:31:09 +02:00
db/migrate FEATURE: closed events (#564) 2024-05-14 10:12:47 +02:00
jobs FIX: delete future holidays on region change (#571) 2024-05-21 16:46:07 +02:00
lib FEATURE: closed events (#564) 2024-05-14 10:12:47 +02:00
public/javascripts DEV: more explicit filename 2018-12-27 19:48:30 +01:00
spec DEV: fix flakey post event spec (#596) 2024-08-08 15:44:22 -04:00
test/javascripts FIX: show events calendar on category page irrespective of query params (#565) 2024-05-14 15:13:55 +05:30
vendor/holidays Update Canada Civic Holiday (#594) 2024-08-02 09:40:09 -07:00
.discourse-compatibility DEV: Pin plugin for Discourse < 3.4.0.beta1-dev (#592) 2024-08-02 17:04:52 +08:00
.eslintrc.cjs DEV: update eslint, prettier and template-lint (#465) 2023-10-30 16:39:54 -03:00
.gitignore DEV: Clean up the plugin (#426) 2023-08-01 22:32:30 +02:00
.prettierignore DEV: Update eslint-config-discourse, use prettier for hbs (#365) 2023-01-04 13:44:33 +01:00
.prettierrc.cjs DEV: update eslint, prettier and template-lint (#465) 2023-10-30 16:39:54 -03:00
.rubocop.yml DEV: Introduce syntax_tree for ruby formatting (#363) 2022-12-29 13:30:41 +01:00
.streerc FEATURE: customizable event colors by tags and adjustable max rows in calendar (#482) 2023-12-01 10:10:34 -04:00
.template-lintrc.cjs DEV: Update linting (#491) 2023-11-29 18:31:03 +01:00
Gemfile DEV: Update linting (#491) 2023-11-29 18:31:03 +01:00
Gemfile.lock Bump rexml from 3.2.8 to 3.3.3 (#593) 2024-08-05 13:19:38 +02:00
LICENSE first commit 2018-06-06 15:24:56 +02:00
README.md Update README.md (#598) 2024-08-12 20:26:56 -04:00
package.json DEV: Update rubocop-discourse to version 3.8.0 (#576) 2024-05-28 11:15:47 +02:00
plugin.rb PERF: removed N*2+1 in availability topic (#599) 2024-08-14 18:11:24 +02:00
translator.yml DEV: Add Crowdin support (#84) 2020-12-22 13:08:54 +01:00
yarn.lock Bump braces from 3.0.2 to 3.0.3 (#583) 2024-06-16 22:30:15 +02:00

README.md

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

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. Then make your updates in the vendor/holiday/definitions directory.

Generate updated holidays as follows.

cd vendor/holidays

# Generate holiday definitions
rake generate:definitions

Install the plugin and switch to the discourse root(not the plugin directory).

# 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 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, for example MMMM D, YYYY.