Discrepancy with $this->date between EventReader and EventList

[fritzmg]

All the event templates use the variable $this->date. However, the Event modules do not fill this variable with the same values. While the EventList module fills this variable with just the date, e.g. 2015-09-14 the EventReader module on the other hand fills this variable with the date wrapped within an HTML <time> tag, e.g.

<time datetime="2016-05-23T00:00:00+02:00">2016-05-23</time>

So, if you select the default event_list template in the EventReader (for whatever reason) it will produce invalid HTML:

<h2><a href="" title="The Contao NRW-Day (<time datetime="2016-05-23T00:00:00+02:00">2016-05-23</time>)"></a></h2>

This is also reproducible in the Contao Online Demo.

The reason why the EventReader module produces a different value for $this->date is probably because the default event_full template has this line in it:

<p class="info"><?= $this->date ?></p>

which in the end will produce

<p class="info"><time datetime="2016-05-23T00:00:00+02:00">2016-05-23</time></p>

But in the teaser and list template, the variable is used within the title attribute of the link.

See also 3.5.3 Event Reader zeigt nur Teaserinhalt und seltsame Zeichen

[leofeyer]

Although this is easy to fix, I wonder if the problem will ever really occur. If you chose any event_ template but event_full in the event reader module, the output will be broken anyway (e.g. the href attribute will be empty, there will be no link text etc.).

[leofeyer]

@contao/developers /cc

[aschempp]

Unifying the templates would certainly be a good thing, but I wouldn't consider this a bugfix…

[leofeyer]

It is a bugfix without a doubt. The question is if this case will ever really occur, because if you chose any event_ template but event_full in the event reader module, the output will be broken anyway (e.g. the href attribute will be empty, there will be no link text etc.).

[aschempp]

That's what I mean. Fixing the date only does not make sense for the moment. Adjusting the reader and list so all templates work with all modules makes sense, but I would not consider that a bugfix.

[leofeyer]

Adjusting the reader and list so all templates work with all modules makes sense

It does not make sense at all, because a list template has different requirements than a reader template!

[aschempp]

In my opinion both show an event. Maybe people want to show the full event details in a list.

[Toflar]

Maybe people want to show the full event details in a list.

Happened often to me.

[leofeyer]

I it really happened often, you would have noticed that it is not possible :)

[fritzmg]

@Toflar @aschempp The problem isn't using the event_full template in an event list (this won't cause any invalid html at least), but the other way around.

However, I also think it's very rare that someone wants to use the event_list template in the event reader.

I would consider it a known limitation right now and maybe fix it for Contao 5?

[aschempp]

I it really happened often, you would have noticed that it is not possible :)

Well one just needs to rewrite the template in that case. Guess we always did that :D

[leofeyer]

Guess we always did that :D

No, I guess you never had this case before. See @fritzmg's comment to understand which case we are discussing:

use the event_list template in the event reader.

[leofeyer]

Fixed in a6c674f.

[xchs]

How do we handle date ranges (e.g. 25/11/2015 – 30/11/2015)? We might want to mark up the date/time with two separate <time> elements:

<time datetime="2015-11-25">25/11/2015</time> – <time datetime="2015-11-30">30/11/2015</time>

[leofeyer]

That would be wrong, because the <time> tag indicates the start date of an event. Only schema.org allows to distinguish between itemprop="startDate" and itemprop="endDate".

[aschempp]

Hmm: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/time

This element is intended to be used presenting dates and times in a machine readable format. This can be helpful for user agents to offer any event scheduling for user's calendar.

I can't see any reason why it should not be used multiple times?

[leofeyer]

It can be used multiple times but it should not be used for both the event start date and end date without additional markup such as schema.org.

[aschempp]

Ok, so how about we add that markup? Would make sense anyway?

[leofeyer]

Yes, but that's a separate ticket then (feature request in https://github.com/contao/calendar-bundle). We will have to add some more variables to the template and move all of this logic to the template. Not nice but possible.