Documentation attribute doesn't specify mime-type

XMLWordPrintable

    • Type: Improvement
    • Resolution: Unresolved
    • Priority: Minor
    • V1.1_CSD01
    • Affects Version/s: V1.1_CSD01
    • Component/s: Spec
    • None
    • Hide

      At the most simple, consider adding an optional contentType attribute to indicate the type of content so that processors will know how to render it. For example: contentType="text/html" or contentType="text/plain"

      <xs:attribute name="contentType" type="xs:string"/>

      Show
      At the most simple, consider adding an optional contentType attribute to indicate the type of content so that processors will know how to render it. For example: contentType="text/html" or contentType="text/plain" <xs:attribute name="contentType" type="xs:string"/>

      The documentation element has the following description:

      "All TOSCA elements MAY use the documentation element to provide annnotation for users. The content could be a plain text, HTML, and so on."

      There is no standard way for a processor to know how to interpret / display the documentation. Just directly embedding any kind of content could be problematic for visually rendering the documentation. Or course, it would likely be entity escaped text or have a nested CDATA section if it is HTML, however the processor should be given a clue on the format of the embedded documentation.

            Assignee:
            Unassigned
            Reporter:
            Travis Tripp (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated: