Event template suggestions

[hamishwillee]

MDN documents events using a standard interface page for the object that describes one or more events, and specific pages for each event derived from the interface.

1. I think we should require that the interface page for an event lists the events that it is used in. Some event pages do this already, but it is not formalised or done in a standard way.

   I was thinking we should add a additional section ## Event instances to these pages as a peer of the Syntax section.

   Note, I thought perhaps just "Events" but that is apparently used to indicate events fired at an interface.

2. The events themselves are supposed to match the API_event_subpage_template.

   I propose that we remove the Event properties section from this template.
   My reasoning is that it duplicates the interface data, to no real value.

[Josh-Cena]

For 2: mdn/content#18700

[hamishwillee]

Ha ha. I was "for" keeping the event properties in mdn/content#18700 but I am against now.

I see both arguments. I'm leaning this way because I think it is confusing messaging to have the interface and the properties here.

[wbamberg]

I think we should require that the interface page for an event lists the events that it is used in. Some event pages do this already, but it is not formalised or done in a standard way.

So do you mean, for instance, BackgroundFetchEvent should reference backgroundfetchclick and backgroundfetchabort? But BackgroundFetchEvent derives from ExtendableEvent, should that page link to these events as well? And that derives from Event, should that page also link there? It seems like either way the list for Event would be huge and hard to maintain.

Or am I misunderstanding you?

I propose that we remove the Event properties section from this template.

+1. I argued about this ages ago but can't find the thread any more. We don't do this for anything else, why do it for events?

[hamishwillee]

That is exactly what I am suggesting for the event properties. Created mdn/content#44393 to see if I can get more interest.

[hamishwillee]

The change to the template was accepted. I'm going to just be thankful for that. Will remove the sections as soon as I can. Closing this discussion.