summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/scontents/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/scontents/README.md')
-rw-r--r--macros/latex/contrib/scontents/README.md47
1 files changed, 30 insertions, 17 deletions
diff --git a/macros/latex/contrib/scontents/README.md b/macros/latex/contrib/scontents/README.md
index fe1c537bf1..95b0291960 100644
--- a/macros/latex/contrib/scontents/README.md
+++ b/macros/latex/contrib/scontents/README.md
@@ -1,42 +1,48 @@
## scontents — Stores LaTeX contents in memory or files
-- Version: 1.9
-- Date: 2020-01-21
-- Author: Pablo González
+
+Release v2.0 \[2022-04-04\]
## Description
+
This package allows to store `LaTeX` code, including _"verbatim"_, in <code>&lt;sequences&gt;</code>
using the `l3seq` module of `expl3`. The <code>&lt;stored content&gt;</code> can be used
as many times as desired in the document, additionally you can write to <code>&lt;external files&gt;</code>
or show it in <code>&lt;verbatim style&gt;</code>.
## Requirements
+
The package loads and depends on updated versions of:
- [expl3](https://ctan.org/pkg/expl3)
- [l3keys2e](https://ctan.org/pkg/l3keys2e)
-- [xparse](https://ctan.org/pkg/xparse)
## Installation
-The package `scontents` is present in `TeXLive` and `MiKTeX`, use the
+The package `scontents` is present in `TeX Live` and `MiKTeX`, use the
package manager to install.
-For manual installation, download `scontents.zip` and unzip it,
+For manual installation, download [scontents.zip](http://mirrors.ctan.org/macros/latex/contrib/scontents.zip) and unzip it,
then run:
+
```
-$ pdftex scontents.ins
+$ luatex scontents.ins
```
-and move all files to appropriate locations:
+
+Now the different files must be moved into the different directories in your
+installation `TDS` tree or in your `TEXMFHOME`:
+
```
- scontents.tex -> TDS:tex/generic/scontents/
- scontents-code.tex -> TDS:tex/generic/scontents/
- scontents.sty -> TDS:tex/latex/scontents/
- t-scontents.mkiv -> TDS:tex/context/third/scontents/
- scontents.pdf -> TDS:doc/latex/scontents/
- README.md -> TDS:doc/latex/scontents/
- scontents.dtx -> TDS:source/latex/scontents/
- scontents.ins -> TDS:source/latex/scontents/
+ scontents.tex -> TDS:tex/generic/scontents/scontents.tex
+ scontents-code.tex -> TDS:tex/generic/scontents/scontents-code.tex
+ scontents.sty -> TDS:tex/latex/scontents/scontents.sty
+ t-scontents.mkiv -> TDS:tex/context/third/scontents/t-scontents.mkiv
+ scontents.pdf -> TDS:doc/latex/scontents/scontents.pdf
+ scontents.dtx -> TDS:source/latex/scontents/scontents.dtx
+ scontents.ins -> TDS:source/latex/scontents/scontents.ins
```
-then run `mktexlsr`.
+
+then run `mktexlsr`. To produce the documentation with source code run `luatex scontents.ins` and
+`lualatex scontents.dtx` three times.
+
## Examples
The file <code>&lt;scontents.pdf&gt;</code> contains attached examples, which can be extracted
@@ -45,14 +51,21 @@ from the PDF viewer or from the command line by running:
```
$ pdfdetach -saveall scontents.pdf
```
+
and then you can use the excellent `arara` tool to compile them.
## License
+
The scontents package may be modified and distributed under the terms and
conditions of the [LaTeX Project Public License](https://www.latex-project.org/lppl/), version 1.3c or greater.
## Contents
+
- README.md (this file)
- scontents.pdf (documentation)
- scontents.dtx (master file that produced all files)
- scontents.ins (installer to extract all files)
+
+## Author and copyright
+
+Copyright 2019-2022 by Pablo González L.