[OASIS Issue Tracker] Commented: (TOSCA-77) Documentation attribute doesn't specify mime-type

[ http://tools.oasis-open.org/issues/browse/TOSCA-77?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=35337#action_35337 ] 

Paul Lipton  commented on TOSCA-77:
-----------------------------------

Stephane Maes volunteered to proxy this item and report back (17 Oct)

> Documentation attribute doesn't specify mime-type
> -------------------------------------------------
>
>                 Key: TOSCA-77
>                 URL: http://tools.oasis-open.org/issues/browse/TOSCA-77
>             Project: OASIS Topology and Orchestration Specification for Cloud Applications (TOSCA) TC
>          Issue Type: Improvement
>          Components: Spec
>    Affects Versions: V1.1_CSD01
>            Reporter: Travis Tripp
>            Priority: Minor
>             Fix For: V1.1_CSD01
>
>
> 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.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira