Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clean up use of quote symbols (#2508)
This fixes most of #2364 (carefully avoiding wording that would trigger GitHub action). Summary of what this PR aims to cover: - No upright quotes should appear outside of code snippets (`lstlisting` and `lstinline`). - No quotes around inline code. - Use `\lstinline` instead of quotes for inline code. - Use `\emph` when there is a need to remind that something has a special meaning in the context of the specification (when the thing was introduced, it should have been marked with `\firstuse`, see below). - Titles of publications, chapters, and sections in `\emph` instead of quotes. - Use matching pairs of double quotes (“conceptual”) when using a word or phrase that is intentionally vague, lacking proper definition, or otherwise calls for the reader's imagination. - Single quotes around single special characters where needed to get more clear separation from surrounding text. Example (somewhat damaged by GitHub's font): > …there is an operator ‘`0`’ defining the zero-value - Filenames in `\filename` (pretty big risk of not having found all occurrences). - Use of `\firstuse` instead of `\emph` when a term is introduced (pretty big risk of not having found all occurrences). - Use of the `example` and `nonnormative` environments whenever possible with at most minimal changes to content, in order to avoid misuse of interleaved fragments in `\emph`, making the source code maintainable, avoiding lots of tiny errors in the markup, and correcting many places where formatting was missing between the `\emph` fragments. Parts of #2364 not covered by this PR: - Proper handling of references. - Cleanup inside non-normative text that couldn't be converted to use the `nonnormative` environment due to not being a stand alone sequence of paragraphs. This requires #2368. Minor changes: * Clean up use of ``...'' * Clean up related to " being used outside of code snippets * Use \filename to markup some filenames * Get rid of some meaningless uses of \textbf * Improve markup in simple cases of non-normative text and examples * More cleanup, with special attention to single quotes * Typesetting \filename with \textsf instead of \textit * Remove forgotten \emph inside nonnormative * Say 'stronger requirement than being balanced' * Remove LaTeX source comment replaced by #2510 * Don't write math-like equation as Modelica source listing * Use \emph instead of \lstinline for 'platform' in context of LibraryDirectory * Wrap 'enabled' in \emph instead of \lstinline * Add double quotes around fragment of inline code when explaining multiple iterators * Use '\textgreater{} 2' instead of '$> 2$' * Write ="Hz" inside \lstinline instead of just 'Hz' * Write \lstinline!unit="s"! instead of 'unit \emph{s}' * Fix quoting of opening parenthesis character * Use \filename instead of \lstinline for some modelica URIs * Fix encoding of backslashes inside \filename * Fix matching of single quotes * Say \lstinline!'+'! instead of just \lstinline!+! when speaking of operator overloading * Say 'positive edge of' instead of 'when ... becomes ...' * Wrap content of \filename in \mbox to prevent hyphenation from injecting hyphens Co-authored-by: HansOlsson <hans.olsson@3ds.com>
- Loading branch information