qualipool / swissrets

A swiss real estate transaction standard
https://swissrets.ch
MIT License
26 stars 18 forks source link

HTML-Tags/Markdown for descriptions #173

Open lcaviezel opened 3 years ago

lcaviezel commented 3 years ago

Problem description The question is open as to whether portals support HTML tags or Markdown for formatting descriptive text. In the current documentation of SwissRETS (https://swissrets.ch/docs/noNamespace/element/export.properties.property.localizations.localization.html), only a string is required in this regard, which does not answer the open question.

<xs:element maxOccurs="1" minOccurs="0" name="description" type="xs:string">
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="location" type="xs:string">
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="equipment" type="xs:string">
</xs:element>

Desired Solution

  1. it should be clarified whether portals support such tags/markdown/text formatting at all.
  2. it should be clarified which tags exactly are accepted.
  3. the documentation should be adapted accordingly.
jensstalder commented 3 years ago

I was just thinking that it might be prudent to start thinking about a "Standards Recommendation" section. Things that can't be validated by xml due to technical restrictions - such as the one you mentioned - might be better discussed, agreed upan and documented in such a fassion. Unless there is a way to validate that within the schema which would be even better.