use of summary #45

New issue

ruru4143 · 2024-09-29T14:57:19+02:00

ruru4143 commented

2024-09-29 14:57:19 +02:00

Current state of the activitypub network on the `summary` property

W3C wiki has a list of html properties which should be supported in the summary property. <li>/<ul> are not in the list
- it also states that it should not be longer than one paragraph
Gancio and Mobilizon are using the property for place and name.
Mastodon uses summary for Content Warnings

In our plugin

Event has a get_summary() method which generates a quite long summary using a unordered list and maybe includes the whole content.

My suggestion

I would either do what Gancio and Mobilizon is doing or the wordpress excerpt if available.

### Current state of the activitypub network on the `summary` property - [W3C wiki](https://www.w3.org/wiki/ActivityPub/Primer/HTML) has a list of html properties which should be supported in the `summary` property. `<li>`/`<ul>` are not in the list - it also states that it should not be longer than one paragraph - [Gancio](https://github.com/lesion/gancio/blob/gh/server/api/models/event.js#L51) and [Mobilizon](https://framagit.org/framasoft/mobilizon/-/blob/main/lib/federation/activity_stream/converter/event.ex#L357) are using the property for place and name. - Mastodon uses summary for Content Warnings ### In our plugin `Event` has a `get_summary()` method which generates a quite long summary using a unordered list and maybe includes the whole content. ### My suggestion I would either do what Gancio and Mobilizon is doing or the wordpress excerpt if available.

linos commented

2024-09-29 16:19:26 +02:00

I agree the summary should be short, maybe even the content should not be included at all. The list was just an example of what could be done. These are just guidances! If we have good reasons to compose our summary different, we can. This could also likely be a settings, controlled via templates and shortcodes.

Some implementations like Misskey/Sharkey seem not to allow summaries longer than 512 characters.

Proposal:

Information that summary should contain:

Event status if canceled
Start Time
Location

Information that summary could contain:

End Time
Categories/Tags

Anything else?

I agree the summary should be short, maybe even the content should not be included at all. The list was just an example of what could be done. These are just guidances! If we have good reasons to compose our summary different, we can. This could also likely be a settings, controlled via templates and shortcodes. Some implementations like Misskey/Sharkey seem not to allow summaries longer than 512 characters. Proposal: Information that summary should contain: - Event status if canceled - Start Time - Location Information that summary could contain: - End Time - Categories/Tags Anything else?

Sign in to join this conversation.