From d6011ecd569ab7a4cf2cac3c5d7ca96d46f2ca6e Mon Sep 17 00:00:00 2001 From: Miguel Angel Reina Ortega <miguelangel.reinaortega@etsi.org> Date: Wed, 27 Nov 2024 09:12:08 +0000 Subject: [PATCH] Adding formulas and equations clause --- Specification drafting guidelines.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/Specification drafting guidelines.md b/Specification drafting guidelines.md index d21d390..8521866 100644 --- a/Specification drafting guidelines.md +++ b/Specification drafting guidelines.md @@ -44,17 +44,26 @@ width is justified E.g. + |Title 1|**Title 2**|Title 3| + |-|-|-| + |Row 1 Cell 1|Row 1 Cell 2|Row 1 Cell 3| + |Row 2 Cell 1|Row 2 Cell 2|Row 2 Cell 3| + + Rendered view: + |Title 1|**Title 2**|Title 3| |-|-|-| |Row 1 Cell 1|Row 1 Cell 2|Row 1 Cell 3| |Row 2 Cell 1|Row 2 Cell 2|Row 2 Cell 3| + + 2. Grid tables. This kind of tables can be used for complex tables where merge cells are needed. Grid tables use separator lines between data rows (header and body). Separator lines are composed of "+" symbols and "-" or "=" between the "+" symbols. "="s are used to separate header and body. Columns MUST be aligned, meaning that position of "+" must be the same for every separator line, unless merged columns are being used. Body rows are defined as pipe tables rows, by using "|" to separate cells. However, separator lines can be defined for certain columns, which make possible to define merge cells. -E.g. +E.g. +------------+------------+------------+ |Title 1 |__Title 2__ |Title 3 | @@ -89,7 +98,19 @@ More detailed information can be found at [Pandoc documentation](https://pandoc. Diagrams can be specified by using UML diagrams. The recommendation is to generate the PlantUML diagram image by using any PlantUML online servers ([ETSI PlantUML server](http://tools.etsi.org/plant)), and adding both the source code (.puml) and the image files to the media folder. Then, the diagram can be added as a normal figure as described at [Figures](#-figures). -## Equations +## Formulas and Equations + +Formulas and equations can be specified using LaTeX syntax within the markdown specification. Formulas **shall be surrounded** by "$" symbol for inline formulas or "$$" for display formulas. + + $$My formula$$ + + E.g. + + $\left[\int_{-infty}^{\infty} f(x) \; dx\right]$ + +$$\left[\int_{-infty}^{\infty} f(x) \; dx\right]$$ + +More detailed information about formulas (operators, symbols, equations, ...) can be found at [LaTeX documentation](https://en.wikibooks.org/wiki/LaTeX/Mathematics) ## Anchors -- GitLab