formattedDescription about modelling-opportunity-data HOT 3 OPEN

One issue we're going to have here is that we have a number of different descriptive properties: description, attendeeInstructions, meetingPoint, accessibilitySupport, accessibilityInformation all of which could reasonably include markup that might be useful to users. So we need to agree on a pattern for doing this.

Rather than multiply properties, I'd suggest that these properties should only be plain text, to support their use in the widest possible range of environments where markup might not be useful. Related content like videos and images can already be referenced as media.

This also avoids setting expectations with data publishers that their data will be consistently formatted and displayed everywhere, avoids potential issues with broken markup and embedded styles, as well as security loopholes (a consuming application should sanitise this type of markup before displaying to users).

from modelling-opportunity-data.

Perhaps supporting markdown or similar is a halfway house on this? The challenge we have is that publishers often want to include hyperlinks and bullet points in their descriptions. Though most publishers store rich text in HTML format, so they'll all need to use HTML -> Markdown libraries to achieve this...

from modelling-opportunity-data.

Updating this issue to match the common use of the beta:formattedDescription property: this beta property must contain HTML. See clarification commit: openactive/ns-beta@05223d2.

from modelling-opportunity-data.