Clarify HTML encoded contents. (modelica#2672)

* Clarify HTML encoded contents. Closes modelica#2593
henrikt-ma · Oct 8, 2020 · 162c7fd · 162c7fd
1 parent 55c8131
commit 162c7fd
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/chapters/annotations.tex b/chapters/annotations.tex
@@ -49,10 +49,12 @@ \section{Annotations for Documentation}\label{annotations-for-documentation}
 giving a textual description, the \lstinline!revisions! annotation giving a list
 of revisions and other annotations defined by a tool.
 How the tool interprets the information in \lstinline!Documentation! is
-unspecified. Within a string of the \lstinline!Documentation! annotation, the
-tags \lstinline!<HTML>! and \lstinline!</HTML>! or
-\lstinline!<html>! and \lstinline!</html>! define
-optionally begin and end of content that is HTML encoded. For external
+unspecified. If the string starts with the tag
+\lstinline!<html>! or \lstinline!<HTML>! the entire string is HTML encoded
+(and is assumed to end with \lstinline!</html>! or \lstinline!</HTML>! and shall
+be rendered as HTML even if the end-tags are missing),
+otherwise the entire string is rendered as is.
+The HTML encoded content may contain links. For external
 links see \cref{external-resources}. Links to Modelica classes may be defined with
 the HTML link command using scheme \lstinline!Modelica!
 (using its lower case form in the URI, see \cref{external-resources}), e.g.,