Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pablgonz/scontents

Stores LaTeX content in memory or files
https://github.com/pablgonz/scontents

expl3 latex

Last synced: about 2 months ago
JSON representation

Stores LaTeX content in memory or files

Awesome Lists containing this project

README

        

## scontents — Stores LaTeX contents in memory or files
![GitHub release (latest by date)](https://img.shields.io/github/v/release/pablgonz/scontents?label=version)
![GitHub Release Date](https://img.shields.io/github/release-date/pablgonz/scontents)
![GitHub last commit](https://img.shields.io/github/last-commit/pablgonz/scontents)

## Description

This package allows to store `LaTeX` code, including _"verbatim"_, in ⟨sequences⟩
using the `l3seq` module of `expl3`. The <stored content> can be used
as many times as desired in the document, additionally you can write to <external files>
or show it in <verbatim style>.

## Requirements

The package loads and depends on updated versions of:
- [expl3](https://ctan.org/pkg/expl3)
- [latex-base](https://www.ctan.org/pkg/latex-base)

## Installation

The package `scontents` is present in `TeX Live` and `MiKTeX`, use the
package manager to install.

For manual installation, download [scontents.zip](http://mirrors.ctan.org/macros/latex/contrib/scontents.zip) and unzip it,
then run:

```
$ luatex scontents.ins
```

and move all files to appropriate locations:

```
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`. To produce the documentation with source code run `luatex scontents.ins` and
`lualatex scontents.dtx` three times.

## Examples

The file <scontents.pdf> contains attached examples, which can be extracted
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.

## Development

The version numbers and dates are guaranteed to be correct in
the repository is in the `l3build` configuration file `build.lua`.

The date format (`pkgdate`) is `YYYY-MM-DD`. If it is important to you
that the files created have the correct version and date, you should run
`l3build tag` before any other build-related task.

`scontents` utilizes the `l3build` system. You can run:

- `l3build unpack` to extract the code files into the directory `build/unpacked/`.
- `l3build doc` to build the documentation.
- `l3build install` put all files in your `TEXMFHOME`.
- `l3build uninstall` will remove them.
- `l3build testpkg` to test files.
- `l3build examples` to compile example files.

## 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.

## Content of the repository

```
├── README.md
├── build.lua
├── ctan.ann
└── sources
├── CTANREADME.md
├── scontents-code.tex
├── scontents.dtx
├── scontents.ins
├── scontents.sty
├── scontents.tex
├── t-scontents.mkiv
└── test-pkg
   ├── test-format.context.tex
   ├── test-format.latex.tex
   ├── test-format.plain.tex
   ├── test-nospace.tex
   ├── test-pkg-current.tex
   └── test-pkg-other.tex
```

## Copyright

Copyright (C) 2019-2024 by Pablo González L.