Add a documentation about matrices (ForNeVeR#100)

B3zaleel · Aug 19, 2019 · 3d700b1 · 3d700b1
1 parent 2f3e330
commit 3d700b1
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -85,10 +85,11 @@ You may also pass your own `IElementRenderer` implementation to `TexFormula.Rend
 Documentation
 -------------
 
-- [How to prepare `DefaultTexFont.xml` from the font file][docs-prepare-font]
-
+- [Matrices and Matrix-Like Constructs][docs-matrices]
 - [How to improve blurred formulas][docs-blurred-text-issue]
 
+- [How to prepare `DefaultTexFont.xml` from the font file][docs-prepare-font]
+
 - [Licensing history][docs-licensing-history]
 
 Build and Maintenance Instructions
@@ -133,6 +134,7 @@ We're very grateful to JMathTeX authors for their work and allowing to redistrib
 [docs-prepare-font]: docs/prepare-font.md
 [docs-blurred-text-issue]: docs/blurred-text-issue.md
 [docs-licensing-history]: docs/licensing-history.md
+[docs-matrices]: docs/matrices.md
 [example]: WpfMath.Example/
 [fonts]: src/WpfMath/Fonts/
 [license]: LICENSE.md

diff --git a/WpfMath.sln b/WpfMath.sln
@@ -29,6 +29,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{39669369-C
 	ProjectSection(SolutionItems) = preProject
 		docs\example-screenshot.png = docs\example-screenshot.png
 		docs\licensing-history.md = docs\licensing-history.md
+		docs\blurred-text-issue.md = docs\blurred-text-issue.md
+		docs\cleartype.png = docs\cleartype.png
+		docs\default.png = docs\default.png
+		docs\matrices.md = docs\matrices.md
+		docs\prepare-font.md = docs\prepare-font.md
 	EndProjectSection
 EndProject
 Global

diff --git a/docs/matrices.md b/docs/matrices.md
@@ -0,0 +1,26 @@
+Matrices and Matrix-Like Constructs
+===================================
+
+WPF-Math supports multiple types of matrices and similar constructs (that allow to build the items into rows and columns).
+
+All commands offer a similar syntax, but a bit different features. Rows inside of a matrix are separated by two commands:
+
+- `\cr`
+- `\\`
+
+Cells inside of a row are separated by `&`.
+
+For example, the following command creates a matrix with 2 rows and 3 columns:
+
+```
+\matrix{1 & 2 & 3 \\ 4 & 5 & 6}
+```
+
+There're two matrix types supported:
+
+- `\matrix`: a matrix without brackets
+- `\pmatrix`: a matrix within square brackets
+
+There's also a matrix-like construct:
+
+- `\cases`: for piecewise functions etc