diff options
author | Karl Berry <karl@freefriends.org> | 2015-09-22 22:26:18 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-09-22 22:26:18 +0000 |
commit | aa040bf06e9ffb30895fc92178a8f1aa44fda1de (patch) | |
tree | 468f61c3dca995cdd41e9ff4ecc6ae1dd3d0b294 /Master/texmf-dist/doc/latex/unravel/README.md | |
parent | f1f4767bbed8d529512166e9ebc17c398bf22888 (diff) |
unravel (22sep15)
git-svn-id: svn://tug.org/texlive/trunk@38435 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/unravel/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/unravel/README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/unravel/README.md b/Master/texmf-dist/doc/latex/unravel/README.md new file mode 100644 index 00000000000..bc25d285c38 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unravel/README.md @@ -0,0 +1,36 @@ +unravel: Watching TeX digest tokens +==================================================== +* E-mail: blflatex@gmail.com +* Released under the LaTeX Project Public License v1.3c or later + See http://www.latex-project.org/lppl.txt + +The `unravel` LaTeX package provides tools to explore TeX code, +performing expansion and assignments step by step. + +TeX is a strange beast. Its eyes read files, making characters +into tokens. Its mouth then chews tokens, expanding them if +possible, namely, expanding user-defined macros, or conditionals, +etc. When meeting a so called 'unexpandable' token, TeX's +stomach comes into play, performing assignments, or moving boxes +around, eventually typesetting the result thanks to its great +line- and page-breaking algorithms. + +All of this is interleaved, and difficult to follow. Of course, +one can always use `\tracingall`, but the result is... messy. +This package is an attempt to replicate how TeX digests tokens, +and to make the process easier to follow. Namely, +`\unravel{\some\tokens}` will let you go through expansions and +assignments performed by TeX upon seeing of `\some\tokens`, +step by step. + +Some parts of TeX are not covered. In particular, category codes +are fixed for the whole argument of `\unravel` when it is read. + +This package requires up-to-date versions of the `l3kernel`, +`l3packages` and `l3experimental` bundles. + +The package is extracted by running `pdflatex unravel.ins`. +For the documentation, run `pdflatex unravel.dtx` twice. + +This is work in progress, all suggestions/comments/bug reports +are welcome! See https://github.com/blefloch/latex-unravel/ |