diff options
author | Karl Berry <karl@freefriends.org> | 2022-02-27 16:47:55 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-02-27 16:47:55 +0000 |
commit | 4b2d4c25ef033d6f3bd19e2f728691743a450685 (patch) | |
tree | c80d911cec744e2aa13b3fc24e4c3f9dcf6e7d70 /Master/texmf-dist/doc/latex/stex/packages | |
parent | eceb75dcb8e604edf3fbf7542164c8974618a32c (diff) |
stex (26feb22)
git-svn-id: svn://tug.org/texlive/trunk@62230 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/stex/packages')
16 files changed, 185 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-basics.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-basics.tex new file mode 100644 index 00000000000..daa6d6418d2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-basics.tex @@ -0,0 +1,16 @@ +Both the \pkg{stex} package and document class offer the following +options: + +\begin{description} + \item[\texttt{lang}] (\meta{language}$\ast$) Languages + to load with the \pkg{babel} package. + \item[\texttt{mathhub}] (\meta{directory}) MathHub folder + to search for repositories. + \item[\texttt{sms}] (\meta{boolean}) use \emph{persisted} + mode (not yet implemented). + \item[\texttt{image}] (\meta{boolean}) passed on to + \pkg{tikzinput}. + \item[\texttt{debug}] (\meta{log-prefix}$\ast$) Logs debugging + information with the given prefixes to the terminal, + or all if |all| is given. +\end{description}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-document-structure.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-document-structure.tex new file mode 100644 index 00000000000..1c8fe97dac2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-document-structure.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: document-structure documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-features.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-features.tex new file mode 100644 index 00000000000..e70bbaa0e84 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-features.tex @@ -0,0 +1,67 @@ +Given modules: + +\stexexample{ + \begin{smodule}{magma} + \symdef{universe}{\comp{\mathcal U}} + \symdef{operation}[args=2,op=\circ]{#1 \comp\circ #2} + \end{smodule} + \begin{smodule}{monoid} + \importmodule{magma} + \symdef{unit}{\comp e} + \end{smodule} + \begin{smodule}{group} + \importmodule{monoid} + \symdef{inverse}[args=1]{{#1}^{\comp{-1}}} + \end{smodule} +} + +We can form a module for \emph{rings} by ``cloning'' +an instance of |group| (for addition) and |monoid| (for multiplication), +respectively, and ``glueing them together'' to ensure they share the +same universe: + +\stexexample{ + \begin{smodule}{ring} + \begin{copymodule}{group}{addition} + \renamedecl[name=universe]{universe}{runiverse} + \renamedecl[name=plus]{operation}{rplus} + \renamedecl[name=zero]{unit}{rzero} + \renamedecl[name=uminus]{inverse}{ruminus} + \end{copymodule} + \notation*{rplus}[plus,op=+,prec=60]{#1 \comp+ #2} + %\setnotation{rplus}{plus} + \notation*{rzero}[zero]{\comp0} + %\setnotation{rzero}{zero} + \notation*{ruminus}[uminus,op=-]{\comp- #1} + %\setnotation{ruminus}{uminus} + \begin{copymodule}{monoid}{multiplication} + \assign{universe}{\runiverse} + \renamedecl[name=times]{operation}{rtimes} + \renamedecl[name=one]{unit}{rone} + \end{copymodule} + \notation*{rtimes}[cdot,op=\cdot,prec=50]{#1 \comp\cdot #2} + %\setnotation{rtimes}{cdot} + \notation*{rone}[one]{\comp1} + %\setnotation{rone}{one} + Test: $\rtimes a{\rplus c{\rtimes de}}$ + \end{smodule} +} + +\textcolor{red}{TODO: explain donotclone} + + +\stexexample{ + \begin{smodule}{int} + \symdef{Integers}{\comp{\mathbb Z}} + \symdef{plus}[args=2,op=+]{#1 \comp+ #2} + \symdef{zero}{\comp0} + \symdef{uminus}[args=1,op=-]{\comp-#1} + + \begin{interpretmodule}{group}{intisgroup} + \assign{universe}{\Integers} + \assign{operation}{\plus!} + \assign{unit}{\zero} + \assign{inverse}{\uminus!} + \end{interpretmodule} + \end{smodule} +}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-hwexam.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-hwexam.tex new file mode 100644 index 00000000000..5f1758b0150 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-hwexam.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: hwexam documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-inheritance.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-inheritance.tex new file mode 100644 index 00000000000..41631f94d27 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-inheritance.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: inheritance documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-mathhub.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-mathhub.tex new file mode 100644 index 00000000000..4b05134e70d --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-mathhub.tex @@ -0,0 +1,89 @@ +\begin{sfragment}{The Local MathHub-Directory} + |\usemodule|, |\importmodule|, |\inputref| etc. allow for + including content modularly without having to specify absolute + paths, which would differ between users and machines. Instead, + \sTeX uses \emph{archives} that determine the global + namespaces for symbols and statements and make it possible + for \sTeX to find content referenced via such URIs. + + All \sTeX archives need to exist in the local |MathHub|-directory. + \sTeX knows where this folder is via one of three means: + + \begin{enumerate} + \item If the \sTeX package is loaded with the option + |mathhub=/path/to/mathhub|, then \sTeX will consider + |/path/to/mathhub| as the local |MathHub|-directory. + \item If the |mathhub| package option is \emph{not} + set, but the macro |\mathhub| exists when the + \sTeX-package is loaded, then this macro is + assumed to point to the local |MathHub|-directory; i.e. + |\def\mathhub{/path/to/mathhub}\usepackage{stex}| + will set the |MathHub|-directory as |path/to/mathhub|. + \item Otherwise, \sTeX will attempt to retrieve the + system variable |MATHHUB|, assuming it will + point to the local |MathHub|-directory. Since this + variant needs setting up only \emph{once} and is + machine-specific (rather than defined in tex code), + it is compatible with collaborating and sharing tex + content, and hence recommended. + \end{enumerate} +\end{sfragment} + +\begin{sfragment}{The Structure of \sTeX Archives} + An \sTeX archive |group/name| needs to be stored in the + directory |/path/to/mathhub/group/name|; e.g. assuming your + local |MathHub|-directory is set as |/user/foo/MathHub|, then + in order for the |smglom/calculus|-archive to be found by the + \sTeX system, it needs to be in |/user/foo/MathHub/smglom/calculus|. + + Each such archive needs two subdirectories: + \begin{itemize} + \item |/source| -- this is where all your tex files go. + \item |/META-INF| -- a directory containing a single file + |MANIFEST.MF|, the content of which we will consider shortly + \end{itemize} + An additional |lib|-directory is optional, and is where \sTeX will + look for files included via |\libinput|. + + Additionally a \emph{group} of archives |group/name| may have + an additional archive |group/meta-inf|. If this |meta-inf|-archive + has a |/lib|-subdirectory, it too will be searched by |\libinput| + from all tex files in any archive in the |group/*|-group. +\end{sfragment} + +\begin{sfragment}{MANIFEST.MF-Files} + The |MANIFEST.MF| in the |META-INF|-directory consists of + key-value-pairs, instructing \sTeX (and associated software) + of various properties of an archive. For example, + the |MANIFEST.MF| of the |smglom/calculus|-archive looks like this: + + \begin{framed} + \begin{verbatim} + id: smglom/calculus + source-base: http://mathhub.info/smglom/calculus + narration-base: http://mathhub.info/smglom/calculus + dependencies: smglom/arithmetics,smglom/sets,smglom/topology, + smglom/mv,smglom/linear-algebra,smglom/algebra + responsible: Michael.Kohlhase@FAU.de + title: Elementary Calculus + teaser: Terminology for the mathematical study of change. + description: desc.html + \end{verbatim} + \end{framed} + + Many of these are in fact ignored by \sTeX, but some are important: + \begin{itemize} + \item[|id|:] The name of the archive, including its group (e.g. |smglom/calculus|), + \item[|source-base|] or + \item[|ns|:] The namespace from which all symbol and module URIs + in this repository are formed, see (\textcolor{red}{TODO}), + \item[|narration-base:|] The namespace from which all document + URIs in this repository are formed, see (\textcolor{red}{TODO}), + \item[|url-base|:] The URL that is formed as a basis for \emph{external references}, + see (\textcolor{red}{TODO}), + \item[|dependencies|:] All archives that this archive depends on. \sTeX ignores + this field, but \mmt can pick up on them to resolve dependencies, + e.g. for |lmh install|. + \end{itemize} + +\end{sfragment}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-metatheory.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-metatheory.tex new file mode 100644 index 00000000000..1585ba504c8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-metatheory.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: metatheory documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-modules.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-modules.tex new file mode 100644 index 00000000000..c067f28a1c3 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-modules.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: modules documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-problem.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-problem.tex new file mode 100644 index 00000000000..1ce5aaa3a23 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-problem.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: problem documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-proofs.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-proofs.tex new file mode 100644 index 00000000000..0523c65948d --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-proofs.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: sproofs documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-references.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-references.tex new file mode 100644 index 00000000000..bf8a8ed66c0 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-references.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: references documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-slides.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-slides.tex new file mode 100644 index 00000000000..1f9d0c989d6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-slides.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: notesslides documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-statements.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-statements.tex new file mode 100644 index 00000000000..aa9f5f76abf --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-statements.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: statements documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-symbols.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-symbols.tex new file mode 100644 index 00000000000..50b450a248f --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-symbols.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: symbols documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-terms.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-terms.tex new file mode 100644 index 00000000000..cc67ce0c7fc --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-terms.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: terms documentation}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/stex/packages/stex-tikzinput.tex b/Master/texmf-dist/doc/latex/stex/packages/stex-tikzinput.tex new file mode 100644 index 00000000000..fb7d0c1e5b2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/stex/packages/stex-tikzinput.tex @@ -0,0 +1 @@ +\textcolor{red}{TODO: tikzinput documentation}
\ No newline at end of file |