diff --git a/chapters/annotations.tex b/chapters/annotations.tex index 03003ff12..7b8f450a6 100644 --- a/chapters/annotations.tex +++ b/chapters/annotations.tex @@ -163,8 +163,9 @@ \subsection{Class Description and Revision History}\label{annotation-info-revisi The \lstinline!revisions! documentation may be omitted in printed documentation. \end{nonnormative} -If the string starts with the tag \lstinline!! or \lstinline!!, the entire string is HTML encoded (assumed to end with \lstinline!! or \lstinline!!, but to be rendered as HTML even if the end-tag is missing). -Otherwise, the entire string is rendered as is. +If the string starts with the tag \lstinline!! or \lstinline!! the entire string is HTML encoded (and is assumed to end with \lstinline!! or \lstinline!! and shall be rendered as HTML even if the end-tags are missing). +Otherwise the entire string is seen as GitHub flavored markdown \textcite{GitHubFlavoredMarkdown}, including display math using a subset of \LaTeX. +For backwards compatibility non-HTML text can be rendered as is instead of as markdown. HTML encoded content may contain links. Modelica URIs may be used to refer to external resources (see \cref{external-resources}), as well as to refer to Modelica classes, e.g., \begin{lstlisting}[language=modelica] diff --git a/mls.bib b/mls.bib index 9266d1b55..0cb806299 100644 --- a/mls.bib +++ b/mls.bib @@ -102,3 +102,10 @@ @InProceedings{Buerger2019SelectiveModel address = {Regensburg, Germany}, doi = {10.3384/ecp19157277}, } + +@Manual{GitHubFlavoredMarkdown, + author = {MacFarlane, John and others}, + title = {GitHub Flavored Markdown Spec, Version 0.29-gfm}, + year = {2019}, + url = {https://github.github.com/gfm/}, +}