show End in Calendar Config

[cweinhofer]

I’m wondering if there is some mistake in the Calendar config documentation. The documentation seems to refer to two options named showEnd, which I don’t believe is possible.

Also, it’s not really clear what this option does. In my thinking, “end time of events” would mean I would have “Jan 18th 16:30 - 17:30” instead of just “Jan 18th 16:30” and “end of a date” would mean “Jan 18th - 21st”

But this doesn’t seem to do either of those. It seems like it adds the time (with formatting determined by dateEndFormat) so that “Jan 18th” becomes “Jan 18th 16:30”.

Am I understanding this correctly? If so, I can put in a pull request to change the documentation.

[sdetweil]

@cweinhofer you can have it set globally for ALL calendars (above the calendars:[] list

OR you can set it in A calendar entry

      {  
          url:
          showEnd: true
      }

this is to show the end date/time of the event

without

event for tomorrow STARTS at 4pm
 
with 

event for tomorrow STARTS at 4pm and ENDS at 5pm

[cweinhofer]

Both of the things you mention make logical sense, but neither seem to work that way in real life.

when showEnd is set to false (or left blank, as false is defualt), the event only shows the day and not any time
when showEnd is set to true, the event shows the day and the start time
neither option seems to show the end time (or end day) of an event

and showEnd works when I set it in the global section, but does nothing when I add it to an individual calendar entry

Is your MM behaving differently then mine?

[sdetweil]

@cweinhofer AND you have to set timeFormat:‘absolute’

and u MAY have to change the getRelative and other settings…

way too many settings

config: {
				showEnd:true,
				timeFormat:"absolute",
				urgency:0,
				getRelative:0,

[cweinhofer]

I agree. The number of settings and their interrelatedness is a little overwhelming.

My config already has the other three settings

  {
    module: "calendar",
    position: "right",
    config: {
      maximumNumberOfDays: 2,
      displaySymbol: true,
      fetchInterval: 15 * 60 * 1000,
      fade: false,
      urgency: 0,
      timeFormat: "absolute",
      dateFormat: "ddd",
      fullDayEventDateFormat: "ddd",
      showEnd: true,
      getRelative: 0,
      showTimeToday: true,
      colored: false,
      calendars: [
      {
         url: "https://calendar.google.com/calendar/ical/   ...   /basic.ics",
         symbol: "c",
       },
       {
         url: "https://calendar.google.com/calendar/ical/   ...   /basic.ics",
         symbol: "j",
       },
       {
         url: "https://calendar.google.com/calendar/ical/   ...   /basic.ics",
         symbol: "t",
       },
     ],
   }
  },

** I deleted and reposted my entry from yesterday becuse I realized in my various testing I had left off one of the options. This is my actual config. **

[sdetweil]

@cweinhofer your dateFormat says only show date

[cweinhofer]

Thanks, @sdetweil That was the ticket.

From both the name of the option and the fact that the description and example don’t say anything about including a time format, I assumed this was not the place to set that.

I think I had even tried doing it at one point and it didn’t work – but I probably hadn’t tried it with urgency:0 and getRelative:0 set.

I’m going to put in a pull request to try to make this a little less confusing for others in the future. Can you tell me if this sounds okay?

CURRENT ENTRY

Format to use for the date of events when using absolute dates. (version <= 2.16.0) From version 2.16.0, this option will be used to format absolute and relative dates. (e.g. DD/MM/YY to change from the default MM/DD/YYYY)

Possible values: See Moment.js formats
Default value: MMM Do (e.g. Jan 18th)

PROPOSED CHANGE

Format to use for the date of events when using absolute dates. (version <= 2.16.0) From version 2.16.0, this option will be used to format absolute and relative dates. (e.g. DD/MM/YY to change from the default MM/DD/YYYY)

To show the event time along with the date, use a format like MMM Do HH:mm. Depending on configuration, may also require the options timeFormat:“absolute”, urgency:0, getRelative:0,

Possible values: See Moment.js formats
Default value: MMM Do (e.g. Jan 18th)

[sdetweil]

@cweinhofer its ok… who reads the doc?! lol…

like any other reference manual it leaves out a lot of detail.

someone could write 50-75 pages of explanation with matching output examples. but it would be a bear to maintain… as we still take changes to provide other formatting options…

(a recently submitted one wants to show ONLY the start date/time when the event duration is 0 and showEnd is true…)