summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/stex/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/stex/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/stex/README.md52
1 files changed, 43 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/stex/README.md b/Master/texmf-dist/doc/latex/stex/README.md
index 13caa1f7342..b5eed1a41fa 100644
--- a/Master/texmf-dist/doc/latex/stex/README.md
+++ b/Master/texmf-dist/doc/latex/stex/README.md
@@ -3,8 +3,13 @@ sTeX: An Infrastructure for Semantic Preloading of LaTeX Documents
![CI Status](https://github.com/slatex/sTeX/workflows/CI/badge.svg)
This repository contains the sTeX package collection, a version of TeX/LaTeX that allows
-to markup TeX/LaTeX documents semantically without leaving the document format,
-essentially turning it into a document format for mathematical knowledge management (MKM).
+to markup TeX/LaTeX documents semantically without leaving the document format.
+
+Running `pdflatex` over sTeX-annotated documents formats them into normal-looking PDF. But
+sTeX also comes with a [conversion pipeline](https://github.com/slatex/RusTeX) into
+semantically annotated HTML5, which can host semantic added-value services that make the
+documents active (i.e. interactive and user-adaptive) and essentially turning LaTeX into a
+document format for (mathematical) knowledge management (MKM).
## Copyright & License
@@ -12,12 +17,41 @@ Copyright (c) 2022 Michael Kohlhase
The package is distributed under the terms of the LaTeX Project Public License (LPPL)
## Maintainers
-Michael Kohlhase, Dennis Müller, FAU Erlangen-Nürnberg.
+[Michael Kohlhase](https://kwarc.info/kohlhase), [Dennis Müller](https://kwarc.info/people/dmueller), FAU Erlangen-Nürnberg.
## Documentation
-See the
-[documentation of the sTeX package](https://github.com/slatex/sTeX/blob/main/doc/stex-doc.pdf)
-for details.
+The [sTeX manual ](https://github.com/slatex/sTeX/blob/main/doc/stex-manual.pdf) gives a
+general introduction and motivation. The
+[sTeX package documentation](https://github.com/slatex/sTeX/blob/main/doc/stex-doc.pdf)
+gives the details of the implementation. A complete list of sTeX-related publications can
+be found [here](https://kwarc.github.io/bibs/sTeX/).
+
+## sTeX Corpus & Best Practices
+
+sTeX comes with a large corpus of pre-annotated materials that act as evaluation grounds
+and regression tests for the sTeX functionality and best practices that are publicly
+available.
+* [HelloWorld](https://gl.mathhub.info/HelloWorld) a collection of simple hello world
+ examples the show off the best practices of sTeX annotation.
+* [SMGLoM](https://gl.mathhub.info/smglom), the Semantic, Multilingual Glossary of
+ Mathematics (and similar disciplines). SMGloM provides a large set of definitions and
+ well-designed semantic macros for core mathematical (and computation) concepts and
+ objects. This resource greatly facilitates "getting off the ground" in semantic
+ annotation.
+* [MiKoMH](https://gl.mathhub.info/MiKoMH) a set of semantically annotated courses in
+ computer science and (symbolic) AI (ca. 5000 pages of slides and notes). Ca. 3000
+ problem/solutions exist are only available upon request.
+* [sTeX3 Labs](https://gl.mathhub.info/sTeX) a set of experimental re-formalizations of
+ (mostly) [SMGLoM](https://gl.mathhub.info/smglom) material to fully take advantage of
+ the sTeX3 functionality and the
+ [rusTeX](https://github.com/slatex/RusTeX)/[MMT](https://uniformal.github.io) pipeline
+ and knowledge managemen facilities.
+
+All of these are hosted on [MathHub](https://mathhub.info), an experimental portal for the
+management of active mathematical documents and flexiformal mathematics. The organization
+of the material into "mathematical archives" (GIT repositories with a particular
+standardized structure on [a GitLab repository management server](https://gl.mathhub.info)
+greatly enhances modularization and the provision of added value services.
## Setup
@@ -31,10 +65,10 @@ Then update your `TEXINPUTS` environment variable, e.g. by placing the followin
export TEXINPUTS="$(TEXINPUTS):<sTeXDIR>//:
```
-Similarly, set your `MATHHUB` environment variable to where you intend to keep your sTeX archives. For details, see the documentation linked above.
+Similarly, set your `MATHHUB` environment variable to where you intend to keep your sTeX
+archives. For details, see the documentation linked above. For a LaTeX IDE, update the directory path where `pdflatex` looks for paths.
-For a LaTeX IDE, update the directory path where `pdflatex` looks for paths.
-For larger documents it may be necessary to enlarge the internal memory allocation of the TEX/LATEX executables. This can be done by adding the following configurations in `texmf.cnf` (or changing them, if they already exist).
+For larger documents it may (rarely) be necessary to enlarge the internal memory allocation of the TEX/LATEX executables. This can be done by adding the following configurations in `texmf.cnf` (or changing them, if they already exist).
```
param_size = 20000 % simultaneous macro parameters, also applies to MP
nest_size = 1000 % simultaneous semantic levels (e.g., groups)