Please better document the Discourse Calendar plugin

Continuing the discussion from Discourse Calendar — since my post there is about to get auto-deleted after a month.

The top post describing this plugin needs some work. It’s really confusing. Specifically:

Event Confusion

There seem to be three separate things all called “event”:

  1. Most basic: a reply with a [date] , which gets shown in a calendar in the first post in the topic.
  2. A first-post-in topic which contains [event], used by the optional “alpha state” feature separately described here.
  3. A completely separate plugin with a similar name: Events instead of Event.

That’s… confusing.

Unclear syntax for the basic single-topic event

  1. How does one set the name of the event? The plugin description shows text with events, but not how that actually got set.
  2. How does one create repeating events?
  3. The holiday calendar shows colors. Can the regular calendar have colors too, and if so, how?
  4. The separate “events” feature can apparently produce an ical feed. Can a “basic” calendar?

More questions about the holiday calendar

Does that use the same syntax as the per-topic calendar, or the “event” one? Is it limited to “staff holidays”, or could it be used by anyone who can reply to a given topic? Where do the colors come from? Is the :desert_island: “Holiday flair” emoji changeable? Is it possible to make that visible to anyone, or to some arbitrary group, not just staff?

Etc…

Some of this I’ve figured out on my own or by asking support. But it really needs to be documented in the plugin documentation topic.

It would probably also be good to spell out some of the limitations, too — week-start-date doesn’t follow your locale and isnt’ configurable, the whole thing is confused about timezones… and if there’s a roadmap or plans to address some of these things or add new features (or if there isn’t!), please say that as well.

Thank you! This is a nifty little Discourse feature which could be super-useful to a lot of people, but it’s also pretty confusing.

3 Likes

That post is a wiki - so you can make your own contributions to it easily. That would be very helpful for all.

5 Likes

I can, although some things will just be guesses!

2 Likes