From 98de5dbf81c9e414fd932d68dd6ec65e61963cf6 Mon Sep 17 00:00:00 2001
From: Philip Bergmann <philip.bergmann@uni-wuerzburg.de>
Date: Mon, 22 Jul 2024 15:51:57 +0200
Subject: [PATCH] add hints about text within math mode

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 1ef31bf..5745dba 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,15 @@ It must be included as follows:
 - All symbols that appear in equations (or elsewhere) must be properly explained.
 - Symbol usage must be consistent throughout your writeup, e.g. don't use `x(t)` to refer to the baseband and the passband signal.
 
+#### Text Within Math Mode
+Note: Fonts and text rendering with or without LaTeX is seemingly pretty complicated, so some terms might not be 100% correct. The main goal of this section is however to avoid writing text in math mode, and I think for that it's sufficient ;) It applies as written when using the default font setup (serif / roman fonts)
+
+- Sub- and superscripts that are not variables, i.e. are not stand-ins for numbers/expressions, shall be set upright in the math font family, e.g. `\mathrm{word}`. Examples:
+    - if you have the radius of the Earth as `R_E`, the `E` shall not be cursive, because it does not replace something else (it's a name), so write `R_\mathrm{E}`
+    - set the summation index cursive (that is, without any special markup): `\sum_{i=1}^{N} x_i` (the `_i` shall be replaced by 1, 2, ..., N and is therefore a variable that is set cursive)
+- Words or abbreviations in equations that still act as symbols are set upright in the math font family, e.g. `\mathrm{velocity} = \frac{\mathrm{distance}}{\mathrm{time}}`. This also applies to subscripts, etc. Please note that `\mathrm` is very limited and does e.g. not support (i.e. eat) spaces.
+- `\text{your text here}` is used when actual text is needed in math mode, e.g. in a `cases` environment with `\text{if\ } x >0` or `\text{otherwise}`
+
 ### Units and Quantities
 - When writing quantities, use a package like `siunitx` (if possible) - then you don't have to deal with the typography yourself.
 - Prefer quantity equations (equations that remain valid independent of the units, e.g. `\lambda = c / f`) and make sure the units work out. Avoid numerical-value equations (equations that depend on the quantities being expressed in specific units, e.g. `\lambda in m = 300 / f in MHz`). If numerical-value equations are required or very common, give the quantity equation beforehand.
-- 
GitLab