From 142adac7b2ac170400dc4d0591498032cd0664a8 Mon Sep 17 00:00:00 2001 From: HOS Date: Fri, 24 Jan 2025 16:51:49 +0100 Subject: [PATCH 1/2] Start --- chapters/annotations.tex | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/chapters/annotations.tex b/chapters/annotations.tex index b1daa4f8f..3167e64a7 100644 --- a/chapters/annotations.tex +++ b/chapters/annotations.tex @@ -139,7 +139,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 (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 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, including display math using a subset of \LaTeX. +For backwards compatibility non-HTML text can be rendered as is instead of as markdown. 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., From ece62183a0114c949ba011abe57e2a2d6818e857 Mon Sep 17 00:00:00 2001 From: HOS Date: Wed, 29 Jan 2025 10:26:47 +0100 Subject: [PATCH 2/2] Add reference for GitHub flavored markdown. --- chapters/annotations.tex | 2 +- mls.bib | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/chapters/annotations.tex b/chapters/annotations.tex index 3167e64a7..885dae953 100644 --- a/chapters/annotations.tex +++ b/chapters/annotations.tex @@ -140,7 +140,7 @@ \subsection{Class Description and Revision History}\label{annotation-info-revisi \end{nonnormative} 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, including display math using a subset of \LaTeX. +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. The HTML encoded content may contain links. For external links, see \cref{external-resources}. diff --git a/mls.bib b/mls.bib index a5de3e9e3..b1ac6c42d 100644 --- a/mls.bib +++ b/mls.bib @@ -101,3 +101,10 @@ @InProceedings{Buerger2019SelectiveModel address = {Regensburg, Germany}, url = {https://doi.org/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/}, +}